From 09ff5b94ac884f1a8bc65807919f84bf760415f9 Mon Sep 17 00:00:00 2001 From: ucorina Date: Mon, 17 Dec 2012 15:53:10 +0000 Subject: [PATCH] Updated code comments for PHPDocumentor - XmlQueryParser, QueryParser, DBParser and column classes git-svn-id: http://xe-core.googlecode.com/svn/branches/luminous@12419 201d5d3c-b55e-5fd7-737f-ddc643e51545 --- classes/xml/XmlQueryParser.150.class.php | 5 ++- classes/xml/xmlquery/DBParser.class.php | 37 ++++++++++++------- classes/xml/xmlquery/QueryParser.class.php | 9 +++-- .../xmlquery/tags/column/ColumnTag.class.php | 7 ++-- .../tags/column/InsertColumnTag.class.php | 17 ++++++--- .../InsertColumnTagWithoutArgument.class.php | 5 +-- .../tags/column/InsertColumnsTag.class.php | 12 ++++-- .../tags/column/SelectColumnTag.class.php | 19 ++++++---- .../tags/column/SelectColumnsTag.class.php | 6 +-- .../tags/column/UpdateColumnTag.class.php | 11 ++++-- .../tags/column/UpdateColumnsTag.class.php | 10 +++-- 11 files changed, 83 insertions(+), 55 deletions(-) diff --git a/classes/xml/XmlQueryParser.150.class.php b/classes/xml/XmlQueryParser.150.class.php index b34163bc2..a32217e87 100644 --- a/classes/xml/XmlQueryParser.150.class.php +++ b/classes/xml/XmlQueryParser.150.class.php @@ -39,17 +39,18 @@ if(!defined('__XE_LOADED_XML_CLASS__')){ } /** - * New XmlQueryParser class + * New XmlQueryParser class
* Parses XE XML query files * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml + * @package classes\xml * @version 0.1 */ class XmlQueryParser extends XmlParser { /** * Create XmlQueryParser instance for Singleton + * * @return XmlQueryParser object */ function &getInstance() diff --git a/classes/xml/xmlquery/DBParser.class.php b/classes/xml/xmlquery/DBParser.class.php index b107dc419..a3336566c 100644 --- a/classes/xml/xmlquery/DBParser.class.php +++ b/classes/xml/xmlquery/DBParser.class.php @@ -3,12 +3,12 @@ * File containing the DBParser class */ /** - * Escapes query statements: - * - column names: member.member_srl => "member"."member_srl" - * - expressions: SUM(member.member_srl) => SUM("member"."member_srl") + * Escapes query statements:
+ * - column names: member.member_srl => "member"."member_srl"
+ * - expressions: SUM(member.member_srl) => SUM("member"."member_srl")
* * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery + * @package classes\xml\xmlquery * @version 0.1 */ class DBParser @@ -17,7 +17,7 @@ class DBParser * Character for escape target value on the left * * For example, in CUBRID left and right escape - * chars are the same, the double quote - " + * chars are the same, the double quote - "
* But for SQL Server, the escape is made with * [double brackets], so the left and right char differ * @@ -30,7 +30,7 @@ class DBParser * Character for escape target value on the right * * For example, in CUBRID left and right escape - * chars are the same, the double quote - " + * chars are the same, the double quote - "
* But for SQL Server, the escape is made with * [double brackets], so the left and right char differ * @@ -66,6 +66,7 @@ class DBParser /** * Get escape character + * * @param string $leftOrRight left or right * @return string */ @@ -77,6 +78,7 @@ class DBParser /** * Escape the value + * * @param mixed $name * @return string */ @@ -87,6 +89,7 @@ class DBParser /** * Escape the string value + * * @param string $name * @return string */ @@ -97,6 +100,7 @@ class DBParser /** * Escape the string value + * * @param string $value * @return string */ @@ -152,7 +156,7 @@ class DBParser /** * Checks to see if a given column name is unqualified * - * Ex: "member_srl" -> unqualified + * Ex: "member_srl" -> unqualified
* "member"."member_srl" -> qualified * * @param string $column_name @@ -167,7 +171,7 @@ class DBParser /** * Checks to see if a given column name is qualified * - * Ex: "member_srl" -> unqualified + * Ex: "member_srl" -> unqualified
* "member"."member_srl" -> qualified * * @param string $column_name @@ -182,12 +186,17 @@ class DBParser /** * Escapes a query expression * - * This can be: - * - a column name: "member_srl" or "xe_member"."member_srl" - * - an expression: - * - LEFT(UPPER("content")) - * - readed_count + voted_count - * - CAST(regdate as DATE) + * An expression can be:
+ * * * @param $column_name * @return string diff --git a/classes/xml/xmlquery/QueryParser.class.php b/classes/xml/xmlquery/QueryParser.class.php index 868dbea6d..47c8a97ca 100644 --- a/classes/xml/xmlquery/QueryParser.class.php +++ b/classes/xml/xmlquery/QueryParser.class.php @@ -3,17 +3,18 @@ * File containing the QueryParser class */ /** - * Parses an XML Object and returns a string used for generating the PHP cache file + * Parses an XML Object and returns a string used for generating the PHP cache file
* The XML Object structure must be the one defined in the XmlParser class * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery + * @package classes\xml\xmlquery * @version 0.1 */ class QueryParser { /** * Property containing the associated QueryTag object + * * @var QueryTag object */ var $queryTag; @@ -34,9 +35,9 @@ class QueryParser { } /** - * Return table information - * Used for finding column type info (string/numeric) + * Returns table information * + * Used for finding column type info (string/numeric)
* Obtains the table info from XE's XML schema files * * @param object $query_id diff --git a/classes/xml/xmlquery/tags/column/ColumnTag.class.php b/classes/xml/xmlquery/tags/column/ColumnTag.class.php index d3f6206a7..7c5da2fb7 100644 --- a/classes/xml/xmlquery/tags/column/ColumnTag.class.php +++ b/classes/xml/xmlquery/tags/column/ColumnTag.class.php @@ -1,13 +1,12 @@ tag inside an XML Query file - * Since the tag supports different attributes depending on + * Models the <column> tag inside an XML Query file
+ * Since the <column> tag supports different attributes depending on * the type of query (select, update, insert, delete) this is only * the base class for the classes that will model each type tag. * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery/tags/column + * @package classes\xml\xmlquery\tags\column * @version 0.1 */ class ColumnTag diff --git a/classes/xml/xmlquery/tags/column/InsertColumnTag.class.php b/classes/xml/xmlquery/tags/column/InsertColumnTag.class.php index 2a7ada41f..2f9d3248c 100644 --- a/classes/xml/xmlquery/tags/column/InsertColumnTag.class.php +++ b/classes/xml/xmlquery/tags/column/InsertColumnTag.class.php @@ -1,26 +1,29 @@ tag inside an XML Query file whose action is 'insert' + * Models the <column> tag inside an XML Query file whose action is 'insert' * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery/tags/column + * @package classes\xml\xmlquery\tags\column * @version 0.1 */ class InsertColumnTag extends ColumnTag { /** * Argument + * * @var QueryArgument object */ var $argument; /** * Constructor + * * @param object $column + * * @return void */ - function InsertColumnTag($column) { + function InsertColumnTag($column) + { parent::ColumnTag($column->attrs->name); $dbParser = DB::getParser(); $this->name = $dbParser->parseColumnName($this->name); @@ -34,7 +37,8 @@ class InsertColumnTag extends ColumnTag * * @return string */ - function getExpressionString(){ + function getExpressionString() + { return sprintf('new InsertExpression(\'%s\', ${\'%s_argument\'})' , $this->name , $this->argument->argument_name); @@ -45,7 +49,8 @@ class InsertColumnTag extends ColumnTag * * @return QueryArgument */ - function getArgument(){ + function getArgument() + { return $this->argument; } diff --git a/classes/xml/xmlquery/tags/column/InsertColumnTagWithoutArgument.class.php b/classes/xml/xmlquery/tags/column/InsertColumnTagWithoutArgument.class.php index 0683fa6b9..df4f71520 100644 --- a/classes/xml/xmlquery/tags/column/InsertColumnTagWithoutArgument.class.php +++ b/classes/xml/xmlquery/tags/column/InsertColumnTagWithoutArgument.class.php @@ -1,10 +1,9 @@ tag inside an XML Query file whose action is 'insert-select' + * Models the <column> tag inside an XML Query file whose action is 'insert-select' * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery/tags/column + * @package classes\xml\xmlquery\tags\column * @version 0.1 */ class InsertColumnTagWithoutArgument extends ColumnTag diff --git a/classes/xml/xmlquery/tags/column/InsertColumnsTag.class.php b/classes/xml/xmlquery/tags/column/InsertColumnsTag.class.php index 5623929a0..15e6b962e 100644 --- a/classes/xml/xmlquery/tags/column/InsertColumnsTag.class.php +++ b/classes/xml/xmlquery/tags/column/InsertColumnsTag.class.php @@ -1,21 +1,23 @@ tag inside an XML Query file whose action is 'insert' + * Models the <columns> tag inside an XML Query file whose action is 'insert' * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery/tags/column + * @package classes\xml\xmlquery\tags\column * @version 0.1 */ -class InsertColumnsTag{ +class InsertColumnsTag +{ /** * Column list + * * @var array value is InsertColumnTag object */ var $columns; /** * Constructor + * * @param array|string $xml_columns * @return void */ @@ -37,6 +39,7 @@ class InsertColumnsTag{ /** * InsertColumnTag object to string + * * @return string */ function toString() @@ -52,6 +55,7 @@ class InsertColumnsTag{ /** * Return argument list + * * @return array */ function getArguments() diff --git a/classes/xml/xmlquery/tags/column/SelectColumnTag.class.php b/classes/xml/xmlquery/tags/column/SelectColumnTag.class.php index af9715574..5482116f2 100644 --- a/classes/xml/xmlquery/tags/column/SelectColumnTag.class.php +++ b/classes/xml/xmlquery/tags/column/SelectColumnTag.class.php @@ -1,28 +1,30 @@ tag inside an XML Query file whose action is 'select' + * Models the <column> tag inside an XML Query file whose action is 'select' * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery/tags/column + * @package classes\xml\xmlquery\tags\column * @version 0.1 */ class SelectColumnTag extends ColumnTag { /** * Column alias + * * @var string */ var $alias; /** * Click count status + * * @var bool */ var $click_count; /** * Constructor + * * @param string|object $column * @return void */ @@ -48,13 +50,16 @@ class SelectColumnTag extends ColumnTag * Returns the string to be output in the cache file * * A select column tag in an XML query can be used for: - * - a star expression: SELECT * - * - a click count expression: SELECT + UPDATE - * - any other select expression (column name, function call etc). + *
    + *
  • a star expression: SELECT * + *
  • a click count expression: SELECT + UPDATE + *
  • any other select expression (column name, function call etc).
    • + *
* * @return string */ - function getExpressionString(){ + function getExpressionString() + { if($this->name == '*') return "new StarExpression()"; if($this->click_count) return sprintf('new ClickCountExpression(\'%s\', %s, $args->%s)', $this->name, $this->alias ? '\'' . $this->alias . '\'' : "''",$this->click_count); diff --git a/classes/xml/xmlquery/tags/column/SelectColumnsTag.class.php b/classes/xml/xmlquery/tags/column/SelectColumnsTag.class.php index 95ab7664b..76477170e 100644 --- a/classes/xml/xmlquery/tags/column/SelectColumnsTag.class.php +++ b/classes/xml/xmlquery/tags/column/SelectColumnsTag.class.php @@ -1,16 +1,16 @@ tag inside an XML Query file whose action is 'select' + * Models the <columns> tag inside an XML Query file whose action is 'select' * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery/tags/column + * @package classes\xml\xmlquery\tags\column * @version 0.1 */ class SelectColumnsTag { /** * Column list + * * @var array value is SelectColumnTag object */ var $columns; diff --git a/classes/xml/xmlquery/tags/column/UpdateColumnTag.class.php b/classes/xml/xmlquery/tags/column/UpdateColumnTag.class.php index 5b595749e..547f590ed 100644 --- a/classes/xml/xmlquery/tags/column/UpdateColumnTag.class.php +++ b/classes/xml/xmlquery/tags/column/UpdateColumnTag.class.php @@ -1,27 +1,30 @@ tag inside an XML Query file whose action is 'update' + * Models the <column> tag inside an XML Query file whose action is 'update' * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery/tags/column + * @package classes\xml\xmlquery\tags\column * @version 0.1 */ -class UpdateColumnTag extends ColumnTag { +class UpdateColumnTag extends ColumnTag +{ /** * Argument + * * @var QueryArgument object */ var $argument; /** * Default value + * * @var string */ var $default_value; /** * Constructor + * * @param object $column * @return void */ diff --git a/classes/xml/xmlquery/tags/column/UpdateColumnsTag.class.php b/classes/xml/xmlquery/tags/column/UpdateColumnsTag.class.php index ca18dfdc3..acd3fc9de 100644 --- a/classes/xml/xmlquery/tags/column/UpdateColumnsTag.class.php +++ b/classes/xml/xmlquery/tags/column/UpdateColumnsTag.class.php @@ -1,21 +1,23 @@ tag inside an XML Query file whose action is 'update' + * Models the <columns> tag inside an XML Query file whose action is 'update' * * @author Corina Udrescu (corina.udrescu@arnia.ro) - * @package /classes/xml/xmlquery/tags/column + * @package classes\xml\xmlquery\tags\column * @version 0.1 */ -class UpdateColumnsTag{ +class UpdateColumnsTag +{ /** * Column list + * * @var array value is UpdateColumnTag object */ var $columns; /** * Constructor + * * @param array|object $xml_columns * @return void */