Node.php 11.8 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Definition of Drupal\node\Entity\Node.
6 7
 */

8
namespace Drupal\node\Entity;
9

10
use Drupal\Core\Entity\EntityNG;
11
use Drupal\Core\Entity\EntityStorageControllerInterface;
12
use Drupal\Core\Entity\Annotation\EntityType;
13
use Drupal\Core\Annotation\Translation;
14 15
use Drupal\Core\Language\Language;
use Drupal\Core\Session\AccountInterface;
16
use Drupal\node\NodeInterface;
17 18 19

/**
 * Defines the node entity class.
20
 *
21
 * @EntityType(
22
 *   id = "node",
23
 *   label = @Translation("Content"),
24
 *   bundle_label = @Translation("Content type"),
25
 *   module = "node",
26 27 28 29 30
 *   controllers = {
 *     "storage" = "Drupal\node\NodeStorageController",
 *     "render" = "Drupal\node\NodeRenderController",
 *     "access" = "Drupal\node\NodeAccessController",
 *     "form" = {
31
 *       "default" = "Drupal\node\NodeFormController",
32
 *       "delete" = "Drupal\node\Form\NodeDeleteForm",
33
 *       "edit" = "Drupal\node\NodeFormController"
34 35
 *     },
 *     "translation" = "Drupal\node\NodeTranslationController"
36 37
 *   },
 *   base_table = "node",
38 39
 *   data_table = "node_field_data",
 *   revision_table = "node_field_revision",
40 41
 *   uri_callback = "node_uri",
 *   fieldable = TRUE,
42
 *   translatable = TRUE,
43 44 45 46 47 48 49 50 51
 *   entity_keys = {
 *     "id" = "nid",
 *     "revision" = "vid",
 *     "bundle" = "type",
 *     "label" = "title",
 *     "uuid" = "uuid"
 *   },
 *   bundle_keys = {
 *     "bundle" = "type"
52
 *   },
53
 *   route_base_path = "admin/structure/types/manage/{bundle}",
54 55 56 57 58 59
 *   permission_granularity = "bundle",
 *   links = {
 *     "canonical" = "/node/{node}",
 *     "edit-form" = "/node/{node}/edit",
 *     "version-history" = "/node/{node}/revisions"
 *   }
60
 * )
61
 */
62
class Node extends EntityNG implements NodeInterface {
63 64

  /**
65
   * Implements Drupal\Core\Entity\EntityInterface::id().
66
   */
67 68 69
  public function id() {
    return $this->get('nid')->value;
  }
70

71
  /**
72
   * Overrides Drupal\Core\Entity\Entity::getRevisionId().
73
   */
74 75 76
  public function getRevisionId() {
    return $this->get('vid')->value;
  }
77

78
  /**
79
   * {@inheritdoc}
80
   */
81
  public function preSave(EntityStorageControllerInterface $storage_controller) {
82 83
    parent::preSave($storage_controller);

84 85 86
    // Before saving the node, set changed and revision times.
    $this->changed->value = REQUEST_TIME;
  }
87 88

  /**
89
   * {@inheritdoc}
90
   */
91
  public function preSaveRevision(EntityStorageControllerInterface $storage_controller, \stdClass $record) {
92 93
    parent::preSaveRevision($storage_controller, $record);

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
    if ($this->newRevision) {
      // When inserting either a new node or a new node revision, $node->log
      // must be set because {node_field_revision}.log is a text column and
      // therefore cannot have a default value. However, it might not be set at
      // this point (for example, if the user submitting a node form does not
      // have permission to create revisions), so we ensure that it is at least
      // an empty string in that case.
      // @todo Make the {node_field_revision}.log column nullable so that we
      //   can remove this check.
      if (!isset($record->log)) {
        $record->log = '';
      }
    }
    elseif (isset($this->original) && (!isset($record->log) || $record->log === '')) {
      // If we are updating an existing node without adding a new revision, we
      // need to make sure $entity->log is reset whenever it is empty.
      // Therefore, this code allows us to avoid clobbering an existing log
      // entry with an empty one.
112
      $record->log = $this->original->log->value;
113 114
    }
  }
115 116

  /**
117
   * {@inheritdoc}
118
   */
119
  public function postSave(EntityStorageControllerInterface $storage_controller, $update = TRUE) {
120 121
    parent::postSave($storage_controller, $update);

122 123 124 125
    // Update the node access table for this node, but only if it is the
    // default revision. There's no need to delete existing records if the node
    // is new.
    if ($this->isDefaultRevision()) {
126
      \Drupal::entityManager()->getAccessController('node')->writeGrants($this, $update);
127 128
    }
  }
129 130

  /**
131
   * {@inheritdoc}
132
   */
133
  public static function preDelete(EntityStorageControllerInterface $storage_controller, array $entities) {
134 135
    parent::preDelete($storage_controller, $entities);

136
    if (module_exists('search')) {
137
      foreach ($entities as $entity) {
138 139 140 141
        search_reindex($entity->nid->value, 'node');
      }
    }
  }
142

143 144 145 146 147 148 149
  /**
   * {@inheritdoc}
   */
  public function getType() {
    return $this->bundle();
  }

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
  /**
   * {@inheritdoc}
   */
  public function access($operation = 'view', AccountInterface $account = NULL) {
    if ($operation == 'create') {
      return parent::access($operation, $account);
    }

    return \Drupal::entityManager()
      ->getAccessController($this->entityType)
      ->access($this, $operation, $this->prepareLangcode(), $account);
  }

  /**
   * {@inheritdoc}
   */
  public function prepareLangcode() {
    $langcode = $this->language()->id;
    // If the Language module is enabled, try to use the language from content
    // negotiation.
    if (\Drupal::moduleHandler()->moduleExists('language')) {
      // Load languages the node exists in.
      $node_translations = $this->getTranslationLanguages();
      // Load the language from content negotiation.
      $content_negotiation_langcode = \Drupal::languageManager()->getLanguage(Language::TYPE_CONTENT)->id;
      // If there is a translation available, use it.
      if (isset($node_translations[$content_negotiation_langcode])) {
        $langcode = $content_negotiation_langcode;
      }
    }
    return $langcode;
  }


184 185 186 187 188 189 190
  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return $this->get('title')->value;
  }

191
  /**
192
   * {@inheritdoc}
193
   */
194 195 196 197
  public function setTitle($title) {
    $this->set('title', $title);
    return $this;
  }
198 199

  /**
200
   * {@inheritdoc}
201
   */
202 203 204
  public function getCreatedTime() {
    return $this->get('created')->value;
  }
205 206 207


  /**
208
   * {@inheritdoc}
209
   */
210 211 212 213
  public function setCreatedTime($timestamp) {
    $this->set('created', $timestamp);
    return $this;
  }
214 215

  /**
216
   * {@inheritdoc}
217
   */
218 219 220
  public function getChangedTime() {
    return $this->get('changed')->value;
  }
221 222

  /**
223
   * {@inheritdoc}
224
   */
225 226 227
  public function isPromoted() {
    return (bool) $this->get('promote')->value;
  }
228 229

  /**
230
   * {@inheritdoc}
231
   */
232
  public function setPromoted($promoted) {
233
    $this->set('promote', $promoted ? NODE_PROMOTED : NODE_NOT_PROMOTED);
234 235
    return $this;
  }
236 237

  /**
238
   * {@inheritdoc}
239
   */
240 241 242
  public function isSticky() {
    return (bool) $this->get('sticky')->value;
  }
243 244

  /**
245
   * {@inheritdoc}
246
   */
247 248 249 250
  public function setSticky($sticky) {
    $this->set('sticky', $sticky ? NODE_STICKY : NODE_NOT_STICKY);
    return $this;
  }
251
  /**
252
   * {@inheritdoc}
253
   */
254 255 256
  public function isPublished() {
    return (bool) $this->get('status')->value;
  }
257

258
  /**
259
   * {@inheritdoc}
260
   */
261 262 263
  public function setPublished($published) {
    $this->set('status', $published ? NODE_PUBLISHED : NODE_NOT_PUBLISHED);
    return $this;
264 265 266
  }

  /**
267
   * {@inheritdoc}
268
   */
269
  public function getAuthor() {
270
    return $this->get('uid')->entity;
271
  }
272 273

  /**
274
   * {@inheritdoc}
275
   */
276 277
  public function getAuthorId() {
    return $this->get('uid')->target_id;
278
  }
279

280 281 282
  /**
   * {@inheritdoc}
   */
283 284 285
  public function setAuthorId($uid) {
    $this->set('uid', $uid);
    return $this;
286 287 288 289 290
  }

  /**
   * {@inheritdoc}
   */
291 292
  public function getRevisionCreationTime() {
    return $this->get('revision_timestamp')->value;
293 294 295 296 297
  }

  /**
   * {@inheritdoc}
   */
298 299 300
  public function setRevisionCreationTime($timestamp) {
    $this->set('revision_timestamp', $timestamp);
    return $this;
301 302
  }

303 304 305
  /**
   * {@inheritdoc}
   */
306 307
  public function getRevisionAuthor() {
    return $this->get('revision_uid')->entity;
308 309
  }

310 311 312
  /**
   * {@inheritdoc}
   */
313 314 315
  public function setRevisionAuthorId($uid) {
    $this->set('revision_uid', $uid);
    return $this;
316 317
  }

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions($entity_type) {
    $properties['nid'] = array(
      'label' => t('Node ID'),
      'description' => t('The node ID.'),
      'type' => 'integer_field',
      'read-only' => TRUE,
    );
    $properties['uuid'] = array(
      'label' => t('UUID'),
      'description' => t('The node UUID.'),
      'type' => 'uuid_field',
      'read-only' => TRUE,
    );
    $properties['vid'] = array(
      'label' => t('Revision ID'),
      'description' => t('The node revision ID.'),
      'type' => 'integer_field',
      'read-only' => TRUE,
    );
    $properties['type'] = array(
      'label' => t('Type'),
      'description' => t('The node type.'),
      'type' => 'string_field',
      'read-only' => TRUE,
    );
    $properties['langcode'] = array(
      'label' => t('Language code'),
      'description' => t('The node language code.'),
      'type' => 'language_field',
    );
    $properties['title'] = array(
      'label' => t('Title'),
      'description' => t('The title of this node, always treated as non-markup plain text.'),
      'type' => 'string_field',
      'required' => TRUE,
      'settings' => array(
        'default_value' => '',
      ),
      'property_constraints' => array(
        'value' => array('Length' => array('max' => 255)),
      ),
    );
    $properties['uid'] = array(
      'label' => t('User ID'),
      'description' => t('The user ID of the node author.'),
      'type' => 'entity_reference_field',
      'settings' => array(
        'target_type' => 'user',
        'default_value' => 0,
      ),
    );
    $properties['status'] = array(
      'label' => t('Publishing status'),
      'description' => t('A boolean indicating whether the node is published.'),
      'type' => 'boolean_field',
    );
    $properties['created'] = array(
      'label' => t('Created'),
      'description' => t('The time that the node was created.'),
      'type' => 'integer_field',
    );
    $properties['changed'] = array(
      'label' => t('Changed'),
      'description' => t('The time that the node was last edited.'),
      'type' => 'integer_field',
      'property_constraints' => array(
387
        'value' => array('EntityChanged' => array()),
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
      ),
    );
    $properties['comment'] = array(
      'label' => t('Comment'),
      'description' => t('Whether comments are allowed on this node: 0 = no, 1 = closed (read only), 2 = open (read/write).'),
      'type' => 'integer_field',
    );
    $properties['promote'] = array(
      'label' => t('Promote'),
      'description' => t('A boolean indicating whether the node should be displayed on the front page.'),
      'type' => 'boolean_field',
    );
    $properties['sticky'] = array(
      'label' => t('Sticky'),
      'description' => t('A boolean indicating whether the node should be displayed at the top of lists in which it appears.'),
      'type' => 'boolean_field',
    );
    $properties['tnid'] = array(
      'label' => t('Translation set ID'),
      'description' => t('The translation set id for this node, which equals the node id of the source post in each set.'),
      'type' => 'integer_field',
    );
    $properties['translate'] = array(
      'label' => t('Translate'),
      'description' => t('A boolean indicating whether this translation page needs to be updated.'),
      'type' => 'boolean_field',
    );
    $properties['revision_timestamp'] = array(
      'label' => t('Revision timestamp'),
      'description' => t('The time that the current revision was created.'),
      'type' => 'integer_field',
      'queryable' => FALSE,
    );
    $properties['revision_uid'] = array(
      'label' => t('Revision user ID'),
      'description' => t('The user ID of the author of the current revision.'),
      'type' => 'entity_reference_field',
      'settings' => array('target_type' => 'user'),
      'queryable' => FALSE,
    );
    $properties['log'] = array(
      'label' => t('Log'),
      'description' => t('The log entry explaining the changes in this version.'),
      'type' => 'string_field',
    );
    return $properties;
  }

436
}