WritepropertiesTask

Complexity

Total Complexity

9

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setFile()	0	4	1
A	setUpdate()	0	4	1
A	createProperty()	0	6	1
B	main()	0	27	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 properties to a given 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 WritepropertiesTask extends AgaviTask

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

{
	protected $file = null;
	protected $update = false;
	protected $properties = array();

	/**
	 * Sets the file that this property will modify.
	 *
	 * @param      PhingFile The file to modify.
	 */
	public function setFile(PhingFile $file)
	{
		$this->file = $file;
	}
	
	/**
	 * Sets whether this task will overwrite or update the file.
	 *
	 * @param      boolean Whether the file should be updated or replaced.
	 */
	public function setUpdate($update)
	{
		$this->update = StringHelper::booleanValue($update);
	}
	
	/**
	 * Creates a new property to be added to the property list.
	 */
	public function createProperty()
	{
		$property = new AgaviPropertyType();
		$this->properties[] = $property;
		return $property;
	}
	
	/**
	 * Executes the task.
	 */
	public function main()
	{
		if($this->file === null) {
			throw new \Agavi\Build\Exception\BuildException('The file attribute must be set');
		}
		
		$properties = new Properties();
		if($this->update === true) {
			/* Load existing properties. */
			try {
				$properties->load($this->file);
			}
			catch(IOException $ioe) {
				/* File doesn't exist or isn't readable, so don't worry here. */
			}
		}
		
		/* Add new properties. */
		foreach($this->properties as $property) {
			foreach($property->resolve()->getProperties() as $name => $value) {
				$properties->setProperty($name, $value);
			}
		}
		
		$properties->store($this->file, 'Automatically-updated properties file ' . 
			'generated by the Agavi write-properties task');
	}
}

?>

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