Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Entity;
Chris@0: 
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityBase;
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Base class for config entity types with settings for form and view modes.
Chris@0:  */
Chris@0: abstract class EntityDisplayModeBase extends ConfigEntityBase implements EntityDisplayModeInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The ID of the form or view mode.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $id;
Chris@0: 
Chris@0:   /**
Chris@0:    * The human-readable name of the form or view mode.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $label;
Chris@0: 
Chris@0:   /**
Chris@0:    * The entity type this form or view mode is used for.
Chris@0:    *
Chris@0:    * This is not to be confused with EntityDisplayModeBase::$entityType which is
Chris@0:    * inherited from Entity::$entityType.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $targetEntityType;
Chris@0: 
Chris@0:   /**
Chris@0:    * Whether or not this form or view mode has custom settings by default.
Chris@0:    *
Chris@0:    * If FALSE, entities displayed in this mode will reuse the 'default' display
Chris@0:    * settings by default (e.g. right after the module exposing the form or view
Chris@0:    * mode is enabled), but administrators can later use the Field UI to apply
Chris@0:    * custom display settings specific to the form or view mode.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $status = TRUE;
Chris@0: 
Chris@0:   /**
Chris@0:    * Whether or not the rendered output of this view mode is cached by default.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $cache = TRUE;
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
Chris@0:     /** @var \Drupal\Core\Entity\EntityDisplayModeInterface $a */
Chris@0:     /** @var \Drupal\Core\Entity\EntityDisplayModeInterface $b */
Chris@0:     // Sort by the type of entity the view mode is used for.
Chris@0:     $a_type = $a->getTargetType();
Chris@0:     $b_type = $b->getTargetType();
Chris@0:     $type_order = strnatcasecmp($a_type, $b_type);
Chris@0:     return $type_order != 0 ? $type_order : parent::sort($a, $b);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getTargetType() {
Chris@0:     return $this->targetEntityType;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setTargetType($target_entity_type) {
Chris@0:     $this->targetEntityType = $target_entity_type;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function calculateDependencies() {
Chris@0:     parent::calculateDependencies();
Chris@0:     $target_entity_type = \Drupal::entityManager()->getDefinition($this->targetEntityType);
Chris@0:     $this->addDependency('module', $target_entity_type->getProvider());
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function preSave(EntityStorageInterface $storage) {
Chris@0:     parent::preSave($storage);
Chris@0:     \Drupal::entityManager()->clearCachedFieldDefinitions();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function preDelete(EntityStorageInterface $storage, array $entities) {
Chris@0:     parent::preDelete($storage, $entities);
Chris@0:     \Drupal::entityManager()->clearCachedFieldDefinitions();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected function urlRouteParameters($rel) {
Chris@0:     $uri_route_parameters = parent::urlRouteParameters($rel);
Chris@0:     if ($rel === 'add-form') {
Chris@0:       $uri_route_parameters['entity_type_id'] = $this->getTargetType();
Chris@0:     }
Chris@0: 
Chris@0:     return $uri_route_parameters;
Chris@0:   }
Chris@0: 
Chris@0: }