class LoginDestination in Login Destination 8

Same name and namespace in other branches

8.2 src/Entity/LoginDestination.php \Drupal\login_destination\Entity\LoginDestination

Defines a login destination configuration entity.

Plugin annotation


@ConfigEntityType(
  id = "login_destination",
  label = @Translation("Login Destination"),
  handlers = {
    "form" = {
      "add" = "Drupal\login_destination\Form\LoginDestinationRuleForm",
      "edit" = "Drupal\login_destination\Form\LoginDestinationRuleForm",
      "delete" = "Drupal\login_destination\Form\LoginDestinationDeleteRuleForm",
    },
    "list_builder" = "Drupal\login_destination\Controller\LoginDestinationListBuilder",
  },
  admin_permission = "administer login destination settings",
  config_prefix = "destination",
  entity_keys = {
    "id" = "name",
    "uuid" = "uuid",
    "weight" = "weight",
  },
  links = {
    "edit-form" = "/admin/config/people/login-destination/{login_destination}/edit",
    "delete-form" = "/admin/config/people/login-destination/{login_destination}/delete",
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\login_destination\Entity\LoginDestination implements LoginDestinationInterface

Expanded class hierarchy of LoginDestination

6 files declare their use of LoginDestination

LoginDestinationCreationTrait.php in tests/src/Traits/LoginDestinationCreationTrait.php
LoginDestinationListBuilder.php in src/Controller/LoginDestinationListBuilder.php
LoginDestinationManager.php in src/LoginDestinationManager.php
LoginDestinationManagerInterface.php in src/LoginDestinationManagerInterface.php
LoginDestinationRuleForm.php in src/Form/LoginDestinationRuleForm.php

... See full list

File

src/Entity/LoginDestination.php, line 38

Namespace

Drupal\login_destination\Entity

View source

class LoginDestination extends ConfigEntityBase implements LoginDestinationInterface {

  /**
   * Redirect from all pages except listed.
   */
  const REDIRECT_NOT_LISTED = 0;

  /**
   * Redirect from only the listed pages.
   */
  const REDIRECT_LISTED = 1;

  /**
   * Login trigger.
   */
  const TRIGGER_LOGIN = 'login';

  /**
   * Registration trigger.
   */
  const TRIGGER_REGISTRATION = 'registration';

  /**
   * One-time login trigger.
   */
  const TRIGGER_ONE_TIME_LOGIN = 'one-time-login';

  /**
   * Logout trigger.
   */
  const TRIGGER_LOGOUT = 'logout';

  /**
   * The login destination machine name.
   *
   * @var string
   */
  public $name;

  /**
   * The login destination short description.
   *
   * @var string
   */
  public $label;

  /**
   * The login destination triggers.
   *
   * @var array
   */
  public $triggers = [];

  /**
   * The login destination roles.
   *
   * @var array
   */
  public $roles = [];

  /**
   * The login destination pages type.
   *
   * @var int
   */
  public $pages_type = self::REDIRECT_NOT_LISTED;

  /**
   * The login destination pages.
   *
   * @var string
   */
  public $pages = '';

  /**
   * The login destination language.
   *
   * @var string
   */
  public $language = '';

  /**
   * Status.
   *
   * @var bool
   */
  public $enabled = TRUE;

  /**
   * The login destination destination.
   *
   * @var string
   */
  public $destination_path;

  /**
   * The login destination weight.
   *
   * @var int
   */
  public $weight = 0;

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

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

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

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

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

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function viewTriggers() {
    $items = [];
    foreach ($this->triggers as $trigger) {
      if (empty($trigger)) {
        continue;
      }
      switch ($trigger) {
        case LoginDestination::TRIGGER_REGISTRATION:
          $items[] = t('Registration');
          break;
        case LoginDestination::TRIGGER_LOGIN:
          $items[] = t('Login');
          break;
        case LoginDestination::TRIGGER_ONE_TIME_LOGIN:
          $items[] = t('One-time login link');
          break;
        case LoginDestination::TRIGGER_LOGOUT:
          $items[] = t('Logout');
          break;
      }
    }
    return $this
      ->renderItemList($items, t('All triggers'));
  }

  /**
   * {@inheritdoc}
   */
  public function viewRoles() {
    $roles = $this
      ->getAllSystemRoles();
    $items = array_values(array_intersect_key($roles, $this->roles));
    return $this
      ->renderItemList($items, t('All roles'));
  }

  /**
   * {@inheritdoc}
   */
  public function viewPages() {
    $type = $this->pages_type;
    $pages = trim($this->pages);
    if (empty($pages)) {
      if ($type == self::REDIRECT_NOT_LISTED) {
        return t('All pages');
      }
      return t('No pages');
    }
    $pages = explode("\n", preg_replace('/\\r/', '', $this->pages));
    $items = [];
    foreach ($pages as $page) {
      $items[] = $type == self::REDIRECT_NOT_LISTED ? '~ ' . $page : $page;
    }
    return $this
      ->renderItemList($items, t('Empty'));
  }

  /**
   * {@inheritdoc}
   */
  public function viewDestination() {
    if ($this
      ->isDestinationCurrent()) {
      $scheme = 'internal';
    }
    else {
      $url = Url::fromUri($this->destination_path);
      $label = $this->destination_path;
      if ($url
        ->isExternal()) {
        return Html::escape($label);
      }
      $scheme = parse_url($this->destination_path, PHP_URL_SCHEME);
    }
    if ($scheme === 'internal') {
      return t('Internal destination');
    }
    if ($scheme === 'entity') {
      $params = $url
        ->getRouteParameters();
      $entity = \Drupal::entityTypeManager()
        ->getStorage('node')
        ->load(reset($params));
      return $entity
        ->get('title')->value;
    }
    return Html::escape($this->destination_path);
  }

  /**
   * Check is destination path links to a current page or not.
   *
   * @return bool
   *   TRUE or FALSE.
   */
  public function isDestinationCurrent() {
    return Unicode::strpos($this->destination_path, '<current>') !== FALSE;
  }

  /**
   * Render item list.
   *
   * @param array $array
   *   List of items.
   * @param string $empty_message
   *   Default empty message.
   *
   * @return string|\Drupal\Core\Render\Markup
   *   List of items or empty message.
   */
  protected function renderItemList(array $array, $empty_message) {
    $items = [];
    foreach ($array as $value) {
      if (!empty($value)) {
        $items[] = Html::escape($value);
      }
    }
    if (count($items) === 0) {
      return $empty_message;
    }
    $item_list = [
      '#theme' => 'item_list',
      '#items' => $items,
      '#list_type' => 'ul',
    ];
    return \Drupal::service('renderer')
      ->render($item_list);
  }

  /**
   * Get all roles in the system.
   *
   * @return array
   *   List of system roles.
   */
  public function getAllSystemRoles() {
    $role_options = [];
    foreach (user_roles(TRUE) as $role) {
      $role_options[$role
        ->id()] = $role
        ->label();
    }
    return $role_options;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
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	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
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::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
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::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
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::entityManager Deprecated	protected	function	Gets the entity manager.
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::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	16
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	5
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.
LoginDestination::$destination_path	public	property	The login destination destination.
LoginDestination::$enabled	public	property	Status.
LoginDestination::$label	public	property	The login destination short description.
LoginDestination::$language	public	property	The login destination language.
LoginDestination::$name	public	property	The login destination machine name.
LoginDestination::$pages	public	property	The login destination pages.
LoginDestination::$pages_type	public	property	The login destination pages type.
LoginDestination::$roles	public	property	The login destination roles.
LoginDestination::$triggers	public	property	The login destination triggers.
LoginDestination::$weight	public	property	The login destination weight.
LoginDestination::getAllSystemRoles	public	function	Get all roles in the system.
LoginDestination::getDestination	public	function	Get login destination. Overrides LoginDestinationInterface::getDestination
LoginDestination::getLabel	public	function	Get short description of the login destination rule. Overrides LoginDestinationInterface::getLabel
LoginDestination::getLanguage	public	function
LoginDestination::getMachineName	public	function	Get machine name for destination rule. Overrides LoginDestinationInterface::getMachineName
LoginDestination::getPages	public	function	Get pages. Overrides LoginDestinationInterface::getPages
LoginDestination::getPagesType	public	function	Get Type of pages: Overrides LoginDestinationInterface::getPagesType
LoginDestination::getRoles	public	function	Get Login destination roles. Overrides LoginDestinationInterface::getRoles
LoginDestination::getTriggers	public	function	Get Login Destination Rule triggers. Overrides LoginDestinationInterface::getTriggers
LoginDestination::getWeight	public	function	Get Login destination rule weight. Overrides LoginDestinationInterface::getWeight
LoginDestination::id	public	function	Gets the identifier. Overrides EntityBase::id
LoginDestination::isDestinationCurrent	public	function	Check is destination path links to a current page or not.
LoginDestination::isEnabled	public	function	Return status. Overrides LoginDestinationInterface::isEnabled
LoginDestination::REDIRECT_LISTED		constant	Redirect from only the listed pages.
LoginDestination::REDIRECT_NOT_LISTED		constant	Redirect from all pages except listed.
LoginDestination::renderItemList	protected	function	Render item list.
LoginDestination::TRIGGER_LOGIN		constant	Login trigger.
LoginDestination::TRIGGER_LOGOUT		constant	Logout trigger.
LoginDestination::TRIGGER_ONE_TIME_LOGIN		constant	One-time login trigger.
LoginDestination::TRIGGER_REGISTRATION		constant	Registration trigger.
LoginDestination::viewDestination	public	function	Prepare redirect destination for displaying. Overrides LoginDestinationInterface::viewDestination
LoginDestination::viewPages	public	function	Prepare list of pages for displaying. Overrides LoginDestinationInterface::viewPages
LoginDestination::viewRoles	public	function	Prepare list of roles for displaying. Overrides LoginDestinationInterface::viewRoles
LoginDestination::viewTriggers	public	function	Prepare list of triggers for displaying. Overrides LoginDestinationInterface::viewTriggers
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

You are here

class LoginDestination in Login Destination 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation