You are here

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

class CtoolsConfiguration in Configuration Management 7.2

Hierarchy

Expanded class hierarchy of CtoolsConfiguration

5 files declare their use of CtoolsConfiguration
FieldGroupConfiguration.php in lib/Drupal/configuration/Config/FieldGroupConfiguration.php
Definition of Drupal\configuration\Config\FieldGroupHandlerConfiguration.
PageManagerHandlerConfiguration.php in lib/Drupal/configuration/Config/PageManagerHandlerConfiguration.php
Definition of Drupal\configuration\Config\PageManagerHandlerConfiguration.
PanelizerConfiguration.php in lib/Drupal/configuration/Config/PanelizerConfiguration.php
Definition of Drupal\configuration\Config\PanelizerConfiguration.
StrongarmConfiguration.php in lib/Drupal/configuration/Config/StrongarmConfiguration.php
Definition of Drupal\configuration\Config\StrongarmConfiguration.
ViewConfiguration.php in lib/Drupal/configuration/Config/ViewConfiguration.php
Definition of Drupal\configuration\Config\ViewConfiguration.

File

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

Namespace

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

  /**
   * The component of the current configuration.
   *
   * Usually this component is the table where the configuration object lives.
   *
   * @var string
   */
  protected $component;

  /**
   * Overrides Drupal\configuration\Config\Configuration::__construct().
   */
  public function __construct($identifier, $component = '') {

    // Because CTools can handle multiple types of configurations we need to
    // know what is the current handled configuration. Usually this component is
    // the main table where the ctools object lives.
    $this->component = $component;
    parent::__construct($identifier, $component);
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getStorageInstance().
   */
  protected static function getStorageInstance($component) {
    $storage = static::getStorageSystem($component);
    return new $storage($component);
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::isActive().
   */
  public static function isActive() {
    return module_exists('ctools');
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getComponentHumanName().
   */
  public static function getComponentHumanName($component, $plural = FALSE) {
    ctools_include('export');
    foreach (ctools_export_get_schemas_by_module() as $module => $schemas) {
      if (!empty($schemas[$component])) {
        if (!empty($schemas[$component]['export']['identifier'])) {
          return $schemas[$component]['export']['identifier'];
        }
        return $component;
      }
    }
    return '';
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getComponent().
   */
  public function getComponent() {
    return $this->component;
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::supportedComponents().
   */
  public static function supportedComponents() {
    if (!static::isActive()) {
      return array();
    }
    $supported = array();
    ctools_include('export');
    foreach (ctools_export_get_schemas_by_module() as $module => $schemas) {
      foreach ($schemas as $table => $schema) {
        if (isset($schema['export']) && $schema['export']['bulk export']) {
          $supported[] = $table;
        }
      }
    }
    return $supported;
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getAllIdentifiers().
   */
  public static function getAllIdentifiers($component) {
    ctools_include('export');
    $objects = ctools_export_load_object($component, 'all');
    return drupal_map_assoc(array_keys($objects));
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getStorageSystem().
   */
  protected static function getStorageSystem($component) {
    return '\\Drupal\\configuration\\Storage\\StorageCtools';
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::findRequiredModules().
   */
  public function findRequiredModules() {
    $this
      ->addToModules('ctools');
    foreach (ctools_export_get_schemas_by_module() as $module => $schemas) {
      foreach ($schemas as $table => $schema) {
        if ($table == $this
          ->getComponent()) {
          $this
            ->addToModules($module);
        }
      }
    }
  }

  /**
   * Implements Drupal\configuration\Config\Configuration::prepareBuild().
   */
  public function prepareBuild() {
    ctools_include('export');
    ctools_export_load_object_reset();
    $this->data = ctools_export_crud_load($this
      ->getComponent(), $this
      ->getIdentifier());
    return $this;
  }

  /**
   * Implements Drupal\configuration\Config\Configuration::saveToActiveStore().
   */
  public function saveToActiveStore(ConfigIteratorSettings &$settings) {
    ctools_include('export');
    $object = ctools_export_crud_load($this
      ->getComponent(), $this
      ->getIdentifier());
    if ($object) {
      ctools_export_crud_delete($this
        ->getComponent(), $object);
    }
    $data = $this
      ->getData();
    $data->export_type = NULL;
    ctools_export_crud_save($this
      ->getComponent(), $data);
    $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::alterDependencies public static function Configurations should implement this function to add configuration objects (by using addToDepedencies). 15
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::configForEntity public function Return TRUE if this is the configuration for an entity. 3
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::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::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.
CtoolsConfiguration::$component protected property The component of the current configuration.
CtoolsConfiguration::findRequiredModules public function Overrides Drupal\configuration\Config\Configuration::findRequiredModules(). Overrides Configuration::findRequiredModules 2
CtoolsConfiguration::getAllIdentifiers public static function Overrides Drupal\configuration\Config\Configuration::getAllIdentifiers(). Overrides Configuration::getAllIdentifiers
CtoolsConfiguration::getComponent public function Overrides Drupal\configuration\Config\Configuration::getComponent(). Overrides Configuration::getComponent 5
CtoolsConfiguration::getComponentHumanName public static function Overrides Drupal\configuration\Config\Configuration::getComponentHumanName(). Overrides Configuration::getComponentHumanName 5
CtoolsConfiguration::getStorageInstance protected static function Overrides Drupal\configuration\Config\Configuration::getStorageInstance(). Overrides Configuration::getStorageInstance
CtoolsConfiguration::getStorageSystem protected static function Overrides Drupal\configuration\Config\Configuration::getStorageSystem(). Overrides Configuration::getStorageSystem
CtoolsConfiguration::isActive public static function Overrides Drupal\configuration\Config\Configuration::isActive(). Overrides Configuration::isActive 5
CtoolsConfiguration::prepareBuild public function Implements Drupal\configuration\Config\Configuration::prepareBuild(). Overrides Configuration::prepareBuild
CtoolsConfiguration::saveToActiveStore public function Implements Drupal\configuration\Config\Configuration::saveToActiveStore(). Overrides Configuration::saveToActiveStore 2
CtoolsConfiguration::supportedComponents public static function Overrides Drupal\configuration\Config\Configuration::supportedComponents(). Overrides Configuration::supportedComponents 5
CtoolsConfiguration::__construct public function Overrides Drupal\configuration\Config\Configuration::__construct(). Overrides Configuration::__construct