You are here

Home » API reference » Configuration Management 7.2 » ContentTypeConfiguration.php

class ContentTypeConfiguration in Configuration Management 7.2

Hierarchy

Expanded class hierarchy of ContentTypeConfiguration

File

lib/Drupal/configuration/Config/ContentTypeConfiguration.php, line 13
Definition of Drupal\configuration\Config\ContentTypeConfiguration.

Namespace

Drupal\configuration\Config
View source 
class ContentTypeConfiguration extends Configuration {

  /**
   * Overrides Drupal\configuration\Config\Configuration::__construct().
   */
  function __construct($identifier, $component = '') {
    parent::__construct($identifier);
    $keys = array(
      'type',
      'name',
      'description',
      'has_title',
      'title_label',
      'base',
      'help',
    );
    $this
      ->setKeysToExport($keys);
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getComponent().
   */
  public function getComponent() {
    return 'content_type';
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::supportedComponents().
   */
  public static function supportedComponents() {
    return array(
      'content_type',
    );
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getComponentHumanName().
   */
  public static function getComponentHumanName($component, $plural = FALSE) {
    return $plural ? t('Content types') : t('Content type');
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::configForEntity().
   */
  public function configForEntity() {
    return TRUE;
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getEntityType().
   */
  public function getEntityType() {
    return 'node';
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getAllIdentifiers().
   */
  public static function getAllIdentifiers($component) {
    return node_type_get_names();
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::findRequiredModules().
   */
  public function findRequiredModules() {
    if ($this->data->base == 'node_content' || $this->data->base == 'configuration') {
      $this
        ->addToModules('node');
    }
    else {
      $this
        ->addToModules($this->data->base);
    }
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::alterDependencies().
   */
  public static function alterDependencies(Configuration $config) {
    if ($config
      ->getComponent() == 'permission') {
      foreach (node_permissions_get_configured_types() as $type) {
        foreach (array_keys(node_list_permissions($type)) as $permission) {
          $data = $config
            ->getData();
          if ($permission == $data['permission']) {
            $content_type = ConfigurationManagement::createConfigurationInstance('content_type.' . $type);
            $config
              ->addToDependencies($content_type);
            break;
          }
        }
      }
    }
  }

  /**
   * Implements Drupal\configuration\Config\Configuration::prepareBuild().
   */
  protected function prepareBuild() {
    $data = (object) node_type_get_type($this->identifier);
    $this->data = new \StdClass();
    foreach ($this
      ->getKeysToExport() as $key) {
      $this->data->{$key} = $data->{$key};
    }

    // Force module name to be 'configuration' if set to 'node. If we leave as
    // 'node' the content type will be assumed to be database-stored by
    // the node module.
    $this->data->base = $this->data->base === 'node' ? 'configuration' : $this->data->base;
    return $this;
  }

  /**
   * Implements Drupal\configuration\Config\Configuration::saveToActiveStore().
   */
  public function saveToActiveStore(ConfigIteratorSettings &$settings) {
    $info = (object) $this
      ->getData();
    $info->base = 'node_content';
    $info->module = 'node';
    $info->custom = 1;
    $info->modified = 1;
    $info->locked = 0;
    node_type_save($info);
    $settings
      ->addInfo('imported', $this
      ->getUniqueId());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Configuration::$broken protected property A boolean flag to indicate if the configuration object couldn't be loaded from it source.
Configuration::$built protected property A boolean flag to indicate if the configuration object was already populated from the ActiveStore, or from the DataStore.
Configuration::$context protected property The ConfigIteratorSettings instance used by iterate.
Configuration::$data protected property The data of this configuration.
Configuration::$dependencies protected property An array of configuration objects required to use this configuration.
Configuration::$hash protected property A hash that represent that sumarizes the configuration and can be used to copare configurations.
Configuration::$identifier protected property The identifier that identifies to the component, usually the machine name.
Configuration::$keys_to_export protected property An array of keys names to export. If the array is empty, all the keys of the configuration will be exported.
Configuration::$optional_configurations protected property An array of configuration objects that are parts of this configurations but are not required to use this configuration.
Configuration::$required_modules protected property The required modules to load this configuration.
Configuration::$storage protected property An object to save and load the data from a persistent medium.
Configuration::addToDependencies public function Add a new dependency for this configuration.
Configuration::addToModules public function Add a new dependency for this configuration.
Configuration::addToOptionalConfigurations public function Add a new child configuration for this configuration.
Configuration::build public function Build the configuration object based on the component name and in the identifier.
Configuration::buildHash public function Create a unique hash for this configuration based on the data, dependencies, optional configurations and modules required to use this configuration. Use getHash() after call this function.
Configuration::checkDependencies public function Returns TRUE if all the dependencies of this configurations are met. Returns FALSE if a module or a dependency is required by this configuration is not enabled.
Configuration::configFileExists public function Returns TRUE if the file that represents this configuration exists in the datastore.
Configuration::discoverModules protected function Internal function to discover what modules are required for the current being proccessed configurations.
Configuration::export public function
Configuration::findDependencies public function Ask to each configuration handler to add its dependencies to the current configuration that is being exported. 2
Configuration::getAllIdentifiersCached public static function Cache wrapper for getAllIdentifiers().
Configuration::getAvailableModules protected static function Helper for retrieving info from system table.
Configuration::getData public function Return the data for this configuration.
Configuration::getDependencies public function Returns the list of dependencies of this configuration
Configuration::getDependentModules public static function Determine the status of the given module and of its dependencies.
Configuration::getFileName public function Returns the filename that contains the content of the current configuration.
Configuration::getHash public function Returns the hash of the configuration object.
Configuration::getIdentifier public function Returns the identifier of the configuration object.
Configuration::getKeysToExport public function Returns an array of keys names to export. If the array is empty, all the keys of the configuration will be exported.
Configuration::getModules public function Returns the name of the required_modules that provide this configuration.
Configuration::getOptionalConfigurations public function Returns the list of optional_configurations of this configuration
Configuration::getRequiredModules public function Returns a list of modules that are required to run this configuration.
Configuration::getStatus public function Return the current status of the configuration.
Configuration::getStorageInstance protected static function Returns a Storage Object ready to load or write configurations from the disk. 2
Configuration::getStorageSystem protected static function Returns a class with its namespace to save data to the disk. 2
Configuration::getUniqueId public function Returns an unique identifier for this configuration. Usually something like 'content_type.article' where content_type is the component of the configuration and 'article' is the identifier of the configuration for the given component.
Configuration::import public function Load a configuration from the DataStore and save it into the ActiveStore. This function is called from iterator().
Configuration::inSync constant A bit flag used to let us know if a configuration is the same in both the activestore and the datastore.
Configuration::isActive public static function Determine if the handler can be used. Usually this function should check that modules required to handle the configuration are installed. 8
Configuration::isBroken public function Return TRUE if something went wrong with the load of the configuration.
Configuration::iterate public function This function will exectute a callback function over all the configurations objects that it process.
Configuration::loadFromActiveStore public function Load a configurations from the database.
Configuration::loadFromStorage public function Load the Configuration data from the disk.
Configuration::moduleInstalled constant A bit flag used to let us know if a module for the configuration is already installed.
Configuration::moduleMissing constant A bit flag used to let us know if a module for the configuration is not available to install in the site.
Configuration::moduleToInstall constant A bit flag used to let us know if a module for the configuration is disabled but can be enabled.
Configuration::notTracked constant A bit flag used to let us know if a configuration is not currently being tracked.
Configuration::overridden constant A bit flag used to let us know if a configuration was overridden as a result of changing the activestore directly. (config changes via the UI)
Configuration::printRaw protected function Print the configuration as plain text formatted to use in a tar file.
Configuration::raw public function Print the configuration as plain text formatted to use in a tar file.
Configuration::removeConfiguration public function Removes the configuration record from the configuration_tracked table for the current configuration.
Configuration::removeFromDataStore public function Removes the configuration file from the dataStore folder.
Configuration::scanDataStore public static function Returns the list of components available in the DataStore.
Configuration::setContext public function Set the context where a function is executed.
Configuration::setData public function Set the data for this configuration.
Configuration::setDependencies public function Returns the list of dependencies of this configuration
Configuration::setHash public function Set the hash for this configuration.
Configuration::setIdentifier public function Set the component identifier of this configuration
Configuration::setKeysToExport public function Set an array of keys names to export. If the array is empty, all the keys of the configuration will be exported.
Configuration::setModules public function Set the name of the required_modules that provide this configuration.
Configuration::setOptionalConfigurations public function Returns the list of optional_configurations of this configuration
Configuration::startTracking public function Save a configuration object into the configuration_tracked table.
Configuration::stopTracking public function Removes the configuration record from the configuration_tracked table for the current configuration.
ContentTypeConfiguration::alterDependencies public static function Overrides Drupal\configuration\Config\Configuration::alterDependencies(). Overrides Configuration::alterDependencies
ContentTypeConfiguration::configForEntity public function Overrides Drupal\configuration\Config\Configuration::configForEntity(). Overrides Configuration::configForEntity
ContentTypeConfiguration::findRequiredModules public function Overrides Drupal\configuration\Config\Configuration::findRequiredModules(). Overrides Configuration::findRequiredModules
ContentTypeConfiguration::getAllIdentifiers public static function Overrides Drupal\configuration\Config\Configuration::getAllIdentifiers(). Overrides Configuration::getAllIdentifiers
ContentTypeConfiguration::getComponent public function Overrides Drupal\configuration\Config\Configuration::getComponent(). Overrides Configuration::getComponent
ContentTypeConfiguration::getComponentHumanName public static function Overrides Drupal\configuration\Config\Configuration::getComponentHumanName(). Overrides Configuration::getComponentHumanName
ContentTypeConfiguration::getEntityType public function Overrides Drupal\configuration\Config\Configuration::getEntityType().
ContentTypeConfiguration::prepareBuild protected function Implements Drupal\configuration\Config\Configuration::prepareBuild(). Overrides Configuration::prepareBuild
ContentTypeConfiguration::saveToActiveStore public function Implements Drupal\configuration\Config\Configuration::saveToActiveStore(). Overrides Configuration::saveToActiveStore
ContentTypeConfiguration::supportedComponents public static function Overrides Drupal\configuration\Config\Configuration::supportedComponents(). Overrides Configuration::supportedComponents
ContentTypeConfiguration::__construct function Overrides Drupal\configuration\Config\Configuration::__construct(). Overrides Configuration::__construct