8.2.x ConfigEntityBase.php public ConfigEntityBase::status()
8.0.x ConfigEntityBase.php public ConfigEntityBase::status()
8.1.x ConfigEntityBase.php public ConfigEntityBase::status()
8.3.x ConfigEntityBase.php public ConfigEntityBase::status()

Returns whether the configuration entity is enabled.

Status implementations for configuration entities should follow these general rules:

  • Status does not affect the loading of entities. I.e. Disabling configuration entities should only have UI/access implications.
  • It should only take effect when a 'status' key is explicitly declared in the entity_keys info of a configuration entity's annotation data.
  • Each entity implementation (entity/controller) is responsible for checking and managing the status.

Return value

bool Whether the entity is enabled or not.

Overrides ConfigEntityInterface::status

2 calls to ConfigEntityBase::status()
SearchPage::isIndexable in core/modules/search/src/Entity/SearchPage.php
Determines if this search page entity is indexable.
View::postSave in core/modules/views/src/Entity/View.php
Acts on a saved entity before the insert or update hook is invoked.

File

core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php, line 203

Class

ConfigEntityBase
Defines a base configuration entity class.

Namespace

Drupal\Core\Config\Entity

Code

public function status() {
  return !empty($this->status);
}