2018-04-29 11:58:46 +00:00
< ? 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 " ,
2018-11-09 16:14:48 +00:00
* label = @ Translation ( " Person " ),
* bundle_label = @ Translation ( " Person type " ),
2018-04-29 11:58:46 +00:00
* 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 = {
2018-04-29 13:23:15 +00:00
* " canonical " = " /opencase/oc_actor/ { oc_actor} " ,
* " add-page " = " /opencase/oc_actor/add " ,
* " add-form " = " /opencase/oc_actor/add/ { oc_actor_type} " ,
* " edit-form " = " /opencase/oc_actor/ { oc_actor}/edit " ,
* " delete-form " = " /opencase/oc_actor/ { oc_actor}/delete " ,
* " version-history " = " /opencase/oc_actor/ { oc_actor}/revisions " ,
* " revision " = " /opencase/oc_actor/ { oc_actor}/revisions/ { oc_actor_revision}/view " ,
* " revision_revert " = " /opencase/oc_actor/ { oc_actor}/revisions/ { oc_actor_revision}/revert " ,
* " revision_delete " = " /opencase/oc_actor/ { oc_actor}/revisions/ { oc_actor_revision}/delete " ,
* " translation_revert " = " /opencase/oc_actor/ { oc_actor}/revisions/ { oc_actor_revision}/revert/ { langcode} " ,
* " collection " = " /opencase/oc_actor " ,
2018-04-29 11:58:46 +00:00
* },
* 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 );
}
}
2021-02-08 13:38:54 +00:00
if ( $this -> get ( 'full_name' ) -> value ) {
$name = $this -> get ( 'full_name' ) -> value . ' ' ;
} else {
$name = $this -> get ( 'first_name' ) -> value . ' ' ;
if ( $this -> get ( 'middle_names' ) -> value ) $name .= $this -> get ( 'middle_names' ) -> value . ' ' ;
$name .= $this -> get ( 'last_name' ) -> value . ' ' ;
}
2018-04-29 12:50:41 +00:00
$this -> setName ( $name );
2018-04-29 11:58:46 +00:00
// 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 );
2018-05-07 12:49:31 +00:00
$fields [ 'status' ] = BaseFieldDefinition :: create ( 'boolean' )
-> setLabel ( t ( 'Publishing status' ))
2021-09-13 13:31:12 +00:00
-> setDescription ( 'If this box is not ticked this record will be hidden from view for most users. Users with access to unpublished entities will be able to restore it if needed.' )
2018-05-07 12:49:31 +00:00
-> setRevisionable ( TRUE )
2021-09-13 13:15:02 +00:00
-> setDisplayConfigurable ( " form " , true )
2018-05-07 12:49:31 +00:00
-> setDefaultValue ( TRUE );
// The name gets set on preSave, from the first middle and last
$fields [ 'name' ] = BaseFieldDefinition :: create ( 'string' )
-> setLabel ( t ( 'Name' ))
-> setSettings ([
'max_length' => 100 ,
'text_processing' => 0 ,
]);
2018-04-29 11:58:46 +00:00
$fields [ 'user_id' ] = BaseFieldDefinition :: create ( 'entity_reference' )
2018-05-07 12:49:31 +00:00
-> setLabel ( t ( 'Entered by' ))
2018-04-29 11:58:46 +00:00
-> setDescription ( t ( 'The user ID of author of the Actor entity.' ))
-> setRevisionable ( TRUE )
-> setSetting ( 'target_type' , 'user' )
-> setSetting ( 'handler' , 'default' )
2021-02-14 21:14:33 +00:00
-> setTranslatable ( TRUE );
2018-04-29 12:44:52 +00:00
2021-02-08 13:38:54 +00:00
// When configuring a person type, you will need to choose whether to have full name or first and last name fields displayed.
$fields [ 'full_name' ] = BaseFieldDefinition :: create ( 'string' )
-> setDescription ( t ( 'The person\'s name.' ))
-> setLabel ( t ( 'Name' ))
-> setRevisionable ( TRUE )
-> setSettings ([
2021-02-14 21:14:33 +00:00
'max_length' => 100 ,
2021-02-08 13:38:54 +00:00
'text_processing' => 0 ,
])
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
-> setDefaultValue ( '' )
-> setDisplayOptions ( 'form' , [
'type' => 'string_textfield' ,
'weight' => - 50 ,
])
-> setRequired ( TRUE );
2018-04-29 12:44:52 +00:00
$fields [ 'first_name' ] = BaseFieldDefinition :: create ( 'string' )
-> setLabel ( t ( 'First Name' ))
-> setDescription ( t ( " The person's first name. " ))
-> setRevisionable ( TRUE )
-> setSettings ([
'max_length' => 20 ,
'text_processing' => 0 ,
])
2021-02-05 13:47:52 +00:00
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
2018-04-29 12:44:52 +00:00
-> setDefaultValue ( '' )
-> setDisplayOptions ( 'form' , [
'type' => 'string_textfield' ,
2021-02-18 16:46:59 +00:00
'weight' => - 100 ,
])
-> setRequired ( TRUE );
2018-04-29 12:44:52 +00:00
$fields [ 'middle_names' ] = BaseFieldDefinition :: create ( 'string' )
-> setLabel ( t ( 'Middle Names' ))
-> setDescription ( t ( " The person's middle names, if any. " ))
2018-04-29 11:58:46 +00:00
-> setRevisionable ( TRUE )
-> setSettings ([
'max_length' => 50 ,
'text_processing' => 0 ,
])
2021-02-05 13:47:52 +00:00
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
2018-04-29 11:58:46 +00:00
-> setDefaultValue ( '' )
-> setDisplayOptions ( 'form' , [
'type' => 'string_textfield' ,
2021-02-18 16:46:59 +00:00
'weight' => - 99 ,
2018-04-29 11:58:46 +00:00
])
2018-04-29 12:44:52 +00:00
-> setRequired ( FALSE );
$fields [ 'last_name' ] = BaseFieldDefinition :: create ( 'string' )
-> setLabel ( t ( 'Last Name' ))
-> setDescription ( t ( " The person's last name " ))
-> setRevisionable ( TRUE )
2021-02-05 13:47:52 +00:00
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
2018-04-29 12:44:52 +00:00
-> setSettings ([
'max_length' => 20 ,
'text_processing' => 0 ,
])
-> setDefaultValue ( '' )
-> setDisplayOptions ( 'form' , [
'type' => 'string_textfield' ,
2021-02-18 16:46:59 +00:00
'weight' => - 98 ,
])
-> setRequired ( TRUE );
2018-04-29 11:58:46 +00:00
2018-05-08 18:44:08 +00:00
// Contact details.
$fields [ 'email' ] = BaseFieldDefinition :: create ( 'string' )
-> setLabel ( t ( 'Email Address' ))
2020-05-13 14:41:59 +00:00
-> setRevisionable ( TRUE )
2018-05-08 18:44:08 +00:00
-> setSettings ( array (
'default_value' => '' ,
'max_length' => 30 ,
'text_processing' => 0 ,
))
2021-06-29 07:21:04 +00:00
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
2018-05-08 18:44:08 +00:00
-> setDisplayOptions ( 'view' , array (
'label' => 'above' ,
'type' => 'string' ,
2018-09-19 08:15:42 +00:00
'weight' => - 5 ,
2018-05-08 18:44:08 +00:00
))
-> setDisplayOptions ( 'form' , array (
'type' => 'string_textfield' ,
2018-09-19 08:15:42 +00:00
'weight' => - 5 ,
2018-05-08 18:44:08 +00:00
));
$fields [ 'phone' ] = BaseFieldDefinition :: create ( 'string' )
-> setLabel ( t ( 'Main Phone Number' ))
2020-05-13 14:41:59 +00:00
-> setRevisionable ( TRUE )
2018-05-08 18:44:08 +00:00
-> setSettings ( array (
'default_value' => '' ,
'max_length' => 20 ,
'text_processing' => 0 ,
))
2021-06-29 07:21:04 +00:00
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
2018-05-08 18:44:08 +00:00
-> setDisplayOptions ( 'view' , array (
'label' => 'above' ,
'type' => 'string' ,
2018-09-19 08:15:42 +00:00
'weight' => - 4 ,
2018-05-08 18:44:08 +00:00
))
-> setDisplayOptions ( 'form' , array (
'type' => 'string_textfield' ,
2018-09-19 08:15:42 +00:00
'weight' => - 4 ,
2018-05-08 18:44:08 +00:00
));
$fields [ 'phone2' ] = BaseFieldDefinition :: create ( 'string' )
2020-05-13 14:41:59 +00:00
-> setRevisionable ( TRUE )
2018-05-08 18:44:08 +00:00
-> setLabel ( t ( 'Alternative Phone Number' ))
-> setSettings ( array (
'default_value' => '' ,
'max_length' => 20 ,
'text_processing' => 0 ,
))
2021-06-29 07:21:04 +00:00
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
2018-05-08 18:44:08 +00:00
-> setDisplayOptions ( 'view' , array (
'label' => 'above' ,
'type' => 'string' ,
2018-09-19 08:15:42 +00:00
'weight' => - 3 ,
2018-05-08 18:44:08 +00:00
))
-> setDisplayOptions ( 'form' , array (
'type' => 'string_textfield' ,
2018-09-19 08:15:42 +00:00
'weight' => - 3 ,
2018-05-08 18:44:08 +00:00
));
$fields [ 'postal_address' ] = BaseFieldDefinition :: create ( 'string_long' )
2020-05-13 14:41:59 +00:00
-> setRevisionable ( TRUE )
2018-05-08 18:44:08 +00:00
-> setLabel ( t ( 'Postal Address' ))
-> setDescription ( t ( 'Full address, apart from post code.' ))
-> setSettings ( array (
'default_value' => '' ,
'max_length' => 255 ,
'text_processing' => 0 ,
))
2021-06-29 07:21:04 +00:00
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
2018-05-08 18:44:08 +00:00
-> setDisplayOptions ( 'view' , array (
'label' => 'above' ,
2018-05-11 09:55:26 +00:00
'type' => 'basic_string' ,
2018-09-19 08:15:42 +00:00
'weight' => - 2 ,
2018-05-08 18:44:08 +00:00
))
-> setDisplayOptions ( 'form' , array (
'type' => 'string_textarea' ,
2018-09-19 08:15:42 +00:00
'weight' => - 2 ,
2018-05-08 18:44:08 +00:00
));
$fields [ 'post_code' ] = BaseFieldDefinition :: create ( 'string' )
2020-05-13 14:41:59 +00:00
-> setRevisionable ( TRUE )
2018-05-08 18:44:08 +00:00
-> setLabel ( t ( 'Post Code' ))
-> setSettings ( array (
'default_value' => '' ,
'max_length' => 10 ,
'text_processing' => 0 ,
))
2021-06-29 07:21:04 +00:00
-> setDisplayConfigurable ( " form " , true )
-> setDisplayConfigurable ( " view " , true )
2018-05-08 18:44:08 +00:00
-> setDisplayOptions ( 'view' , array (
'label' => 'above' ,
'type' => 'string' ,
2018-10-25 13:55:25 +00:00
'weight' => - 1 ,
2018-05-08 18:44:08 +00:00
))
-> setDisplayOptions ( 'form' , array (
'type' => 'string_textfield' ,
2018-09-19 08:15:42 +00:00
'weight' => - 1 ,
2018-05-08 18:44:08 +00:00
));
2018-04-29 11:58:46 +00:00
$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' ))
2018-05-07 12:49:31 +00:00
-> setDescription ( t ( 'The time that the entity was last edited.' ));
2018-04-29 11:58:46 +00:00
$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 );
2021-02-05 13:43:11 +00:00
$fields [ 'user_login' ] = BaseFieldDefinition :: create ( 'boolean' )
-> setLabel ( t ( 'Login Access' ))
-> setDescription ( t ( 'Whether this person should be able to log into the system.' ))
-> setDisplayConfigurable ( 'form' , true )
-> setDisplayConfigurable ( 'display' , true )
-> setDefaultValue ( FALSE );
2018-04-29 11:58:46 +00:00
return $fields ;
}
}