dwoo-project / dwoo

lib/Dwoo/Adapters/CodeIgniter/libraries/Dwootemplate.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
      *
      * @param string $sTemplate
      * @param boolean $return
-     * @return mixed
+     * @return null|string
      */
     public function display($sTemplate, $return = FALSE) {
         // Start benchmark

Indentation +149 added lines, -149 removed lines

@@ -20,153 +20,153 @@
  * @uses the dwoo package from http://dwoo.org
  */
 class Dwootemplate extends Dwoo_Core {
-    protected $dwoo_data = array();
-
-    /**
-     * Constructor for the DwooTemplate engine
-     *
-     */
-    public function __construct() {
-        // Call parents constructor
-        parent::__construct();
-
-        // Set the config settings
-        $this->initialize();
-
-        // Assign some defaults to dwoo
-        $CI                         = get_instance();
-        $this->dwoo_data            = new Dwoo_Data();
-        $this->dwoo_data->js_files  = array();
-        $this->dwoo_data->css_files = array();
-        $this->dwoo_data->CI        = $CI;
-        $this->dwoo_data->site_url  = $CI->config->site_url(); // so we can get the full path to CI easily
-        $this->dwoo_data->uniqid    = uniqid();
-        $this->dwoo_data->timestamp = mktime();
-
-        log_message('debug', "Dwoo Template Class Initialized");
-    }
-
-
-    /**
-     * Assign data to dwoo data object
-     *
-     * @param string $key
-     * @param mixed $value
-     */
-    public function assign($key, $value) {
-        $this->dwoo_data->$key = $value;
-    }
-
-
-    /**
-     * Add Javascript files to template
-     *
-     * @param string $js
-     */
-    public function add_js($js) {
-        $current   = $this->dwoo_data->js_files;
-        $current[] = $js;
-        $this->dwoo_data->js_files = $current;
-    }
-
-
-    /**
-     * Add Css stylesheets to template
-     *
-     * @param string $css
-     */
-    public function add_css($css) {
-        $current   = $this->dwoo_data->css_files;
-        $current[] = $css;
-        $this->dwoo_data->css_files = $current;
-    }
-
-
-    /**
-     * Display or return the compiled template
-     * Since we assign the results to the standard CI output module
-     * you can also use the helper from CI in your templates!!
-     *
-     * @param string $sTemplate
-     * @param boolean $return
-     * @return mixed
-     */
-    public function display($sTemplate, $return = FALSE) {
-        // Start benchmark
-        $CI = get_instance();
-        $CI->benchmark->mark('dwoo_parse_start');
-
-        // Check if file exists
-        if ( !file_exists($this->template_dir . $sTemplate ) ) {
-            $message = sprintf('Template file \'%s\' not found.', $sTemplate);
-            show_error($message);
-            log_message('error', $message);
-        }
-
-        // Create new template
-        $tpl = new Dwoo_Template_File($this->template_dir . $sTemplate);
-
-        // render the template
-        $template = $this->get($tpl, $this->dwoo_data);
-
-        // Finish benchmark
-        $CI->benchmark->mark('dwoo_parse_end');
-
-        // Return results or not ?
-        if ($return == FALSE) {
-            $CI->output->final_output = $template;
-        } else {
-            return $template;
-        }
-    }
-
-
-    /**
-     * Toggle Codeigniter profiler on/off
-     *
-     */
-    public function enable_profiler($toggle = TRUE) {
-        $CI = get_instance();
-        $CI->output->enable_profiler($toggle);
-    }
-
-
-    /**
-     * Set http header
-     *
-     * @example $this->output->set_header("HTTP/1.1 200 OK");
-     * @example $this->output->set_header('Last-Modified: '.gmdate('D, d M Y H:i:s', $last_update).' GMT');
-     * @param string $header
-     */
-    public function set_header($header) {
-        $CI = get_instance();
-        $CI->output->set_header($header);
-    }
-
-
-    /**
-     * Set status header
-     *
-     * @example $this->output->set_status_header('401');
-     * @example // Sets the header as: Unauthorized
-     * @param string $header
-     */
-    public function set_status_header($header) {
-        $CI = get_instance();
-        $CI->output->set_status_header($header);
-    }
-
-
-    /**
-     * Assign the dwootemplate config items to the instance
-     *
-     */
-    private function initialize() {
-        $CI = get_instance();
-        $CI->config->load('dwootemplate', TRUE);
-        $config = $CI->config->item('dwootemplate');
-        foreach ($config as $key => $val) {
-                $this->$key = $val;
-        }
-    }
+	protected $dwoo_data = array();
+
+	/**
+	 * Constructor for the DwooTemplate engine
+	 *
+	 */
+	public function __construct() {
+		// Call parents constructor
+		parent::__construct();
+
+		// Set the config settings
+		$this->initialize();
+
+		// Assign some defaults to dwoo
+		$CI                         = get_instance();
+		$this->dwoo_data            = new Dwoo_Data();
+		$this->dwoo_data->js_files  = array();
+		$this->dwoo_data->css_files = array();
+		$this->dwoo_data->CI        = $CI;
+		$this->dwoo_data->site_url  = $CI->config->site_url(); // so we can get the full path to CI easily
+		$this->dwoo_data->uniqid    = uniqid();
+		$this->dwoo_data->timestamp = mktime();
+
+		log_message('debug', "Dwoo Template Class Initialized");
+	}
+
+
+	/**
+	 * Assign data to dwoo data object
+	 *
+	 * @param string $key
+	 * @param mixed $value
+	 */
+	public function assign($key, $value) {
+		$this->dwoo_data->$key = $value;
+	}
+
+
+	/**
+	 * Add Javascript files to template
+	 *
+	 * @param string $js
+	 */
+	public function add_js($js) {
+		$current   = $this->dwoo_data->js_files;
+		$current[] = $js;
+		$this->dwoo_data->js_files = $current;
+	}
+
+
+	/**
+	 * Add Css stylesheets to template
+	 *
+	 * @param string $css
+	 */
+	public function add_css($css) {
+		$current   = $this->dwoo_data->css_files;
+		$current[] = $css;
+		$this->dwoo_data->css_files = $current;
+	}
+
+
+	/**
+	 * Display or return the compiled template
+	 * Since we assign the results to the standard CI output module
+	 * you can also use the helper from CI in your templates!!
+	 *
+	 * @param string $sTemplate
+	 * @param boolean $return
+	 * @return mixed
+	 */
+	public function display($sTemplate, $return = FALSE) {
+		// Start benchmark
+		$CI = get_instance();
+		$CI->benchmark->mark('dwoo_parse_start');
+
+		// Check if file exists
+		if ( !file_exists($this->template_dir . $sTemplate ) ) {
+			$message = sprintf('Template file \'%s\' not found.', $sTemplate);
+			show_error($message);
+			log_message('error', $message);
+		}
+
+		// Create new template
+		$tpl = new Dwoo_Template_File($this->template_dir . $sTemplate);
+
+		// render the template
+		$template = $this->get($tpl, $this->dwoo_data);
+
+		// Finish benchmark
+		$CI->benchmark->mark('dwoo_parse_end');
+
+		// Return results or not ?
+		if ($return == FALSE) {
+			$CI->output->final_output = $template;
+		} else {
+			return $template;
+		}
+	}
+
+
+	/**
+	 * Toggle Codeigniter profiler on/off
+	 *
+	 */
+	public function enable_profiler($toggle = TRUE) {
+		$CI = get_instance();
+		$CI->output->enable_profiler($toggle);
+	}
+
+
+	/**
+	 * Set http header
+	 *
+	 * @example $this->output->set_header("HTTP/1.1 200 OK");
+	 * @example $this->output->set_header('Last-Modified: '.gmdate('D, d M Y H:i:s', $last_update).' GMT');
+	 * @param string $header
+	 */
+	public function set_header($header) {
+		$CI = get_instance();
+		$CI->output->set_header($header);
+	}
+
+
+	/**
+	 * Set status header
+	 *
+	 * @example $this->output->set_status_header('401');
+	 * @example // Sets the header as: Unauthorized
+	 * @param string $header
+	 */
+	public function set_status_header($header) {
+		$CI = get_instance();
+		$CI->output->set_status_header($header);
+	}
+
+
+	/**
+	 * Assign the dwootemplate config items to the instance
+	 *
+	 */
+	private function initialize() {
+		$CI = get_instance();
+		$CI->config->load('dwootemplate', TRUE);
+		$config = $CI->config->item('dwootemplate');
+		foreach ($config as $key => $val) {
+				$this->$key = $val;
+		}
+	}
 }
\ No newline at end of file

lib/Dwoo/Adapters/ZendFramework/PluginProxy.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
 	/**
 	 * Dwoo_Adapters_ZendFramework_PluginProxy's constructor.
 	 *
-	 * @param Zend_View_Interface $view
+	 * @param Dwoo_Adapters_ZendFramework_View $view
 	 */
 	public function __construct(Zend_View_Interface $view) {
 		$this->view = $view;

lib/Dwoo/Data.php

Doc Comments -1 removed lines

@@ -66,7 +66,6 @@
 	 * merges the given array(s) with the current data with array_merge
 	 *
 	 * @param array $data the array to merge
-	 * @param array $data2 $data3 ... other arrays to merge, optional, etc.
 	 */
 	public function mergeData(array $data)
 	{

lib/Dwoo/ICompiler.php

Doc Comments +3 added lines, -1 removed lines

@@ -24,7 +24,7 @@ 
 	/**
 	 * compiles the provided string down to php code
 	 *
-	 * @param string $templateStr the template to compile
+	 * @param string $template the template to compile
 	 * @return string a compiled php code string
 	 */
 	public function compile(Dwoo_Core $dwoo, Dwoo_ITemplate $template);
@@ -34,6 +34,7 @@ 
 	 *
 	 * @see Dwoo_Core::addPlugin
 	 * @param array $customPlugins an array of custom plugins
+	 * @return void
 	 */
 	public function setCustomPlugins(array $customPlugins);
 
@@ -44,6 +45,7 @@ 
 	 * set it on the Dwoo object as it will be passed onto the compiler automatically
 	 *
 	 * @param Dwoo_Security_Policy $policy the security policy object
+	 * @return void
 	 */
 	public function setSecurityPolicy(Dwoo_Security_Policy $policy = null);
 }

lib/Dwoo/Loader.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
 
 	protected $corePluginDir;
 
+	/**
+	 * @param string $cacheDir
+	 */
 	public function __construct($cacheDir)
 	{
 		$this->corePluginDir = DWOO_DIRECTORY . 'plugins';

lib/Dwoo/Template/String.php

Doc Comments +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
 	 *
 	 * @param Dwoo_Core $dwoo the dwoo instance that requests it
 	 * @param string $output the template output
-	 * @return mixed full path of the cached file or false upon failure
+	 * @return false|string full path of the cached file or false upon failure
 	 */
 	public function cache(Dwoo_Core $dwoo, $output)
 	{

lib/plugins/builtin/blocks/dynamic.php

Doc Comments +4 added lines

@@ -53,6 +53,10 @@
 		return $output;
 	}
 
+	/**
+	 * @param string $dynamicId
+	 * @param string $compiledFile
+	 */
 	public static function unescape($output, $dynamicId, $compiledFile)
 	{
 		$output = preg_replace_callback('/<dwoo:dynamic_('.$dynamicId.')>(.+?)<\/dwoo:dynamic_'.$dynamicId.'>/s', array('self', 'unescapePhp'), $output, -1, $count);

lib/Dwoo/Adapters/CodeIgniter/controllers/dwoowelcome.php

Indentation +10 added lines, -10 removed lines

@@ -2,15 +2,15 @@
 
 class Dwoowelcome extends Controller {
 
-    function __construct()
-    {
-        parent::Controller();
-    }
+	function __construct()
+	{
+		parent::Controller();
+	}
 
-    function index()
-    {
-    	$this->load->library('Dwootemplate');
-    	$this->dwootemplate->assign('itshowlate', date('H:i:s'));
-    	$this->dwootemplate->display('dwoowelcome.tpl');
-    }
+	function index()
+	{
+		$this->load->library('Dwootemplate');
+		$this->dwootemplate->assign('itshowlate', date('H:i:s'));
+		$this->dwootemplate->display('dwoowelcome.tpl');
+	}
 }
\ No newline at end of file

lib/Dwoo/Adapters/CakePHP/dwoo.php

Indentation +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
 		$this->_sv_compile_id = $controller->name;
 
 		$this->_dwoo->sv_this = $this;
-        $this->_dwoo->setSecurityPolicy();
+		$this->_dwoo->setSecurityPolicy();
 
 		return;
 	}