Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\taxonomy\Entity;
Chris@0: 
Chris@18: use Drupal\Core\Entity\EditorialContentEntityBase;
Chris@0: use Drupal\Core\Entity\EntityStorageInterface;
Chris@0: use Drupal\Core\Entity\EntityTypeInterface;
Chris@0: use Drupal\Core\Field\BaseFieldDefinition;
Chris@0: use Drupal\taxonomy\TermInterface;
Chris@17: use Drupal\user\StatusItem;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines the taxonomy term entity.
Chris@0:  *
Chris@0:  * @ContentEntityType(
Chris@0:  *   id = "taxonomy_term",
Chris@0:  *   label = @Translation("Taxonomy term"),
Chris@17:  *   label_collection = @Translation("Taxonomy terms"),
Chris@17:  *   label_singular = @Translation("taxonomy term"),
Chris@17:  *   label_plural = @Translation("taxonomy terms"),
Chris@17:  *   label_count = @PluralTranslation(
Chris@17:  *     singular = "@count taxonomy term",
Chris@17:  *     plural = "@count taxonomy terms",
Chris@17:  *   ),
Chris@0:  *   bundle_label = @Translation("Vocabulary"),
Chris@0:  *   handlers = {
Chris@0:  *     "storage" = "Drupal\taxonomy\TermStorage",
Chris@0:  *     "storage_schema" = "Drupal\taxonomy\TermStorageSchema",
Chris@14:  *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
Chris@14:  *     "list_builder" = "Drupal\Core\Entity\EntityListBuilder",
Chris@0:  *     "access" = "Drupal\taxonomy\TermAccessControlHandler",
Chris@0:  *     "views_data" = "Drupal\taxonomy\TermViewsData",
Chris@0:  *     "form" = {
Chris@0:  *       "default" = "Drupal\taxonomy\TermForm",
Chris@0:  *       "delete" = "Drupal\taxonomy\Form\TermDeleteForm"
Chris@0:  *     },
Chris@0:  *     "translation" = "Drupal\taxonomy\TermTranslationHandler"
Chris@0:  *   },
Chris@0:  *   base_table = "taxonomy_term_data",
Chris@0:  *   data_table = "taxonomy_term_field_data",
Chris@18:  *   revision_table = "taxonomy_term_revision",
Chris@18:  *   revision_data_table = "taxonomy_term_field_revision",
Chris@0:  *   uri_callback = "taxonomy_term_uri",
Chris@0:  *   translatable = TRUE,
Chris@0:  *   entity_keys = {
Chris@0:  *     "id" = "tid",
Chris@18:  *     "revision" = "revision_id",
Chris@0:  *     "bundle" = "vid",
Chris@0:  *     "label" = "name",
Chris@0:  *     "langcode" = "langcode",
Chris@17:  *     "uuid" = "uuid",
Chris@17:  *     "published" = "status",
Chris@0:  *   },
Chris@18:  *   revision_metadata_keys = {
Chris@18:  *     "revision_user" = "revision_user",
Chris@18:  *     "revision_created" = "revision_created",
Chris@18:  *     "revision_log_message" = "revision_log_message",
Chris@18:  *   },
Chris@0:  *   bundle_entity_type = "taxonomy_vocabulary",
Chris@0:  *   field_ui_base_route = "entity.taxonomy_vocabulary.overview_form",
Chris@0:  *   common_reference_target = TRUE,
Chris@0:  *   links = {
Chris@0:  *     "canonical" = "/taxonomy/term/{taxonomy_term}",
Chris@0:  *     "delete-form" = "/taxonomy/term/{taxonomy_term}/delete",
Chris@0:  *     "edit-form" = "/taxonomy/term/{taxonomy_term}/edit",
Chris@0:  *     "create" = "/taxonomy/term",
Chris@0:  *   },
Chris@18:  *   permission_granularity = "bundle",
Chris@18:  *   constraints = {
Chris@18:  *     "TaxonomyHierarchy" = {}
Chris@18:  *   }
Chris@0:  * )
Chris@0:  */
Chris@18: class Term extends EditorialContentEntityBase implements TermInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function postDelete(EntityStorageInterface $storage, array $entities) {
Chris@0:     parent::postDelete($storage, $entities);
Chris@0: 
Chris@0:     // See if any of the term's children are about to be become orphans.
Chris@0:     $orphans = [];
Chris@17:     /** @var \Drupal\taxonomy\TermInterface $term */
Chris@17:     foreach ($entities as $tid => $term) {
Chris@17:       if ($children = $storage->getChildren($term)) {
Chris@17:         /** @var \Drupal\taxonomy\TermInterface $child */
Chris@0:         foreach ($children as $child) {
Chris@17:           $parent = $child->get('parent');
Chris@17:           // Update child parents item list.
Chris@17:           $parent->filter(function ($item) use ($tid) {
Chris@17:             return $item->target_id != $tid;
Chris@17:           });
Chris@17: 
Chris@0:           // If the term has multiple parents, we don't delete it.
Chris@17:           if ($parent->count()) {
Chris@17:             $child->save();
Chris@17:           }
Chris@17:           else {
Chris@0:             $orphans[] = $child;
Chris@0:           }
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     if (!empty($orphans)) {
Chris@0:       $storage->delete($orphans);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@17:   public function preSave(EntityStorageInterface $storage) {
Chris@17:     parent::preSave($storage);
Chris@17:     // Terms with no parents are mandatory children of <root>.
Chris@17:     if (!$this->get('parent')->count()) {
Chris@17:       $this->parent->target_id = 0;
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
Chris@0:     /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
Chris@0:     $fields = parent::baseFieldDefinitions($entity_type);
Chris@0: 
Chris@17:     // @todo Remove the usage of StatusItem in
Chris@17:     //   https://www.drupal.org/project/drupal/issues/2936864.
Chris@17:     $fields['status']->getItemDefinition()->setClass(StatusItem::class);
Chris@17: 
Chris@0:     $fields['tid']->setLabel(t('Term ID'))
Chris@0:       ->setDescription(t('The term ID.'));
Chris@0: 
Chris@0:     $fields['uuid']->setDescription(t('The term UUID.'));
Chris@0: 
Chris@0:     $fields['vid']->setLabel(t('Vocabulary'))
Chris@0:       ->setDescription(t('The vocabulary to which the term is assigned.'));
Chris@0: 
Chris@0:     $fields['langcode']->setDescription(t('The term language code.'));
Chris@0: 
Chris@0:     $fields['name'] = BaseFieldDefinition::create('string')
Chris@0:       ->setLabel(t('Name'))
Chris@0:       ->setTranslatable(TRUE)
Chris@18:       ->setRevisionable(TRUE)
Chris@0:       ->setRequired(TRUE)
Chris@0:       ->setSetting('max_length', 255)
Chris@0:       ->setDisplayOptions('view', [
Chris@0:         'label' => 'hidden',
Chris@0:         'type' => 'string',
Chris@0:         'weight' => -5,
Chris@0:       ])
Chris@0:       ->setDisplayOptions('form', [
Chris@0:         'type' => 'string_textfield',
Chris@0:         'weight' => -5,
Chris@0:       ])
Chris@0:       ->setDisplayConfigurable('form', TRUE);
Chris@0: 
Chris@0:     $fields['description'] = BaseFieldDefinition::create('text_long')
Chris@0:       ->setLabel(t('Description'))
Chris@0:       ->setTranslatable(TRUE)
Chris@18:       ->setRevisionable(TRUE)
Chris@0:       ->setDisplayOptions('view', [
Chris@0:         'label' => 'hidden',
Chris@0:         'type' => 'text_default',
Chris@0:         'weight' => 0,
Chris@0:       ])
Chris@0:       ->setDisplayConfigurable('view', TRUE)
Chris@0:       ->setDisplayOptions('form', [
Chris@0:         'type' => 'text_textfield',
Chris@0:         'weight' => 0,
Chris@0:       ])
Chris@0:       ->setDisplayConfigurable('form', TRUE);
Chris@0: 
Chris@0:     $fields['weight'] = BaseFieldDefinition::create('integer')
Chris@0:       ->setLabel(t('Weight'))
Chris@0:       ->setDescription(t('The weight of this term in relation to other terms.'))
Chris@0:       ->setDefaultValue(0);
Chris@0: 
Chris@0:     $fields['parent'] = BaseFieldDefinition::create('entity_reference')
Chris@0:       ->setLabel(t('Term Parents'))
Chris@0:       ->setDescription(t('The parents of this term.'))
Chris@0:       ->setSetting('target_type', 'taxonomy_term')
Chris@17:       ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED);
Chris@0: 
Chris@0:     $fields['changed'] = BaseFieldDefinition::create('changed')
Chris@0:       ->setLabel(t('Changed'))
Chris@0:       ->setDescription(t('The time that the term was last edited.'))
Chris@18:       ->setTranslatable(TRUE)
Chris@18:       ->setRevisionable(TRUE);
Chris@18: 
Chris@18:     // @todo Keep this field hidden until we have a revision UI for terms.
Chris@18:     // @see https://www.drupal.org/project/drupal/issues/2936995
Chris@18:     $fields['revision_log_message']->setDisplayOptions('form', [
Chris@18:       'region' => 'hidden',
Chris@18:     ]);
Chris@0: 
Chris@0:     return $fields;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@17:   public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
Chris@17:     // Only terms in the same bundle can be a parent.
Chris@17:     $fields['parent'] = clone $base_field_definitions['parent'];
Chris@17:     $fields['parent']->setSetting('handler_settings', ['target_bundles' => [$bundle => $bundle]]);
Chris@17:     return $fields;
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * {@inheritdoc}
Chris@17:    */
Chris@0:   public function getDescription() {
Chris@0:     return $this->get('description')->value;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setDescription($description) {
Chris@0:     $this->set('description', $description);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFormat() {
Chris@0:     return $this->get('description')->format;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setFormat($format) {
Chris@0:     $this->get('description')->format = $format;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getName() {
Chris@0:     return $this->label();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setName($name) {
Chris@0:     $this->set('name', $name);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getWeight() {
Chris@0:     return $this->get('weight')->value;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setWeight($weight) {
Chris@0:     $this->set('weight', $weight);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getVocabularyId() {
Chris@0:     @trigger_error('The ' . __METHOD__ . ' method is deprecated since version 8.4.0 and will be removed before 9.0.0. Use ' . __CLASS__ . '::bundle() instead to get the vocabulary ID.', E_USER_DEPRECATED);
Chris@0:     return $this->bundle();
Chris@0:   }
Chris@0: 
Chris@0: }