Added Bank Account entity.

This commit is contained in:
2021-02-07 11:59:17 +00:00
parent 0399c83646
commit eee7604440
15 changed files with 682 additions and 0 deletions

View File

@ -0,0 +1,204 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityPublishedTrait;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\user\UserInterface;
/**
* Defines the Bank Account entity.
*
* @ingroup opencase_entities
*
* @ContentEntityType(
* id = "oc_bank_account",
* label = @Translation("Bank Account"),
* handlers = {
* "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
* "list_builder" = "Drupal\opencase_entities\OCBankAccountListBuilder",
* "views_data" = "Drupal\opencase_entities\Entity\OCBankAccountViewsData",
*
* "form" = {
* "default" = "Drupal\opencase_entities\Form\OCBankAccountForm",
* "add" = "Drupal\opencase_entities\Form\OCBankAccountForm",
* "edit" = "Drupal\opencase_entities\Form\OCBankAccountForm",
* "delete" = "Drupal\opencase_entities\Form\OCBankAccountDeleteForm",
* },
* "route_provider" = {
* "html" = "Drupal\opencase_entities\OCBankAccountHtmlRouteProvider",
* },
* "access" = "Drupal\opencase_entities\OCBankAccountAccessControlHandler",
* },
* base_table = "oc_bank_account",
* translatable = FALSE,
* admin_permission = "administer bank account entities",
* entity_keys = {
* "id" = "id",
* "label" = "name",
* "uuid" = "uuid",
* "uid" = "user_id",
* "langcode" = "langcode",
* "published" = "status",
* },
* links = {
* "canonical" = "/admin/opencase/oc_bank_account/{oc_bank_account}",
* "add-form" = "/admin/opencase/oc_bank_account/add",
* "edit-form" = "/admin/opencase/oc_bank_account/{oc_bank_account}/edit",
* "delete-form" = "/admin/opencase/oc_bank_account/{oc_bank_account}/delete",
* "collection" = "/admin/opencase/oc_bank_account",
* },
* field_ui_base_route = "oc_bank_account.settings"
* )
*/
class OCBankAccount extends ContentEntityBase implements OCBankAccountInterface {
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}
*/
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 the Bank Account entity.'))
->setRevisionable(TRUE)
->setSetting('target_type', 'user')
->setSetting('handler', 'default')
->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 Bank Account entity.'))
->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']->setDescription(t('A boolean indicating whether the Bank Account is published.'))
->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.'));
return $fields;
}
}

View File

@ -0,0 +1,59 @@
<?php
namespace Drupal\opencase_entities\Entity;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\user\EntityOwnerInterface;
/**
* Provides an interface for defining Bank Account entities.
*
* @ingroup opencase_entities
*/
interface OCBankAccountInterface extends ContentEntityInterface, EntityChangedInterface, EntityPublishedInterface, EntityOwnerInterface {
/**
* Add get/set methods for your configuration properties here.
*/
/**
* Gets the Bank Account name.
*
* @return string
* Name of the Bank Account.
*/
public function getName();
/**
* Sets the Bank Account name.
*
* @param string $name
* The Bank Account name.
*
* @return \Drupal\opencase_entities\Entity\OCBankAccountInterface
* The called Bank Account entity.
*/
public function setName($name);
/**
* Gets the Bank Account creation timestamp.
*
* @return int
* Creation timestamp of the Bank Account.
*/
public function getCreatedTime();
/**
* Sets the Bank Account creation timestamp.
*
* @param int $timestamp
* The Bank Account creation timestamp.
*
* @return \Drupal\opencase_entities\Entity\OCBankAccountInterface
* The called Bank Account entity.
*/
public function setCreatedTime($timestamp);
}

View File

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