Skip to content

Commit

Permalink
Changing IniFile to be a ConfigReader for use with Configure. Test ca…
Browse files Browse the repository at this point in the history
…se updated.
  • Loading branch information
markstory committed Dec 4, 2010
1 parent 9e32c13 commit 1e569f5
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 131 deletions.
101 changes: 0 additions & 101 deletions cake/libs/config/ini_file.php

This file was deleted.

73 changes: 73 additions & 0 deletions cake/libs/config/ini_reader.php
@@ -0,0 +1,73 @@
<?php
/**
* IniReader
*
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package cake
* @subpackage cake.cake.libs.controller.components
* @since CakePHP(tm) v 2.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/

/**
* Ini file configuration parser. Since IniReader uses parse_ini_file underneath,
* you should be aware that this class shares the same behavior, especially with
* regards to boolean and null values.
*
* @package cake.config
* @see http://php.net/parse_ini_file
*/
class IniReader implements ConfigReaderInterface {

/**
* The path to read ini files from.
*
* @var array
*/
protected $_path;

/**
* The section to read, if null all sections will be read.
*
* @var string
*/
protected $_section;

/**
* Build and construct a new ini file parser. The parser can be used to read
* ini files that are on the filesystem.
*
* @param string $path Path to load ini config files from.
* @param string $section Only get one section.
*/
public function __construct($path, $section = null) {
$this->_path = $path;
$this->_section = $section;
}

/**
* Read an ini file and return the results as an array.
*
* @param string $file Name of the file to read.
* @return array
*/
public function read($file) {
$filename = $this->_path . $file;
$contents = parse_ini_file($filename, true);
if (!empty($this->_section) && isset($contents[$this->_section])) {
$values = $contents[$this->_section];
} else {
$values = $contents;
}
return $values;
}
}
5 changes: 3 additions & 2 deletions cake/libs/configure.php
Expand Up @@ -313,9 +313,10 @@ public static function drop($name) {
* `Configure::load('setup', 'default');` * `Configure::load('setup', 'default');`
* *
* @link http://book.cakephp.org/view/929/load * @link http://book.cakephp.org/view/929/load
* @param string $key name of configuration resource to load. * @param string $key name of configuration resource to load.
* @param string $config Name of the configured reader to use to read the resource identfied by $key. * @param string $config Name of the configured reader to use to read the resource identfied by $key.
* @return mixed false if file not found, void if load successful * @return mixed false if file not found, void if load successful.
* @throws Exception Will throw any exceptions the reader raises.
*/ */
public static function load($key, $config = 'default') { public static function load($key, $config = 'default') {
if (!isset(self::$_readers[$config])) { if (!isset(self::$_readers[$config])) {
Expand Down
@@ -1,6 +1,6 @@
<?php <?php
/** /**
* IniFileTest * IniReaderTest
* *
* PHP 5 * PHP 5
* *
Expand All @@ -17,9 +17,9 @@
* @since CakePHP(tm) v 2.0 * @since CakePHP(tm) v 2.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php) * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/ */
App::import('Core', 'config/IniFile'); App::import('Core', 'config/IniReader');


class IniFileTest extends CakeTestCase { class IniReaderTest extends CakeTestCase {


/** /**
* The test file that will be read. * The test file that will be read.
Expand All @@ -35,7 +35,7 @@ class IniFileTest extends CakeTestCase {
*/ */
function setup() { function setup() {
parent::setup(); parent::setup();
$this->file = TEST_CAKE_CORE_INCLUDE_PATH . 'tests' . DS . 'test_app' . DS . 'config'. DS . 'acl.ini.php'; $this->path = TEST_CAKE_CORE_INCLUDE_PATH . 'tests' . DS . 'test_app' . DS . 'config'. DS;
} }


/** /**
Expand All @@ -44,7 +44,8 @@ function setup() {
* @return void * @return void
*/ */
function testConstruct() { function testConstruct() {
$config = new IniFile($this->file); $reader = new IniReader($this->path);
$config = $reader->read('acl.ini.php');


$this->assertTrue(isset($config['admin'])); $this->assertTrue(isset($config['admin']));
$this->assertTrue(isset($config['paul']['groups'])); $this->assertTrue(isset($config['paul']['groups']));
Expand All @@ -57,32 +58,11 @@ function testConstruct() {
* @return void * @return void
*/ */
function testReadingOnlyOneSection() { function testReadingOnlyOneSection() {
$config = new IniFile($this->file, 'admin'); $reader = new IniReader($this->path, 'admin');
$config = $reader->read('acl.ini.php');


$this->assertTrue(isset($config['groups'])); $this->assertTrue(isset($config['groups']));
$this->assertEquals('administrators', $config['groups']); $this->assertEquals('administrators', $config['groups']);
} }


/**
* test getting all the values as an array
*
* @return void
*/
function testAsArray() {
$config = new IniFile($this->file);
$content = $config->asArray();

$this->assertTrue(isset($content['admin']['groups']));
$this->assertTrue(isset($content['paul']['groups']));
}

/**
* test that values cannot be modified
*
* @expectedException LogicException
*/
function testNoModification() {
$config = new IniFile($this->file);
$config['admin'] = 'something';
}
} }

0 comments on commit 1e569f5

Please sign in to comment.