You are here

Home » API reference » SAML Service Provider 4.x » Idp.php

class Idp in SAML Service Provider 4.x

Same name and namespace in other branches
  1. 8.3 src/Entity/Idp.php \Drupal\saml_sp\Entity\Idp
  2. 8.2 src/Entity/Idp.php \Drupal\saml_sp\Entity\Idp
  3. 3.x src/Entity/Idp.php \Drupal\saml_sp\Entity\Idp

Defines the Idp entity.

Plugin annotation


@ConfigEntityType(
  id = "idp",
  label = @Translation("Identity Provider"),
  handlers = {
    "list_builder" = "Drupal\saml_sp\Controller\IdpListBuilder",
    "form" = {
      "add" = "Drupal\saml_sp\Form\IdpForm",
      "edit" = "Drupal\saml_sp\Form\IdpForm",
      "delete" = "Drupal\saml_sp\Form\IdpDeleteForm",
    }
  },
  config_prefix = "idp",
  admin_permission = "configure saml sp",
  entity_keys = {
    "id" = "id",
    "label" = "label",
  },
  links = {
    "edit-form" = "/admin/config/people/saml_sp/idp/edit/{idp}",
    "delete-form" = "/admin/config/people/saml_sp/idp/delete/{idp}",
  },
  config_export = {
    "id",
    "label",
    "entity_id",
    "app_name",
    "nameid_field",
    "login_url",
    "logout_url",
    "x509_cert",
    "authn_context_class_ref",
  }
)

Hierarchy

Expanded class hierarchy of Idp

3 files declare their use of Idp
SamlSPDrupalLoginController.php in modules/saml_sp_drupal_login/src/Controller/SamlSPDrupalLoginController.php
saml_sp.module in ./saml_sp.module
SAML Service Provider.
saml_sp_drupal_login.module in modules/saml_sp_drupal_login/saml_sp_drupal_login.module
SAML Drupal Login.

File

src/Entity/Idp.php, line 45

Namespace

Drupal\saml_sp\Entity
View source 
class Idp extends ConfigEntityBase implements IdpInterface {

  /**
   * The machine name of the IdP entity.
   *
   * @var string
   */
  protected $id;

  /**
   * The human-readable name of the IdP entity.
   *
   * @var string
   */
  protected $label;

  /**
   * The name of this application provided to the Identity Provider server.
   *
   * @var string
   */
  protected $app_name;

  /**
   * Authentication methods used by the Identity Provider server.
   *
   * @var array
   */
  protected $authn_context_class_ref;

  /**
   * The entityID that the Identity Provider server will use to identiy itself.
   *
   * @var string
   */
  protected $entity_id;

  /**
   * Login URL of the Identity Provider server.
   *
   * @var string
   */
  protected $login_url;

  /**
   * Logout URL of the Identity Provider server.
   *
   * @var string
   */
  protected $logout_url;

  /**
   * The field used to uniquely identify users.
   *
   * @var string
   */
  protected $nameid_field;

  /**
   * X.509 certificate of the Identity Provider server.
   *
   * @var array
   */
  protected $x509_cert;

  /**
   * {@inheritdoc}
   */

  // phpcs:ignore
  public function __construct(array $values = [], $entity_type = 'idp') {
    return parent::__construct($values, $entity_type);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getAuthnContextClassRef() {
    return is_array($this->authn_context_class_ref) ? $this->authn_context_class_ref : FALSE;
  }

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

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function setAuthnContextClassRef(array $authn_context_class_refs) {
    $array = [];
    foreach ($authn_context_class_refs as $value) {
      if ($value) {
        $array[$value] = $value;
      }
    }
    $this->authn_context_class_ref = $array;
  }

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function setX509Cert(array $x509_certs) {
    if (isset($x509_certs['actions'])) {
      unset($x509_certs['actions']);
    }
    $this->x509_cert = $x509_certs;
  }

}

Members

Namesort descending 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
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 14
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::__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.
Idp::$app_name protected property The name of this application provided to the Identity Provider server.
Idp::$authn_context_class_ref protected property Authentication methods used by the Identity Provider server.
Idp::$entity_id protected property The entityID that the Identity Provider server will use to identiy itself.
Idp::$id protected property The machine name of the IdP entity.
Idp::$label protected property The human-readable name of the IdP entity.
Idp::$login_url protected property Login URL of the Identity Provider server.
Idp::$logout_url protected property Logout URL of the Identity Provider server.
Idp::$nameid_field protected property The field used to uniquely identify users.
Idp::$x509_cert protected property X.509 certificate of the Identity Provider server.
Idp::getAppName public function Returns the application name provided to the IdP server. Overrides IdpInterface::getAppName
Idp::getAuthnContextClassRef public function Returns the authentication methods requested for this IdP. Overrides IdpInterface::getAuthnContextClassRef
Idp::getEntityId public function Returns the entity ID of the IdP server. Overrides IdpInterface::getEntityId
Idp::getLoginUrl public function Returns the IdP server's login URL. Overrides IdpInterface::getLoginUrl
Idp::getLogoutUrl public function Returns the IdP server's login URL. Overrides IdpInterface::getLogoutUrl
Idp::getNameIdField public function Returns the response field used to uniquely identify a user. Overrides IdpInterface::getNameIdField
Idp::getX509Cert public function Returns the X.509 certificates for the IdP server. Overrides IdpInterface::getX509Cert
Idp::setAppName public function Sets the application name. Overrides IdpInterface::setAppName
Idp::setAuthnContextClassRef public function Sets the authentication methods requested for this IdP. Overrides IdpInterface::setAuthnContextClassRef
Idp::setEntityId public function Sets the entity ID of the IdP server. Overrides IdpInterface::setEntityId
Idp::setLoginUrl public function Sets the IdP server's login URL. Overrides IdpInterface::setLoginUrl
Idp::setLogoutUrl public function Sets the IdP server's logout URL. Overrides IdpInterface::setLogoutUrl
Idp::setNameIdField public function Sets the response field used to uniquely identify a user. Overrides IdpInterface::setNameIdField
Idp::setX509Cert public function Sets the X.509 certificates for the IdP server. Overrides IdpInterface::setX509Cert
Idp::__construct public function Constructs an Entity object. Overrides ConfigEntityBase::__construct
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