RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2025-04-03 13:23:37 +03:00
Code Issues Projects Releases Wiki Activity

Fixed documentation for Doctrine\ORM\Query\Expr and Doctrine\ORM\Query\Filter

Browse source
This commit is contained in:
Benjamin Morel 2012-12-13 12:05:34 +00:00
parent d4357801a2
commit 28966e2087
14 changed files with 61 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
lib/Doctrine/ORM/Query/Expr/Andx.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for building DQL and parts * Expression class for building DQL and parts.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>

15
lib/Doctrine/ORM/Query/Expr/Base.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Abstract base Expr class for building DQL parts * Abstract base Expr class for building DQL parts.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -65,8 +64,9 @@ abstract class Base
} }
/** /**
* @param array $args * @param array $args
* @return Base *
* @return Base
*/ */
public function addMultiple($args = array()) public function addMultiple($args = array())
{ {
@ -78,8 +78,11 @@ abstract class Base
} }
/** /**
* @param mixed $arg * @param mixed $arg
* @return Base *
* @return Base
*
* @throws \InvalidArgumentException
*/ */
public function add($arg) public function add($arg)
{ {

9
lib/Doctrine/ORM/Query/Expr/Comparison.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for DQL comparison expressions * Expression class for DQL comparison expressions.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -56,9 +55,9 @@ class Comparison
/** /**
* Creates a comparison expression with the given arguments. * Creates a comparison expression with the given arguments.
* *
* @param mixed $leftExpr * @param mixed $leftExpr
* @param string $operator * @param string $operator
* @param mixed $rightExpr * @param mixed $rightExpr
*/ */
public function __construct($leftExpr, $operator, $rightExpr) public function __construct($leftExpr, $operator, $rightExpr)
{ {

9
lib/Doctrine/ORM/Query/Expr/Composite.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for building DQL and parts * Expression class for building DQL and parts.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -49,10 +48,10 @@ class Composite extends Base
return implode($this->separator, $components); return implode($this->separator, $components);
} }
/** /**
* @param string $part * @param string $part
* @return string *
* @return string
*/ */
private function processQueryPart($part) private function processQueryPart($part)
{ {

9
lib/Doctrine/ORM/Query/Expr/From.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for DQL from * Expression class for DQL from.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -47,9 +46,9 @@ class From
protected $indexBy; protected $indexBy;
/** /**
* @param string $from The class name. * @param string $from The class name.
* @param string $alias The alias of the class. * @param string $alias The alias of the class.
* @param string $indexBy The index for the from. * @param string $indexBy The index for the from.
*/ */
public function __construct($from, $alias, $indexBy = null) public function __construct($from, $alias, $indexBy = null)
{ {

7
lib/Doctrine/ORM/Query/Expr/Func.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for generating DQL functions * Expression class for generating DQL functions.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -44,8 +43,8 @@ class Func
/** /**
* Creates a function, with the given argument. * Creates a function, with the given argument.
* *
* @param string $name * @param string $name
* @param array $arguments * @param array $arguments
*/ */
public function __construct($name, $arguments) public function __construct($name, $arguments)
{ {

3
lib/Doctrine/ORM/Query/Expr/GroupBy.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for building DQL Group By parts * Expression class for building DQL Group By parts.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>

16
lib/Doctrine/ORM/Query/Expr/Join.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for DQL from * Expression class for DQL join.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -68,12 +67,12 @@ class Join
protected $indexBy; protected $indexBy;
/** /**
* @param string $joinType The condition type constant. Either INNER_JOIN or LEFT_JOIN. * @param string $joinType The condition type constant. Either INNER_JOIN or LEFT_JOIN.
* @param string $join The relationship to join * @param string $join The relationship to join.
* @param string $alias The alias of the join * @param string|null $alias The alias of the join.
* @param string $conditionType The condition type constant. Either ON or WITH. * @param string|null $conditionType The condition type constant. Either ON or WITH.
* @param string $condition The condition for the join * @param string|null $condition The condition for the join.
* @param string $indexBy The index for the join * @param string|null $indexBy The index for the join.
*/ */
public function __construct($joinType, $join, $alias = null, $conditionType = null, $condition = null, $indexBy = null) public function __construct($joinType, $join, $alias = null, $conditionType = null, $condition = null, $indexBy = null)
{ {
@ -133,7 +132,6 @@ class Join
return $this->indexBy; return $this->indexBy;
} }
/** /**
* @return string * @return string
*/ */

4
lib/Doctrine/ORM/Query/Expr/Literal.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for generating DQL functions * Expression class for generating DQL functions.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -48,5 +47,4 @@ class Literal extends Base
{ {
return $this->parts; return $this->parts;
} }
} }

9
lib/Doctrine/ORM/Query/Expr/Math.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for DQL math statements * Expression class for DQL math statements.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -49,9 +48,9 @@ class Math
/** /**
* Creates a mathematical expression with the given arguments. * Creates a mathematical expression with the given arguments.
* *
* @param mixed $leftExpr * @param mixed $leftExpr
* @param string $operator * @param string $operator
* @param mixed $rightExpr * @param mixed $rightExpr
*/ */
public function __construct($leftExpr, $operator, $rightExpr) public function __construct($leftExpr, $operator, $rightExpr)
{ {

13
lib/Doctrine/ORM/Query/Expr/OrderBy.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for building DQL Order By parts * Expression class for building DQL Order By parts.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
@ -57,8 +56,8 @@ class OrderBy
protected $parts = array(); protected $parts = array();
/** /**
* @param string $sort * @param string|null $sort
* @param string $order * @param string|null $order
*/ */
public function __construct($sort = null, $order = null) public function __construct($sort = null, $order = null)
{ {
@ -68,8 +67,10 @@ class OrderBy
} }
/** /**
* @param string $sort * @param string $sort
* @param string $order * @param string|null $order
*
* @return void
*/ */
public function add($sort, $order = null) public function add($sort, $order = null)
{ {

3
lib/Doctrine/ORM/Query/Expr/Orx.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for building DQL OR clauses * Expression class for building DQL OR clauses.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>

3
lib/Doctrine/ORM/Query/Expr/Select.php
View file

@ -20,9 +20,8 @@
namespace Doctrine\ORM\Query\Expr; namespace Doctrine\ORM\Query\Expr;
/** /**
* Expression class for building DQL select statements * Expression class for building DQL select statements.
* *
*
* @link www.doctrine-project.org * @link www.doctrine-project.org
* @since 2.0 * @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>

21
lib/Doctrine/ORM/Query/Filter/SQLFilter.php
View file

@ -36,12 +36,14 @@ abstract class SQLFilter
{ {
/** /**
* The entity manager. * The entity manager.
*
* @var EntityManager * @var EntityManager
*/ */
private $em; private $em;
/** /**
* Parameters for the filter. * Parameters for the filter.
*
* @var array * @var array
*/ */
private $parameters; private $parameters;
@ -49,7 +51,7 @@ abstract class SQLFilter
/** /**
* Constructs the SQLFilter object. * Constructs the SQLFilter object.
* *
* @param EntityManager $em The EM * @param EntityManager $em The entity manager.
*/ */
final public function __construct(EntityManager $em) final public function __construct(EntityManager $em)
{ {
@ -59,11 +61,11 @@ abstract class SQLFilter
/** /**
* Sets a parameter that can be used by the filter. * Sets a parameter that can be used by the filter.
* *
* @param string $name Name of the parameter. * @param string $name Name of the parameter.
* @param string $value Value of the parameter. * @param string $value Value of the parameter.
* @param string $type The parameter type. If specified, the given value will be run through * @param string|null $type The parameter type. If specified, the given value will be run through
* the type conversion of this type. This is usually not needed for * the type conversion of this type. This is usually not needed for
* strings and numeric types. * strings and numeric types.
* *
* @return SQLFilter The current SQL filter. * @return SQLFilter The current SQL filter.
*/ */
@ -93,6 +95,8 @@ abstract class SQLFilter
* @param string $name Name of the parameter. * @param string $name Name of the parameter.
* *
* @return string The SQL escaped parameter to use in a query. * @return string The SQL escaped parameter to use in a query.
*
* @throws \InvalidArgumentException
*/ */
final public function getParameter($name) final public function getParameter($name)
{ {
@ -116,7 +120,10 @@ abstract class SQLFilter
/** /**
* Gets the SQL query part to add to a query. * Gets the SQL query part to add to a query.
* *
* @return string The constraint SQL if there is available, empty string otherwise * @param ClassMetaData $targetEntity
* @param string $targetTableAlias
*
* @return string The constraint SQL if there is available, empty string otherwise.
*/ */
abstract public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias); abstract public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias);
} }