Initial commit

lib/Cake/Console/TaskCollection.php

@@ -0,0 +1,100 @@
+<?php
+/**
+ * Task collection is used as a registry for loaded tasks and handles loading
+ * and constructing task class objects.
+ *
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @since         CakePHP(tm) v 2.0
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+
+App::uses('ObjectCollection', 'Utility');
+
+/**
+ * Collection object for Tasks. Provides features
+ * for lazily loading tasks, and firing callbacks on loaded tasks.
+ *
+ * @package       Cake.Console
+ */
+class TaskCollection extends ObjectCollection {
+
+/**
+ * Shell to use to set params to tasks.
+ *
+ * @var Shell
+ */
+	protected $_Shell;
+
+/**
+ * The directory inside each shell path that contains tasks.
+ *
+ * @var string
+ */
+	public $taskPathPrefix = 'tasks/';
+
+/**
+ * Constructor
+ *
+ * @param Shell $Shell The shell this task collection is attached to.
+ */
+	public function __construct(Shell $Shell) {
+		$this->_Shell = $Shell;
+	}
+
+/**
+ * Loads/constructs a task. Will return the instance in the registry if it already exists.
+ *
+ * You can alias your task as an existing task by setting the 'className' key, i.e.,
+ * {{{
+ * public $tasks = array(
+ * 'DbConfig' => array(
+ * 'className' => 'Bakeplus.DbConfigure'
+ * );
+ * );
+ * }}}
+ * All calls to the `DbConfig` task would use `DbConfigure` found in the `Bakeplus` plugin instead.
+ *
+ * @param string $task Task name to load
+ * @param array $settings Settings for the task.
+ * @return Task A task object, Either the existing loaded task or a new one.
+ * @throws MissingTaskException when the task could not be found
+ */
+	public function load($task, $settings = array()) {
+		if (is_array($settings) && isset($settings['className'])) {
+			$alias = $task;
+			$task = $settings['className'];
+		}
+		list($plugin, $name) = pluginSplit($task, true);
+		if (!isset($alias)) {
+			$alias = $name;
+		}
+
+		if (isset($this->_loaded[$alias])) {
+			return $this->_loaded[$alias];
+		}
+		$taskClass = $name . 'Task';
+		App::uses($taskClass, $plugin . 'Console/Command/Task');
+
+		$exists = class_exists($taskClass);
+		if (!$exists) {
+			throw new MissingTaskException(array(
+				'class' => $taskClass,
+				'plugin' => substr($plugin, 0, -1)
+			));
+		}
+
+		$this->_loaded[$alias] = new $taskClass(
+			$this->_Shell->stdout, $this->_Shell->stderr, $this->_Shell->stdin
+		);
+		return $this->_loaded[$alias];
+	}
+
+}