Made Actor, Activity and Case entities

This commit is contained in:
naomi
2018-04-29 13:58:46 +02:00
parent 398a6c71a3
commit 249003bf16
83 changed files with 5914 additions and 4 deletions

View File

@ -0,0 +1,281 @@
<?php
namespace Drupal\opencase_entities\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 Activity entity.
*
* @ingroup opencase_entities
*
* @ContentEntityType(
* id = "oc_activity",
* label = @Translation("Activity"),
* bundle_label = @Translation("Activity type"),
* handlers = {
* "storage" = "Drupal\opencase_entities\OCActivityStorage",
* "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
* "list_builder" = "Drupal\opencase_entities\OCActivityListBuilder",
* "views_data" = "Drupal\opencase_entities\Entity\OCActivityViewsData",
* "translation" = "Drupal\opencase_entities\OCActivityTranslationHandler",
*
* "form" = {
* "default" = "Drupal\opencase_entities\Form\OCActivityForm",
* "add" = "Drupal\opencase_entities\Form\OCActivityForm",
* "edit" = "Drupal\opencase_entities\Form\OCActivityForm",
* "delete" = "Drupal\opencase_entities\Form\OCActivityDeleteForm",
* },
* "access" = "Drupal\opencase_entities\OCActivityAccessControlHandler",
* "route_provider" = {
* "html" = "Drupal\opencase_entities\OCActivityHtmlRouteProvider",
* },
* },
* base_table = "oc_activity",
* data_table = "oc_activity_field_data",
* revision_table = "oc_activity_revision",
* revision_data_table = "oc_activity_field_revision",
* translatable = TRUE,
* admin_permission = "administer activity entities",
* entity_keys = {
* "id" = "id",
* "revision" = "vid",
* "bundle" = "type",
* "label" = "name",
* "uuid" = "uuid",
* "uid" = "user_id",
* "langcode" = "langcode",
* "status" = "status",
* },
* links = {
* "canonical" = "/admin/opencase/oc_activity/{oc_activity}",
* "add-page" = "/admin/opencase/oc_activity/add",
* "add-form" = "/admin/opencase/oc_activity/add/{oc_activity_type}",
* "edit-form" = "/admin/opencase/oc_activity/{oc_activity}/edit",
* "delete-form" = "/admin/opencase/oc_activity/{oc_activity}/delete",
* "version-history" = "/admin/opencase/oc_activity/{oc_activity}/revisions",
* "revision" = "/admin/opencase/oc_activity/{oc_activity}/revisions/{oc_activity_revision}/view",
* "revision_revert" = "/admin/opencase/oc_activity/{oc_activity}/revisions/{oc_activity_revision}/revert",
* "revision_delete" = "/admin/opencase/oc_activity/{oc_activity}/revisions/{oc_activity_revision}/delete",
* "translation_revert" = "/admin/opencase/oc_activity/{oc_activity}/revisions/{oc_activity_revision}/revert/{langcode}",
* "collection" = "/admin/opencase/oc_activity",
* },
* bundle_entity_type = "oc_activity_type",
* field_ui_base_route = "entity.oc_activity_type.edit_form"
* )
*/
class OCActivity extends RevisionableContentEntityBase implements OCActivityInterface {
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 oc_activity 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 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 isPublished() {
return (bool) $this->getEntityKey('status');
}
/**
* {@inheritdoc}
*/
public function setPublished($published) {
$this->set('status', $published ? TRUE : FALSE);
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 Activity 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'))
->setDescription(t('The name of the Activity entity.'))
->setRevisionable(TRUE)
->setSettings([
'max_length' => 50,
'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);
$fields['status'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Publishing status'))
->setDescription(t('A boolean indicating whether the Activity is published.'))
->setRevisionable(TRUE)
->setDefaultValue(TRUE)
->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
'weight' => -3,
]);
$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;
}
}

View File

@ -0,0 +1,116 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\RevisionLogInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\user\EntityOwnerInterface;
/**
* Provides an interface for defining Activity entities.
*
* @ingroup opencase_entities
*/
interface OCActivityInterface extends ContentEntityInterface, RevisionLogInterface, EntityChangedInterface, EntityOwnerInterface {
// Add get/set methods for your configuration properties here.
/**
* Gets the Activity name.
*
* @return string
* Name of the Activity.
*/
public function getName();
/**
* Sets the Activity name.
*
* @param string $name
* The Activity name.
*
* @return \Drupal\opencase_entities\Entity\OCActivityInterface
* The called Activity entity.
*/
public function setName($name);
/**
* Gets the Activity creation timestamp.
*
* @return int
* Creation timestamp of the Activity.
*/
public function getCreatedTime();
/**
* Sets the Activity creation timestamp.
*
* @param int $timestamp
* The Activity creation timestamp.
*
* @return \Drupal\opencase_entities\Entity\OCActivityInterface
* The called Activity entity.
*/
public function setCreatedTime($timestamp);
/**
* Returns the Activity published status indicator.
*
* Unpublished Activity are only visible to restricted users.
*
* @return bool
* TRUE if the Activity is published.
*/
public function isPublished();
/**
* Sets the published status of a Activity.
*
* @param bool $published
* TRUE to set this Activity to published, FALSE to set it to unpublished.
*
* @return \Drupal\opencase_entities\Entity\OCActivityInterface
* The called Activity entity.
*/
public function setPublished($published);
/**
* Gets the Activity revision creation timestamp.
*
* @return int
* The UNIX timestamp of when this revision was created.
*/
public function getRevisionCreationTime();
/**
* Sets the Activity revision creation timestamp.
*
* @param int $timestamp
* The UNIX timestamp of when this revision was created.
*
* @return \Drupal\opencase_entities\Entity\OCActivityInterface
* The called Activity entity.
*/
public function setRevisionCreationTime($timestamp);
/**
* Gets the Activity revision author.
*
* @return \Drupal\user\UserInterface
* The user entity for the revision author.
*/
public function getRevisionUser();
/**
* Sets the Activity revision author.
*
* @param int $uid
* The user ID of the revision author.
*
* @return \Drupal\opencase_entities\Entity\OCActivityInterface
* The called Activity entity.
*/
public function setRevisionUserId($uid);
}

View File

@ -0,0 +1,58 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
/**
* Defines the Activity type entity.
*
* @ConfigEntityType(
* id = "oc_activity_type",
* label = @Translation("Activity type"),
* handlers = {
* "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
* "list_builder" = "Drupal\opencase_entities\OCActivityTypeListBuilder",
* "form" = {
* "add" = "Drupal\opencase_entities\Form\OCActivityTypeForm",
* "edit" = "Drupal\opencase_entities\Form\OCActivityTypeForm",
* "delete" = "Drupal\opencase_entities\Form\OCActivityTypeDeleteForm"
* },
* "route_provider" = {
* "html" = "Drupal\opencase_entities\OCActivityTypeHtmlRouteProvider",
* },
* },
* config_prefix = "oc_activity_type",
* admin_permission = "administer site configuration",
* bundle_of = "oc_activity",
* entity_keys = {
* "id" = "id",
* "label" = "label",
* "uuid" = "uuid"
* },
* links = {
* "canonical" = "/admin/opencase/oc_activity_type/{oc_activity_type}",
* "add-form" = "/admin/opencase/oc_activity_type/add",
* "edit-form" = "/admin/opencase/oc_activity_type/{oc_activity_type}/edit",
* "delete-form" = "/admin/opencase/oc_activity_type/{oc_activity_type}/delete",
* "collection" = "/admin/opencase/oc_activity_type"
* }
* )
*/
class OCActivityType extends ConfigEntityBundleBase implements OCActivityTypeInterface {
/**
* The Activity type ID.
*
* @var string
*/
protected $id;
/**
* The Activity type label.
*
* @var string
*/
protected $label;
}

View File

@ -0,0 +1,13 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Config\Entity\ConfigEntityInterface;
/**
* Provides an interface for defining Activity type entities.
*/
interface OCActivityTypeInterface extends ConfigEntityInterface {
// Add get/set methods for your configuration properties here.
}

View File

@ -0,0 +1,24 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\views\EntityViewsData;
/**
* Provides Views data for Activity entities.
*/
class OCActivityViewsData extends EntityViewsData {
/**
* {@inheritdoc}
*/
public function getViewsData() {
$data = parent::getViewsData();
// Additional information for Views integration, such as table joins, can be
// put here.
return $data;
}
}

View File

@ -0,0 +1,281 @@
<?php
namespace Drupal\opencase_entities\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 Actor entity.
*
* @ingroup opencase_entities
*
* @ContentEntityType(
* id = "oc_actor",
* label = @Translation("Actor"),
* bundle_label = @Translation("Actor type"),
* handlers = {
* "storage" = "Drupal\opencase_entities\OCActorStorage",
* "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
* "list_builder" = "Drupal\opencase_entities\OCActorListBuilder",
* "views_data" = "Drupal\opencase_entities\Entity\OCActorViewsData",
* "translation" = "Drupal\opencase_entities\OCActorTranslationHandler",
*
* "form" = {
* "default" = "Drupal\opencase_entities\Form\OCActorForm",
* "add" = "Drupal\opencase_entities\Form\OCActorForm",
* "edit" = "Drupal\opencase_entities\Form\OCActorForm",
* "delete" = "Drupal\opencase_entities\Form\OCActorDeleteForm",
* },
* "access" = "Drupal\opencase_entities\OCActorAccessControlHandler",
* "route_provider" = {
* "html" = "Drupal\opencase_entities\OCActorHtmlRouteProvider",
* },
* },
* base_table = "oc_actor",
* data_table = "oc_actor_field_data",
* revision_table = "oc_actor_revision",
* revision_data_table = "oc_actor_field_revision",
* translatable = TRUE,
* admin_permission = "administer actor entities",
* entity_keys = {
* "id" = "id",
* "revision" = "vid",
* "bundle" = "type",
* "label" = "name",
* "uuid" = "uuid",
* "uid" = "user_id",
* "langcode" = "langcode",
* "status" = "status",
* },
* links = {
* "canonical" = "/admin/opencase/oc_actor/{oc_actor}",
* "add-page" = "/admin/opencase/oc_actor/add",
* "add-form" = "/admin/opencase/oc_actor/add/{oc_actor_type}",
* "edit-form" = "/admin/opencase/oc_actor/{oc_actor}/edit",
* "delete-form" = "/admin/opencase/oc_actor/{oc_actor}/delete",
* "version-history" = "/admin/opencase/oc_actor/{oc_actor}/revisions",
* "revision" = "/admin/opencase/oc_actor/{oc_actor}/revisions/{oc_actor_revision}/view",
* "revision_revert" = "/admin/opencase/oc_actor/{oc_actor}/revisions/{oc_actor_revision}/revert",
* "revision_delete" = "/admin/opencase/oc_actor/{oc_actor}/revisions/{oc_actor_revision}/delete",
* "translation_revert" = "/admin/opencase/oc_actor/{oc_actor}/revisions/{oc_actor_revision}/revert/{langcode}",
* "collection" = "/admin/opencase/oc_actor",
* },
* bundle_entity_type = "oc_actor_type",
* field_ui_base_route = "entity.oc_actor_type.edit_form"
* )
*/
class OCActor extends RevisionableContentEntityBase implements OCActorInterface {
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 oc_actor 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 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 isPublished() {
return (bool) $this->getEntityKey('status');
}
/**
* {@inheritdoc}
*/
public function setPublished($published) {
$this->set('status', $published ? TRUE : FALSE);
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 Actor 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'))
->setDescription(t('The name of the Actor entity.'))
->setRevisionable(TRUE)
->setSettings([
'max_length' => 50,
'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);
$fields['status'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Publishing status'))
->setDescription(t('A boolean indicating whether the Actor is published.'))
->setRevisionable(TRUE)
->setDefaultValue(TRUE)
->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
'weight' => -3,
]);
$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;
}
}

View File

@ -0,0 +1,116 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\RevisionLogInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\user\EntityOwnerInterface;
/**
* Provides an interface for defining Actor entities.
*
* @ingroup opencase_entities
*/
interface OCActorInterface extends ContentEntityInterface, RevisionLogInterface, EntityChangedInterface, EntityOwnerInterface {
// Add get/set methods for your configuration properties here.
/**
* Gets the Actor name.
*
* @return string
* Name of the Actor.
*/
public function getName();
/**
* Sets the Actor name.
*
* @param string $name
* The Actor name.
*
* @return \Drupal\opencase_entities\Entity\OCActorInterface
* The called Actor entity.
*/
public function setName($name);
/**
* Gets the Actor creation timestamp.
*
* @return int
* Creation timestamp of the Actor.
*/
public function getCreatedTime();
/**
* Sets the Actor creation timestamp.
*
* @param int $timestamp
* The Actor creation timestamp.
*
* @return \Drupal\opencase_entities\Entity\OCActorInterface
* The called Actor entity.
*/
public function setCreatedTime($timestamp);
/**
* Returns the Actor published status indicator.
*
* Unpublished Actor are only visible to restricted users.
*
* @return bool
* TRUE if the Actor is published.
*/
public function isPublished();
/**
* Sets the published status of a Actor.
*
* @param bool $published
* TRUE to set this Actor to published, FALSE to set it to unpublished.
*
* @return \Drupal\opencase_entities\Entity\OCActorInterface
* The called Actor entity.
*/
public function setPublished($published);
/**
* Gets the Actor revision creation timestamp.
*
* @return int
* The UNIX timestamp of when this revision was created.
*/
public function getRevisionCreationTime();
/**
* Sets the Actor revision creation timestamp.
*
* @param int $timestamp
* The UNIX timestamp of when this revision was created.
*
* @return \Drupal\opencase_entities\Entity\OCActorInterface
* The called Actor entity.
*/
public function setRevisionCreationTime($timestamp);
/**
* Gets the Actor revision author.
*
* @return \Drupal\user\UserInterface
* The user entity for the revision author.
*/
public function getRevisionUser();
/**
* Sets the Actor revision author.
*
* @param int $uid
* The user ID of the revision author.
*
* @return \Drupal\opencase_entities\Entity\OCActorInterface
* The called Actor entity.
*/
public function setRevisionUserId($uid);
}

View File

@ -0,0 +1,58 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
/**
* Defines the Actor type entity.
*
* @ConfigEntityType(
* id = "oc_actor_type",
* label = @Translation("Actor type"),
* handlers = {
* "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
* "list_builder" = "Drupal\opencase_entities\OCActorTypeListBuilder",
* "form" = {
* "add" = "Drupal\opencase_entities\Form\OCActorTypeForm",
* "edit" = "Drupal\opencase_entities\Form\OCActorTypeForm",
* "delete" = "Drupal\opencase_entities\Form\OCActorTypeDeleteForm"
* },
* "route_provider" = {
* "html" = "Drupal\opencase_entities\OCActorTypeHtmlRouteProvider",
* },
* },
* config_prefix = "oc_actor_type",
* admin_permission = "administer site configuration",
* bundle_of = "oc_actor",
* entity_keys = {
* "id" = "id",
* "label" = "label",
* "uuid" = "uuid"
* },
* links = {
* "canonical" = "/admin/opencase/oc_actor_type/{oc_actor_type}",
* "add-form" = "/admin/opencase/oc_actor_type/add",
* "edit-form" = "/admin/opencase/oc_actor_type/{oc_actor_type}/edit",
* "delete-form" = "/admin/opencase/oc_actor_type/{oc_actor_type}/delete",
* "collection" = "/admin/opencase/oc_actor_type"
* }
* )
*/
class OCActorType extends ConfigEntityBundleBase implements OCActorTypeInterface {
/**
* The Actor type ID.
*
* @var string
*/
protected $id;
/**
* The Actor type label.
*
* @var string
*/
protected $label;
}

View File

@ -0,0 +1,13 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Config\Entity\ConfigEntityInterface;
/**
* Provides an interface for defining Actor type entities.
*/
interface OCActorTypeInterface extends ConfigEntityInterface {
// Add get/set methods for your configuration properties here.
}

View File

@ -0,0 +1,24 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\views\EntityViewsData;
/**
* Provides Views data for Actor entities.
*/
class OCActorViewsData extends EntityViewsData {
/**
* {@inheritdoc}
*/
public function getViewsData() {
$data = parent::getViewsData();
// Additional information for Views integration, such as table joins, can be
// put here.
return $data;
}
}

View File

@ -0,0 +1,281 @@
<?php
namespace Drupal\opencase_entities\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 Case entity.
*
* @ingroup opencase_entities
*
* @ContentEntityType(
* id = "oc_case",
* label = @Translation("Case"),
* bundle_label = @Translation("Case type"),
* handlers = {
* "storage" = "Drupal\opencase_entities\OCCaseStorage",
* "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
* "list_builder" = "Drupal\opencase_entities\OCCaseListBuilder",
* "views_data" = "Drupal\opencase_entities\Entity\OCCaseViewsData",
* "translation" = "Drupal\opencase_entities\OCCaseTranslationHandler",
*
* "form" = {
* "default" = "Drupal\opencase_entities\Form\OCCaseForm",
* "add" = "Drupal\opencase_entities\Form\OCCaseForm",
* "edit" = "Drupal\opencase_entities\Form\OCCaseForm",
* "delete" = "Drupal\opencase_entities\Form\OCCaseDeleteForm",
* },
* "access" = "Drupal\opencase_entities\OCCaseAccessControlHandler",
* "route_provider" = {
* "html" = "Drupal\opencase_entities\OCCaseHtmlRouteProvider",
* },
* },
* base_table = "oc_case",
* data_table = "oc_case_field_data",
* revision_table = "oc_case_revision",
* revision_data_table = "oc_case_field_revision",
* translatable = TRUE,
* admin_permission = "administer case entities",
* entity_keys = {
* "id" = "id",
* "revision" = "vid",
* "bundle" = "type",
* "label" = "name",
* "uuid" = "uuid",
* "uid" = "user_id",
* "langcode" = "langcode",
* "status" = "status",
* },
* links = {
* "canonical" = "/admin/opencase/oc_case/{oc_case}",
* "add-page" = "/admin/opencase/oc_case/add",
* "add-form" = "/admin/opencase/oc_case/add/{oc_case_type}",
* "edit-form" = "/admin/opencase/oc_case/{oc_case}/edit",
* "delete-form" = "/admin/opencase/oc_case/{oc_case}/delete",
* "version-history" = "/admin/opencase/oc_case/{oc_case}/revisions",
* "revision" = "/admin/opencase/oc_case/{oc_case}/revisions/{oc_case_revision}/view",
* "revision_revert" = "/admin/opencase/oc_case/{oc_case}/revisions/{oc_case_revision}/revert",
* "revision_delete" = "/admin/opencase/oc_case/{oc_case}/revisions/{oc_case_revision}/delete",
* "translation_revert" = "/admin/opencase/oc_case/{oc_case}/revisions/{oc_case_revision}/revert/{langcode}",
* "collection" = "/admin/opencase/oc_case",
* },
* bundle_entity_type = "oc_case_type",
* field_ui_base_route = "entity.oc_case_type.edit_form"
* )
*/
class OCCase extends RevisionableContentEntityBase implements OCCaseInterface {
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 oc_case 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 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 isPublished() {
return (bool) $this->getEntityKey('status');
}
/**
* {@inheritdoc}
*/
public function setPublished($published) {
$this->set('status', $published ? TRUE : FALSE);
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 Case 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'))
->setDescription(t('The name of the Case entity.'))
->setRevisionable(TRUE)
->setSettings([
'max_length' => 50,
'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);
$fields['status'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Publishing status'))
->setDescription(t('A boolean indicating whether the Case is published.'))
->setRevisionable(TRUE)
->setDefaultValue(TRUE)
->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
'weight' => -3,
]);
$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;
}
}

View File

@ -0,0 +1,116 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\RevisionLogInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\user\EntityOwnerInterface;
/**
* Provides an interface for defining Case entities.
*
* @ingroup opencase_entities
*/
interface OCCaseInterface extends ContentEntityInterface, RevisionLogInterface, EntityChangedInterface, EntityOwnerInterface {
// Add get/set methods for your configuration properties here.
/**
* Gets the Case name.
*
* @return string
* Name of the Case.
*/
public function getName();
/**
* Sets the Case name.
*
* @param string $name
* The Case name.
*
* @return \Drupal\opencase_entities\Entity\OCCaseInterface
* The called Case entity.
*/
public function setName($name);
/**
* Gets the Case creation timestamp.
*
* @return int
* Creation timestamp of the Case.
*/
public function getCreatedTime();
/**
* Sets the Case creation timestamp.
*
* @param int $timestamp
* The Case creation timestamp.
*
* @return \Drupal\opencase_entities\Entity\OCCaseInterface
* The called Case entity.
*/
public function setCreatedTime($timestamp);
/**
* Returns the Case published status indicator.
*
* Unpublished Case are only visible to restricted users.
*
* @return bool
* TRUE if the Case is published.
*/
public function isPublished();
/**
* Sets the published status of a Case.
*
* @param bool $published
* TRUE to set this Case to published, FALSE to set it to unpublished.
*
* @return \Drupal\opencase_entities\Entity\OCCaseInterface
* The called Case entity.
*/
public function setPublished($published);
/**
* Gets the Case revision creation timestamp.
*
* @return int
* The UNIX timestamp of when this revision was created.
*/
public function getRevisionCreationTime();
/**
* Sets the Case revision creation timestamp.
*
* @param int $timestamp
* The UNIX timestamp of when this revision was created.
*
* @return \Drupal\opencase_entities\Entity\OCCaseInterface
* The called Case entity.
*/
public function setRevisionCreationTime($timestamp);
/**
* Gets the Case revision author.
*
* @return \Drupal\user\UserInterface
* The user entity for the revision author.
*/
public function getRevisionUser();
/**
* Sets the Case revision author.
*
* @param int $uid
* The user ID of the revision author.
*
* @return \Drupal\opencase_entities\Entity\OCCaseInterface
* The called Case entity.
*/
public function setRevisionUserId($uid);
}

View File

@ -0,0 +1,58 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
/**
* Defines the Case type entity.
*
* @ConfigEntityType(
* id = "oc_case_type",
* label = @Translation("Case type"),
* handlers = {
* "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
* "list_builder" = "Drupal\opencase_entities\OCCaseTypeListBuilder",
* "form" = {
* "add" = "Drupal\opencase_entities\Form\OCCaseTypeForm",
* "edit" = "Drupal\opencase_entities\Form\OCCaseTypeForm",
* "delete" = "Drupal\opencase_entities\Form\OCCaseTypeDeleteForm"
* },
* "route_provider" = {
* "html" = "Drupal\opencase_entities\OCCaseTypeHtmlRouteProvider",
* },
* },
* config_prefix = "oc_case_type",
* admin_permission = "administer site configuration",
* bundle_of = "oc_case",
* entity_keys = {
* "id" = "id",
* "label" = "label",
* "uuid" = "uuid"
* },
* links = {
* "canonical" = "/admin/opencase/oc_case_type/{oc_case_type}",
* "add-form" = "/admin/opencase/oc_case_type/add",
* "edit-form" = "/admin/opencase/oc_case_type/{oc_case_type}/edit",
* "delete-form" = "/admin/opencase/oc_case_type/{oc_case_type}/delete",
* "collection" = "/admin/opencase/oc_case_type"
* }
* )
*/
class OCCaseType extends ConfigEntityBundleBase implements OCCaseTypeInterface {
/**
* The Case type ID.
*
* @var string
*/
protected $id;
/**
* The Case type label.
*
* @var string
*/
protected $label;
}

View File

@ -0,0 +1,13 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Config\Entity\ConfigEntityInterface;
/**
* Provides an interface for defining Case type entities.
*/
interface OCCaseTypeInterface extends ConfigEntityInterface {
// Add get/set methods for your configuration properties here.
}

View File

@ -0,0 +1,24 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\views\EntityViewsData;
/**
* Provides Views data for Case entities.
*/
class OCCaseViewsData extends EntityViewsData {
/**
* {@inheritdoc}
*/
public function getViewsData() {
$data = parent::getViewsData();
// Additional information for Views integration, such as table joins, can be
// put here.
return $data;
}
}