WriteconfigurationTask

Complexity

Total Complexity

10

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setFile()	0	4	1
A	setPath()	0	4	1
A	setValue()	0	4	1
A	setNamespace()	0	3	1
B	main()	0	34	6

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 32 and the first side effect is on line 16.

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+

require_once(__DIR__ . '/AgaviTask.php');

/**
 * Writes XPath-defined configuration values to an Agavi configuration file.
 *
 * @package    agavi
 * @subpackage build
 *
 * @author     Noah Fontes <noah.fontes@bitextender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      1.0.0
 *
 * @version    $Id$
 */
class WriteconfigurationTask extends AgaviTask

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
	protected $file = null;
	protected $path = null;
	protected $value = null;
	protected $namespace = null;
	
	/**
	 * Sets the file to modify.
	 *
	 * @param      PhingFile The file to modify.
	 */
	public function setFile(PhingFile $file)
	{
		$this->file = $file;
	}
	
	/**
	 * Sets the XPath path to search for in the file.
	 *
	 * @param      string The search path.
	 */
	public function setPath($path)
	{
		$this->path = $path;
	}
	
	/**
	 * Sets the new value for the configuration element.
	 *
	 * @param      mixed The new value.
	 */
	public function setValue($value)
	{
		$this->value = $value;
	}

	/**
	 * Sets the document namespace for this task.
	 *
	 * @param      string The document namespace.
	 */
	public function setNamespace($namespace) {
		$this->namespace = $namespace;
	}
	
	/**
	 * Executes this task.
	 */
	public function main()
	{
		if($this->file === null) {
			throw new \Agavi\Build\Exception\BuildException('The file attribute must be specified');
		}
		if($this->path === null) {
			throw new \Agavi\Build\Exception\BuildException('The path attribute must be specified');
		}
		if($this->value === null) {
			throw new \Agavi\Build\Exception\BuildException('The value attribute must be specified');
		}
		
		$document = new DOMDocument();
		$document->preserveWhiteSpace = true;
		$document->load($this->file->getAbsolutePath());
		
		$path = new DOMXPath($document);
		$path->registerNamespace('envelope', 'http://agavi.org/agavi/config/global/envelope/1.0');
		$path->registerNamespace('envelope10', 'http://agavi.org/agavi/config/global/envelope/1.0');
		$path->registerNamespace('envelope11', 'http://agavi.org/agavi/config/global/envelope/1.1');
		if($this->namespace !== null) {
			$path->registerNamespace('document', $this->namespace);
		}
		
		$entries = $path->query($this->path);
		foreach($entries as $entry) {
			$entry->nodeValue = (string)$this->value;
		}
		
		$document->save($this->file->getAbsolutePath());
		
		$this->log(sprintf('Writing configuration file %s with new data for %s (%s)',
			$this->file->getAbsolutePath(), $this->path, $this->value), Project::MSG_INFO);
	}
}

?>

It is not recommended to use PHP's closing tag ?> in files other than templates.