interface EventEnrollmentInterface in Open Social 8.9
Same name and namespace in other branches
- 8 modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 8.2 modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 8.3 modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 8.4 modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 8.5 modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 8.6 modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 8.7 modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 8.8 modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 10.3.x modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 10.0.x modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 10.1.x modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
- 10.2.x modules/social_features/social_event/src/EventEnrollmentInterface.php \Drupal\social_event\EventEnrollmentInterface
Provides an interface for defining Event enrollment entities.
Hierarchy
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable; interface \Drupal\Core\Entity\EntityChangedInterface; interface \Drupal\user\EntityOwnerInterface
- interface \Drupal\social_event\EventEnrollmentInterface
Expanded class hierarchy of EventEnrollmentInterface
All classes that implement EventEnrollmentInterface
28 files declare their use of EventEnrollmentInterface
- ActivityFactory.php in modules/
custom/ activity_creator/ src/ ActivityFactory.php - CancelEnrollInviteController.php in modules/
social_features/ social_event/ modules/ social_event_invite/ src/ Controller/ CancelEnrollInviteController.php - EnrollActionForm.php in modules/
social_features/ social_event/ src/ Form/ EnrollActionForm.php - EnrollInviteEmailForm.php in modules/
social_features/ social_event/ modules/ social_event_invite/ src/ Form/ EnrollInviteEmailForm.php - EnrollRequestDeclineForm.php in modules/
social_features/ social_event/ src/ Form/ EnrollRequestDeclineForm.php
File
- modules/
social_features/ social_event/ src/ EventEnrollmentInterface.php, line 14
Namespace
Drupal\social_eventView source
interface EventEnrollmentInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {
/**
* Event enrollment method where users can directly enroll.
*/
const ENROLL_METHOD_JOIN = 1;
/**
* Event enrollment method where users need to request enrollment.
*/
const ENROLL_METHOD_REQUEST = 2;
/**
* Event enrollment method where users need to get invited.
*/
const ENROLL_METHOD_INVITE = 3;
/**
* Request created and waiting for event owners or managers response.
*/
const REQUEST_PENDING = 0;
/**
* Request approved by event owner or manager.
*/
const REQUEST_APPROVED = 1;
/**
* Request or invite declined by event owner, manager or user.
*/
const REQUEST_OR_INVITE_DECLINED = 2;
/**
* Invited, a status to check if a user has been invited.
*/
const INVITE_INVITED = 3;
/**
* Invite is pending by invited user.
*/
const INVITE_PENDING_REPLY = 4;
/**
* Invite has been accepted and the user joined.
*/
const INVITE_ACCEPTED_AND_JOINED = 5;
/**
* Invite is invalid or has been expired.
*/
const INVITE_INVALID_OR_EXPIRED = 6;
/**
* Gets the Event enrollment name.
*
* @return string
* Name of the Event enrollment.
*/
public function getName();
/**
* Sets the Event enrollment name.
*
* @param string $name
* The Event enrollment name.
*
* @return \Drupal\social_event\EventEnrollmentInterface
* The called Event enrollment entity.
*/
public function setName($name);
/**
* Gets the Event enrollment creation timestamp.
*
* @return int
* Creation timestamp of the Event enrollment.
*/
public function getCreatedTime();
/**
* Sets the Event enrollment creation timestamp.
*
* @param int $timestamp
* The Event enrollment creation timestamp.
*
* @return \Drupal\social_event\EventEnrollmentInterface
* The called Event enrollment entity.
*/
public function setCreatedTime($timestamp);
/**
* Returns the Event enrollment published status indicator.
*
* Unpublished Event enrollment are only visible to restricted users.
*
* @return bool
* TRUE if the Event enrollment is published.
*/
public function isPublished();
/**
* Sets the published status of a Event enrollment.
*
* @param bool $published
* TRUE to set this Event enrollment to published, FALSE for unpublished.
*
* @return \Drupal\social_event\EventEnrollmentInterface
* The called Event enrollment entity.
*/
public function setPublished($published);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 9 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 27 |
EntityChangedInterface:: |
public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedInterface:: |
public | function | Gets the timestamp of the last entity change across all translations. | |
EntityChangedInterface:: |
public | function | Sets the timestamp of the last entity change for the current translation. | |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public | function | Deprecated way of generating a link to the entity. See toLink(). | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the public URL for this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
EntityOwnerInterface:: |
public | function | Returns the entity owner's user entity. | 1 |
EntityOwnerInterface:: |
public | function | Returns the entity owner's user ID. | 1 |
EntityOwnerInterface:: |
public | function | Sets the entity owner's user entity. | 1 |
EntityOwnerInterface:: |
public | function | Sets the entity owner's user ID. | 1 |
EventEnrollmentInterface:: |
constant | Event enrollment method where users need to get invited. | ||
EventEnrollmentInterface:: |
constant | Event enrollment method where users can directly enroll. | ||
EventEnrollmentInterface:: |
constant | Event enrollment method where users need to request enrollment. | ||
EventEnrollmentInterface:: |
public | function | Gets the Event enrollment creation timestamp. | 1 |
EventEnrollmentInterface:: |
public | function | Gets the Event enrollment name. | 1 |
EventEnrollmentInterface:: |
constant | Invite has been accepted and the user joined. | ||
EventEnrollmentInterface:: |
constant | Invite is invalid or has been expired. | ||
EventEnrollmentInterface:: |
constant | Invited, a status to check if a user has been invited. | ||
EventEnrollmentInterface:: |
constant | Invite is pending by invited user. | ||
EventEnrollmentInterface:: |
public | function | Returns the Event enrollment published status indicator. | 1 |
EventEnrollmentInterface:: |
constant | Request approved by event owner or manager. | ||
EventEnrollmentInterface:: |
constant | Request or invite declined by event owner, manager or user. | ||
EventEnrollmentInterface:: |
constant | Request created and waiting for event owners or managers response. | ||
EventEnrollmentInterface:: |
public | function | Sets the Event enrollment creation timestamp. | 1 |
EventEnrollmentInterface:: |
public | function | Sets the Event enrollment name. | 1 |
EventEnrollmentInterface:: |
public | function | Sets the published status of a Event enrollment. | 1 |
FieldableEntityInterface:: |
public static | function | Provides base field definitions for an entity type. | 2 |
FieldableEntityInterface:: |
public static | function | Provides field definitions for a specific bundle. | 2 |
FieldableEntityInterface:: |
public | function | Gets a field item list. | 1 |
FieldableEntityInterface:: |
public | function | Gets the definition of a contained field. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of field definitions of all contained fields. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of all field item lists. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of field item lists for translatable fields. | 1 |
FieldableEntityInterface:: |
public | function | Determines whether the entity has a field with the given name. | 1 |
FieldableEntityInterface:: |
public | function | Checks whether entity validation is required before saving the entity. | 1 |
FieldableEntityInterface:: |
public | function | Reacts to changes to a field. | 1 |
FieldableEntityInterface:: |
public | function | Sets a field value. | 1 |
FieldableEntityInterface:: |
public | function | Sets whether entity validation is required before saving the entity. | 1 |
FieldableEntityInterface:: |
public | function |
Gets an array of all field values. Overrides EntityInterface:: |
|
FieldableEntityInterface:: |
public | function | Validates the currently set values. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
RevisionableInterface:: |
public | function | Gets the loaded Revision ID of the entity. | 1 |
RevisionableInterface:: |
public | function | Gets the revision identifier of the entity. | 1 |
RevisionableInterface:: |
public | function | Checks if this entity is the default revision. | 1 |
RevisionableInterface:: |
public | function | Checks if this entity is the latest revision. | 1 |
RevisionableInterface:: |
public | function | Determines whether a new revision should be created on save. | 1 |
RevisionableInterface:: |
public | function | Acts on a revision before it gets saved. | 1 |
RevisionableInterface:: |
public | function | Enforces an entity to be saved as a new revision. | 1 |
RevisionableInterface:: |
public | function | Updates the loaded Revision ID with the revision ID. | 1 |
RevisionableInterface:: |
public | function | Checks whether the entity object was a default revision when it was saved. | 1 |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | 1 |
TranslatableInterface:: |
public | function | Adds a new translation to the translatable object. | 1 |
TranslatableInterface:: |
public | function | Gets a translation of the data. | 1 |
TranslatableInterface:: |
public | function | Returns the languages the data is translated to. | 1 |
TranslatableInterface:: |
public | function | Returns the translatable object referring to the original language. | 1 |
TranslatableInterface:: |
public | function | Checks there is a translation for the given language code. | 1 |
TranslatableInterface:: |
public | function | Determines if the current translation of the entity has unsaved changes. | 1 |
TranslatableInterface:: |
public | function | Checks whether the translation is the default one. | 1 |
TranslatableInterface:: |
public | function | Checks whether the translation is new. | 1 |
TranslatableInterface:: |
public | function | Returns the translation support status. | 1 |
TranslatableInterface:: |
public | function | Removes the translation identified by the given language code. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks if untranslatable fields should affect only the default translation. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks whether this is the latest revision affecting this translation. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks whether the current translation is affected by the current revision. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks if the revision translation affected flag value has been enforced. | 1 |
TranslatableRevisionableInterface:: |
public | function | Marks the current revision translation as affected. | 1 |
TranslatableRevisionableInterface:: |
public | function | Enforces the revision translation affected flag value. | 1 |