You are here

interface PhoneNumberSettingsInterface in SMS Framework 8

Same name and namespace in other branches
  1. 2.x src/Entity/PhoneNumberSettingsInterface.php \Drupal\sms\Entity\PhoneNumberSettingsInterface
  2. 2.1.x src/Entity/PhoneNumberSettingsInterface.php \Drupal\sms\Entity\PhoneNumberSettingsInterface

Interface for SMS Gateway configuration entity.

Hierarchy

Expanded class hierarchy of PhoneNumberSettingsInterface

All classes that implement PhoneNumberSettingsInterface

5 files declare their use of PhoneNumberSettingsInterface
AdminSettingsForm.php in modules/sms_user/src/Form/AdminSettingsForm.php
PhoneNumberSettings.php in src/Plugin/migrate/destination/PhoneNumberSettings.php
SmsFrameworkPhoneNumberVerificationTest.php in tests/src/Kernel/SmsFrameworkPhoneNumberVerificationTest.php
SmsFrameworkTestTrait.php in tests/src/Functional/SmsFrameworkTestTrait.php
sms_user.module in modules/sms_user/sms_user.module
Provides integration between the SMS Framework and Drupal users.

File

src/Entity/PhoneNumberSettingsInterface.php, line 10

Namespace

Drupal\sms\Entity
View source
interface PhoneNumberSettingsInterface extends ConfigEntityInterface {

  /**
   * Gets the phone number settings entity type.
   *
   * @return string
   *   Entity type ID of phone number settings.
   */
  public function getPhoneNumberEntityTypeId();

  /**
   * Sets the phone number settings entity type.
   *
   * @param string $entity_type_id
   *   Entity type ID of phone number settings.
   *
   * @return $this
   *   Return phone number settings for chaining.
   */
  public function setPhoneNumberEntityTypeId($entity_type_id);

  /**
   * Gets the phone number settings bundle.
   *
   * @return string
   *   Bundle of phone number settings.
   */
  public function getPhoneNumberBundle();

  /**
   * Sets the phone number settings bundle.
   *
   * @param string $bundle
   *   Bundle of phone number settings.
   *
   * @return $this
   *   Return phone number settings for chaining.
   */
  public function setPhoneNumberBundle($bundle);

  /**
   * Gets the message template to send for phone number verification.
   *
   * @return string
   *   Message template to send for phone number verification.
   */
  public function getVerificationMessage();

  /**
   * Sets the message template to send for phone number verification.
   *
   * @param string $message
   *   Message template to send for phone number verification.
   *
   * @return $this
   *   Return phone number settings for chaining.
   */
  public function setVerificationMessage($message);

  /**
   * Gets the number of seconds before phone number verifications expire.
   *
   * @return int
   *   Number of seconds before phone number verifications expire.
   */
  public function getVerificationCodeLifetime();

  /**
   * Sets the number of seconds before phone number verifications expire.
   *
   * @param int $lifetime
   *   Number of seconds before phone number verifications expire.
   *
   * @return $this
   *   Return phone number settings for chaining.
   */
  public function setVerificationCodeLifetime($lifetime);

  /**
   * Whether phone numbers are purged when verifications expire.
   *
   * Determines if phone number field values are removed when phone number
   * verifications expire.
   *
   * @return bool
   *   Whether to remove phone number field values
   */
  public function getPurgeVerificationPhoneNumber();

  /**
   * Whether phone numbers should be purged when verifications expire.
   *
   * Sets if phone number field values are removed when phone number
   * verifications expire.
   *
   * @param bool $purge
   *   Whether to remove phone number field values.
   *
   * @return $this
   *   Return phone number settings for chaining.
   */
  public function setPurgeVerificationPhoneNumber($purge);

  /**
   * Gets a field mapping.
   *
   * @param string $map
   *   ID to map field name, as found in sms.phone.*.*.fields.$map.
   *
   * @return string|null
   *   A field name, or NULL if not set.
   */
  public function getFieldName($map);

  /**
   * Gets a field mapping.
   *
   * @param string $map
   *   ID to map field name, as found in sms.phone.*.*.fields.$map.
   * @param string|null $field_name
   *   A field name, or NULL to unset.
   *
   * @return $this
   *   Return phone number settings for chaining.
   */
  public function setFieldName($map, $field_name);

}

Members

Namesort descending 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
PhoneNumberSettingsInterface::getFieldName public function Gets a field mapping. 1
PhoneNumberSettingsInterface::getPhoneNumberBundle public function Gets the phone number settings bundle. 1
PhoneNumberSettingsInterface::getPhoneNumberEntityTypeId public function Gets the phone number settings entity type. 1
PhoneNumberSettingsInterface::getPurgeVerificationPhoneNumber public function Whether phone numbers are purged when verifications expire. 1
PhoneNumberSettingsInterface::getVerificationCodeLifetime public function Gets the number of seconds before phone number verifications expire. 1
PhoneNumberSettingsInterface::getVerificationMessage public function Gets the message template to send for phone number verification. 1
PhoneNumberSettingsInterface::setFieldName public function Gets a field mapping. 1
PhoneNumberSettingsInterface::setPhoneNumberBundle public function Sets the phone number settings bundle. 1
PhoneNumberSettingsInterface::setPhoneNumberEntityTypeId public function Sets the phone number settings entity type. 1
PhoneNumberSettingsInterface::setPurgeVerificationPhoneNumber public function Whether phone numbers should be purged when verifications expire. 1
PhoneNumberSettingsInterface::setVerificationCodeLifetime public function Sets the number of seconds before phone number verifications expire. 1
PhoneNumberSettingsInterface::setVerificationMessage public function Sets the message template to send for phone number verification. 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