LocatemoduleTask

Complexity

Total Complexity

14

Size/Duplication

Total Lines	91
Duplicated Lines	20.88 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setProperty()	0	4	1
A	setPath()	0	4	1
A	setIgnoreIfSet()	0	4	1
C	main()	19	51	11

<?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');

/**
 * Locates a module directory given a project and a module name.
 *
 * @package    agavi
 * @subpackage build
 *
 * @author     Noah Fontes <noah.fontes@bitextender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      1.0.0
 *
 * @version    $Id$
 */
class LocatemoduleTask extends AgaviTask

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

{
	protected $property = null;
	protected $path = null;
	protected $ignoreIfSet = false;
	
	/**
	 * Sets the property that this task will modify.
	 *
	 * @param      string The property to modify.
	 */
	public function setProperty($property)
	{
		$this->property = $property;
	}
	
	/**
	 * Sets the path to use to locate the module.
	 *
	 * @param      string The path to use.
	 */
	public function setPath(PhingFile $path)
	{
		$this->path = $path;
	}
	
	/**
	 * Sets whether to ignore this check if the property is already set.
	 *
	 * @param      bool Whether to bypass the check if the property is set.
	 */
	public function setIgnoreIfSet($ignoreIfSet)
	{
		$this->ignoreIfSet = StringHelper::booleanValue($ignoreIfSet);
	}
	
	/**
	 * Executes the task.
	 */
	public function main()
	{
		if($this->property === null) {
			throw new \Agavi\Build\Exception\BuildException('The property attribute must be specified');
		}
		if($this->path === null) {
			throw new \Agavi\Build\Exception\BuildException('The path attribute must be specified');
		}
		
		if($this->ignoreIfSet && $this->project->getProperty($this->property) !== null) {
			return;
		}
		
		if(!$this->path->exists()) {
			throw new \Agavi\Build\Exception\BuildException('The path ' . $this->path->getAbsolutePath() . ' does not exist');
		}
		$this->path = $this->path->getAbsoluteFile();
		if(!$this->path->isDirectory()) {
			$this->path = $this->path->getParentFile();
		}
		
		/* Check if the current directory is a project directory. */
		$check = new \Agavi\Build\Check\ModuleFilesystemCheck();
		$check->setConfigDirectory($this->project->getProperty('module.config.directory'));
		
		$check->setPath($this->path->getAbsolutePath());
		if($check->check()) {

This code seems to be duplicated across your project.

			/* The current path is the project directory. */
			$this->log('Module base directory: ' . $this->path);
			$this->project->setUserProperty($this->property, $this->path->getName());
			return;
		}
		
		$check->setPath($this->path->getAbsolutePath());
		if($check->check()) {

This code seems to be duplicated across your project.

			$this->log('Module base directory: ' . $this->path);
			$this->project->setUserProperty($this->property, $this->path->getName());
			return;
		}
		
		/* Last chance: recurse upward and check for a project directory. */
		$directory = $this->path;
		while(($directory = $directory->getParentFile()) !== null) {

This code seems to be duplicated across your project.

			$check->setPath($directory->getAbsolutePath());
			if($check->check()) {
				$this->log('Module base directory: ' . $directory);
				$this->project->setUserProperty($this->property, $directory->getName());
				return;
			}
		}
	}
}

?>

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