pradosoft / prado

bin/prado-cli.php

Doc Comments +40 added lines

@@ -145,6 +145,10 @@ 
 	 */
 	public abstract function performAction($args);
 
+	/**
+	 * @param string $dir
+	 * @param integer $mask
+	 */
 	protected function createDirectory($dir, $mask)
 	{
 		if(!is_dir($dir))
@@ -156,6 +160,9 @@ 
 			chmod($dir, $mask);
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	protected function createFile($filename, $content)
 	{
 		if(!is_file($filename))
@@ -304,6 +311,9 @@ 
 ';
 	}
 
+	/**
+	 * @param string $appName
+	 */
 	protected function renderConfigFile($appName)
 	{
 		return <<<EOD
@@ -500,6 +510,9 @@ 
 		require_once($TEST_TOOLS.'/simpletest/reporter.php');
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	protected function runUnitTests($dir, $args)
 	{
 		$app_dir = $this->getAppDir($dir);
@@ -538,6 +551,9 @@ 
 		return realpath($dir.'/tests/unit/');
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	protected function getUnitTestCases($dir,$args)
 	{
 		$matches = null;
@@ -549,6 +565,9 @@ 
 		return $test;
 	}
 
+	/**
+	 * @param GroupTest $test
+	 */
 	protected function addTests($test,$path,$recursive=true,$match=null)
 	{
 		$dir=opendir($path);
@@ -565,6 +584,9 @@ 
 		closedir($dir);
 	}
 
+	/**
+	 * @param string $entry
+	 */
 	protected function hasMatch($match,$entry)
 	{
 		$file = strtolower(substr($entry,0,strrpos($entry,'.')));
@@ -630,6 +652,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getActiveRecordConfig($app_dir)
 	{
 		if(false === ($xml=$this->getXmlFile($app_dir)))
@@ -645,6 +670,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getOutputFile($app_dir, $namespace)
 	{
 		if(is_file($namespace) && strpos($namespace, $app_dir)===0)
@@ -659,6 +687,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param TActiveRecordConfig $config
+	 */
 	protected function generateActiveRecord($config, $tablename, $output)
 	{
 		$manager = TActiveRecordManager::getInstance();
@@ -706,6 +737,9 @@ 
 		return $prop;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	protected function generateClass($properties, $tablename, $class)
 	{
 		$props = implode("\n", $properties);
@@ -799,6 +833,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $app_dir
+     */
     protected function getActiveRecordConfig($app_dir) {
         if (false === ($xml = $this->getXmlFile($app_dir)))
             return false;
@@ -842,6 +879,9 @@ 
 			}
 	    }
 
+	    /**
+	     * @param string $l
+	     */
 	    public function generate($l)
 	    {
 			$input = explode(" ", trim($l));

Indentation +94 added lines, -94 removed lines

@@ -740,89 +740,89 @@ 
  */
 class PradoCommandLineActiveRecordGenAll extends PradoCommandLineAction {
 
-    protected $action = 'generateAll';
-    protected $parameters = array('output');
-    protected $optional = array('directory', 'soap', 'overwrite', 'prefix', 'postfix');
-    protected $description = "Generate Active Record skeleton for all Tables to <output> file using application.xml in [directory]. May also generate [soap] properties.\nGenerated Classes are named like the Table with optional [Prefix] and/or [Postfix]. [Overwrite] is used to overwrite existing Files.";
-    private $_soap = false;
-    private $_prefix = '';
-    private $_postfix = '';
-    private $_overwrite = false;
-
-    public function performAction($args) {
-        $app_dir = count($args) > 2 ? $this->getAppDir($args[2]) : $this->getAppDir();
-        $this->_soap = count($args) > 3 ? ($args[3] == "soap" || $args[3] == "true" ? true : false) : false;
-        $this->_overwrite = count($args) > 4 ? ($args[4] == "overwrite" || $args[4] == "true" ? true : false) : false;
-        $this->_prefix = count($args) > 5 ? $args[5] : '';
-        $this->_postfix = count($args) > 6 ? $args[6] : '';
-
-        if ($app_dir !== false) {
-            $config = $this->getActiveRecordConfig($app_dir);
-
-            $manager = TActiveRecordManager::getInstance();
-            $con = $manager->getDbConnection();
-            $con->Active = true;
-            $command = $con->createCommand("Show Tables");
-            $dataReader = $command->query();
-            $dataReader->bindColumn(1, $table);
-            $generator = new PHP_Shell_Extensions_ActiveRecord();
-            $tables = array();
-            while ($dataReader->read() !== false) {
-                $tables[] = $table;
-            }
-            $con->Active = False;
-            foreach ($tables as $key => $table) {
-                $output = $args[1] . "." . $this->_prefix . ucfirst($table) . $this->_postfix;
-                if ($config !== false && $output !== false) {
-                    $generator->generate("generate " . $table . " " . $output . " " . $this->_soap . " " . $this->_overwrite);
-                }
-            }
-        }
-        return true;
-    }
-
-    protected function getAppDir($dir=".") {
-        if (is_dir($dir))
-            return realpath($dir);
-        if (false !== ($app_dir = realpath($dir . '/protected/')) && is_dir($app_dir))
-            return $app_dir;
-        echo '** Unable to find directory "' . $dir . "\".\n";
-        return false;
-    }
-
-    protected function getXmlFile($app_dir) {
-        if (false !== ($xml = realpath($app_dir . '/application.xml')) && is_file($xml))
-            return $xml;
-        if (false !== ($xml = realpath($app_dir . '/protected/application.xml')) && is_file($xml))
-            return $xml;
-        echo '** Unable to find application.xml in ' . $app_dir . "\n";
-        return false;
-    }
-
-    protected function getActiveRecordConfig($app_dir) {
-        if (false === ($xml = $this->getXmlFile($app_dir)))
-            return false;
-        if (false !== ($app = $this->initializePradoApplication($app_dir))) {
-            Prado::using('System.Data.ActiveRecord.TActiveRecordConfig');
-            foreach ($app->getModules() as $module)
-                if ($module instanceof TActiveRecordConfig)
-                    return $module;
-            echo '** Unable to find TActiveRecordConfig module in ' . $xml . "\n";
-        }
-        return false;
-    }
-
-    protected function getOutputFile($app_dir, $namespace) {
-        if (is_file($namespace) && strpos($namespace, $app_dir) === 0)
-            return $namespace;
-        $file = Prado::getPathOfNamespace($namespace, "");
-        if ($file !== null && false !== ($path = realpath(dirname($file))) && is_dir($path)) {
-            if (strpos($path, $app_dir) === 0)
-                return $file;
-        }
-        echo '** Output file ' . $file . ' must be within directory ' . $app_dir . "\n";
-        return false;
-    }
+	protected $action = 'generateAll';
+	protected $parameters = array('output');
+	protected $optional = array('directory', 'soap', 'overwrite', 'prefix', 'postfix');
+	protected $description = "Generate Active Record skeleton for all Tables to <output> file using application.xml in [directory]. May also generate [soap] properties.\nGenerated Classes are named like the Table with optional [Prefix] and/or [Postfix]. [Overwrite] is used to overwrite existing Files.";
+	private $_soap = false;
+	private $_prefix = '';
+	private $_postfix = '';
+	private $_overwrite = false;
+
+	public function performAction($args) {
+		$app_dir = count($args) > 2 ? $this->getAppDir($args[2]) : $this->getAppDir();
+		$this->_soap = count($args) > 3 ? ($args[3] == "soap" || $args[3] == "true" ? true : false) : false;
+		$this->_overwrite = count($args) > 4 ? ($args[4] == "overwrite" || $args[4] == "true" ? true : false) : false;
+		$this->_prefix = count($args) > 5 ? $args[5] : '';
+		$this->_postfix = count($args) > 6 ? $args[6] : '';
+
+		if ($app_dir !== false) {
+			$config = $this->getActiveRecordConfig($app_dir);
+
+			$manager = TActiveRecordManager::getInstance();
+			$con = $manager->getDbConnection();
+			$con->Active = true;
+			$command = $con->createCommand("Show Tables");
+			$dataReader = $command->query();
+			$dataReader->bindColumn(1, $table);
+			$generator = new PHP_Shell_Extensions_ActiveRecord();
+			$tables = array();
+			while ($dataReader->read() !== false) {
+				$tables[] = $table;
+			}
+			$con->Active = False;
+			foreach ($tables as $key => $table) {
+				$output = $args[1] . "." . $this->_prefix . ucfirst($table) . $this->_postfix;
+				if ($config !== false && $output !== false) {
+					$generator->generate("generate " . $table . " " . $output . " " . $this->_soap . " " . $this->_overwrite);
+				}
+			}
+		}
+		return true;
+	}
+
+	protected function getAppDir($dir=".") {
+		if (is_dir($dir))
+			return realpath($dir);
+		if (false !== ($app_dir = realpath($dir . '/protected/')) && is_dir($app_dir))
+			return $app_dir;
+		echo '** Unable to find directory "' . $dir . "\".\n";
+		return false;
+	}
+
+	protected function getXmlFile($app_dir) {
+		if (false !== ($xml = realpath($app_dir . '/application.xml')) && is_file($xml))
+			return $xml;
+		if (false !== ($xml = realpath($app_dir . '/protected/application.xml')) && is_file($xml))
+			return $xml;
+		echo '** Unable to find application.xml in ' . $app_dir . "\n";
+		return false;
+	}
+
+	protected function getActiveRecordConfig($app_dir) {
+		if (false === ($xml = $this->getXmlFile($app_dir)))
+			return false;
+		if (false !== ($app = $this->initializePradoApplication($app_dir))) {
+			Prado::using('System.Data.ActiveRecord.TActiveRecordConfig');
+			foreach ($app->getModules() as $module)
+				if ($module instanceof TActiveRecordConfig)
+					return $module;
+			echo '** Unable to find TActiveRecordConfig module in ' . $xml . "\n";
+		}
+		return false;
+	}
+
+	protected function getOutputFile($app_dir, $namespace) {
+		if (is_file($namespace) && strpos($namespace, $app_dir) === 0)
+			return $namespace;
+		$file = Prado::getPathOfNamespace($namespace, "");
+		if ($file !== null && false !== ($path = realpath(dirname($file))) && is_dir($path)) {
+			if (strpos($path, $app_dir) === 0)
+				return $file;
+		}
+		echo '** Output file ' . $file . ' must be within directory ' . $app_dir . "\n";
+		return false;
+	}
 
 }
 
@@ -830,20 +830,20 @@ 
 if(class_exists('PHP_Shell_Commands', false))
 {
 	class PHP_Shell_Extensions_ActiveRecord implements PHP_Shell_Extension {
-	    public function register()
-	    {
+		public function register()
+		{
 
-	        $cmd = PHP_Shell_Commands::getInstance();
+			$cmd = PHP_Shell_Commands::getInstance();
 			if(Prado::getApplication() !== null)
 			{
-		        $cmd->registerCommand('#^generate#', $this, 'generate', 'generate <table> <output> [soap]',
-		            'Generate Active Record skeleton for <table> to <output> file using'.PHP_EOL.
-		            '    application.xml in [directory]. May also generate [soap] properties.');
+				$cmd->registerCommand('#^generate#', $this, 'generate', 'generate <table> <output> [soap]',
+					'Generate Active Record skeleton for <table> to <output> file using'.PHP_EOL.
+					'    application.xml in [directory]. May also generate [soap] properties.');
 			}
-	    }
+		}
 
-	    public function generate($l)
-	    {
+		public function generate($l)
+		{
 			$input = explode(" ", trim($l));
 			if(count($input) > 2)
 			{
@@ -860,12 +860,12 @@ 
 			{
 				echo "\n    Usage: generate table_name Application.pages.RecordClassName\n";
 			}
-	    }
+		}
 	}
 
 	$__shell_exts = PHP_Shell_Extensions::getInstance();
 	$__shell_exts->registerExtensions(array(
-		    "active-record"        => new PHP_Shell_Extensions_ActiveRecord)); /* the :set command */
+			"active-record"        => new PHP_Shell_Extensions_ActiveRecord)); /* the :set command */
 
 	include_once(realpath(dirname(dirname(__FILE__))).'/framework/3rdParty/PhpShell/php-shell-cmd.php');
 }

buildscripts/classtree/build.php

Doc Comments +12 added lines

@@ -67,6 +67,9 @@ 
 		$this->displayTreeInternal(array_keys($this->_baseClasses),0);
 	}
 
+	/**
+	 * @param integer $level
+	 */
 	public function displayTreeInternal($classNames,$level)
 	{
 		foreach($classNames as $className)
@@ -153,6 +156,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $path
+	 */
 	protected function isValidPath($path)
 	{
 		if(is_dir($path))
@@ -161,6 +167,9 @@ 
 			return basename($path)!==basename($path,'.php') && !isset($this->_exclusions[basename($path)]);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public function getSourceFiles($path)
 	{
 		$files=array();
@@ -227,6 +236,9 @@ 
 
 	}
 
+	/**
+	 * @param PradoVTMDocument $doc
+	 */
 	private	function processObjectType($objectType,$objectInfo,$prefix,$doc)
 	{
 		foreach($objectInfo['Properties'] as $name=>$property)

buildscripts/classtree/DWExtension.php

Doc Comments +3 added lines

@@ -100,6 +100,9 @@
 	private $_filesElement;
 	private $_document;
 
+	/**
+	 * @param string $version
+	 */
 	public function __construct($version)
 	{
 		$this->_document = new DOMDocument('1.0', 'utf-8');

buildscripts/index/api_index.php

Doc Comments +3 added lines

@@ -10,6 +10,9 @@
 	private $_index;	
 	private $_api;
 	
+	/**
+	 * @param string $api
+	 */
 	public function __construct($index_file, $api)
 	{
 		$this->_api = $api;

buildscripts/index/quickstart_index.php

Doc Comments +8 added lines

@@ -8,6 +8,10 @@ 
 	private $_base;
 	private $_source;
 
+	/**
+	 * @param string $base
+	 * @param string $source
+	 */
 	public function __construct($index_file, $base, $source)
 	{
 		$this->_index = new Zend_Search_Lucene($index_file, true);
@@ -37,6 +41,10 @@ 
 		echo "\n {$count} files indexed.\n";
 	}
 
+	/**
+	 * @param string $content
+	 * @param integer $mtime
+	 */
 	public function add($content, $section, $mtime)
 	{
 		foreach($this->split_headings($content) as $headers)

buildscripts/texbuilder/Page2Tex.php

Doc Comments +3 added lines

@@ -71,6 +71,9 @@
 		}
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	function include_figure($info, $filename)
 	{
 		$width = sprintf('%0.2f', $info[0]/(135/2.54));

Indentation +2 added lines, -2 removed lines

@@ -167,10 +167,10 @@
 
 		//DocLink
 		$html = preg_replace('/<com:DocLink\s+ClassPath="([^"]*)[.]([^."]*)"\s+Text="([^"]+)"\s*\/>/',
-	                        '\href{http://pradosoft.github.io/docs/manual/$1/$2.html}{$3}', $html);
+							'\href{http://pradosoft.github.io/docs/manual/$1/$2.html}{$3}', $html);
 
 		$html = preg_replace('/<com:DocLink\s+ClassPath="([^"]*)[.]([^.]*)"\s+\/>/',
-	                        '\href{http://pradosoft.github.io/docs/manual/$1/$2.html}{$1.$2 API Reference}', $html);
+							'\href{http://pradosoft.github.io/docs/manual/$1/$2.html}{$1.$2 API Reference}', $html);
 
 		//text modifiers
 		$html = preg_replace('/<(b|strong)[^>]*>([^<]*)<\/(b|strong)>/', '\textbf{$2}', $html);

demos/blog-tutorial/samples/day5/blog/protected/pages/posts/ListPost.php

Doc Comments +1 added lines

@@ -48,6 +48,7 @@
 
 	/**
 	 * Fetches posts from database with offset and limit.
+	 * @param double $offset
 	 */
 	protected function getPosts($offset, $limit)
 	{

demos/blog/protected/Common/BlogUserManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
 	/**
 	 * Returns a user instance given the user name.
 	 * @param string user name, null if it is a guest.
-	 * @return TUser the user instance, null if the specified username is not in the user database.
+	 * @return BlogUser|null the user instance, null if the specified username is not in the user database.
 	 */
 	public function getUser($username=null)
 	{

demos/blog/protected/Pages/SearchPost.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
 		return $limit;
 	}
 
+	/**
+	 * @param integer $newOffset
+	 */
 	private function formUrl($newOffset)
 	{
 		$gets=array();