class Storage in Configuration Management 7.2

Hierarchy

• class \Drupal\configuration\Storage\Storage

2 files declare their use of Storage

ConfigurationManagement.php in lib/Drupal/configuration/Config/ConfigurationManagement.php

Definition of Drupal\configuration\Config\ConfigurationManagement.

StoragePhp.php in lib/Drupal/configuration/Storage/StoragePhp.php

Definition of Drupal\configuration\Storage\StoragePhp.

File

lib/Drupal/configuration/Storage/Storage.php, line 11

Definition of Drupal\configuration\Storage\Storage.

Namespace

Drupal\configuration\Storage

class Storage {
  protected $data;
  protected $dependencies;
  protected $optional_configurations;
  protected $required_modules;
  protected $api_version;
  protected $filename;
  protected $loaded;
  protected $hash;
  protected $keys_to_export = array();
  public static $file_extension = '';

  /**
   * Returns TRUE if the file for a configuration exists
   * in the config:// directory.
   */
  public static function configFileExists($filename) {
    return file_exists(ConfigurationManagement::getStream() . '/' . $filename);
  }

  /**
   * Returns TRUE if the current user has write permissions for a configuration
   * file in the config:// directory.
   */
  public static function checkFilePermissions($filename) {
    $dir_path = ConfigurationManagement::getStream();
    $full_path = $dir_path . '/' . $filename;
    if (static::checkDirectory($dir_path)) {
      if (file_exists($full_path)) {
        if (is_writable($full_path) || drupal_chmod($full_path)) {
          return TRUE;
        }
        else {
          drupal_set_message(t('The current user does not have permissions to edit the file %file.', array(
            '%file' => $full_path,
          )), 'error');
        }
      }
      else {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Returns TRUE if the path is a directory or we can create one in that path.
   */
  public static function checkDirectory($dir_path) {
    if (!is_dir($dir_path)) {
      if (drupal_mkdir($dir_path, NULL, TRUE)) {
        return TRUE;
      }
      else {

        // If the directory does not exists and cannot be created.
        drupal_set_message(st('The directory %directory does not exist and could not be created.', array(
          '%directory' => $dir_path,
        )), 'error');
        watchdog('file system', 'The directory %directory does not exist and could not be created.', array(
          '%directory' => $dir_path,
        ), WATCHDOG_ERROR);
        return FALSE;
      }
    }
    else {
      if (is_writable($dir_path) || drupal_chmod($dir_path)) {
        return TRUE;
      }
      watchdog('configuration', 'The current user does not have write permissions in the directory %dir.', array(
        '%dir' => $dir_path,
      ), WATCHDOG_ERROR);
      drupal_set_message(t('The current user does not have write permissions in the directory %dir.', array(
        '%dir' => $dir_path,
      )), 'error', FALSE);
    }
    return FALSE;
  }
  public function __construct() {
    $this
      ->reset();
  }
  public function reset() {
    $this->hash = '';
    $this->loaded = FALSE;
    $this->dependencies = array();
    $this->optional_configurations = array();
    $this->data = NULL;
    $this->api_version = '0.0.0';
  }
  public function export($var, $prefix = '') {
  }
  public function import($file_content) {
  }

  /**
   * Saves the configuration object into the DataStore.
   */
  public function save() {
  }

  /**
   * Loads the configuration object from the DataStore.
   *
   * @param $file_content
   *   Optional. The content to load directly.
   * @param $source
   *   Optional. An optional path to load the configuration.
   */
  public function load($file_content = NULL, $source = NULL) {
    return $this;
  }
  public function reLoad($file_content = NULL, $source = NULL) {
    $this
      ->reset();
    return $this
      ->load($file_content);
  }
  public function setFileName($filename) {
    $this->filename = $filename;
    return $this;
  }
  public function getFileName() {
    return $this->filename;
  }
  public function setData($data) {
    $this->data = $data;
    return $this;
  }

  /**
   * Set an array of keys names to export. If the array is empty,
   * all the keys of the configuration will be exported.
   */
  public function setKeysToExport($keys) {
    $this->keys_to_export = $keys;
    return $this;
  }
  public function withData() {
    return !empty($this->data);
  }
  public function getData() {
    return $this->data;
  }
  public function getDependencies() {
    return $this->dependencies;
  }
  public function setDependencies($dependencies) {
    $this->dependencies = $dependencies;
    return $this;
  }
  public function getOptionalConfigurations() {
    return $this->optional_configurations;
  }
  public function setOptionalConfigurations($optional_configurations) {
    $this->optional_configurations = $optional_configurations;
    return $this;
  }
  public function getModules() {
    return $this->required_modules;
  }
  public function setModules($modules) {
    $this->required_modules = $modules;
    return $this;
  }
  public function setApiVersion($api_version) {
    $this->api_version = $api_version;
    return $this;
  }
  public function getApiVersion() {
    return $this->api_version;
  }
  public function checkForChanges($object) {
    $new = $this
      ->export($object);
    $original = $this
      ->export($this
      ->load()->data);
    return $new != $original;
  }
  public function getHash() {
    return $this->hash;
  }
  public static function getFileExtension() {
    return static::$file_extension;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Storage::$api_version	protected	property
Storage::$data	protected	property
Storage::$dependencies	protected	property
Storage::$filename	protected	property
Storage::$file_extension	public static	property		1
Storage::$hash	protected	property
Storage::$keys_to_export	protected	property
Storage::$loaded	protected	property
Storage::$optional_configurations	protected	property
Storage::$required_modules	protected	property
Storage::checkDirectory	public static	function	Returns TRUE if the path is a directory or we can create one in that path.
Storage::checkFilePermissions	public static	function	Returns TRUE if the current user has write permissions for a configuration file in the config:// directory.
Storage::checkForChanges	public	function
Storage::configFileExists	public static	function	Returns TRUE if the file for a configuration exists in the config:// directory.
Storage::export	public	function		1
Storage::getApiVersion	public	function
Storage::getData	public	function
Storage::getDependencies	public	function
Storage::getFileExtension	public static	function
Storage::getFileName	public	function
Storage::getHash	public	function
Storage::getModules	public	function
Storage::getOptionalConfigurations	public	function
Storage::import	public	function		1
Storage::load	public	function	Loads the configuration object from the DataStore.	1
Storage::reLoad	public	function
Storage::reset	public	function
Storage::save	public	function	Saves the configuration object into the DataStore.	1
Storage::setApiVersion	public	function
Storage::setData	public	function
Storage::setDependencies	public	function
Storage::setFileName	public	function
Storage::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.
Storage::setModules	public	function
Storage::setOptionalConfigurations	public	function
Storage::withData	public	function
Storage::__construct	public	function		2