Entity-ների տիպերը

• Drupal 7-ում Entity-ները սովորաբար stdClass օբյեկտներ էին:
• Drupal 8-ում Entity-ները այժմ հատուկ տիպավորությամբ օբյեկտներ են, և յուրաքանչյուր Entity տիպ սահմանում է դաս, որը կկիրառվի տվյալ Entity-ի օրինակների համար:

Պահանջներ
Entity դասերը պետք է գտնվեն մոդուլի Entity ենթաստեղծության մեջ, որը տրամադրում է Entity տիպը, օրինակ՝ \Drupal\[module_name]\Entity։ Սա նշանակում է, որ PHP Entity դասերի ֆայլերը պետք է գտնվեն մոդուլի src/Entity թղթապանակում։

Դասի դոքբլոկը պետք է պարունակի EntityType անոտացիա, որը սահմանում է տվյալ Entity տիպի մետատվյալները՝ ներառյալ Entity տիպի անվանումը, կառավարիչները, աղյուսակները և այլն։ Ընդլայնված և մանրամասն հատկությունների ցանկը կարելի է տեսնել \Drupal\Core\Entity\Annotation\EntityType դասում։

Անվանում

Entity տիպերի անունները պետք է ունենան մոդուլի անվան նախածանց, եթե Entity տիպի անունը տարբերվում է մոդուլի անունից։ Entity տիպի դասի անվանումի նախածանց անհրաժեշտ չէ, քանի որ այն գտնվում է մոդուլի namespace-ում, որտեղ սահմանվում է, եթե դասի անունը ինքնուրույն բովանդակային է։ Օրինակ, taxonomy_term Entity տիպի դասը կոչվում է Drupal\taxonomy\Entity\Term:

Ինտերֆեյսներ

Drupal 8-ը առաջարկում է ֆունկցիաների տիպային հուշումներ և մեթոդների սահմանումներ իրականացնել ինտերֆեյսների միջոցով, ոչ թե դասերի։ Օրինակ՝ ընդհանուր Entity պահոցը ընդունում է EntityInterface տիպային հուշում (hook_entity_insert (EntityInterface $entity)), իսկ հատուկ Node պահոցը ընդունում է NodeInterface տիպային հուշում (hook_node_insert (NodeInterface $node))։

Entity-ի դաշտերը / հատկությունները սովորաբար շատ կարճ են, միայն պահեստավորման համար նախատեսված և սահմանափակ տեղեկություն ունեն։ Բացի այդ, բովանդակային Entity-ները դաշտերի համար չեն օգտագործում որոշակի հատկություններ (ներառյալ հիմնական դաշտերը, օրինակ՝ node-ի վերնագիր)։

Հետևաբար խորհուրդ է տրվում տրամադրել ինտերֆեյս, որտեղ մեթոդների անվանումները հստակ տրված են։ Կան որոշ կանոններ.

• Մեթոդները սովորաբար ունենում են get/set/is նախածանցներ, օրինակ՝ getSomething(), setSomething($value), isSomething()։
• Մի ավելացրեք մեթոդներ այն հատկությունների համար, որոնք այլ կոդը պետք չէ փոփոխի։ Օրինակ, վերջին փոփոխման ամսաթիվը ($node->updated) չպետք է փոխվի, դրա համար կա $node->getChangedTime(), բայց չկա $node->setChangedTime()։
• Օգտագործեք ինքնաքննադատական մեթոդների անուններ, օրինակ՝ $node->status-ին հասանելիության մեթոդը կոչվում է $node->isPublished()։

Հասկանալիություն

Որպեսզի իմանաք, թե որ Entity տիպերն է տրամադրում մոդուլը, նայեք 해당 մոդուլի Entity ենթաստեղծության դասերին, որոնց դոքբլոկում կա @EntityType անոտացիա, որտեղ էլ կան id բանալիով տիպի անուններ։

Երբ փորձում եք գտնել, թե որտեղ է սահմանված տվյալ Entity տիպը, առաջինը պետք է փնտրեք Entity տիպի նախածանցը։ Եթե մոդուլը չի հետևում անունների այս պայմանագրին, կարող եք որոնել id = "$type"։ Եթե հայտնի է դասը կամ ինտերֆեյսը, ապա namespace-ն կասի, որտեղ է դա գտնվել։

Օրինակ

core/modules/node/src/Entity/Node.php:

namespace Drupal\node\Entity;

use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Session\AccountInterface;
use Drupal\node\NodeInterface;
use Drupal\user\UserInterface;

/**
 * Defines the node entity class.
 *
 * @ContentEntityType(
 *   id = "node",
 *   label = @Translation("Content"),
 *   bundle_label = @Translation("Content type"),
 *   handlers = {
 *     "storage" = "Drupal\node\NodeStorage",
 *     "storage_schema" = "Drupal\node\NodeStorageSchema",
 *     "view_builder" = "Drupal\node\NodeViewBuilder",
 *     "access" = "Drupal\node\NodeAccessControlHandler",
 *     "views_data" = "Drupal\node\NodeViewsData",
 *     "form" = {
 *       "default" = "Drupal\node\NodeForm",
 *       "delete" = "Drupal\node\Form\NodeDeleteForm",
 *       "edit" = "Drupal\node\NodeForm"
 *     },
 *     "route_provider" = {
 *       "html" = "Drupal\node\Entity\NodeRouteProvider",
 *     },
 *     "list_builder" = "Drupal\node\NodeListBuilder",
 *     "translation" = "Drupal\node\NodeTranslationHandler"
 *   },
 *   base_table = "node",
 *   data_table = "node_field_data",
 *   revision_table = "node_revision",
 *   revision_data_table = "node_field_revision",
 *   translatable = TRUE,
 *   list_cache_contexts = { "user.node_grants:view" },
 *   entity_keys = {
 *     "id" = "nid",
 *     "revision" = "vid",
 *     "bundle" = "type",
 *     "label" = "title",
 *     "langcode" = "langcode",
 *     "uuid" = "uuid",
 *     "status" = "status",
 *     "uid" = "uid",
 *   },
 *   bundle_entity_type = "node_type",
 *   field_ui_base_route = "entity.node_type.edit_form",
 *   common_reference_target = TRUE,
 *   permission_granularity = "bundle",
 *   links = {
 *     "canonical" = "/node/{node}",
 *     "delete-form" = "/node/{node}/delete",
 *     "edit-form" = "/node/{node}/edit",
 *     "version-history" = "/node/{node}/revisions",
 *     "revision" = "/node/{node}/revisions/{node_revision}/view",
 *   }
 * )
 */
class Node extends ContentEntityBase implements NodeInterface {
  // ...
}

Լրիվ պատկերացում ստանալու համար Drupal 8-ի Entity-ների մասին կարող եք դիտել հետևյալ դիագրամը։ Այն ներկայացնում է Entity դասերը։ Տեսնելու համար բացեք նոր պատուհանում՝