FileStorage.php 5.06 KB
Newer Older
1 2
<?php

3 4 5 6 7
/**
 * @file
 * Definition of Drupal\Core\Config\FileStorage.
 */

8 9
namespace Drupal\Core\Config;

10 11
use Symfony\Component\Yaml\Dumper;
use Symfony\Component\Yaml\Parser;
12

13
/**
14
 * Defines the file storage controller.
15
 */
16
class FileStorage implements StorageInterface {
17 18

  /**
19
   * The filesystem path for configuration objects.
20
   *
21
   * @var string
22
   */
23
  protected $directory = '';
24

25 26 27 28 29 30 31 32 33 34 35 36 37 38
  /**
   * A shared YAML dumper instance.
   *
   * @var Symfony\Component\Yaml\Dumper
   */
  protected $dumper;

  /**
   * A shared YAML parser instance.
   *
   * @var Symfony\Component\Yaml\Parser
   */
  protected $parser;

39
  /**
40 41 42 43
   * Constructs a new FileStorage controller.
   *
   * @param string $directory
   *   A directory path to use for reading and writing of configuration files.
44
   */
45 46
  public function __construct($directory) {
    $this->directory = $directory;
47 48 49
  }

  /**
50
   * Returns the path to the configuration file.
51
   *
52 53
   * @return string
   *   The path to the configuration file.
54
   */
55
  public function getFilePath($name) {
56
    return $this->directory . '/' . $name . '.' . self::getFileExtension();
57 58 59 60 61 62 63 64 65 66
  }

  /**
   * Returns the file extension used by the file storage for all configuration files.
   *
   * @return string
   *   The file extension.
   */
  public static function getFileExtension() {
    return 'yml';
67 68 69
  }

  /**
70
   * Implements Drupal\Core\Config\StorageInterface::exists().
71
   */
72 73
  public function exists($name) {
    return file_exists($this->getFilePath($name));
74 75 76
  }

  /**
77
   * Implements Drupal\Core\Config\StorageInterface::read().
78
   *
79
   * @throws Symfony\Component\Yaml\Exception\ParseException
80
   */
81 82
  public function read($name) {
    if (!$this->exists($name)) {
83
      return FALSE;
84 85 86 87 88 89
    }
    $data = file_get_contents($this->getFilePath($name));
    // @todo Yaml throws a ParseException on invalid data. Is it expected to be
    //   caught or not?
    $data = $this->decode($data);
    return $data;
90 91 92
  }

  /**
93
   * Implements Drupal\Core\Config\StorageInterface::write().
94
   *
95 96
   * @throws Symfony\Component\Yaml\Exception\DumpException
   * @throws Drupal\Core\Config\StorageException
97
   */
98 99 100 101 102
  public function write($name, array $data) {
    $data = $this->encode($data);
    $status = @file_put_contents($this->getFilePath($name), $data);
    if ($status === FALSE) {
      throw new StorageException('Failed to write configuration file: ' . $this->getFilePath($name));
103
    }
104
    return TRUE;
105 106 107
  }

  /**
108
   * Implements Drupal\Core\Config\StorageInterface::delete().
109
   */
110 111
  public function delete($name) {
    if (!$this->exists($name)) {
112 113
      if (!file_exists($this->directory)) {
        throw new StorageException($this->directory . '/ not found.');
114 115 116 117
      }
      return FALSE;
    }
    return drupal_unlink($this->getFilePath($name));
118
  }
119

120
  /**
121
   * Implements Drupal\Core\Config\StorageInterface::rename().
122 123 124 125 126 127 128 129 130
   */
  public function rename($name, $new_name) {
    $status = @rename($this->getFilePath($name), $this->getFilePath($new_name));
    if ($status === FALSE) {
      throw new StorageException('Failed to rename configuration file from: ' . $this->getFilePath($name) . ' to: ' . $this->getFilePath($new_name));
    }
    return TRUE;
  }

131 132 133 134 135 136 137 138
  /**
   * Gets the YAML dumper instance.
   *
   * @return Symfony\Component\Yaml\Dumper
   */
  protected function getDumper() {
    if (!isset($this->dumper)) {
      $this->dumper = new Dumper();
139 140 141
      // Set Yaml\Dumper's default indentation for nested nodes/collections to
      // 2 spaces for consistency with Drupal coding standards.
      $this->dumper->setIndentation(2);
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
    }
    return $this->dumper;
  }

  /**
   * Gets the YAML parser instance.
   *
   * @return Symfony\Component\Yaml\Parser
   */
  protected function getParser() {
    if (!isset($this->parser)) {
      $this->parser = new Parser();
    }
    return $this->parser;
  }

158
  /**
159 160 161
   * Implements Drupal\Core\Config\StorageInterface::encode().
   *
   * @throws Symfony\Component\Yaml\Exception\DumpException
162
   */
163
  public function encode($data) {
164 165
    // The level where you switch to inline YAML is set to PHP_INT_MAX to ensure
    // this does not occur.
166
    return $this->getDumper()->dump($data, PHP_INT_MAX);
167 168 169
  }

  /**
170 171 172
   * Implements Drupal\Core\Config\StorageInterface::decode().
   *
   * @throws Symfony\Component\Yaml\Exception\ParseException
173
   */
174 175
  public function decode($raw) {
    $data = $this->getParser()->parse($raw);
176 177 178
    // A simple string is valid YAML for any reason.
    if (!is_array($data)) {
      return FALSE;
179
    }
180
    return $data;
181 182 183
  }

  /**
184
   * Implements Drupal\Core\Config\StorageInterface::listAll().
185
   */
186 187 188
  public function listAll($prefix = '') {
    // glob() silently ignores the error of a non-existing search directory,
    // even with the GLOB_ERR flag.
189 190
    if (!file_exists($this->directory)) {
      throw new StorageException($this->directory . '/ not found.');
191 192
    }
    $extension = '.' . self::getFileExtension();
193
    $files = glob($this->directory . '/' . $prefix . '*' . $extension);
194 195
    $clean_name = function ($value) use ($extension) {
      return basename($value, $extension);
196 197
    };
    return array_map($clean_name, $files);
198
  }
199
}