pictcode

<?php

/**

 * Template Task can generate templated output Used in other Tasks

 *

 * 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 1.3

 * @license       http://www.opensource.org/licenses/mit-license.php MIT License

 */

App::uses('AppShell', 'Console/Command');

App::uses('Folder', 'Utility');

/**

 * Template Task can generate templated output Used in other Tasks.

 * Acts like a simplified View class.

 *

 * @package       Cake.Console.Command.Task

 */

class TemplateTask extends AppShell {

/**

 * variables to add to template scope

 *

 * @var array

 */

        public $templateVars = array();

/**

 * Paths to look for templates on.

 * Contains a list of $theme => $path

 *

 * @var array

 */

        public $templatePaths = array();

/**

 * Initialize callback. Setup paths for the template task.

 *

 * @return void

 */

        public function initialize() {

                $this->templatePaths = $this->_findThemes();

        }

/**

 * Find the paths to all the installed shell themes in the app.

 *

 * Bake themes are directories not named `skel` inside a `Console/Templates` path.

 * They are listed in this order: app -> plugin -> default

 *

 * @return array Array of bake themes that are installed.

 */

        protected function _findThemes() {

                $paths = App::path('Console');

                $plugins = App::objects('plugin');

                foreach ($plugins as $plugin) {

                        $paths[] = $this->_pluginPath($plugin) . 'Console' . DS;

                }

                $core = current(App::core('Console'));

                $separator = DS === '/' ? '/' : '\\\\';

                $core = preg_replace('#shells' . $separator . '$#', '', $core);

                $Folder = new Folder($core . 'Templates' . DS . 'default');

                $contents = $Folder->read();

                $themeFolders = $contents[0];

                $paths[] = $core;

                foreach ($paths as $i => $path) {

                        $paths[$i] = rtrim($path, DS) . DS;

                }

                $themes = array();

                foreach ($paths as $path) {

                        $Folder = new Folder($path . 'Templates', false);

                        $contents = $Folder->read();

                        $subDirs = $contents[0];

                        foreach ($subDirs as $dir) {

                                if (empty($dir) || preg_match('@^skel$|_skel$@', $dir)) {

                                        continue;

                                }

                                $Folder = new Folder($path . 'Templates' . DS . $dir);

                                $contents = $Folder->read();

                                $subDirs = $contents[0];

                                if (array_intersect($contents[0], $themeFolders)) {

                                        $templateDir = $path . 'Templates' . DS . $dir . DS;

                                        $themes[$dir] = $templateDir;

                                }

                        }

                }

                return $themes;

        }

/**

 * Set variable values to the template scope

 *

 * @param string|array $one A string or an array of data.

 * @param string|array $two Value in case $one is a string (which then works as the key).

 *   Unused if $one is an associative array, otherwise serves as the values to $one's keys.

 * @return void

 */

        public function set($one, $two = null) {

                if (is_array($one)) {

                        if (is_array($two)) {

                                $data = array_combine($one, $two);

                        } else {

                                $data = $one;

                        }

                } else {

                        $data = array($one => $two);

                }

                if (!$data) {

                        return false;

                }

                $this->templateVars = $data + $this->templateVars;

        }

/**

 * Runs the template

 *

 * @param string $directory directory / type of thing you want

 * @param string $filename template name

 * @param array $vars Additional vars to set to template scope.

 * @return string contents of generated code template

 */

        public function generate($directory, $filename, $vars = null) {

                if ($vars !== null) {

                        $this->set($vars);

                }

                if (empty($this->templatePaths)) {

                        $this->initialize();

                }

                $themePath = $this->getThemePath();

                $templateFile = $this->_findTemplate($themePath, $directory, $filename);

                if ($templateFile) {

                        extract($this->templateVars);

                        ob_start();

                        ob_implicit_flush(0);

                        include $templateFile;

                        $content = ob_get_clean();

                        return $content;

                }

                return '';

        }

/**

 * Find the theme name for the current operation.

 * If there is only one theme in $templatePaths it will be used.

 * If there is a -theme param in the cli args, it will be used.

 * If there is more than one installed theme user interaction will happen

 *

 * @return string returns the path to the selected theme.

 */

        public function getThemePath() {

                if (count($this->templatePaths) === 1) {

                        $paths = array_values($this->templatePaths);

                        return $paths[0];

                }

                if (!empty($this->params['theme']) && isset($this->templatePaths[$this->params['theme']])) {

                        return $this->templatePaths[$this->params['theme']];

                }

                $this->hr();

                $this->out(__d('cake_console', 'You have more than one set of templates installed.'));

                $this->out(__d('cake_console', 'Please choose the template set you wish to use:'));

                $this->hr();

                $i = 1;

                $indexedPaths = array();

                foreach ($this->templatePaths as $key => $path) {

                        $this->out($i . '. ' . $key);

                        $indexedPaths[$i] = $path;

                        $i++;

                }

                $index = $this->in(__d('cake_console', 'Which bake theme would you like to use?'), range(1, $i - 1), 1);

                $themeNames = array_keys($this->templatePaths);

                $this->params['theme'] = $themeNames[$index - 1];

                return $indexedPaths[$index];

        }

/**

 * Find a template inside a directory inside a path.

 * Will scan all other theme dirs if the template is not found in the first directory.

 *

 * @param string $path The initial path to look for the file on. If it is not found fallbacks will be used.

 * @param string $directory Subdirectory to look for ie. 'views', 'objects'

 * @param string $filename lower_case_underscored filename you want.

 * @return string filename will exit program if template is not found.

 */

        protected function _findTemplate($path, $directory, $filename) {

                $themeFile = $path . $directory . DS . $filename . '.ctp';

                if (file_exists($themeFile)) {

                        return $themeFile;

                }

                foreach ($this->templatePaths as $path) {

                        $templatePath = $path . $directory . DS . $filename . '.ctp';

                        if (file_exists($templatePath)) {

                                return $templatePath;

                        }

                }

                $this->err(__d('cake_console', 'Could not find template for %s', $filename));

                return false;

        }

}