public function ContentEntityBase::onChange

public ContentEntityBase::onChange($name)

Reacts to changes to a field.

Note that this is invoked after any changes have been applied.

Parameters

string $field_name: The name of the field which is changed.

Throws

\InvalidArgumentException When trying to assign a value to the language field that matches an existing translation.

\LogicException When trying to change:

  • The language of a translation.
  • The value of the flag identifying the default translation object.

Overrides FieldableEntityInterface::onChange

File

core/lib/Drupal/Core/Entity/ContentEntityBase.php, line 665

Class

ContentEntityBase
Implements Entity Field API specific enhancements to the Entity class.

Namespace

Drupal\Core\Entity

Code

public function onChange($name) {
  // Check if the changed name is the value of an entity key and if the value
  // of that is currently cached, if so, reset it. Exclude the bundle from
  // that check, as it ready only and must not change, unsetting it could
  // lead to recursions.
  if ($key = array_search($name, $this->getEntityType()->getKeys())) {
    if ($key != 'bundle') {
      if (isset($this->entityKeys[$key])) {
        unset($this->entityKeys[$key]);
      }
      elseif (isset($this->translatableEntityKeys[$key][$this->activeLangcode])) {
        unset($this->translatableEntityKeys[$key][$this->activeLangcode]);
      }
    }
  }

  switch ($name) {
    case $this->langcodeKey:
      if ($this->isDefaultTranslation()) {
        // Update the default internal language cache.
        $this->setDefaultLangcode();
        if (isset($this->translations[$this->defaultLangcode])) {
          $message = SafeMarkup::format('A translation already exists for the specified language (@langcode).', array('@langcode' => $this->defaultLangcode));
          throw new \InvalidArgumentException($message);
        }
        $this->updateFieldLangcodes($this->defaultLangcode);
      }
      else {
        // @todo Allow the translation language to be changed. See
        //   https://www.drupal.org/node/2443989.
        $items = $this->get($this->langcodeKey);
        if ($items->value != $this->activeLangcode) {
          $items->setValue($this->activeLangcode, FALSE);
          $message = SafeMarkup::format('The translation language cannot be changed (@langcode).', array('@langcode' => $this->activeLangcode));
          throw new \LogicException($message);
        }
      }
      break;

    case $this->defaultLangcodeKey:
      // @todo Use a standard method to make the default_langcode field
      //   read-only. See https://www.drupal.org/node/2443991.
      if (isset($this->values[$this->defaultLangcodeKey]) && $this->get($this->defaultLangcodeKey)->value != $this->isDefaultTranslation()) {
        $this->get($this->defaultLangcodeKey)->setValue($this->isDefaultTranslation(), FALSE);
        $message = SafeMarkup::format('The default translation flag cannot be changed (@langcode).', array('@langcode' => $this->activeLangcode));
        throw new \LogicException($message);
      }
      break;
  }
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Entity!ContentEntityBase.php/function/ContentEntityBase::onChange/8.1.x