class SitewideAlert in Sitewide Alert 8

Defines the Sitewide Alert entity.

Plugin annotation


@ContentEntityType(
  id = "sitewide_alert",
  label = @Translation("Sitewide Alert"),
  label_plural = @Translation("Sitewide Alerts"),
  label_collection = @Translation("Sitewide Alerts"),
  handlers = {
    "storage" = "Drupal\sitewide_alert\SitewideAlertStorage",
    "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
    "list_builder" = "Drupal\sitewide_alert\SitewideAlertListBuilder",
    "views_data" = "Drupal\sitewide_alert\Entity\SitewideAlertViewsData",
    "translation" = "Drupal\sitewide_alert\SitewideAlertTranslationHandler",

    "form" = {
      "default" = "Drupal\sitewide_alert\Form\SitewideAlertForm",
      "add" = "Drupal\sitewide_alert\Form\SitewideAlertForm",
      "edit" = "Drupal\sitewide_alert\Form\SitewideAlertForm",
      "delete" = "Drupal\sitewide_alert\Form\SitewideAlertDeleteForm",
    },
    "route_provider" = {
      "html" = "Drupal\sitewide_alert\SitewideAlertHtmlRouteProvider",
    },
    "access" = "Drupal\sitewide_alert\SitewideAlertAccessControlHandler",
  },
  base_table = "sitewide_alert",
  data_table = "sitewide_alert_field_data",
  revision_table = "sitewide_alert_revision",
  revision_data_table = "sitewide_alert_field_revision",
  show_revision_ui = TRUE,
  translatable = TRUE,
  admin_permission = "administer sitewide alert entities",
  entity_keys = {
    "id" = "id",
    "revision" = "vid",
    "label" = "name",
    "uuid" = "uuid",
    "uid" = "user_id",
    "langcode" = "langcode",
    "published" = "status",
  },
  revision_metadata_keys = {
    "revision_user" = "revision_user",
    "revision_created" = "revision_created",
    "revision_log_message" = "revision_log",
  },
  links = {
    "canonical" = "/admin/content/sitewide_alert/{sitewide_alert}",
    "add-form" = "/admin/content/sitewide_alert/add",
    "edit-form" = "/admin/content/sitewide_alert/{sitewide_alert}/edit",
    "delete-form" = "/admin/content/sitewide_alert/{sitewide_alert}/delete",
    "version-history" = "/admin/content/sitewide_alert/{sitewide_alert}/revisions",
    "revision" = "/admin/content/sitewide_alert/{sitewide_alert}/revisions/{sitewide_alert_revision}/view",
    "revision_revert" = "/admin/content/sitewide_alert/{sitewide_alert}/revisions/{sitewide_alert_revision}/revert",
    "revision_delete" = "/admin/content/sitewide_alert/{sitewide_alert}/revisions/{sitewide_alert_revision}/delete",
    "translation_revert" = "/admin/content/sitewide_alert/{sitewide_alert}/revisions/{sitewide_alert_revision}/revert/{langcode}",
    "collection" = "/admin/content/sitewide_alert",
  },
  field_ui_base_route = "sitewide_alert.settings",
  constraints = {
    "ScheduledDateProvided" = {}
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
  - class \Drupal\Core\Entity\EditorialContentEntityBase implements EntityChangedInterface, EntityPublishedInterface, RevisionLogInterface uses EntityChangedTrait, EntityPublishedTrait, RevisionLogEntityTrait
    class \Drupal\sitewide_alert\Entity\SitewideAlert implements SitewideAlertInterface uses EntityChangedTrait, EntityPublishedTrait

Expanded class hierarchy of SitewideAlert

File

src/Entity/SitewideAlert.php, line 85

Namespace

Drupal\sitewide_alert\Entity

View source

class SitewideAlert extends EditorialContentEntityBase implements SitewideAlertInterface {
  use EntityChangedTrait;
  use EntityPublishedTrait;

  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage_controller, array &$values) {
    parent::preCreate($storage_controller, $values);
    $values += [
      'user_id' => \Drupal::currentUser()
        ->id(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) {
    $uri_route_parameters = parent::urlRouteParameters($rel);
    if ($rel === 'revision_revert' && $this instanceof RevisionableInterface) {
      $uri_route_parameters[$this
        ->getEntityTypeId() . '_revision'] = $this
        ->getRevisionId();
    }
    elseif ($rel === 'revision_delete' && $this instanceof RevisionableInterface) {
      $uri_route_parameters[$this
        ->getEntityTypeId() . '_revision'] = $this
        ->getRevisionId();
    }
    return $uri_route_parameters;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);
    foreach (array_keys($this
      ->getTranslationLanguages()) as $langcode) {
      $translation = $this
        ->getTranslation($langcode);

      // If no owner has been set explicitly, make the anonymous user the owner.
      if (!$translation
        ->getOwner()) {
        $translation
          ->setOwnerId(0);
      }
    }

    // If no revision author has been set explicitly,
    // make the sitewide_alert owner the revision author.
    if (!$this
      ->getRevisionUser()) {
      $this
        ->setRevisionUserId($this
        ->getOwnerId());
    }

    // Unset the date field if this entity is not marked as scheduled.
    if (!$this
      ->isScheduled()) {
      $this
        ->set('scheduled_date', [
        'value' => NULL,
        'end_value' => NULL,
      ]);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this
      ->get('name')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setName($name) {
    $this
      ->set('name', $name);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this
      ->get('created')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCreatedTime($timestamp) {
    $this
      ->set('created', $timestamp);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwner() {
    return $this
      ->get('user_id')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwnerId() {
    return $this
      ->get('user_id')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwnerId($uid) {
    $this
      ->set('user_id', $uid);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwner(UserInterface $account) {
    $this
      ->set('user_id', $account
      ->id());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);

    // Add the published field.
    $fields += static::publishedBaseFieldDefinitions($entity_type);
    $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Authored by'))
      ->setDescription(t('The user ID of author of this Sitewide Alert.'))
      ->setRevisionable(TRUE)
      ->setSetting('target_type', 'user')
      ->setSetting('handler', 'default')
      ->setTranslatable(TRUE)
      ->setDisplayOptions('form', [
      'type' => 'entity_reference_autocomplete',
      'weight' => 5,
      'settings' => [
        'match_operator' => 'CONTAINS',
        'size' => '60',
        'autocomplete_type' => 'tags',
        'placeholder' => '',
      ],
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', FALSE);
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('A brief description of this Sitewide Alert. Used for administrative reference only.'))
      ->setRevisionable(TRUE)
      ->setSettings([
      'max_length' => 50,
      'text_processing' => 0,
    ])
      ->setDefaultValue('')
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => -15,
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE)
      ->setRequired(TRUE);
    $fields['status']
      ->setLabel(new TranslatableMarkup('Active'))
      ->setDescription(t('If selected this Sitewide Alert will be active and will show if all other conditions are met.'))
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'weight' => 99,
    ]);
    $fields['style'] = BaseFieldDefinition::create('list_string')
      ->setLabel(new TranslatableMarkup('Alert Style'))
      ->setDescription(new TranslatableMarkup('The style of this alert. This mainly can be used to change the color of the alert.'))
      ->setSettings([
      'allowed_values_function' => '\\Drupal\\sitewide_alert\\AlertStyleProvider::alertStyles',
    ])
      ->setDisplayOptions('form', [
      'type' => 'options_select',
      'weight' => -14,
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE)
      ->setRequired(TRUE);
    $fields['dismissible'] = BaseFieldDefinition::create('boolean')
      ->setLabel(new TranslatableMarkup('Dismissible'))
      ->setDescription(new TranslatableMarkup('If selected, visitors will be able to dismiss the alert so it will not be seen again. This is per browser, and does not require the visitor to be logged in.'))
      ->setRequired(FALSE)
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'weight' => -10,
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
    $fields['dismissible_ignore_before_time'] = BaseFieldDefinition::create('timestamp')
      ->setLabel(new TranslatableMarkup('Ignore Dismissals Before'))
      ->setDefaultValue(0)
      ->setDescription(new TranslatableMarkup('Ignore any dismissals made before this date. If you are editing an existing alert, and this is a major change to the content, you may want to ignore the fact that this alert was dismissed.'))
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
    $fields['limit_to_pages'] = BaseFieldDefinition::create('string_long')
      ->setLabel(t('Pages'))
      ->setDescription(new TranslatableMarkup('Specify pages by using their paths. Enter one path per line. The \'*\' character is a wildcard. An example path is /user/* for every user page. / is the front page.'))
      ->setTranslatable(FALSE)
      ->setRevisionable(TRUE)
      ->setSettings([
      'default_value' => '',
    ])
      ->setDefaultValue('')
      ->setDisplayOptions('form', [
      'type' => 'string_textarea',
      'weight' => -5,
      'settings' => [
        'rows' => 4,
      ],
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE)
      ->setRequired(FALSE);
    $fields['limit_to_pages_negate'] = BaseFieldDefinition::create('boolean')
      ->setLabel(new TranslatableMarkup('Negate for listed pages'))
      ->setRequired(TRUE)
      ->setDefaultValue(FALSE)
      ->setDisplayOptions('form', [
      'type' => 'options_buttons',
      'label' => 'hidden',
      'weight' => -4,
      'settings' => [
        'on_label' => 'Hide for the listed pages',
        'off_label' => 'Show for the listed pages',
      ],
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
    $fields['message'] = BaseFieldDefinition::create('text_long')
      ->setLabel(t('Alert Message'))
      ->setTranslatable(TRUE)
      ->setRevisionable(TRUE)
      ->setSettings([
      'default_value' => '',
      'text_processing' => 0,
    ])
      ->setDefaultValue('')
      ->setDisplayOptions('form', [
      'type' => 'text_textarea',
      'weight' => -13,
      'settings' => [
        'rows' => 4,
      ],
    ])
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'text_default',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE)
      ->setRequired(TRUE);
    $fields['scheduled_alert'] = BaseFieldDefinition::create('boolean')
      ->setLabel(new TranslatableMarkup('Schedule Alert'))
      ->setDescription(new TranslatableMarkup('Schedule this alert to start and stop showing at a particular date/time.'))
      ->setRequired(FALSE)
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'weight' => -8,
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
    $fields['scheduled_date'] = BaseFieldDefinition::create('daterange')
      ->setLabel(new TranslatableMarkup('Date'))
      ->setDescription(t('This defines when this Sitewide Alert be scheduled to show.'))
      ->setRequired(FALSE)
      ->setDisplayOptions('form', [
      'type' => 'daterange_default',
      'weight' => -7,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time that the entity was created.'));
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the entity was last edited.'));
    $fields['revision_translation_affected'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Revision translation affected'))
      ->setDescription(t('Indicates if the last edit of a translation belongs to current revision.'))
      ->setReadOnly(TRUE)
      ->setRevisionable(TRUE)
      ->setTranslatable(TRUE);
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function isScheduled() : bool {
    return (bool) $this
      ->get('scheduled_alert')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function isScheduledToShowAt(\DateTime $dateTime) {

    // If this Sitewide Alert is not a scheduled alert, it should show regardless of time.
    if (!$this
      ->isScheduled()) {
      return TRUE;
    }
    $startTime = $this
      ->getScheduledStartDateTime();
    $endTime = $this
      ->getScheduledEndDateTime();

    // The Sitewide Alert is marked as scheduled but dates have not been provided.
    if ($startTime === NULL || $endTime === NULL) {
      return FALSE;
    }

    // Convert to a DrupalDatetime.
    $dateTimeToCompare = DrupalDateTime::createFromDateTime($dateTime);
    return $dateTimeToCompare >= $startTime && $dateTimeToCompare <= $endTime;
  }

  /**
   * {@inheritdoc}
   */
  public function getScheduledStartDateTime() : ?DrupalDateTime {
    $value = $this
      ->get('scheduled_date')->value;
    if ($value === NULL || is_array($value) && (empty($value['date']) || empty($value['time']))) {
      return NULL;
    }
    return DrupalDateTime::createFromFormat(DateTimeItemInterface::DATETIME_STORAGE_FORMAT, $value, DateTimeItemInterface::STORAGE_TIMEZONE);
  }

  /**
   * {@inheritdoc}
   */
  public function getScheduledEndDateTime() : ?DrupalDateTime {
    $end_value = $this
      ->get('scheduled_date')->end_value;
    if ($end_value === NULL || is_array($end_value) && (empty($end_value['date']) || empty($end_value['time']))) {
      return NULL;
    }
    return DrupalDateTime::createFromFormat(DateTimeItemInterface::DATETIME_STORAGE_FORMAT, $end_value, DateTimeItemInterface::STORAGE_TIMEZONE);
  }

  /**
   * {@inheritdoc}
   */
  public function isDismissible() : bool {
    return (bool) $this
      ->get('dismissible')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function getDismissibleIgnoreBeforeTime() : int {
    return $this
      ->get('dismissible_ignore_before_time')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setDismissibleIgnoreBeforeTime($timestamp) : SitewideAlertInterface {
    $this
      ->get('dismissible_ignore_before_time')->value = $timestamp;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getStyle() : string {
    return $this
      ->get('style')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function getStyleClass() : string {
    return Html::cleanCssIdentifier('alert-' . $this
      ->get('style')->value);
  }

  /**
   * {@inheritdoc}
   */
  public function getPagesToShowOn() : array {
    $paths = [];
    $pagesString = $this
      ->get('limit_to_pages')->value;

    // If it has not been set return no restrictions.
    if (!$pagesString) {
      return $paths;
    }
    foreach (explode("\n", strip_tags($pagesString)) as $path) {
      $path = trim($path);
      if (!empty($path) && strpos($path, '/') === 0) {
        $paths[] = $path;
      }
    }
    return $paths;
  }

  /**
   * {@inheritdoc}
   */
  public function shouldNegatePagesToShowOn() : bool {
    return (bool) $this
      ->get('limit_to_pages_negate')->value;
  }

}

Members

Name	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.
ContentEntityBase::$activeLangcode	protected	property	Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode	protected	property	Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey	protected	property	The default langcode entity key.
ContentEntityBase::$enforceRevisionTranslationAffected	protected	property	Whether the revision translation affected flag has been enforced.
ContentEntityBase::$entityKeys	protected	property	Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions	protected	property	Local cache for field definitions.
ContentEntityBase::$fields	protected	property	The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck	protected static	property	Local cache for fields to skip from the checking for translation changes.
ContentEntityBase::$isDefaultRevision	protected	property	Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey	protected	property	The language entity key.
ContentEntityBase::$languages	protected	property	Local cache for the available language objects.
ContentEntityBase::$loadedRevisionId	protected	property	The loaded revision ID before the new revision was set.
ContentEntityBase::$newRevision	protected	property	Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$revisionTranslationAffectedKey	protected	property	The revision translation affected entity key.
ContentEntityBase::$translatableEntityKeys	protected	property	Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize	protected	property	A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations	protected	property	An array of entity translation metadata.
ContentEntityBase::$validated	protected	property	Whether entity validation was performed.
ContentEntityBase::$validationRequired	protected	property	Whether entity validation is required before saving the entity.
ContentEntityBase::$values	protected	property	The plain data values of the contained fields.
ContentEntityBase::access	public	function	Checks data value access. Overrides EntityBase::access	1
ContentEntityBase::addTranslation	public	function	Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions	4
ContentEntityBase::clearTranslationCache	protected	function	Clear entity translation object cache to remove stale references.
ContentEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ContentEntityBase::get	public	function	Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey	protected	function	Gets the value of the given entity key, if defined.	1
ContentEntityBase::getFieldDefinition	public	function	Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions	public	function	Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields	public	function	Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck	protected	function	Returns an array of field names to skip in ::hasTranslationChanges.	1
ContentEntityBase::getIterator	public	function
ContentEntityBase::getLanguages	protected	function
ContentEntityBase::getLoadedRevisionId	public	function	Gets the loaded Revision ID of the entity. Overrides RevisionableInterface::getLoadedRevisionId
ContentEntityBase::getRevisionId	public	function	Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields	public	function	Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField	protected	function	Gets a translated field.
ContentEntityBase::getTranslation	public	function	Gets a translation of the data. Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages	public	function	Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getTranslationStatus	public	function	Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated	public	function	Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField	public	function	Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation	public	function	Checks there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface::hasTranslationChanges
ContentEntityBase::id	public	function	Gets the identifier. Overrides EntityBase::id
ContentEntityBase::initializeTranslation	protected	function	Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision	public	function	Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation	public	function	Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isDefaultTranslationAffectedOnly	public	function	Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly
ContentEntityBase::isLatestRevision	public	function	Checks if this entity is the latest revision. Overrides RevisionableInterface::isLatestRevision
ContentEntityBase::isLatestTranslationAffectedRevision	public	function	Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision
ContentEntityBase::isNewRevision	public	function	Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation	public	function	Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected
ContentEntityBase::isRevisionTranslationAffectedEnforced	public	function	Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced
ContentEntityBase::isTranslatable	public	function	Returns the translation support status. Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::label	public	function	Gets the label of the entity. Overrides EntityBase::label	2
ContentEntityBase::language	public	function	Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange	public	function	Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate
ContentEntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave	5
ContentEntityBase::preSaveRevision	public	function	Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision	2
ContentEntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities	1
ContentEntityBase::removeTranslation	public	function	Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set	public	function	Sets a field value. Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode	protected	function	Populates the local cache for the default language code.
ContentEntityBase::setNewRevision	public	function	Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected
ContentEntityBase::setRevisionTranslationAffectedEnforced	public	function	Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced
ContentEntityBase::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray
ContentEntityBase::updateFieldLangcodes	protected	function	Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId	public	function	Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface::updateLoadedRevisionId
ContentEntityBase::updateOriginalValues	public	function	Updates the original values with the interim changes.
ContentEntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate	public	function	Validates the currently set values. Overrides FieldableEntityInterface::validate
ContentEntityBase::wasDefaultRevision	public	function	Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface::wasDefaultRevision
ContentEntityBase::__clone	public	function	Magic method: Implements a deep clone.
ContentEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct
ContentEntityBase::__get	public	function	Implements the magic method for getting object properties.
ContentEntityBase::__isset	public	function	Implements the magic method for isset().
ContentEntityBase::__set	public	function	Implements the magic method for setting object properties.
ContentEntityBase::__sleep	public	function	Overrides EntityBase::__sleep
ContentEntityBase::__unset	public	function	Implements the magic method for unset().
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
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::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::entityManager Deprecated	protected	function	Gets the entity manager.
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::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate	2
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName	1
EntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget	1
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::getOriginalId	public	function	Gets the original ID. Overrides EntityInterface::getOriginalId	1
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::invalidateTagsOnDelete	protected static	function	Invalidates an entity's cache tags upon delete.	1
EntityBase::invalidateTagsOnSave	protected	function	Invalidates an entity's cache tags upon save.	1
EntityBase::isNew	public	function	Determines whether the entity is new. Overrides EntityInterface::isNew	2
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link	1
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::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete	4
EntityBase::save	public	function	Saves an entity permanently. Overrides EntityInterface::save	3
EntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityInterface::setOriginalId	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityInterface::toUrl	2
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityInterface::url	2
EntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityInterface::urlInfo	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
EntityChangedTrait::getChangedTime	public	function	Gets the timestamp of the last entity change for the current translation.
EntityChangedTrait::getChangedTimeAcrossTranslations	public	function	Returns the timestamp of the last entity change across all translations.
EntityChangedTrait::setChangedTime	public	function	Sets the timestamp of the last entity change for the current translation.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck	protected	function	Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
EntityPublishedTrait::isPublished	public	function
EntityPublishedTrait::publishedBaseFieldDefinitions	public static	function	Returns an array of base field definitions for publishing status.
EntityPublishedTrait::setPublished	public	function
EntityPublishedTrait::setUnpublished	public	function
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
RevisionLogEntityTrait::getRevisionCreationTime	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().	1
RevisionLogEntityTrait::getRevisionLogMessage	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().	1
RevisionLogEntityTrait::getRevisionMetadataKey	protected static	function	Gets the name of a revision metadata field.
RevisionLogEntityTrait::getRevisionUser	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().	1
RevisionLogEntityTrait::getRevisionUserId	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().	1
RevisionLogEntityTrait::revisionLogBaseFieldDefinitions	public static	function	Provides revision-related base field definitions for an entity type.
RevisionLogEntityTrait::setRevisionCreationTime	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().	1
RevisionLogEntityTrait::setRevisionLogMessage	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().	1
RevisionLogEntityTrait::setRevisionUser	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().	1
RevisionLogEntityTrait::setRevisionUserId	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().	1
SitewideAlert::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type. Overrides EditorialContentEntityBase::baseFieldDefinitions
SitewideAlert::getCreatedTime	public	function	Gets the Sitewide Alert creation timestamp. Overrides SitewideAlertInterface::getCreatedTime
SitewideAlert::getDismissibleIgnoreBeforeTime	public	function	Gets the timestamp of when any dismissals should be ignored before. Overrides SitewideAlertInterface::getDismissibleIgnoreBeforeTime
SitewideAlert::getName	public	function	Gets the Sitewide Alert name. Overrides SitewideAlertInterface::getName
SitewideAlert::getOwner	public	function	Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
SitewideAlert::getOwnerId	public	function	Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
SitewideAlert::getPagesToShowOn	public	function	Gets the pages to show on. Overrides SitewideAlertInterface::getPagesToShowOn
SitewideAlert::getScheduledEndDateTime	public	function	Gets the end date of this Sitewide Alert. Overrides SitewideAlertInterface::getScheduledEndDateTime
SitewideAlert::getScheduledStartDateTime	public	function	Gets the start date of this Sitewide Alert. Overrides SitewideAlertInterface::getScheduledStartDateTime
SitewideAlert::getStyle	public	function
SitewideAlert::getStyleClass	public	function	Gets the style class to use for the alert. Overrides SitewideAlertInterface::getStyleClass
SitewideAlert::isDismissible	public	function	Returns weather or not the Sitewide Alert is dismissible. Overrides SitewideAlertInterface::isDismissible
SitewideAlert::isScheduled	public	function	Returns weather or not the Sitewide Alert is scheduled. Overrides SitewideAlertInterface::isScheduled
SitewideAlert::isScheduledToShowAt	public	function	Determines if this SitewideAlert should be shown at the given time. Overrides SitewideAlertInterface::isScheduledToShowAt
SitewideAlert::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityBase::preCreate
SitewideAlert::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
SitewideAlert::setCreatedTime	public	function	Sets the Sitewide Alert creation timestamp. Overrides SitewideAlertInterface::setCreatedTime
SitewideAlert::setDismissibleIgnoreBeforeTime	public	function	Sets the timestamp of when any dismissals should be ignored before. Overrides SitewideAlertInterface::setDismissibleIgnoreBeforeTime
SitewideAlert::setName	public	function	Sets the Sitewide Alert name. Overrides SitewideAlertInterface::setName
SitewideAlert::setOwner	public	function	Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
SitewideAlert::setOwnerId	public	function	Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
SitewideAlert::shouldNegatePagesToShowOn	public	function	Should we negate the pages we show on. Overrides SitewideAlertInterface::shouldNegatePagesToShowOn
SitewideAlert::urlRouteParameters	protected	function	Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
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
TranslationStatusInterface::TRANSLATION_CREATED		constant	Status code identifying a newly created translation.
TranslationStatusInterface::TRANSLATION_EXISTING		constant	Status code identifying an existing translation.
TranslationStatusInterface::TRANSLATION_REMOVED		constant	Status code identifying a removed translation.

You are here

class SitewideAlert in Sitewide Alert 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation