alert_types-8.x-1.x-dev/src/Entity/Alert.php
src/Entity/Alert.php
<?php
namespace Drupal\alert_types\Entity;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Entity\RevisionableContentEntityBase;
use Drupal\Core\Entity\RevisionableInterface;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\user\UserInterface;
/**
* Defines the Alert entity.
*
* @ingroup alert_types
*
* @ContentEntityType(
* id = "alert",
* label = @Translation("Alert"),
* label_collection = @Translation("Alerts"),
* label_singular = @Translation("Alert"),
* label_plural = @Translation("alerts"),
* label_count = @PluralTranslation(
* singular = "@count alert",
* plural = "@count alerts"
* ),
* bundle_label = @Translation("Alert type"),
* handlers = {
* "storage" = "Drupal\alert_types\AlertStorage",
* "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
* "list_builder" = "Drupal\alert_types\AlertListBuilder",
* "views_data" = "Drupal\alert_types\Entity\AlertViewsData",
* "translation" = "Drupal\alert_types\AlertTranslationHandler",
* "form" = {
* "default" = "Drupal\alert_types\Form\AlertForm",
* "add" = "Drupal\alert_types\Form\AlertForm",
* "edit" = "Drupal\alert_types\Form\AlertForm",
* "delete" = "Drupal\alert_types\Form\AlertDeleteForm",
* },
* "access" = "Drupal\alert_types\AlertAccessControlHandler",
* "route_provider" = {
* "html" = "Drupal\alert_types\AlertHtmlRouteProvider",
* },
* },
* base_table = "alert",
* data_table = "alert_field_data",
* revision_table = "alert_revision",
* revision_data_table = "alert_field_revision",
* show_revision_ui = TRUE,
* translatable = TRUE,
* admin_permission = "administer alert entities",
* entity_keys = {
* "id" = "id",
* "revision" = "vid",
* "bundle" = "type",
* "label" = "name",
* "uuid" = "uuid",
* "uid" = "user_id",
* "langcode" = "langcode",
* "status" = "status",
* },
* revision_metadata_keys = {
* "revision_user" = "revision_uid",
* "revision_created" = "revision_timestamp",
* "revision_log_message" = "revision_log"
* },
* links = {
* "canonical" = "/alert/{alert}",
* "add-page" = "/alert/add",
* "add-form" = "/alert/add/{alert_type}",
* "edit-form" = "/alert/{alert}/edit",
* "delete-form" = "/alert/{alert}/delete",
* "version-history" = "/admin/structure/alert/{alert}/revisions",
* "revision" = "/admin/structure/alert/{alert}/revisions/{alert_revision}/view",
* "revision_revert" = "/admin/structure/alert/{alert}/revisions/{alert_revision}/revert",
* "revision_delete" = "/admin/structure/alert/{alert}/revisions/{alert_revision}/delete",
* "translation_revert" = "/admin/structure/alert/{alert}/revisions/{alert_revision}/revert/{langcode}",
* "collection" = "/admin/content/alerts",
* },
* bundle_entity_type = "alert_type",
* field_ui_base_route = "entity.alert_type.edit_form"
* )
*/
class Alert extends RevisionableContentEntityBase implements AlertInterface {
use EntityChangedTrait;
/**
* {@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 alert owner
// the revision author.
if (!$this->getRevisionUser()) {
$this->setRevisionUserId($this->getOwnerId());
}
}
/**
* {@inheritdoc}
*/
public function getName() {
return $this->get('name')->value;
}
/**
* {@inheritdoc}
*/
public function setName($name) {
$this->set('name', $name);
return $this;
}
/**
* {@inheritdoc}
*/
public function getMessage() {
return $this->get('message')->value;
}
/**
* {@inheritdoc}
*/
public function setMessage($name) {
$this->set('message', $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 function isActive() {
return (bool) $this->getEntityKey('status');
}
/**
* {@inheritdoc}
*/
public function getWeight() {
return $this->get('weight')->value;
}
/**
* {@inheritdoc}
*/
public function setWeight($weight) {
$this->set('weight', $weight);
return $this;
}
/**
* {@inheritdoc}
*/
public function getDismisstimer() {
return $this->get('dismiss_timer')->value;
}
/**
* {@inheritdoc}
*/
public function setDismissTimer($seconds) {
$this->set('dismiss_timer', $seconds);
return $this;
}
/**
* {@inheritdoc}
*/
public function setActive($active) {
$this->set('status', $active ? TRUE : FALSE);
return $this;
}
/**
* {@inheritdoc}
*/
public function getConditions() {
if (!empty($this->get('conditions')->value)) {
return unserialize($this->get('conditions')->value);
}
return [];
}
/**
* {@inheritdoc}
*/
public function setConditions(array $conditions) {
$conditions = serialize($conditions);
$this->set('conditions', [$conditions]);
return $this;
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['user_id'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Authored by'))
->setDescription(t('The user ID of author of the Alert entity.'))
->setRevisionable(TRUE)
->setSetting('target_type', 'user')
->setSetting('handler', 'default')
->setTranslatable(TRUE)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'author',
'weight' => 0,
])
->setDisplayOptions('form', [
'type' => 'entity_reference_autocomplete',
'weight' => 5,
'settings' => [
'match_operator' => 'CONTAINS',
'size' => '60',
'autocomplete_type' => 'tags',
'placeholder' => '',
],
])
->setDisplayConfigurable('form', TRUE)
->setDisplayConfigurable('view', TRUE);
$fields['name'] = BaseFieldDefinition::create('string')
->setLabel(t('Name'))
->setRevisionable(TRUE)
->setSettings([
'text_processing' => 0,
])
->setDefaultValue('')
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'string',
'weight' => -4,
])
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -4,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayConfigurable('view', TRUE)
->setRequired(TRUE)
->setTranslatable(TRUE);
$fields['message'] = BaseFieldDefinition::create('string_long')
->setLabel(t('Message'))
->setRevisionable(TRUE)
->setSettings([
'text_processing' => 0,
])
->setDefaultValue('')
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'string',
'weight' => -4,
])
->setDisplayOptions('form', [
'type' => 'string_textarea',
'weight' => -4,
'settings' => [
'rows' => 4,
],
])
->setDisplayConfigurable('form', TRUE)
->setDisplayConfigurable('view', TRUE)
->setRequired(FALSE)
->setTranslatable(TRUE);
$fields['dismissable'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Dismissable'))
->setDescription(t('Allow users to dismiss this alert.'))
->setRevisionable(TRUE)
->setDefaultValue(FALSE)
->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
'weight' => -4,
])
->setDisplayConfigurable('form', TRUE);
$fields['dismiss_timer'] = BaseFieldDefinition::create('integer')
->setLabel(t('Auto Dismiss'))
->setDescription(t('Automatically dismiss this alert after a certain number of seconds. Set to 0 to disable.'))
->setDefaultValue(0)
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -4,
])
->setDisplayConfigurable('form', TRUE);
$fields['conditions'] = BaseFieldDefinition::create('string_long')
->setLabel(t('Conditions'))
->setDescription(t('Store conditions in serialized array'))
->setDefaultValue('')
->setDisplayConfigurable('form', FALSE)
->setDisplayConfigurable('view', FALSE);
$fields['weight'] = BaseFieldDefinition::create('integer')
->setLabel(t('Weight'))
->setDescription(t('The weight of this alert in relation to other alerts.'))
->setDefaultValue(0);
$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['status'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Active'))
->setRevisionable(TRUE)
->setDefaultValue(TRUE)
->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
])
->setDisplayConfigurable('form', TRUE);
$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;
}
}
