interface IdpInterface in SAML Service Provider 8.3

Provides an interface defining a Example entity.

Hierarchy

• interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
  • interface \Drupal\Core\Config\Entity\ConfigEntityInterface
    • interface \Drupal\saml_sp\IdpInterface

1 file declares its use of IdpInterface

Idp.php in src/Entity/Idp.php

File

src/IdpInterface.php, line 10

Namespace

Drupal\saml_sp

interface IdpInterface extends ConfigEntityInterface {

  /**
   * Returns the application name provided to the IdP server.
   *
   * @return string
   *   The application name.
   */
  public function getAppName();

  /**
   * Returns the authentication methods requested for this IdP.
   *
   * @return array
   *   The authentication methods.
   */
  public function getAuthnContextClassRef();

  /**
   * Returns the entity ID of the IdP server.
   *
   * @return string
   *   The IdP server's entity ID.
   */
  public function getEntityId();

  /**
   * Returns the IdP server's login URL.
   *
   * @return string
   *   The login URL.
   */
  public function getLoginUrl();

  /**
   * Returns the IdP server's login URL.
   *
   * @return string
   *   The logout URL.
   */
  public function getLogoutUrl();

  /**
   * Returns the response field used to uniquely identify a user.
   *
   * @return string
   *   The field name.
   */
  public function getNameIdField();

  /**
   * Returns the X.509 certificates for the IdP server.
   *
   * @return string
   *   The certificates.
   */
  public function getX509Cert();

  /**
   * Sets the application name.
   *
   * @param string $app_name
   *   The application name.
   */
  public function setAppName($app_name);

  /**
   * Sets the authentication methods requested for this IdP.
   *
   * @param array $authn_context_class_ref
   *   The authentication methods.
   */
  public function setAuthnContextClassRef(array $authn_context_class_ref);

  /**
   * Sets the entity ID of the IdP server.
   *
   * @param string $entity_id
   *   The IdP server's entity ID.
   */
  public function setEntityId($entity_id);

  /**
   * Sets the IdP server's login URL.
   *
   * @param string $login_url
   *   The login URL.
   */
  public function setLoginUrl($login_url);

  /**
   * Sets the IdP server's logout URL.
   *
   * @param string $logout_url
   *   The logout URL.
   */
  public function setLogoutUrl($logout_url);

  /**
   * Sets the response field used to uniquely identify a user.
   *
   * @param string $nameid_field
   *   The field name.
   */
  public function setNameIdField($nameid_field);

  /**
   * Sets the X.509 certificates for the IdP server.
   *
   * @param array $x509_certs
   *   The certificates.
   */
  public function setX509Cert(array $x509_certs);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
IdpInterface::getAppName	public	function	Returns the application name provided to the IdP server.	1
IdpInterface::getAuthnContextClassRef	public	function	Returns the authentication methods requested for this IdP.	1
IdpInterface::getEntityId	public	function	Returns the entity ID of the IdP server.	1
IdpInterface::getLoginUrl	public	function	Returns the IdP server's login URL.	1
IdpInterface::getLogoutUrl	public	function	Returns the IdP server's login URL.	1
IdpInterface::getNameIdField	public	function	Returns the response field used to uniquely identify a user.	1
IdpInterface::getX509Cert	public	function	Returns the X.509 certificates for the IdP server.	1
IdpInterface::setAppName	public	function	Sets the application name.	1
IdpInterface::setAuthnContextClassRef	public	function	Sets the authentication methods requested for this IdP.	1
IdpInterface::setEntityId	public	function	Sets the entity ID of the IdP server.	1
IdpInterface::setLoginUrl	public	function	Sets the IdP server's login URL.	1
IdpInterface::setLogoutUrl	public	function	Sets the IdP server's logout URL.	1
IdpInterface::setNameIdField	public	function	Sets the response field used to uniquely identify a user.	1
IdpInterface::setX509Cert	public	function	Sets the X.509 certificates for the IdP server.	1
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5