You are here

Home » API reference » Rabbit Hole 2.x » BehaviorSettings.php

class BehaviorSettings in Rabbit Hole 2.x

Same name and namespace in other branches
  1. 8 src/Entity/BehaviorSettings.php \Drupal\rabbit_hole\Entity\BehaviorSettings

Defines the Behavior settings entity.

Plugin annotation


@ConfigEntityType(
  id = "behavior_settings",
  label = @Translation("Rabbit hole settings"),
  handlers = {},
  config_prefix = "behavior_settings",
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "uuid" = "uuid",
    "action" = "action",
    "allow_override" = "allow_override",
    "redirect" = "redirect",
    "redirect_code" = "redirect_code",
    "redirect_fallback_action" = "redirect_fallback_action"
  },
  config_export = {
    "id",
    "entity_type_id",
    "entity_id",
    "uuid",
    "action",
    "allow_override",
    "redirect",
    "redirect_code",
    "redirect_fallback_action"
  },
  links = {}
)

Hierarchy

Expanded class hierarchy of BehaviorSettings

5 files declare their use of BehaviorSettings
BehaviorSettingsManager.php in src/BehaviorSettingsManager.php
FormManglerService.php in src/FormManglerService.php
RabbitHoleBehaviorSettingsEntityMethodsTest.php in tests/src/Functional/RabbitHoleBehaviorSettingsEntityMethodsTest.php
RabbitHoleBehaviorSettingsFormTestBase.php in tests/src/Functional/RabbitHoleBehaviorSettingsFormTestBase.php
RabbitHoleBehaviorSettingsTest.php in tests/src/Functional/RabbitHoleBehaviorSettingsTest.php

File

src/Entity/BehaviorSettings.php, line 41

Namespace

Drupal\rabbit_hole\Entity
View source 
class BehaviorSettings extends ConfigEntityBase implements BehaviorSettingsInterface {
  const OVERRIDE_ALLOW = TRUE;
  const OVERRIDE_DISALLOW = FALSE;
  const REDIRECT_NOT_APPLICABLE = 0;
  const REDIRECT_MOVED_PERMANENTLY = 301;
  const REDIRECT_FOUND = 302;
  const REDIRECT_SEE_OTHER = 303;
  const REDIRECT_NOT_MODIFIED = 304;
  const REDIRECT_USE_PROXY = 305;
  const REDIRECT_TEMPORARY_REDIRECT = 307;

  /**
   * The Behavior settings ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The configured action (e.g. display_page).
   *
   * @var string
   */
  protected $action;

  /**
   * Whether inherited behaviors can be edited (if this is a bundle).
   *
   * @var bool
   */
  protected $allow_override;

  /**
   * The path to use for redirects (if the action is redirect).
   *
   * Todo: It may be possible to make this reliant on a plugin instead (i.e.
   *  the redirect plugin) - if so, we should probably do this.
   *
   * @var string
   */
  protected $redirect;

  /**
   * The code to use for redirects (if the action is redirect).
   *
   * Todo: It may be possible to make this reliant on a plugin instead (i.e.
   * the redirect plugin) - if so, we should probably do this.
   *
   * @var int
   */
  protected $redirect_code;

  /**
   * The entity type id, eg. 'node_type'.
   *
   * @var string
   */
  protected $entity_type_id;

  /**
   * The entity id, eg. 'article'.
   *
   * @var string
   */
  protected $entity_id;

  /**
   * {@inheritdoc}
   */
  public function setAction($action) {
    $this->action = $action;
  }

  /**
   * {@inheritdoc}
   */
  public function getAction() {
    return $this->action;
  }

  /**
   * {@inheritdoc}
   */
  public function setAllowOverride($allow_override) {
    if (!is_bool($allow_override)) {
      throw new InvalidBehaviorSettingException('allow_override');
    }
    $this->allow_override = $allow_override;
  }

  /**
   * {@inheritdoc}
   */
  public function getAllowOverride() {
    return $this->allow_override;
  }

  /**
   * {@inheritdoc}
   *
   * @todo Possibly this should instead rely on the redirect plugin?
   */
  public function setRedirectCode($redirect_code) {
    if (!in_array($redirect_code, [
      self::REDIRECT_NOT_APPLICABLE,
      self::REDIRECT_MOVED_PERMANENTLY,
      self::REDIRECT_FOUND,
      self::REDIRECT_SEE_OTHER,
      self::REDIRECT_NOT_MODIFIED,
      self::REDIRECT_USE_PROXY,
      self::REDIRECT_TEMPORARY_REDIRECT,
    ])) {
      throw new InvalidBehaviorSettingException('redirect_code');
    }
    if ($this->action !== 'redirect' && $redirect_code !== self::REDIRECT_NOT_APPLICABLE) {
      throw new InvalidBehaviorSettingException('redirect_code');
    }
    $this->redirect_code = $redirect_code;
  }

  /**
   * {@inheritdoc}
   */
  public function getRedirectCode() {
    return $this->redirect_code;
  }

  /**
   * {@inheritdoc}
   */
  public function setRedirectPath($redirect) {
    if ($this->action !== 'redirect' && $redirect != "") {
      throw new InvalidBehaviorSettingException('redirect');
    }
    $this->redirect = $redirect;
  }

  /**
   * {@inheritdoc}
   */
  public function getRedirectPath() {
    return $this->redirect;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();
    if ($this->entity_type_id && $this->entity_id) {

      // Create dependency on the bundle.
      $bundle = \Drupal::entityTypeManager()
        ->getDefinition($this->entity_type_id);
      $entity_type = \Drupal::entityTypeManager()
        ->getDefinition($bundle
        ->getBundleOf());
      $bundle_config_dependency = $entity_type
        ->getBundleConfigDependency($this->entity_id);
      $this
        ->addDependency($bundle_config_dependency['type'], $bundle_config_dependency['name']);
    }
    return $this;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BehaviorSettings::$action protected property The configured action (e.g. display_page).
BehaviorSettings::$allow_override protected property Whether inherited behaviors can be edited (if this is a bundle).
BehaviorSettings::$entity_id protected property The entity id, eg. 'article'.
BehaviorSettings::$entity_type_id protected property The entity type id, eg. 'node_type'.
BehaviorSettings::$id protected property The Behavior settings ID.
BehaviorSettings::$redirect protected property The path to use for redirects (if the action is redirect).
BehaviorSettings::$redirect_code protected property The code to use for redirects (if the action is redirect).
BehaviorSettings::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
BehaviorSettings::getAction public function Get the configured action. Overrides BehaviorSettingsInterface::getAction
BehaviorSettings::getAllowOverride public function Get whether overrides are allowed if this is for a bundle. Overrides BehaviorSettingsInterface::getAllowOverride
BehaviorSettings::getRedirectCode public function Get the redirect code if action is redirect. Overrides BehaviorSettingsInterface::getRedirectCode
BehaviorSettings::getRedirectPath public function Get the redirect path if action is redirect. Overrides BehaviorSettingsInterface::getRedirectPath
BehaviorSettings::OVERRIDE_ALLOW constant
BehaviorSettings::OVERRIDE_DISALLOW constant
BehaviorSettings::REDIRECT_FOUND constant
BehaviorSettings::REDIRECT_MOVED_PERMANENTLY constant
BehaviorSettings::REDIRECT_NOT_APPLICABLE constant
BehaviorSettings::REDIRECT_NOT_MODIFIED constant
BehaviorSettings::REDIRECT_SEE_OTHER constant
BehaviorSettings::REDIRECT_TEMPORARY_REDIRECT constant
BehaviorSettings::REDIRECT_USE_PROXY constant
BehaviorSettings::setAction public function Set the configured action. Overrides BehaviorSettingsInterface::setAction
BehaviorSettings::setAllowOverride public function Set whether overrides are allowed if this is for a bundle. Overrides BehaviorSettingsInterface::setAllowOverride
BehaviorSettings::setRedirectCode public function @todo Possibly this should instead rely on the redirect plugin? Overrides BehaviorSettingsInterface::setRedirectCode
BehaviorSettings::setRedirectPath public function Set the redirect path if action is redirect. Overrides BehaviorSettingsInterface::setRedirectPath
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function