You are here

interface EventTypeInterface in RNG - Events and Registrations 8.2

Same name and namespace in other branches
  1. 3.x src/Entity/EventTypeInterface.php \Drupal\rng\Entity\EventTypeInterface

Provides an interface defining a event config entity.

Hierarchy

Expanded class hierarchy of EventTypeInterface

All classes that implement EventTypeInterface

5 files declare their use of EventTypeInterface
EventManager.php in src/EventManager.php
EventManagerInterface.php in src/EventManagerInterface.php
EventTypeDefaultMessagesAddForm.php in src/Form/EventTypeDefaultMessagesAddForm.php
EventTypeRuleDeleteAll.php in src/Form/EventTypeRuleDeleteAll.php
rng.module in ./rng.module

File

src/Entity/EventTypeInterface.php, line 10

Namespace

Drupal\rng\Entity
View source
interface EventTypeInterface extends ConfigEntityInterface {

  /**
   * Get event entity type ID.
   *
   * @return string
   *   An entity type ID.
   */
  public function getEventEntityTypeId();

  /**
   * Sets the event entity type ID.
   *
   * @param string $entity_type
   *   An entity type ID.
   */
  public function setEventEntityTypeId($entity_type);

  /**
   * Get event bundle.
   *
   * @return string
   *   A bundle name.
   */
  public function getEventBundle();

  /**
   * Sets the event bundle.
   *
   * @param string $bundle
   *   A bundle name.
   */
  public function setEventBundle($bundle);

  /**
   * Gets which permission on event entity grants 'event manage' permission.
   */
  public function getEventManageOperation();

  /**
   * Sets operation to mirror from the event entity.
   *
   * @param string $permission
   *   The operation to mirror.
   *
   * @return static
   *   Return this event type for chaining.
   */
  public function setEventManageOperation($permission);

  /**
   * Gets whether anonymous registrants should be created/used.
   *
   * @return bool
   *   The setting.
   */
  public function getAllowAnonRegistrants();

  /**
   * Set whether or not to allow anonymous registrants.
   *
   * @param bool $allow_anon_registrants
   *
   * @return static
   *   Return this event type for chaining.
   */
  public function setAllowAnonRegistrants($allow_anon_registrants);

  /**
   * Gets whether registrants should automatically sync with their identities.
   *
   * @return bool
   *   The setting.
   */
  public function getAutoSyncRegistrants();

  /**
   * Set whether or not to automatically sync identity data with registrant data.
   *
   * @param bool $auto_sync_registrants
   *
   * @return static
   *   Return this event type for chaining.
   */
  public function setAutoSyncRegistrants($auto_sync_registrants);

  /**
   * Gets whether existing users should be added as identities when email matches.
   *
   * @return bool
   *   The setting.
   */
  public function getAutoAttachUsers();

  /**
   * Set whether or not to automatically add user identities that match by email.
   *
   * @param bool $auto_attach_users
   *
   * @return static
   *   Return this event type for chaining.
   */
  public function setAutoAttachUsers($auto_attach_users);

  /**
   * Gets the machine name of field containing email on registrant to use for sync.
   *
   * @return string
   *   The setting.
   */
  public function getRegistrantEmailField();

  /**
   * Set the machine name of an email field on the registrant to use for sync.
   *
   * @param string $registrant_email_field
   *
   * @return static
   *   Return this event type for chaining.
   */
  public function setRegistrantEmailField($registrant_email_field);

  /**
   * Gets the machine name of the field containing the event start date on the ewent entity.
   *
   * @return string|bppl
   *   The start date field.
   */
  public function getEventStartDateField();

  /**
   * Set the machine name of the start date field.
   *
   * @param string $event_start_date_field
   *
   * @return static
   *   Return this event type for chaining.
   */
  public function setEventStartDateField($event_start_date_field);

  /**
   * Gets the machine name of the field containing the event end date on the event entity.
   *
   * @return string|bool
   *   The end date field.
   */
  public function getEventEndDateField();

  /**
   * Set the machine name of the end date field. Uses end_value if daterange.
   *
   * @param string $event_end_date_field
   *
   * @return static
   *   Return this event type for chaining.
   */
  public function setEventEndDateField($event_end_date_field);

  /**
   * Whether to allow event managers to customize default rules.
   *
   * @return bool
   *   Whether event managers are allowed to customize default rules.
   */
  public function getAllowCustomRules();

  /**
   * Set whether event managers can customize default rules.
   *
   * @param bool $allow
   *   Whether event managers are allowed to customize default rules.
   *
   * @return $this
   *   Return this event type for chaining.
   */
  public function setAllowCustomRules($allow);

  /**
   * Registrant type for new registrants associated with this event type.
   *
   * @return string|null
   *   The Registrant type used for new registrants associated with this event
   *   type.
   */
  public function getDefaultRegistrantType();

  /**
   * Default messages configured for this event type.
   *
   * @return array
   */
  public function getDefaultMessages();

  /**
   * Set default messages for this event type.
   *
   * @param array $messages
   *   Default messages array.
   */
  public function setDefaultMessages($messages);

  /**
   * Whether a identity type can be created.
   *
   * @param string $entity_type
   *   The identity entity type ID.
   * @param string $bundle
   *   The identity bundle.
   *
   * @return bool
   *   Whether a identity type can be created.
   */
  public function canIdentityTypeCreate($entity_type, $bundle);

  /**
   * Set whether an identity type can be created.
   *
   * @param string $entity_type
   *   The identity entity type ID.
   * @param string $bundle
   *   The identity bundle.
   * @param bool $enabled
   *   Whether the identity type can be created.
   *
   * @return $this
   *   Return this event type for chaining.
   */
  public function setIdentityTypeCreate($entity_type, $bundle, $enabled);

  /**
   * Get the form display mode used when the identity is created inline.
   *
   * @param string $entity_type
   *   The identity entity type ID.
   * @param string $bundle
   *   The identity bundle.
   *
   * @return string
   *   The form display mode used when the identity is created inline.
   */
  public function getIdentityTypeEntityFormMode($entity_type, $bundle);

  /**
   * Get the form display modes for creating identities inline.
   *
   * @return array
   *   An array keyed as follows: [entity_type][bundle] = form_mode.
   */
  public function getIdentityTypeEntityFormModes();

  /**
   * Set the form display mode used when the identity is created inline.
   *
   * @param string $entity_type
   *   The identity entity type ID.
   * @param string $bundle
   *   The identity bundle.
   * @param string $form_mode
   *   The form mode ID.
   *
   * @return $this
   *   Return this event type for chaining.
   */
  public function setIdentityTypeEntityFormMode($entity_type, $bundle, $form_mode);

  /**
   * Whether an existing identity type can be referenced.
   *
   * @param string $entity_type
   *   The identity entity type ID.
   * @param string $bundle
   *   The identity bundle.
   *
   * @return bool
   *   Whether an existing identity type can be referenced.
   */
  public function canIdentityTypeReference($entity_type, $bundle);

  /**
   * Set whether existing identity type can be referenced.
   *
   * @param string $entity_type
   *   The identity entity type ID.
   * @param string $bundle
   *   The identity bundle.
   * @param bool $enabled
   *   Whether existing identity type can be referenced.
   *
   * @return $this
   *   Return this event type for chaining.
   */
  public function setIdentityTypeReference($entity_type, $bundle, $enabled);

  /**
   * Set registrant type for new registrants associated with this event type.
   *
   * @param string|null $registrant_type_id
   *   The Registrant type used for new registrants associated with this event
   *   type.
   *
   * @return $this
   *   Return this event type for chaining.
   */
  public function setDefaultRegistrantType($registrant_type_id);

  /**
   * Create or clean up courier_context if none exist for an entity type.
   *
   * @param string $entity_type
   *   Entity type of the event type.
   * @param string $operation
   *   An operation: 'create' or 'delete'.
   */
  public static function courierContextCC($entity_type, $operation);

}

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
EventTypeInterface::canIdentityTypeCreate public function Whether a identity type can be created. 1
EventTypeInterface::canIdentityTypeReference public function Whether an existing identity type can be referenced. 1
EventTypeInterface::courierContextCC public static function Create or clean up courier_context if none exist for an entity type. 1
EventTypeInterface::getAllowAnonRegistrants public function Gets whether anonymous registrants should be created/used. 1
EventTypeInterface::getAllowCustomRules public function Whether to allow event managers to customize default rules. 1
EventTypeInterface::getAutoAttachUsers public function Gets whether existing users should be added as identities when email matches. 1
EventTypeInterface::getAutoSyncRegistrants public function Gets whether registrants should automatically sync with their identities. 1
EventTypeInterface::getDefaultMessages public function Default messages configured for this event type. 1
EventTypeInterface::getDefaultRegistrantType public function Registrant type for new registrants associated with this event type. 1
EventTypeInterface::getEventBundle public function Get event bundle. 1
EventTypeInterface::getEventEndDateField public function Gets the machine name of the field containing the event end date on the event entity. 1
EventTypeInterface::getEventEntityTypeId public function Get event entity type ID. 1
EventTypeInterface::getEventManageOperation public function Gets which permission on event entity grants 'event manage' permission. 1
EventTypeInterface::getEventStartDateField public function Gets the machine name of the field containing the event start date on the ewent entity. 1
EventTypeInterface::getIdentityTypeEntityFormMode public function Get the form display mode used when the identity is created inline. 1
EventTypeInterface::getIdentityTypeEntityFormModes public function Get the form display modes for creating identities inline. 1
EventTypeInterface::getRegistrantEmailField public function Gets the machine name of field containing email on registrant to use for sync. 1
EventTypeInterface::setAllowAnonRegistrants public function Set whether or not to allow anonymous registrants. 1
EventTypeInterface::setAllowCustomRules public function Set whether event managers can customize default rules. 1
EventTypeInterface::setAutoAttachUsers public function Set whether or not to automatically add user identities that match by email. 1
EventTypeInterface::setAutoSyncRegistrants public function Set whether or not to automatically sync identity data with registrant data. 1
EventTypeInterface::setDefaultMessages public function Set default messages for this event type. 1
EventTypeInterface::setDefaultRegistrantType public function Set registrant type for new registrants associated with this event type. 1
EventTypeInterface::setEventBundle public function Sets the event bundle. 1
EventTypeInterface::setEventEndDateField public function Set the machine name of the end date field. Uses end_value if daterange. 1
EventTypeInterface::setEventEntityTypeId public function Sets the event entity type ID. 1
EventTypeInterface::setEventManageOperation public function Sets operation to mirror from the event entity. 1
EventTypeInterface::setEventStartDateField public function Set the machine name of the start date field. 1
EventTypeInterface::setIdentityTypeCreate public function Set whether an identity type can be created. 1
EventTypeInterface::setIdentityTypeEntityFormMode public function Set the form display mode used when the identity is created inline. 1
EventTypeInterface::setIdentityTypeReference public function Set whether existing identity type can be referenced. 1
EventTypeInterface::setRegistrantEmailField public function Set the machine name of an email field on the registrant to use for sync. 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