Node.php 11.3 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\ContentEntityBase;
11
use Drupal\Core\Entity\EntityStorageControllerInterface;
12 13
use Drupal\Core\Language\Language;
use Drupal\Core\Session\AccountInterface;
14
use Drupal\node\NodeInterface;
15 16 17

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

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

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

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

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

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

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
    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.
111
      $record->log = $this->original->log->value;
112 113
    }
  }
114 115

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

121 122 123 124
    // 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()) {
125
      \Drupal::entityManager()->getAccessController('node')->writeGrants($this, $update);
126 127
    }
  }
128 129

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

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

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

149 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
  /**
   * {@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;
  }


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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

309 310 311
  /**
   * {@inheritdoc}
   */
312 313 314
  public function setRevisionAuthorId($uid) {
    $this->set('revision_uid', $uid);
    return $this;
315 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
  /**
   * {@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(
386
        'value' => array('EntityChanged' => array()),
387 388 389 390 391 392 393 394 395 396 397 398
      ),
    );
    $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',
    );
399 400 401 402 403
    $properties['translate'] = array(
      'label' => t('Translate'),
      'description' => t('A boolean indicating whether this translation page needs to be updated.'),
      'type' => 'boolean_field',
    );
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
    $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;
  }

425
}