* @package Gedmo.Sluggable.Mapping.Driver * @subpackage Annotation * @link http://www.gediminasm.org * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ class Annotation implements AnnotationDriverInterface { /** * Annotation to mark field as sluggable and include it in slug building */ const SLUGGABLE = 'Gedmo\\Mapping\\Annotation\\Sluggable'; /** * Annotation to identify field as one which holds the slug * together with slug options */ const SLUG = 'Gedmo\\Mapping\\Annotation\\Slug'; /** * List of types which are valid for slug and sluggable fields * * @var array */ private $validTypes = array( 'string', 'text' ); /** * Annotation reader instance * * @var object */ private $reader; /** * original driver if it is available */ protected $_originalDriver = null; /** * {@inheritDoc} */ public function setAnnotationReader($reader) { $this->reader = $reader; } /** * {@inheritDoc} */ public function validateFullMetadata(ClassMetadata $meta, array $config) { if ($config && !isset($config['fields'])) { throw new InvalidMappingException("Unable to find any sluggable fields specified for Sluggable entity - {$meta->name}"); } } /** * {@inheritDoc} */ public function readExtendedMetadata(ClassMetadata $meta, array &$config) { $class = $meta->getReflectionClass(); // property annotations foreach ($class->getProperties() as $property) { if ($meta->isMappedSuperclass && !$property->isPrivate() || $meta->isInheritedField($property->name) || isset($meta->associationMappings[$property->name]['inherited']) ) { continue; } // sluggable property if ($sluggable = $this->reader->getPropertyAnnotation($property, self::SLUGGABLE)) { $field = $property->getName(); if (!$meta->hasField($field)) { throw new InvalidMappingException("Unable to find sluggable [{$field}] as mapped property in entity - {$meta->name}"); } if (!$this->isValidField($meta, $field)) { throw new InvalidMappingException("Cannot slug field - [{$field}] type is not valid and must be 'string' in class - {$meta->name}"); } $config['fields'][] = array('field' => $field, 'position' => $sluggable->position); } // slug property if ($slug = $this->reader->getPropertyAnnotation($property, self::SLUG)) { $field = $property->getName(); if (!$meta->hasField($field)) { throw new InvalidMappingException("Unable to find slug [{$field}] as mapped property in entity - {$meta->name}"); } if (!$this->isValidField($meta, $field)) { throw new InvalidMappingException("Cannot use field - [{$field}] for slug storage, type is not valid and must be 'string' in class - {$meta->name}"); } <<<<<<< HEAD if (isset($config['slug'])) { throw new InvalidMappingException("There cannot be two slug fields: [{$slugField}] and [{$config['slug']}], in class - {$meta->name}."); } $config['slug'] = $field; $config['style'] = $slug->style; $config['updatable'] = $slug->updatable; $config['unique'] = $slug->unique; $config['separator'] = $slug->separator; ======= $config['slugFields'][$field]['slug'] = $field; $config['slugFields'][$field]['style'] = $slug->style; $config['slugFields'][$field]['updatable'] = $slug->updatable; $config['slugFields'][$field]['unique'] = $slug->unique; $config['slugFields'][$field]['separator'] = $slug->separator; >>>>>>> a6dd4fd... Fixed coding standard problems } } } /** * Checks if $field type is valid as Sluggable field * * @param ClassMetadata $meta * @param string $field * @return boolean */ protected function isValidField(ClassMetadata $meta, $field) { $mapping = $meta->getFieldMapping($field); return $mapping && in_array($mapping['type'], $this->validTypes); } /** * Passes in the mapping read by original driver * * @param $driver * @return void */ public function setOriginalDriver($driver) { $this->_originalDriver = $driver; } }