diff --git a/lib/Doctrine/Access.php b/lib/Doctrine/Access.php index 91ca06d9e..9bd8c2b9d 100644 --- a/lib/Doctrine/Access.php +++ b/lib/Doctrine/Access.php @@ -22,12 +22,7 @@ /** * Provides array access and property overload interface for Doctrine subclasses. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ @@ -36,8 +31,7 @@ abstract class Doctrine_Access extends Doctrine_Locator_Injectable implements Ar /** * Set an entire aray to the data. * - * @param array $array An array of key => value pairs - * + * @param array $array An array of key => value pairs * @return Doctrine_Access */ public function setArray(array $array) @@ -72,9 +66,8 @@ public function __get($name) /** * Check if key exists in data. * - * @param string $name - * - * @return bool whether or not this object contains $name + * @param string $name + * @return bool whether or not this object contains $name */ public function __isset($name) { @@ -133,9 +126,8 @@ public function offsetUnset($offset) /** * Remove the element with the specified offset. * - * @param mixed $offset The offset to remove - * - * @return bool True if removed otherwise false + * @param mixed $offset The offset to remove + * @return bool True if removed otherwise false */ public function remove($offset) { @@ -166,9 +158,8 @@ public function set($offset, $value) /** * Check if the specified offset exists. * - * @param mixed $offset The offset to check - * - * @return bool True if exists otherwise false + * @param mixed $offset The offset to check + * @return bool True if exists otherwise false */ public function contains($offset) { diff --git a/lib/Doctrine/Adapter/Exception.php b/lib/Doctrine/Adapter/Exception.php index f13ef4860..cb22c7129 100644 --- a/lib/Doctrine/Adapter/Exception.php +++ b/lib/Doctrine/Adapter/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine_Adapter exception class. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Adapter/Interface.php b/lib/Doctrine/Adapter/Interface.php index b79c46701..3e0101d4e 100644 --- a/lib/Doctrine/Adapter/Interface.php +++ b/lib/Doctrine/Adapter/Interface.php @@ -23,12 +23,8 @@ * This adapter interface should be implemented by all custom adapters. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ interface Doctrine_Adapter_Interface { diff --git a/lib/Doctrine/Adapter/Mock.php b/lib/Doctrine/Adapter/Mock.php index c1640d9fb..74edcb8fd 100644 --- a/lib/Doctrine/Adapter/Mock.php +++ b/lib/Doctrine/Adapter/Mock.php @@ -23,12 +23,8 @@ * Doctrine mock connection adapter. This class is used for special testing purposes. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_Adapter_Mock implements Doctrine_Adapter_Interface, Countable { @@ -109,8 +105,7 @@ public function forceException($name, $message = '', $code = 0) /** * Prepare a query statement. * - * @param string $query Query to prepare - * + * @param string $query Query to prepare * @return Doctrine_Adapter_Statement_Mock $mock Mock prepared statement */ public function prepare($query) @@ -134,8 +129,7 @@ public function addQuery($query) /** * Fake the execution of query and add it to the stack of executed queries. * - * @param string $query - * + * @param string $query * @return Doctrine_Adapter_Statement_Mock $stmt */ public function query($query) @@ -171,8 +165,7 @@ public function getAll() /** * Quote a value for the dbms. * - * @param string $input - * + * @param string $input * @return string $quoted */ public function quote($input) diff --git a/lib/Doctrine/Adapter/Oracle.php b/lib/Doctrine/Adapter/Oracle.php index 8f4e97c21..75a930df7 100644 --- a/lib/Doctrine/Adapter/Oracle.php +++ b/lib/Doctrine/Adapter/Oracle.php @@ -25,12 +25,8 @@ * @author Konsta Vesterinen * @author vadik56 * @author Miloslav Kmet - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ */ class Doctrine_Adapter_Oracle implements Doctrine_Adapter_Interface { @@ -142,8 +138,7 @@ public function __construct($config = array(), $username = null, $password = nul /** * Prepare a query statement. * - * @param string $query Query to prepare - * + * @param string $query Query to prepare * @return Doctrine_Adapter_Statement_Oracle $stmt prepared statement */ public function prepare($query) @@ -154,8 +149,7 @@ public function prepare($query) /** * Execute query and return results as statement object. * - * @param string $query - * + * @param string $query * @return Doctrine_Adapter_Statement_Oracle $stmt */ public function query($query) @@ -169,8 +163,7 @@ public function query($query) /** * Quote a value for the dbms. * - * @param string $input - * + * @param string $input * @return string $quoted */ public function quote($input) @@ -234,10 +227,9 @@ public function rollBack() /** * Set connection attribute. * - * @param int $attribute - * @param mixed $value the value of given attribute - * - * @return bool returns TRUE on success or FALSE on failure + * @param int $attribute + * @param mixed $value the value of given attribute + * @return bool returns TRUE on success or FALSE on failure */ public function setAttribute($attribute, $value) { diff --git a/lib/Doctrine/Adapter/Statement.php b/lib/Doctrine/Adapter/Statement.php index e4197c678..a4183c830 100644 --- a/lib/Doctrine/Adapter/Statement.php +++ b/lib/Doctrine/Adapter/Statement.php @@ -23,12 +23,8 @@ * Doctrine_Adapter_Statement. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ abstract class Doctrine_Adapter_Statement { diff --git a/lib/Doctrine/Adapter/Statement/Interface.php b/lib/Doctrine/Adapter/Statement/Interface.php index 0835b86e2..664758e0b 100644 --- a/lib/Doctrine/Adapter/Statement/Interface.php +++ b/lib/Doctrine/Adapter/Statement/Interface.php @@ -23,25 +23,20 @@ * Interface for Doctrine adapter statements. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ interface Doctrine_Adapter_Statement_Interface { /** * Bind a column to a PHP variable. * - * @param mixed $column Number of the column (1-indexed) or name of the column in the result set. - * If using the column name, be aware that the name should match - * the case of the column, as returned by the driver. - * @param string $param name of the PHP variable to which the column will be bound - * @param int $type data type of the parameter, specified by the Doctrine_Core::PARAM_* constants - * - * @return bool Returns TRUE on success or FALSE on failure + * @param mixed $column Number of the column (1-indexed) or name of the column in the result set. + * If using the column name, be aware that the name should match + * the case of the column, as returned by the driver. + * @param string $param name of the PHP variable to which the column will be bound + * @param int $type data type of the parameter, specified by the Doctrine_Core::PARAM_* constants + * @return bool Returns TRUE on success or FALSE on failure */ public function bindColumn($column, $param, $type = null); @@ -49,13 +44,12 @@ public function bindColumn($column, $param, $type = null); * Binds a value to a corresponding named or question mark * placeholder in the SQL statement that was use to prepare the statement. * - * @param mixed $param Parameter identifier. For a prepared statement using named placeholders, - * this will be a parameter name of the form :name. For a prepared statement - * using question mark placeholders, this will be the 1-indexed position of the parameter - * @param mixed $value the value to bind to the parameter - * @param int $type explicit data type for the parameter using the Doctrine_Core::PARAM_* constants - * - * @return bool returns TRUE on success or FALSE on failure + * @param mixed $param Parameter identifier. For a prepared statement using named placeholders, + * this will be a parameter name of the form :name. For a prepared statement + * using question mark placeholders, this will be the 1-indexed position of the parameter + * @param mixed $value the value to bind to the parameter + * @param int $type explicit data type for the parameter using the Doctrine_Core::PARAM_* constants + * @return bool returns TRUE on success or FALSE on failure */ public function bindValue($param, $value, $type = null); @@ -70,14 +64,13 @@ public function bindValue($param, $value, $type = null); * of stored procedures that return data as output parameters, and some also as input/output * parameters that both send in data and are updated to receive it. * - * @param mixed $variable name of the PHP variable to bind to the SQL statement parameter - * @param int $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return - * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the - * Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter. - * @param int $length Length of the data type. To indicate that a parameter is an OUT parameter - * from a stored procedure, you must explicitly set the length. - * - * @return bool returns TRUE on success or FALSE on failure + * @param mixed $variable name of the PHP variable to bind to the SQL statement parameter + * @param int $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return + * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the + * Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter. + * @param int $length Length of the data type. To indicate that a parameter is an OUT parameter + * from a stored procedure, you must explicitly set the length. + * @return bool returns TRUE on success or FALSE on failure */ public function bindParam($column, &$variable, $type = null, $length = null, $driverOptions = array()); @@ -124,10 +117,9 @@ public function errorInfo(); * if any, of their associated parameter markers or pass an array of input-only * parameter values * - * @param array $params an array of values with as many elements as there are - * bound parameters in the SQL statement being executed - * - * @return bool returns TRUE on success or FALSE on failure + * @param array $params an array of values with as many elements as there are + * bound parameters in the SQL statement being executed + * @return bool returns TRUE on success or FALSE on failure */ public function execute($params = null); @@ -164,10 +156,9 @@ public function fetch( /** * Returns an array containing all of the result set rows. * - * @param int $fetchStyle Controls how the next row will be returned to the caller. - * This value must be one of the Doctrine_Core::FETCH_* constants, - * defaulting to Doctrine_Core::FETCH_BOTH - * + * @param int $fetchStyle Controls how the next row will be returned to the caller. + * This value must be one of the Doctrine_Core::FETCH_* constants, + * defaulting to Doctrine_Core::FETCH_BOTH * @return array */ public function fetchAll($fetchStyle = Doctrine_Core::FETCH_BOTH); @@ -176,10 +167,9 @@ public function fetchAll($fetchStyle = Doctrine_Core::FETCH_BOTH); * Returns a single column from the next row of a * result set or FALSE if there are no more rows. * - * @param int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no - * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() - * fetches the first column. - * + * @param int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no + * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() + * fetches the first column. * @return string returns a single column in the next row of a result set */ public function fetchColumn($columnIndex = 0); @@ -190,11 +180,10 @@ public function fetchColumn($columnIndex = 0); * Fetches the next row and returns it as an object. This function is an alternative to * Doctrine_Adapter_Statement_Interface->fetch() with Doctrine_Core::FETCH_CLASS or Doctrine_Core::FETCH_OBJ style. * - * @param string $className name of the created class, defaults to stdClass - * @param array $args elements of this array are passed to the constructor - * - * @return mixed an instance of the required class with property names that correspond - * to the column names or FALSE in case of an error + * @param string $className name of the created class, defaults to stdClass + * @param array $args elements of this array are passed to the constructor + * @return mixed an instance of the required class with property names that correspond + * to the column names or FALSE in case of an error */ public function fetchObject($className = 'stdClass', $args = array()); @@ -212,8 +201,7 @@ public function getAttribute($attribute); /** * Returns metadata for a column in a result set. * - * @param int $column the 0-indexed column in the result set - * + * @param int $column the 0-indexed column in the result set * @return array Associative meta data array with the following structure: * * native_type The PHP native type used to represent the column value. @@ -254,21 +242,19 @@ public function rowCount(); /** * Set a statement attribute. * - * @param int $attribute - * @param mixed $value the value of given attribute - * - * @return bool returns TRUE on success or FALSE on failure + * @param int $attribute + * @param mixed $value the value of given attribute + * @return bool returns TRUE on success or FALSE on failure */ public function setAttribute($attribute, $value); /** * Set the default fetch mode for this statement. * - * @param int $mode the fetch mode must be one of the Doctrine_Core::FETCH_* constants - * @param mixed|null $arg1 - * @param mixed|null $arg2 - * - * @return bool returns 1 on success or FALSE on failure + * @param int $mode the fetch mode must be one of the Doctrine_Core::FETCH_* constants + * @param mixed|null $arg1 + * @param mixed|null $arg2 + * @return bool returns 1 on success or FALSE on failure */ public function setFetchMode($mode, $arg1 = null, $arg2 = null); } diff --git a/lib/Doctrine/Adapter/Statement/Mock.php b/lib/Doctrine/Adapter/Statement/Mock.php index c8b8f2483..ca245e6ad 100644 --- a/lib/Doctrine/Adapter/Statement/Mock.php +++ b/lib/Doctrine/Adapter/Statement/Mock.php @@ -23,12 +23,8 @@ * Mock connection adapter statement class. Used for special testing purposes. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_Adapter_Statement_Mock implements Doctrine_Adapter_Statement_Interface { @@ -61,13 +57,12 @@ public function __construct($mock) * * Bind a column to a PHP variable * - * @param mixed $column Number of the column (1-indexed) or name of the column in the result set. - * If using the column name, be aware that the name should match - * the case of the column, as returned by the driver. - * @param string $param name of the PHP variable to which the column will be bound - * @param int $type data type of the parameter, specified by the Doctrine_Core::PARAM_* constants - * - * @return bool Returns TRUE on success or FALSE on failure + * @param mixed $column Number of the column (1-indexed) or name of the column in the result set. + * If using the column name, be aware that the name should match + * the case of the column, as returned by the driver. + * @param string $param name of the PHP variable to which the column will be bound + * @param int $type data type of the parameter, specified by the Doctrine_Core::PARAM_* constants + * @return bool Returns TRUE on success or FALSE on failure */ public function bindColumn($column, $param, $type = null) { @@ -79,13 +74,12 @@ public function bindColumn($column, $param, $type = null) * Binds a value to a corresponding named or question mark * placeholder in the SQL statement that was use to prepare the statement. * - * @param mixed $param Parameter identifier. For a prepared statement using named placeholders, - * this will be a parameter name of the form :name. For a prepared statement - * using question mark placeholders, this will be the 1-indexed position of the parameter - * @param mixed $value the value to bind to the parameter - * @param int $type explicit data type for the parameter using the Doctrine_Core::PARAM_* constants - * - * @return bool returns TRUE on success or FALSE on failure + * @param mixed $param Parameter identifier. For a prepared statement using named placeholders, + * this will be a parameter name of the form :name. For a prepared statement + * using question mark placeholders, this will be the 1-indexed position of the parameter + * @param mixed $value the value to bind to the parameter + * @param int $type explicit data type for the parameter using the Doctrine_Core::PARAM_* constants + * @return bool returns TRUE on success or FALSE on failure */ public function bindValue($param, $value, $type = null) { @@ -104,14 +98,13 @@ public function bindValue($param, $value, $type = null) * of stored procedures that return data as output parameters, and some also as input/output * parameters that both send in data and are updated to receive it. * - * @param mixed $variable name of the PHP variable to bind to the SQL statement parameter - * @param int $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return - * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the - * Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter. - * @param int $length Length of the data type. To indicate that a parameter is an OUT parameter - * from a stored procedure, you must explicitly set the length. - * - * @return bool returns TRUE on success or FALSE on failure + * @param mixed $variable name of the PHP variable to bind to the SQL statement parameter + * @param int $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return + * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the + * Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter. + * @param int $length Length of the data type. To indicate that a parameter is an OUT parameter + * from a stored procedure, you must explicitly set the length. + * @return bool returns TRUE on success or FALSE on failure */ public function bindParam($column, &$variable, $type = null, $length = null, $driverOptions = array()) { @@ -226,10 +219,9 @@ public function fetchAll($fetchMode = Doctrine_Core::FETCH_BOTH) * if any, of their associated parameter markers or pass an array of input-only * parameter values * - * @param array $params an array of values with as many elements as there are - * bound parameters in the SQL statement being executed - * - * @return bool returns TRUE on success or FALSE on failure + * @param array $params an array of values with as many elements as there are + * bound parameters in the SQL statement being executed + * @return bool returns TRUE on success or FALSE on failure */ public function execute($params = null) { @@ -246,10 +238,9 @@ public function execute($params = null) * Returns a single column from the next row of a * result set or FALSE if there are no more rows. * - * @param int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no - * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() - * fetches the first column. - * + * @param int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no + * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() + * fetches the first column. * @return string returns a single column in the next row of a result set */ public function fetchColumn($columnIndex = 0) @@ -265,11 +256,10 @@ public function fetchColumn($columnIndex = 0) * Fetches the next row and returns it as an object. This function is an alternative to * Doctrine_Adapter_Statement_Interface->fetch() with Doctrine_Core::FETCH_CLASS or Doctrine_Core::FETCH_OBJ style. * - * @param string $className name of the created class, defaults to stdClass - * @param array $args elements of this array are passed to the constructor - * - * @return mixed an instance of the required class with property names that correspond - * to the column names or FALSE in case of an error + * @param string $className name of the created class, defaults to stdClass + * @param array $args elements of this array are passed to the constructor + * @return mixed an instance of the required class with property names that correspond + * to the column names or FALSE in case of an error */ public function fetchObject($className = 'stdClass', $args = array()) { @@ -316,8 +306,7 @@ public function rowCount() * * Returns metadata for a column in a result set * - * @param int $column the 0-indexed column in the result set - * + * @param int $column the 0-indexed column in the result set * @return array Associative meta data array with the following structure: * * native_type The PHP native type used to represent the column value. @@ -352,10 +341,9 @@ public function getAttribute($attribute) * * Set a statement attribute * - * @param int $attribute - * @param mixed $value the value of given attribute - * - * @return bool returns TRUE on success or FALSE on failure + * @param int $attribute + * @param mixed $value the value of given attribute + * @return bool returns TRUE on success or FALSE on failure */ public function setAttribute($attribute, $value) { @@ -366,11 +354,10 @@ public function setAttribute($attribute, $value) * * Set the default fetch mode for this statement * - * @param int $mode the fetch mode must be one of the Doctrine_Core::FETCH_* constants - * @param mixed|null $arg1 - * @param mixed|null $arg2 - * - * @return bool returns 1 on success or FALSE on failure + * @param int $mode the fetch mode must be one of the Doctrine_Core::FETCH_* constants + * @param mixed|null $arg1 + * @param mixed|null $arg2 + * @return bool returns 1 on success or FALSE on failure */ public function setFetchMode($mode, $arg1 = null, $arg2 = null) { diff --git a/lib/Doctrine/Adapter/Statement/Oracle.php b/lib/Doctrine/Adapter/Statement/Oracle.php index e6f70185c..b2812e669 100644 --- a/lib/Doctrine/Adapter/Statement/Oracle.php +++ b/lib/Doctrine/Adapter/Statement/Oracle.php @@ -25,12 +25,8 @@ * @author Konsta Vesterinen * @author vadik56 * @author Miloslav Kmet - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Rev$ */ class Doctrine_Adapter_Statement_Oracle implements Doctrine_Adapter_Statement_Interface { @@ -88,13 +84,12 @@ public function __construct(Doctrine_Adapter_Oracle $connection, $query, $execut /** * Bind a column to a PHP variable. * - * @param mixed $column Number of the column (1-indexed) or name of the column in the result set. - * If using the column name, be aware that the name should match - * the case of the column, as returned by the driver. - * @param string $param name of the PHP variable to which the column will be bound - * @param int $type data type of the parameter, specified by the Doctrine_Core::PARAM_* constants - * - * @return bool Returns TRUE on success or FALSE on failure + * @param mixed $column Number of the column (1-indexed) or name of the column in the result set. + * If using the column name, be aware that the name should match + * the case of the column, as returned by the driver. + * @param string $param name of the PHP variable to which the column will be bound + * @param int $type data type of the parameter, specified by the Doctrine_Core::PARAM_* constants + * @return bool Returns TRUE on success or FALSE on failure */ public function bindColumn($column, $param, $type = null) { @@ -105,13 +100,12 @@ public function bindColumn($column, $param, $type = null) * Binds a value to a corresponding named or question mark * placeholder in the SQL statement that was use to prepare the statement. * - * @param mixed $param Parameter identifier. For a prepared statement using named placeholders, - * this will be a parameter name of the form :name. For a prepared statement - * using question mark placeholders, this will be the 1-indexed position of the parameter - * @param mixed $value the value to bind to the parameter - * @param int $type explicit data type for the parameter using the Doctrine_Core::PARAM_* constants - * - * @return bool returns TRUE on success or FALSE on failure + * @param mixed $param Parameter identifier. For a prepared statement using named placeholders, + * this will be a parameter name of the form :name. For a prepared statement + * using question mark placeholders, this will be the 1-indexed position of the parameter + * @param mixed $value the value to bind to the parameter + * @param int $type explicit data type for the parameter using the Doctrine_Core::PARAM_* constants + * @return bool returns TRUE on success or FALSE on failure */ public function bindValue($param, $value, $type = null) { @@ -133,14 +127,13 @@ public function bindValue($param, $value, $type = null) * of stored procedures that return data as output parameters, and some also as input/output * parameters that both send in data and are updated to receive it. * - * @param mixed $variable name of the PHP variable to bind to the SQL statement parameter - * @param int $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return - * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the - * Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter. - * @param int $length Length of the data type. To indicate that a parameter is an OUT parameter - * from a stored procedure, you must explicitly set the length. - * - * @return bool returns TRUE on success or FALSE on failure + * @param mixed $variable name of the PHP variable to bind to the SQL statement parameter + * @param int $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return + * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the + * Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter. + * @param int $length Length of the data type. To indicate that a parameter is an OUT parameter + * from a stored procedure, you must explicitly set the length. + * @return bool returns TRUE on success or FALSE on failure */ public function bindParam($column, &$variable, $type = null, $length = null, $driverOptions = array()) { @@ -255,10 +248,9 @@ private function getOciError() * if any, of their associated parameter markers or pass an array of input-only * parameter values * - * @param array $params an array of values with as many elements as there are - * bound parameters in the SQL statement being executed - * - * @return bool returns TRUE on success or FALSE on failure + * @param array $params an array of values with as many elements as there are + * bound parameters in the SQL statement being executed + * @return bool returns TRUE on success or FALSE on failure */ public function execute($params = null) { @@ -345,10 +337,9 @@ public function fetch($fetchStyle = Doctrine_Core::FETCH_BOTH, $cursorOrientatio /** * Returns an array containing all of the result set rows. * - * @param int $fetchStyle Controls how the next row will be returned to the caller. - * This value must be one of the Doctrine_Core::FETCH_* constants, - * defaulting to Doctrine_Core::FETCH_BOTH - * + * @param int $fetchStyle Controls how the next row will be returned to the caller. + * This value must be one of the Doctrine_Core::FETCH_* constants, + * defaulting to Doctrine_Core::FETCH_BOTH * @return array */ public function fetchAll($fetchStyle = Doctrine_Core::FETCH_BOTH, $colnum = 0) @@ -383,10 +374,9 @@ public function fetchAll($fetchStyle = Doctrine_Core::FETCH_BOTH, $colnum = 0) * Returns a single column from the next row of a * result set or FALSE if there are no more rows. * - * @param int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no - * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() - * fetches the first column. - * + * @param int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no + * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() + * fetches the first column. * @return string returns a single column in the next row of a result set */ public function fetchColumn($columnIndex = 0) @@ -407,11 +397,10 @@ public function fetchColumn($columnIndex = 0) * Fetches the next row and returns it as an object. This function is an alternative to * Doctrine_Adapter_Statement_Interface->fetch() with Doctrine_Core::FETCH_CLASS or Doctrine_Core::FETCH_OBJ style. * - * @param string $className name of the created class, defaults to stdClass - * @param array $args elements of this array are passed to the constructor - * - * @return mixed an instance of the required class with property names that correspond - * to the column names or FALSE in case of an error + * @param string $className name of the created class, defaults to stdClass + * @param array $args elements of this array are passed to the constructor + * @return mixed an instance of the required class with property names that correspond + * to the column names or FALSE in case of an error */ public function fetchObject($className = 'stdClass', $args = array()) { @@ -450,8 +439,7 @@ public function fetchObject($className = 'stdClass', $args = array()) /** * Returns metadata for a column in a result set. * - * @param int $column the 0-indexed column in the result set - * + * @param int $column the 0-indexed column in the result set * @return array Associative meta data array with the following structure: * * native_type The PHP native type used to represent the column value. @@ -514,10 +502,9 @@ public function rowCount() /** * Set a statement attribute. * - * @param int $attribute - * @param mixed $value the value of given attribute - * - * @return bool returns TRUE on success or FALSE on failure + * @param int $attribute + * @param mixed $value the value of given attribute + * @return bool returns TRUE on success or FALSE on failure */ public function setAttribute($attribute, $value) { @@ -547,11 +534,10 @@ public function getAttribute($attribute) /** * Set the default fetch mode for this statement. * - * @param int $mode the fetch mode must be one of the Doctrine_Core::FETCH_* constants - * @param mixed|null $arg1 - * @param mixed|null $arg2 - * - * @return bool returns 1 on success or FALSE on failure + * @param int $mode the fetch mode must be one of the Doctrine_Core::FETCH_* constants + * @param mixed|null $arg1 + * @param mixed|null $arg2 + * @return bool returns 1 on success or FALSE on failure */ public function setFetchMode($mode, $arg1 = null, $arg2 = null) { @@ -577,9 +563,8 @@ private function handleError($params = array()) * Parse actual query from queryString and returns OCI statement handler. * * @param string Query string to parse, if NULL, $this->queryString is used - * @param mixed|null $query - * - * @return resource OCI statement handler + * @param mixed|null $query + * @return resource OCI statement handler */ private function parseQuery($query = null) { diff --git a/lib/Doctrine/AuditLog.php b/lib/Doctrine/AuditLog.php index 83daa5f53..44316989c 100644 --- a/lib/Doctrine/AuditLog.php +++ b/lib/Doctrine/AuditLog.php @@ -22,12 +22,7 @@ /** * Doctrine_AuditLog. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ * * @author Konsta Vesterinen */ @@ -110,10 +105,9 @@ public function setTableDefinition() /** * Get array of information for the passed record and the specified version. * - * @param int $version - * @param int $hydrationMode - * @param bool $asCollection - * + * @param int $version + * @param int $hydrationMode + * @param bool $asCollection * @return array An array or Doctrine_Collection or a Doctrine_Record */ public function getVersion(Doctrine_Record $record, $version, $hydrationMode = Doctrine_Core::HYDRATE_ARRAY, $asCollection = true) diff --git a/lib/Doctrine/AuditLog/Listener.php b/lib/Doctrine/AuditLog/Listener.php index 6b745428a..f0cdd93ea 100644 --- a/lib/Doctrine/AuditLog/Listener.php +++ b/lib/Doctrine/AuditLog/Listener.php @@ -22,12 +22,7 @@ /** * Doctrine_AuditLog_Listener. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/AuditLog/Listener/Microtime.php b/lib/Doctrine/AuditLog/Listener/Microtime.php index 65f7871e2..f8d8a93fd 100644 --- a/lib/Doctrine/AuditLog/Listener/Microtime.php +++ b/lib/Doctrine/AuditLog/Listener/Microtime.php @@ -22,12 +22,7 @@ /** * Doctrine_AuditLog_Listener. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ * * @author Lukas Smith */ diff --git a/lib/Doctrine/Builder.php b/lib/Doctrine/Builder.php index c566b54fc..c523b64c4 100644 --- a/lib/Doctrine/Builder.php +++ b/lib/Doctrine/Builder.php @@ -24,12 +24,6 @@ * * @see www.doctrine-project.org * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * - * @since 1.0 - * - * @version $Revision: 4593 $ - * * @author Jonathan H. Wage */ class Doctrine_Builder diff --git a/lib/Doctrine/Cache/Apc.php b/lib/Doctrine/Cache/Apc.php index 50244fd65..89f8d715d 100644 --- a/lib/Doctrine/Cache/Apc.php +++ b/lib/Doctrine/Cache/Apc.php @@ -22,12 +22,7 @@ /** * APC Cache Driver. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen * @author Jonathan H. Wage @@ -50,10 +45,9 @@ public function __construct($options = array()) /** * Fetch a cache record from this cache driver instance. * - * @param string $id cache id - * @param bool $testCacheValidity if set to false, the cache validity won't be tested - * - * @return mixed Returns either the cached data or false + * @param string $id cache id + * @param bool $testCacheValidity if set to false, the cache validity won't be tested + * @return mixed Returns either the cached data or false */ protected function _doFetch($id, $testCacheValidity = true) { @@ -63,9 +57,8 @@ protected function _doFetch($id, $testCacheValidity = true) /** * Test if a cache record exists for the passed id. * - * @param string $id cache id - * - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record + * @param string $id cache id + * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record */ protected function _doContains($id) { @@ -79,11 +72,10 @@ protected function _doContains($id) * Save a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::save(). * - * @param string $id cache id - * @param string $data data to cache - * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) - * - * @return bool true if no problem + * @param string $id cache id + * @param string $data data to cache + * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) + * @return bool true if no problem */ protected function _doSave($id, $data, $lifeTime = false) { @@ -94,9 +86,8 @@ protected function _doSave($id, $data, $lifeTime = false) * Remove a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::delete(). * - * @param string $id cache id - * - * @return bool true if no problem + * @param string $id cache id + * @return bool true if no problem */ protected function _doDelete($id) { diff --git a/lib/Doctrine/Cache/Array.php b/lib/Doctrine/Cache/Array.php index 26e9aa976..4fef1fd63 100644 --- a/lib/Doctrine/Cache/Array.php +++ b/lib/Doctrine/Cache/Array.php @@ -22,12 +22,7 @@ /** * Array cache driver. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen * @author Jonathan H. Wage @@ -42,10 +37,9 @@ class Doctrine_Cache_Array extends Doctrine_Cache_Driver /** * Fetch a cache record from this cache driver instance. * - * @param string $id cache id - * @param bool $testCacheValidity if set to false, the cache validity won't be tested - * - * @return mixed Returns either the cached data or false + * @param string $id cache id + * @param bool $testCacheValidity if set to false, the cache validity won't be tested + * @return mixed Returns either the cached data or false */ protected function _doFetch($id, $testCacheValidity = true) { @@ -59,9 +53,8 @@ protected function _doFetch($id, $testCacheValidity = true) /** * Test if a cache record exists for the passed id. * - * @param string $id cache id - * - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record + * @param string $id cache id + * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record */ protected function _doContains($id) { @@ -72,11 +65,10 @@ protected function _doContains($id) * Save a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::save(). * - * @param string $id cache id - * @param string $data data to cache - * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) - * - * @return bool true if no problem + * @param string $id cache id + * @param string $data data to cache + * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) + * @return bool true if no problem */ protected function _doSave($id, $data, $lifeTime = false) { @@ -89,9 +81,8 @@ protected function _doSave($id, $data, $lifeTime = false) * Remove a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::delete(). * - * @param string $id cache id - * - * @return bool true if no problem + * @param string $id cache id + * @return bool true if no problem */ protected function _doDelete($id) { diff --git a/lib/Doctrine/Cache/Db.php b/lib/Doctrine/Cache/Db.php index 36275b72c..ef394fa3a 100644 --- a/lib/Doctrine/Cache/Db.php +++ b/lib/Doctrine/Cache/Db.php @@ -22,12 +22,7 @@ /** * Database cache driver. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen * @author Jonathan H. Wage @@ -66,10 +61,9 @@ public function getConnection() /** * Fetch a cache record from this cache driver instance. * - * @param string $id cache id - * @param bool $testCacheValidity if set to false, the cache validity won't be tested - * - * @return mixed Returns either the cached data or false + * @param string $id cache id + * @param bool $testCacheValidity if set to false, the cache validity won't be tested + * @return mixed Returns either the cached data or false */ protected function _doFetch($id, $testCacheValidity = true) { @@ -92,9 +86,8 @@ protected function _doFetch($id, $testCacheValidity = true) /** * Test if a cache record exists for the passed id. * - * @param string $id cache id - * - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record + * @param string $id cache id + * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record */ protected function _doContains($id) { @@ -114,11 +107,10 @@ protected function _doContains($id) * Save a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::save(). * - * @param string $id cache id - * @param string $data data to cache - * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) - * - * @return bool true if no problem + * @param string $id cache id + * @param string $data data to cache + * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) + * @return bool true if no problem */ protected function _doSave($id, $data, $lifeTime = false, $saveKey = true) { @@ -156,9 +148,8 @@ protected function _doSave($id, $data, $lifeTime = false, $saveKey = true) * Remove a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::delete(). * - * @param string $id cache id - * - * @return bool true if no problem + * @param string $id cache id + * @return bool true if no problem */ protected function _doDelete($id) { @@ -198,8 +189,7 @@ public function createTable() * Convert hex data to binary data. If passed data is not hex then * it is returned as is. * - * @param string $hex - * + * @param string $hex * @return string $binary */ protected function _hex2bin($hex) diff --git a/lib/Doctrine/Cache/Driver.php b/lib/Doctrine/Cache/Driver.php index 7b74998d2..9de58b1f5 100644 --- a/lib/Doctrine/Cache/Driver.php +++ b/lib/Doctrine/Cache/Driver.php @@ -22,12 +22,7 @@ /** * Abstract cache driver class. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen * @author Jonathan H. Wage @@ -50,10 +45,9 @@ public function __construct($options = array()) /** * Set option name and value. * - * @param mixed $option the option name - * @param mixed $value option value - * - * @return bool TRUE on success, FALSE on failure + * @param mixed $option the option name + * @param mixed $value option value + * @return bool TRUE on success, FALSE on failure */ public function setOption($option, $value) { @@ -69,8 +63,7 @@ public function setOption($option, $value) /** * Get value of option. * - * @param mixed $option the option name - * + * @param mixed $option the option name * @return mixed option value */ public function getOption($option) @@ -85,10 +78,9 @@ public function getOption($option) /** * Fetch a cache record from this cache driver instance. * - * @param string $id cache id - * @param bool $testCacheValidity if set to false, the cache validity won't be tested - * - * @return mixed Returns either the cached data or false + * @param string $id cache id + * @param bool $testCacheValidity if set to false, the cache validity won't be tested + * @return mixed Returns either the cached data or false */ public function fetch($id, $testCacheValidity = true) { @@ -100,9 +92,8 @@ public function fetch($id, $testCacheValidity = true) /** * Test if a cache record exists for the passed id. * - * @param string $id cache id - * - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record + * @param string $id cache id + * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record */ public function contains($id) { @@ -114,11 +105,10 @@ public function contains($id) /** * Save some string datas into a cache record. * - * @param string $id cache id - * @param string $data data to cache - * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) - * - * @return bool true if no problem + * @param string $id cache id + * @param string $data data to cache + * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) + * @return bool true if no problem */ public function save($id, $data, $lifeTime = false) { @@ -132,9 +122,8 @@ public function save($id, $data, $lifeTime = false) * * Note: This method accepts wildcards with the * character * - * @param string $id cache id - * - * @return bool true if no problem + * @param string $id cache id + * @return bool true if no problem */ public function delete($id) { @@ -150,9 +139,8 @@ public function delete($id) /** * Delete cache entries where the key matches a PHP regular expressions. * - * @param string $regex - * - * @return int $count The number of deleted cache entries + * @param string $regex + * @return int $count The number of deleted cache entries */ public function deleteByRegex($regex) { @@ -173,9 +161,8 @@ public function deleteByRegex($regex) /** * Delete cache entries where the key has the passed prefix. * - * @param string $prefix - * - * @return int $count The number of deleted cache entries + * @param string $prefix + * @return int $count The number of deleted cache entries */ public function deleteByPrefix($prefix) { @@ -196,9 +183,8 @@ public function deleteByPrefix($prefix) /** * Delete cache entries where the key has the passed suffix. * - * @param string $suffix - * - * @return int $count The number of deleted cache entries + * @param string $suffix + * @return int $count The number of deleted cache entries */ public function deleteBySuffix($suffix) { @@ -237,8 +223,7 @@ public function deleteAll() /** * Get the hash key passing its suffix. * - * @param string $id The hash key suffix - * + * @param string $id The hash key suffix * @return string Hash key to be used by drivers */ protected function _getKey($id) @@ -262,19 +247,17 @@ abstract protected function _getCacheKeys(); /** * Fetch a cache record from this cache driver instance. * - * @param string $id cache id - * @param bool $testCacheValidity if set to false, the cache validity won't be tested - * - * @return mixed Returns either the cached data or false + * @param string $id cache id + * @param bool $testCacheValidity if set to false, the cache validity won't be tested + * @return mixed Returns either the cached data or false */ abstract protected function _doFetch($id, $testCacheValidity = true); /** * Test if a cache record exists for the passed id. * - * @param string $id cache id - * - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record + * @param string $id cache id + * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record */ abstract protected function _doContains($id); @@ -282,11 +265,10 @@ abstract protected function _doContains($id); * Save a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::save(). * - * @param string $id cache id - * @param string $data data to cache - * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) - * - * @return bool true if no problem + * @param string $id cache id + * @param string $data data to cache + * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) + * @return bool true if no problem */ abstract protected function _doSave($id, $data, $lifeTime = false); @@ -294,9 +276,8 @@ abstract protected function _doSave($id, $data, $lifeTime = false); * Remove a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::delete(). * - * @param string $id cache id - * - * @return bool true if no problem + * @param string $id cache id + * @return bool true if no problem */ abstract protected function _doDelete($id); } diff --git a/lib/Doctrine/Cache/Exception.php b/lib/Doctrine/Cache/Exception.php index 998a51710..3aeede3b8 100644 --- a/lib/Doctrine/Cache/Exception.php +++ b/lib/Doctrine/Cache/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine cache exception class. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen * @author Jonathan H. Wage diff --git a/lib/Doctrine/Cache/Interface.php b/lib/Doctrine/Cache/Interface.php index 1274cf75f..ea01ac354 100644 --- a/lib/Doctrine/Cache/Interface.php +++ b/lib/Doctrine/Cache/Interface.php @@ -22,12 +22,7 @@ /** * Doctrine cache driver interface. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen * @author Jonathan H. Wage @@ -37,39 +32,35 @@ interface Doctrine_Cache_Interface /** * Fetch a cache record from this cache driver instance. * - * @param string $id cache id - * @param bool $testCacheValidity if set to false, the cache validity won't be tested - * - * @return mixed Returns either the cached data or false + * @param string $id cache id + * @param bool $testCacheValidity if set to false, the cache validity won't be tested + * @return mixed Returns either the cached data or false */ public function fetch($id, $testCacheValidity = true); /** * Test if a cache record exists for the passed id. * - * @param string $id cache id - * - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record + * @param string $id cache id + * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record */ public function contains($id); /** * Save a cache record and add the key to the index of cached keys. * - * @param string $id cache id - * @param string $data data to cache - * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) - * - * @return bool true if no problem + * @param string $id cache id + * @param string $data data to cache + * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) + * @return bool true if no problem */ public function save($id, $data, $lifeTime = false); /** * Remove a cache record. * - * @param string $id cache id - * - * @return bool true if no problem + * @param string $id cache id + * @return bool true if no problem */ public function delete($id); } diff --git a/lib/Doctrine/Cache/Memcache.php b/lib/Doctrine/Cache/Memcache.php index ab0afa8cf..28e1a35fd 100644 --- a/lib/Doctrine/Cache/Memcache.php +++ b/lib/Doctrine/Cache/Memcache.php @@ -22,12 +22,7 @@ /** * Memcache cache driver. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen * @author Jonathan H. Wage @@ -76,9 +71,8 @@ public function __construct($options = array()) /** * Test if a cache record exists for the passed id. * - * @param string $id cache id - * - * @return mixed Returns either the cached data or false + * @param string $id cache id + * @return mixed Returns either the cached data or false */ protected function _doFetch($id, $testCacheValidity = true) { @@ -88,9 +82,8 @@ protected function _doFetch($id, $testCacheValidity = true) /** * Test if a cache is available or not (for the given id). * - * @param string $id cache id - * - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record + * @param string $id cache id + * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record */ protected function _doContains($id) { @@ -101,11 +94,10 @@ protected function _doContains($id) * Save a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::save(). * - * @param string $id cache id - * @param string $data data to cache - * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) - * - * @return bool true if no problem + * @param string $id cache id + * @param string $data data to cache + * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) + * @return bool true if no problem */ protected function _doSave($id, $data, $lifeTime = false) { @@ -122,9 +114,8 @@ protected function _doSave($id, $data, $lifeTime = false) * Remove a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::delete(). * - * @param string $id cache id - * - * @return bool true if no problem + * @param string $id cache id + * @return bool true if no problem */ protected function _doDelete($id) { diff --git a/lib/Doctrine/Cache/Xcache.php b/lib/Doctrine/Cache/Xcache.php index a24161e29..d739e4b07 100644 --- a/lib/Doctrine/Cache/Xcache.php +++ b/lib/Doctrine/Cache/Xcache.php @@ -22,12 +22,7 @@ /** * Xcache cache driver. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: $ * * @author Dmitry Bakaleinik (dima@snaiper.net) * @author Konsta Vesterinen @@ -52,9 +47,8 @@ public function __construct($options = array()) /** * Test if a cache record exists for the passed id. * - * @param string $id cache id - * - * @return mixed Returns either the cached data or false + * @param string $id cache id + * @return mixed Returns either the cached data or false */ protected function _doFetch($id, $testCacheValidity = true) { @@ -64,9 +58,8 @@ protected function _doFetch($id, $testCacheValidity = true) /** * Test if a cache is available or not (for the given id). * - * @param string $id cache id - * - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record + * @param string $id cache id + * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record */ protected function _doContains($id) { @@ -77,11 +70,10 @@ protected function _doContains($id) * Save a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::save(). * - * @param string $id cache id - * @param string $data data to cache - * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) - * - * @return bool true if no problem + * @param string $id cache id + * @param string $data data to cache + * @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime) + * @return bool true if no problem */ protected function _doSave($id, $data, $lifeTime = false) { @@ -92,9 +84,8 @@ protected function _doSave($id, $data, $lifeTime = false) * Remove a cache record directly. This method is implemented by the cache * drivers and used in Doctrine_Cache_Driver::delete(). * - * @param string $id cache id - * - * @return bool true if no problem + * @param string $id cache id + * @return bool true if no problem */ protected function _doDelete($id) { diff --git a/lib/Doctrine/Cli.php b/lib/Doctrine/Cli.php index b3969a36e..bcfc3e5a3 100644 --- a/lib/Doctrine/Cli.php +++ b/lib/Doctrine/Cli.php @@ -24,12 +24,7 @@ * * Interface for easily executing Doctrine_Task classes from a command line interface * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 2761 $ * * @author Jonathan H. Wage */ @@ -114,8 +109,7 @@ public function getFormatter() /** * Returns the specified value from the config, or the default value, if specified. * - * @param string $name - * + * @param string $name * @throws OutOfBoundsException If the element does not exist in the config */ public function getConfigValue($name/* , $defaultValue */) @@ -142,7 +136,6 @@ public function getConfigValue($name/* , $defaultValue */) * @param string $name * @param mixed [$value=null] * @param bool [$strict=false] - * * @return bool */ public function hasConfigValue($name, $value = null, $strict = false) @@ -183,8 +176,7 @@ public function getRegisteredTasks() /** * Returns TRUE if the specified Task-class is registered, or FALSE otherwise. * - * @param string $className - * + * @param string $className * @return bool */ public function taskClassIsRegistered($className) @@ -199,7 +191,6 @@ public function taskClassIsRegistered($className) * * @param string $taskName * @param string|null [&$className=null] - * * @return bool */ public function taskNameIsRegistered($taskName, &$className = null) @@ -280,10 +271,8 @@ protected function includeAndRegisterDoctrineTaskClasses($directories = null) * This means that a file called "Foo.php", say, will be expected to contain a Task class called * "Doctrine_Task_Foo". Hence the method's name, "include*Doctrine*TaskClasses". * - * @param string $directory - * - * @return array $taskClassesIncluded - * + * @param string $directory + * @return array $taskClassesIncluded * @throws InvalidArgumentException If the directory does not exist */ protected function includeDoctrineTaskClasses($directory) @@ -330,8 +319,7 @@ protected function includeDoctrineTaskClasses($directory) /** * Registers the specified _included_ task-class. * - * @param string $className - * + * @param string $className * @throws InvalidArgumentException If the class does not exist or the task-name is blank * @throws DomainException If the class is not a Doctrine Task */ @@ -356,8 +344,7 @@ public function registerTaskClass($className) /** * Returns TRUE if the specified class is a Task, or FALSE otherwise. * - * @param string $className - * + * @param string $className * @return bool */ protected function classIsTask($className) @@ -372,9 +359,8 @@ protected function classIsTask($className) * * Displays a message, and returns FALSE, if there were problems instantiating the class * - * @param string $className - * @param object $cli Doctrine_Cli - * + * @param string $className + * @param object $cli Doctrine_Cli * @return object Doctrine_Task */ protected function createTaskInstance($className, Doctrine_Cli $cli) @@ -466,8 +452,7 @@ public function run(array $args) /** * Run the actual task execution with the passed arguments. * - * @param array $args Array of arguments for this task being executed - * + * @param array $args Array of arguments for this task being executed * @throws Doctrine_Cli_Exception If the requested task has not been registered or if required arguments are missing * * @todo Continue refactoring for testing @@ -502,8 +487,7 @@ protected function _run(array $args) /** * Executes the task with the specified _prepared_ arguments. * - * @param object $task Doctrine_Task - * + * @param object $task Doctrine_Task * @throws Doctrine_Cli_Exception If required arguments are missing */ protected function executeTask(Doctrine_Task $task, array $preparedArguments) @@ -521,8 +505,7 @@ protected function executeTask(Doctrine_Task $task, array $preparedArguments) * Prepare the raw arguments for execution. Combines with the required and optional argument * list in order to determine a complete array of arguments for the task. * - * @param array $args Array of raw arguments - * + * @param array $args Array of raw arguments * @return array $prepared Array of prepared arguments * * @todo Continue refactoring for testing @@ -607,8 +590,7 @@ public function printTasks($taskName = null, $full = false) } /** - * @param object $formatter Doctrine_Cli_Formatter - * + * @param object $formatter Doctrine_Cli_Formatter * @return string */ protected function assembleArgumentList(array $argumentsDescriptions, array $config, Doctrine_Cli_Formatter $formatter) diff --git a/lib/Doctrine/Cli/AnsiColorFormatter.php b/lib/Doctrine/Cli/AnsiColorFormatter.php index a443baa5a..aa8a020db 100644 --- a/lib/Doctrine/Cli/AnsiColorFormatter.php +++ b/lib/Doctrine/Cli/AnsiColorFormatter.php @@ -33,12 +33,8 @@ * * @author Fabien Potencier * @author Jonathan H. Wage - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 4252 $ */ class Doctrine_Cli_AnsiColorFormatter extends Doctrine_Cli_Formatter { @@ -68,7 +64,6 @@ public function setStyle($name, $options = array()) * * @param string The test to style * @param mixed An array of options or a style name - * * @return string The styled text */ public function format($text = '', $parameters = array(), $stream = STDOUT) @@ -123,9 +118,8 @@ public function formatSection($section, $text, $size = null) * * @param string The text * @param int The maximum size of the returned string (65 by default) - * @param mixed|null $size - * - * @return string The truncated string + * @param mixed|null $size + * @return string The truncated string */ public function excerpt($text, $size = null) { @@ -151,7 +145,6 @@ public function excerpt($text, $size = null) * - non tty consoles * * @param mixed A stream - * * @return bool true if the stream supports colorization, false otherwise */ public function supportsColors($stream) diff --git a/lib/Doctrine/Cli/Exception.php b/lib/Doctrine/Cli/Exception.php index 2f12ddf21..77a790f46 100644 --- a/lib/Doctrine/Cli/Exception.php +++ b/lib/Doctrine/Cli/Exception.php @@ -22,12 +22,7 @@ /** * Cli exception class. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 2761 $ * * @author Jonathan H. Wage */ diff --git a/lib/Doctrine/Cli/Formatter.php b/lib/Doctrine/Cli/Formatter.php index 486729ff3..6248e96ab 100644 --- a/lib/Doctrine/Cli/Formatter.php +++ b/lib/Doctrine/Cli/Formatter.php @@ -33,12 +33,8 @@ * * @author Fabien Potencier * @author Jonathan H. Wage - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 2761 $ */ class Doctrine_Cli_Formatter { @@ -60,7 +56,6 @@ public function __construct($maxLineSize = 65) * @param string The test to style * @param mixed An array of parameters * @param stream A stream (default to STDOUT) - * * @return string The formatted text */ public function format($text = '', $parameters = array(), $stream = STDOUT) @@ -86,9 +81,8 @@ public function formatSection($section, $text, $size = null) * * @param string The text * @param int The maximum size of the returned string (65 by default) - * @param mixed|null $size - * - * @return string The truncated string + * @param mixed|null $size + * @return string The truncated string */ public function excerpt($text, $size = null) { diff --git a/lib/Doctrine/Collection.php b/lib/Doctrine/Collection.php index de96030ef..586bf46c2 100644 --- a/lib/Doctrine/Collection.php +++ b/lib/Doctrine/Collection.php @@ -23,12 +23,7 @@ * Doctrine_Collection * Collection of Doctrine_Record objects. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7686 $ * * @author Konsta Vesterinen */ @@ -206,8 +201,7 @@ public function __unserialize($data) /** * Sets the key column for this collection. * - * @param string $column - * + * @param string $column * @return Doctrine_Collection $this */ public function setKeyColumn($column) @@ -341,8 +335,7 @@ public function remove($key) /** * Whether or not this collection contains a specified element. * - * @param mixed $key the key of the element - * + * @param mixed $key the key of the element * @return bool */ public function contains($key) @@ -371,8 +364,7 @@ public function search(Doctrine_Record $record) * * Collection also maps referential information to newly created records * - * @param mixed $key the key of the element - * + * @param mixed $key the key of the element * @return Doctrine_Record return a specified record */ public function get($key) @@ -466,9 +458,8 @@ public function set($key, $record) /** * Adds a record to collection. * - * @param Doctrine_Record $record record to be added - * @param string $key optional key for the record - * + * @param Doctrine_Record $record record to be added + * @param string $key optional key for the record * @return bool */ public function add($record, $key = null) @@ -545,8 +536,7 @@ public function merge(Doctrine_Collection $coll) /** * Load all relationships or the named relationship passed. * - * @param mixed|null $name - * + * @param mixed|null $name * @return bool */ public function loadRelated($name = null) @@ -730,10 +720,9 @@ public function toArray($deep = true, $prefixKey = false) /** * Build an array made up of the values from the 2 specified columns. * - * @param string $key - * @param string $value - * - * @return array $result + * @param string $key + * @param string $value + * @return array $result */ public function toKeyValueArray($key, $value) { @@ -891,9 +880,8 @@ public function getInsertDiff() /** * Compares two records. To be used on _snapshot diffs using array_udiff. * - * @param Doctrine_Record $a - * @param Doctrine_Record $b - * + * @param Doctrine_Record $a + * @param Doctrine_Record $b * @return int */ protected function compareRecords($a, $b) @@ -909,8 +897,7 @@ protected function compareRecords($a, $b) * Saves all records of this collection and processes the * difference of the last snapshot and the current data. * - * @param Doctrine_Connection $conn optional connection parameter - * + * @param Doctrine_Connection $conn optional connection parameter * @return Doctrine_Collection */ public function save(Doctrine_Connection $conn = null, $processDiff = true) @@ -945,8 +932,7 @@ public function save(Doctrine_Connection $conn = null, $processDiff = true) * Replaces all records of this collection and processes the * difference of the last snapshot and the current data. * - * @param Doctrine_Connection $conn optional connection parameter - * + * @param Doctrine_Connection $conn optional connection parameter * @return Doctrine_Collection */ public function replace(Doctrine_Connection $conn = null, $processDiff = true) diff --git a/lib/Doctrine/Collection/Exception.php b/lib/Doctrine/Collection/Exception.php index e71bc9a3c..3121fe2e6 100644 --- a/lib/Doctrine/Collection/Exception.php +++ b/lib/Doctrine/Collection/Exception.php @@ -22,12 +22,7 @@ /** * Collection exception class. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Collection/Iterator.php b/lib/Doctrine/Collection/Iterator.php index 9b3287a1d..cbad90744 100644 --- a/lib/Doctrine/Collection/Iterator.php +++ b/lib/Doctrine/Collection/Iterator.php @@ -23,12 +23,7 @@ * Doctrine_Collection_Iterator * iterates through Doctrine_Collection. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Collection/Iterator/Expandable.php b/lib/Doctrine/Collection/Iterator/Expandable.php index 1fbb941fb..54ee0b5ac 100644 --- a/lib/Doctrine/Collection/Iterator/Expandable.php +++ b/lib/Doctrine/Collection/Iterator/Expandable.php @@ -22,12 +22,7 @@ /** * Expandable collection iterator class. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Collection/Iterator/Normal.php b/lib/Doctrine/Collection/Iterator/Normal.php index 498bc490d..17d98af0d 100644 --- a/lib/Doctrine/Collection/Iterator/Normal.php +++ b/lib/Doctrine/Collection/Iterator/Normal.php @@ -22,12 +22,7 @@ /** * Doctrine_Collection_Iterator_Normal. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Collection/Iterator/Offset.php b/lib/Doctrine/Collection/Iterator/Offset.php index 8b8a16bfc..1a80465bd 100644 --- a/lib/Doctrine/Collection/Iterator/Offset.php +++ b/lib/Doctrine/Collection/Iterator/Offset.php @@ -22,12 +22,7 @@ /** * Doctrine_Collection_Iterator_Normal. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Collection/Offset.php b/lib/Doctrine/Collection/Offset.php index 51b332104..c9f2b7493 100644 --- a/lib/Doctrine/Collection/Offset.php +++ b/lib/Doctrine/Collection/Offset.php @@ -23,12 +23,7 @@ * Doctrine_Collection_Offset * Collection of Doctrine_Record objects. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Collection/OnDemand.php b/lib/Doctrine/Collection/OnDemand.php index 272eb0bdf..4c722a12f 100644 --- a/lib/Doctrine/Collection/OnDemand.php +++ b/lib/Doctrine/Collection/OnDemand.php @@ -23,12 +23,7 @@ * Doctrine_Collection_OnDemand * iterates through Doctrine_Records hydrating one at a time. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.1 - * - * @version $Revision$ * * @author Geoff Davis */ diff --git a/lib/Doctrine/Column.php b/lib/Doctrine/Column.php index fde9d7206..a4269ba00 100644 --- a/lib/Doctrine/Column.php +++ b/lib/Doctrine/Column.php @@ -24,12 +24,8 @@ * This class represents a database column. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * - * @version $Revision: 7663 $ * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_Column extends Doctrine_Access implements IteratorAggregate, Countable { @@ -113,8 +109,7 @@ public function getEnumValues() /** * Retrieves an enum value. * - * @param int $index - * + * @param int $index * @return string integer ($index) if not present */ public function enumValue($index) diff --git a/lib/Doctrine/Compiler.php b/lib/Doctrine/Compiler.php index 07b5fec54..9e6e458cb 100644 --- a/lib/Doctrine/Compiler.php +++ b/lib/Doctrine/Compiler.php @@ -24,12 +24,8 @@ * This class can be used for compiling the entire Doctrine framework into a single file. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpllicense.php LGPL * * @see www.phpdoctrine. - * @since 1.0 - * - * @version $Revision: 7677 $ */ class Doctrine_Compiler { @@ -39,9 +35,7 @@ class Doctrine_Compiler * cases dozens of files) can improve performance by an order of magnitude. * * @param mixed|null $target - * * @return $target Path the compiled file was written to - * * @throws Doctrine_Compiler_Exception if something went wrong during the compile operation */ public static function compile($target = null, $includedDrivers = array()) diff --git a/lib/Doctrine/Compiler/Exception.php b/lib/Doctrine/Compiler/Exception.php index 1cd7aab89..4d18b8800 100644 --- a/lib/Doctrine/Compiler/Exception.php +++ b/lib/Doctrine/Compiler/Exception.php @@ -23,12 +23,8 @@ * Doctrine_Compiler_Exception. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_Compiler_Exception extends Doctrine_Exception { diff --git a/lib/Doctrine/Configurable.php b/lib/Doctrine/Configurable.php index 992745423..7c9371662 100644 --- a/lib/Doctrine/Configurable.php +++ b/lib/Doctrine/Configurable.php @@ -23,12 +23,7 @@ * Doctrine_Configurable * the base for Doctrine_Table, Doctrine_Manager and Doctrine_Connection. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ * * @author Konsta Vesterinen */ @@ -171,9 +166,8 @@ public function getParam($name, $namespace = null) * * this method is the base of Doctrine dependency injection * - * @param string $template name of the class template - * @param string $class name of the class to be bound - * + * @param string $template name of the class template + * @param string $class name of the class to be bound * @return Doctrine_Configurable this object */ public function setImpl($template, $class) @@ -226,10 +220,9 @@ public function setEventListener($listener) /** * addRecordListener. * - * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener - * @param mixed|null $name - * - * @return Doctrine_Configurable this object + * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener + * @param mixed|null $name + * @return Doctrine_Configurable this object */ public function addRecordListener($listener, $name = null) { @@ -263,9 +256,8 @@ public function getRecordListener() /** * setListener. * - * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener - * - * @return Doctrine_Configurable this object + * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener + * @return Doctrine_Configurable this object */ public function setRecordListener($listener) { @@ -282,10 +274,9 @@ public function setRecordListener($listener) /** * addListener. * - * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener - * @param mixed|null $name - * - * @return Doctrine_Configurable this object + * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener + * @param mixed|null $name + * @return Doctrine_Configurable this object */ public function addListener($listener, $name = null) { @@ -319,9 +310,8 @@ public function getListener() /** * setListener. * - * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener - * - * @return Doctrine_Configurable this object + * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener + * @return Doctrine_Configurable this object */ public function setListener($listener) { diff --git a/lib/Doctrine/Connection.php b/lib/Doctrine/Connection.php index 8e701404f..3e6de0c0f 100644 --- a/lib/Doctrine/Connection.php +++ b/lib/Doctrine/Connection.php @@ -44,12 +44,7 @@ * is divided into modules. For a full list of connection modules see * Doctrine_Connection::$_modules * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ * * @author Konsta Vesterinen * @author Lukas Smith (MDB2 library) @@ -334,8 +329,7 @@ public static function getSupportedDrivers() * @todo why check for >= 100? has this any special meaning when creating * attributes? * - * @param int $attribute - * + * @param int $attribute * @return bool */ public function setAttribute($attribute, $value) @@ -396,10 +390,8 @@ public function getDriverName() * @see Doctrine_Transaction * @see Doctrine_Connection::$modules all availible modules * - * @param string $name the name of the module to get - * - * @return Doctrine_Connection_Module connection module - * + * @param string $name the name of the module to get + * @return Doctrine_Connection_Module connection module * @throws Doctrine_Connection_Exception if trying to get an unknown module */ public function __get($name) @@ -528,9 +520,8 @@ public function driverName($name) /** * supports. * - * @param string $feature the name of the feature - * - * @return bool whether or not this drivers supports given feature + * @param string $feature the name of the feature + * @return bool whether or not this drivers supports given feature */ public function supports($feature) { @@ -564,7 +555,6 @@ public function supports($feature) * the provided key fields * * this method will fail if no key fields are specified - * * @throws Doctrine_Connection_Exception if this driver doesn't support replace * @throws Doctrine_Connection_Exception if some of the key values was null * @throws Doctrine_Connection_Exception if there were no key fields @@ -607,11 +597,9 @@ public function replace(Doctrine_Table $table, array $fields, array $keys) /** * deletes table row(s) matching the specified identifier. * - * @param string $table The table to delete data from - * @param array $identifier an associateve array containing identifier column-value pairs - * - * @return int The number of affected rows - * + * @param string $table The table to delete data from + * @param array $identifier an associateve array containing identifier column-value pairs + * @return int The number of affected rows * @throws Doctrine_Connection_Exception if something went wrong at the database level */ public function delete(Doctrine_Table $table, array $identifier) @@ -632,10 +620,8 @@ public function delete(Doctrine_Table $table, array $identifier) /** * Updates table row(s) with specified data. * - * @param Doctrine_Table $table The table to insert data into - * - * @return int the number of affected rows. Boolean false if empty value array was given, - * + * @param Doctrine_Table $table The table to insert data into + * @return int the number of affected rows. Boolean false if empty value array was given, * @throws Doctrine_Connection_Exception if something went wrong at the database level */ public function update(Doctrine_Table $table, array $fields, array $identifier) @@ -667,9 +653,8 @@ public function update(Doctrine_Table $table, array $fields, array $identifier) /** * Inserts a table row with specified data. * - * @param Doctrine_Table $table the table to insert data into - * - * @return int the number of affected rows. Boolean false if empty value array was given, + * @param Doctrine_Table $table the table to insert data into + * @return int the number of affected rows. Boolean false if empty value array was given, */ public function insert(Doctrine_Table $table, array $fields) { @@ -724,9 +709,8 @@ public function insert(Doctrine_Table $table, array $fields) * InterBase doesn't seem to be able to use delimited identifiers * via PHP 4. They work fine under PHP 5. * - * @param string $str identifier name to be quoted - * @param bool $checkOption check the 'quote_identifier' option - * + * @param string $str identifier name to be quoted + * @param bool $checkOption check the 'quote_identifier' option * @return string quoted identifier string */ public function quoteIdentifier($str, $checkOption = true) @@ -746,9 +730,8 @@ public function quoteIdentifier($str, $checkOption = true) * quoteMultipleIdentifier * Quotes multiple identifier strings. * - * @param array $arr identifiers array to be quoted - * @param bool $checkOption check the 'quote_identifier' option - * + * @param array $arr identifiers array to be quoted + * @param bool $checkOption check the 'quote_identifier' option * @return string quoted identifier string */ public function quoteMultipleIdentifier($arr, $checkOption = true) @@ -778,9 +761,8 @@ public function convertBooleans($item) * quote * quotes given input parameter. * - * @param mixed $input parameter to be quoted - * @param string $type - * + * @param mixed $input parameter to be quoted + * @param string $type * @return string */ public function quote($input, $type = null) @@ -801,9 +783,8 @@ public function setDateFormat($format = null) /** * fetchAll. * - * @param string $statement sql query to be executed - * @param array $params prepared statement params - * + * @param string $statement sql query to be executed + * @param array $params prepared statement params * @return array */ public function fetchAll($statement, array $params = array()) @@ -826,9 +807,8 @@ public function fetchOne($statement, array $params = array(), $colnum = 0) /** * fetchRow. * - * @param string $statement sql query to be executed - * @param array $params prepared statement params - * + * @param string $statement sql query to be executed + * @param array $params prepared statement params * @return array */ public function fetchRow($statement, array $params = array()) @@ -839,9 +819,8 @@ public function fetchRow($statement, array $params = array()) /** * fetchArray. * - * @param string $statement sql query to be executed - * @param array $params prepared statement params - * + * @param string $statement sql query to be executed + * @param array $params prepared statement params * @return array */ public function fetchArray($statement, array $params = array()) @@ -852,10 +831,9 @@ public function fetchArray($statement, array $params = array()) /** * fetchColumn. * - * @param string $statement sql query to be executed - * @param array $params prepared statement params - * @param int $colnum 0-indexed column number to retrieve - * + * @param string $statement sql query to be executed + * @param array $params prepared statement params + * @param int $colnum 0-indexed column number to retrieve * @return array */ public function fetchColumn($statement, array $params = array(), $colnum = 0) @@ -866,9 +844,8 @@ public function fetchColumn($statement, array $params = array(), $colnum = 0) /** * fetchAssoc. * - * @param string $statement sql query to be executed - * @param array $params prepared statement params - * + * @param string $statement sql query to be executed + * @param array $params prepared statement params * @return array */ public function fetchAssoc($statement, array $params = array()) @@ -879,9 +856,8 @@ public function fetchAssoc($statement, array $params = array()) /** * fetchBoth. * - * @param string $statement sql query to be executed - * @param array $params prepared statement params - * + * @param string $statement sql query to be executed + * @param array $params prepared statement params * @return array */ public function fetchBoth($statement, array $params = array()) @@ -984,10 +960,9 @@ public function queryOne($query, array $params = array()) * queries the database with limit and offset * added to the query and returns a Doctrine_Connection_Statement object. * - * @param string $query - * @param int $limit - * @param int $offset - * + * @param string $query + * @param int $limit + * @param int $offset * @return Doctrine_Connection_Statement */ public function select($query, $limit = 0, $offset = 0) @@ -1002,9 +977,8 @@ public function select($query, $limit = 0, $offset = 0) /** * standaloneQuery. * - * @param string $query sql query - * @param array $params query parameters - * + * @param string $query sql query + * @param array $params query parameters * @return PDOStatement|Doctrine_Adapter_Statement */ public function standaloneQuery($query, $params = array()) @@ -1015,9 +989,8 @@ public function standaloneQuery($query, $params = array()) /** * execute. * - * @param string $query sql query - * @param array $params query parameters - * + * @param string $query sql query + * @param array $params query parameters * @return PDOStatement|Doctrine_Adapter_Statement */ public function execute($query, array $params = array()) @@ -1052,9 +1025,8 @@ public function execute($query, array $params = array()) /** * exec. * - * @param string $query sql query - * @param array $params query parameters - * + * @param string $query sql query + * @param array $params query parameters * @return int */ public function exec($query, array $params = array()) @@ -1089,8 +1061,7 @@ public function exec($query, array $params = array()) /** * rethrowException. * - * @param mixed|null $query - * + * @param mixed|null $query * @throws Doctrine_Connection_Exception */ public function rethrowException(Exception $e, $invoker, $query = null) @@ -1133,8 +1104,7 @@ public function hasTable($name) /** * returns a table object for given component name. * - * @param string $name component name - * + * @param string $name component name * @return Doctrine_Table */ public function getTable($name) @@ -1218,8 +1188,7 @@ public function count() * addTable * adds a Doctrine_Table object into connection registry. * - * @param $table a Doctrine_Table object to be added into registry - * + * @param $table a Doctrine_Table object to be added into registry * @return bool */ public function addTable(Doctrine_Table $table) @@ -1240,8 +1209,7 @@ public function addTable(Doctrine_Table $table) * * create creates a record * - * @param string $name component name - * + * @param string $name component name * @return Doctrine_Record Doctrine_Record object */ public function create($name) @@ -1432,10 +1400,8 @@ public function lastInsertId($table = null, $field = null) * * Listeners: onPreTransactionBegin, onTransactionBegin * - * @param string $savepoint name of a savepoint to set - * - * @return int current transaction nesting level - * + * @param string $savepoint name of a savepoint to set + * @return int current transaction nesting level * @throws Doctrine_Transaction_Exception if the transaction fails at database level */ public function beginTransaction($savepoint = null) @@ -1456,10 +1422,8 @@ public function beginInternalTransaction($savepoint = null) * * Listeners: onPreTransactionCommit, onTransactionCommit * - * @param string $savepoint name of a savepoint to release - * - * @return bool false if commit couldn't be performed, true otherwise - * + * @param string $savepoint name of a savepoint to release + * @return bool false if commit couldn't be performed, true otherwise * @throws Doctrine_Transaction_Exception if the transaction fails at PDO level * @throws Doctrine_Validator_Exception if the transaction fails due to record validations */ @@ -1478,10 +1442,8 @@ public function commit($savepoint = null) * this method can be listened with onPreTransactionRollback and onTransactionRollback * eventlistener methods * - * @param string $savepoint name of a savepoint to rollback to - * - * @return bool false if rollback couldn't be performed, true otherwise - * + * @param string $savepoint name of a savepoint to rollback to + * @return bool false if rollback couldn't be performed, true otherwise * @throws Doctrine_Transaction_Exception if the rollback operation fails at database level */ public function rollback($savepoint = null) @@ -1687,9 +1649,8 @@ public function __unserialize($data) /** * Get/generate a unique foreign key name for a relationship. * - * @param Doctrine_Relation $relation Relation object to generate the foreign key name for - * - * @return string $fkName + * @param Doctrine_Relation $relation Relation object to generate the foreign key name for + * @return string $fkName */ public function generateUniqueRelationForeignKeyName(Doctrine_Relation $relation) { @@ -1708,9 +1669,8 @@ public function generateUniqueRelationForeignKeyName(Doctrine_Relation $relation /** * Get/generate unique index name for a table name and set of fields. * - * @param string $tableName The name of the table the index exists - * @param string $fields The fields that makes up the index - * + * @param string $tableName The name of the table the index exists + * @param string $fields The fields that makes up the index * @return string $indexName The name of the generated index */ public function generateUniqueIndexName($tableName, $fields) diff --git a/lib/Doctrine/Connection/Common.php b/lib/Doctrine/Connection/Common.php index d63e53d7c..cc5c5261a 100644 --- a/lib/Doctrine/Connection/Common.php +++ b/lib/Doctrine/Connection/Common.php @@ -24,12 +24,6 @@ * * @see www.doctrine-project.org * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * - * @since 1.0 - * - * @version $Revision: 7490 $ - * * @author Konsta Vesterinen */ class Doctrine_Connection_Common extends Doctrine_Connection @@ -37,8 +31,7 @@ class Doctrine_Connection_Common extends Doctrine_Connection /** * Adds an driver-specific LIMIT clause to the query. * - * @param string $query - * + * @param string $query * @return string */ public function modifyLimitQuery($query, $limit = false, $offset = false, $isManip = false) diff --git a/lib/Doctrine/Connection/Db2.php b/lib/Doctrine/Connection/Db2.php index dee23d4bc..7f554d381 100644 --- a/lib/Doctrine/Connection/Db2.php +++ b/lib/Doctrine/Connection/Db2.php @@ -22,12 +22,7 @@ /** * Doctrine_Connection_Db2. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ @@ -36,10 +31,9 @@ class Doctrine_Connection_Db2 extends Doctrine_Connection_Common /** * Adds an driver-specific LIMIT clause to the query. * - * @param string $query query to modify - * @param int $limit limit the number of rows - * @param int $offset start reading from given offset - * + * @param string $query query to modify + * @param int $limit limit the number of rows + * @param int $offset start reading from given offset * @return string the modified query */ public function modifyLimitQuery($query, $limit = false, $offset = false, $isManip = false) diff --git a/lib/Doctrine/Connection/Exception.php b/lib/Doctrine/Connection/Exception.php index 796a4b6f8..a489d9761 100644 --- a/lib/Doctrine/Connection/Exception.php +++ b/lib/Doctrine/Connection/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ @@ -73,7 +68,6 @@ class Doctrine_Connection_Exception extends Doctrine_Exception /** * @see Doctrine_Core::ERR_* constants - * @since 1.0 * * @var int portable error code */ @@ -107,10 +101,9 @@ public function getPortableMessage() * @param int|array integer error code, * null to get the current error code-message map, * or an array with a new error code-message map - * @param mixed|null $value - * - * @return string error message, or false if the error code was - * not recognized + * @param mixed|null $value + * @return string error message, or false if the error code was + * not recognized */ public function errorMessage($value = null) { @@ -123,12 +116,9 @@ public function errorMessage($value = null) * converted into a portable code and then adds this * portable error code to $portableCode field. * - * @param array $errorInfo error info array - * - * @since 1.0 - * - * @return bool whether or not the error info processing was successfull - * (the process is successfull if portable error code was found) + * @param array $errorInfo error info array + * @return bool whether or not the error info processing was successfull + * (the process is successfull if portable error code was found) */ public function processErrorInfo(array $errorInfo) { diff --git a/lib/Doctrine/Connection/Mock.php b/lib/Doctrine/Connection/Mock.php index 220059754..3acf13ba5 100644 --- a/lib/Doctrine/Connection/Mock.php +++ b/lib/Doctrine/Connection/Mock.php @@ -22,14 +22,10 @@ /** * Doctrine_Connection_Mysql. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_Connection_Mock extends Doctrine_Connection_Common { diff --git a/lib/Doctrine/Connection/Module.php b/lib/Doctrine/Connection/Module.php index d8b572c84..4ddb0e516 100644 --- a/lib/Doctrine/Connection/Module.php +++ b/lib/Doctrine/Connection/Module.php @@ -22,12 +22,7 @@ /** * Doctrine_Connection_Module. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Connection/Mssql.php b/lib/Doctrine/Connection/Mssql.php index f83458983..be121fb0b 100644 --- a/lib/Doctrine/Connection/Mssql.php +++ b/lib/Doctrine/Connection/Mssql.php @@ -22,14 +22,10 @@ /** * Doctrine_Connection_Mssql. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @version $Revision: 7690 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_Connection_Mssql extends Doctrine_Connection_Common { @@ -73,9 +69,8 @@ public function __construct(Doctrine_Manager $manager, $adapter) * * Quoting style depends on which database driver is being used. * - * @param string $identifier identifier name to be quoted - * @param bool $checkOption check the 'quote_identifier' option - * + * @param string $identifier identifier name to be quoted + * @param bool $checkOption check the 'quote_identifier' option * @return string quoted identifier string */ public function quoteIdentifier($identifier, $checkOption = false) @@ -194,9 +189,8 @@ private function parseOrderBy($orderby) * * @see DC-828 * - * @param string $field - * @param string $term the term which will changed if it's necessary, depending to the field type - * + * @param string $field + * @param string $term the term which will changed if it's necessary, depending to the field type * @return string */ public function modifyOrderByColumn(Doctrine_Table $table, $field, $term) @@ -224,8 +218,7 @@ public function modifyLimitSubquery(Doctrine_Table $rootTable, $query, $limit = /** * return version information about the server. * - * @param bool $native determines if the raw version string should be returned - * + * @param bool $native determines if the raw version string should be returned * @return array version information */ public function getServerVersion($native = false) @@ -285,9 +278,8 @@ public function checkSequence($seqName) /** * execute. * - * @param string $query sql query - * @param array $params query parameters - * + * @param string $query sql query + * @param array $params query parameters * @return PDOStatement|Doctrine_Adapter_Statement */ public function execute($query, array $params = array()) @@ -302,9 +294,8 @@ public function execute($query, array $params = array()) /** * execute. * - * @param string $query sql query - * @param array $params query parameters - * + * @param string $query sql query + * @param array $params query parameters * @return PDOStatement|Doctrine_Adapter_Statement */ public function exec($query, array $params = array()) @@ -340,9 +331,8 @@ protected function replaceBoundParamsWithInlineValuesInQuery($query, array $para /** * Inserts a table row with specified data. * - * @param Doctrine_Table $table the table to insert data into - * - * @return int the number of affected rows. Boolean false if empty value array was given, + * @param Doctrine_Table $table the table to insert data into + * @return int the number of affected rows. Boolean false if empty value array was given, */ public function insert(Doctrine_Table $table, array $fields) { diff --git a/lib/Doctrine/Connection/Mssql/Exception.php b/lib/Doctrine/Connection/Mssql/Exception.php index 992713b30..6172792a5 100644 --- a/lib/Doctrine/Connection/Mssql/Exception.php +++ b/lib/Doctrine/Connection/Mssql/Exception.php @@ -22,14 +22,9 @@ /** * Doctrine_Connection_Mssql_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @since 1.0 - * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org */ class Doctrine_Connection_Mssql_Exception extends Doctrine_Connection_Exception @@ -59,12 +54,9 @@ class Doctrine_Connection_Mssql_Exception extends Doctrine_Connection_Exception * converted into a portable code and then adds this * portable error code to $portableCode field. * - * @param array $errorInfo error info array - * - * @since 1.0 - * - * @return bool whether or not the error info processing was successfull - * (the process is successfull if portable error code was found) + * @param array $errorInfo error info array + * @return bool whether or not the error info processing was successfull + * (the process is successfull if portable error code was found) */ public function processErrorInfo(array $errorInfo) { diff --git a/lib/Doctrine/Connection/Mysql.php b/lib/Doctrine/Connection/Mysql.php index 89b22e5b0..b1c5bbbe5 100644 --- a/lib/Doctrine/Connection/Mysql.php +++ b/lib/Doctrine/Connection/Mysql.php @@ -22,14 +22,10 @@ /** * Doctrine_Connection_Mysql. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_Connection_Mysql extends Doctrine_Connection_Common { @@ -190,7 +186,6 @@ public function setCharset($charset) * part of unique index they may not be null. * * Default: 0 - * * @return int the number of affected rows */ public function replace(Doctrine_Table $table, array $fields, array $keys) diff --git a/lib/Doctrine/Connection/Mysql/Exception.php b/lib/Doctrine/Connection/Mysql/Exception.php index a4b2b7b3f..9887bcc8c 100644 --- a/lib/Doctrine/Connection/Mysql/Exception.php +++ b/lib/Doctrine/Connection/Mysql/Exception.php @@ -22,14 +22,9 @@ /** * Doctrine_Connection_Mysql_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @since 1.0 - * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org */ class Doctrine_Connection_Mysql_Exception extends Doctrine_Connection_Exception @@ -70,12 +65,9 @@ class Doctrine_Connection_Mysql_Exception extends Doctrine_Connection_Exception * converted into a portable code and then adds this * portable error code to $portableCode field. * - * @param array $errorInfo error info array - * - * @since 1.0 - * - * @return bool whether or not the error info processing was successfull - * (the process is successfull if portable error code was found) + * @param array $errorInfo error info array + * @return bool whether or not the error info processing was successfull + * (the process is successfull if portable error code was found) */ public function processErrorInfo(array $errorInfo) { diff --git a/lib/Doctrine/Connection/Oracle.php b/lib/Doctrine/Connection/Oracle.php index 7fecc2b52..4643feb92 100644 --- a/lib/Doctrine/Connection/Oracle.php +++ b/lib/Doctrine/Connection/Oracle.php @@ -22,12 +22,7 @@ /** * Doctrine_Connection_Oracle. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7664 $ * * @author Konsta Vesterinen */ @@ -85,10 +80,9 @@ public function setDateFormat($format = 'YYYY-MM-DD HH24:MI:SS') /** * Adds an driver-specific LIMIT clause to the query. * - * @param string $query query to modify - * @param int $limit limit the number of rows - * @param int $offset start reading from given offset - * + * @param string $query query to modify + * @param int $limit limit the number of rows + * @param int $offset start reading from given offset * @return string the modified query */ public function modifyLimitQuery($query, $limit = false, $offset = false, $isManip = false) diff --git a/lib/Doctrine/Connection/Oracle/Exception.php b/lib/Doctrine/Connection/Oracle/Exception.php index 77c1577f2..adcb3fa7d 100644 --- a/lib/Doctrine/Connection/Oracle/Exception.php +++ b/lib/Doctrine/Connection/Oracle/Exception.php @@ -22,14 +22,9 @@ /** * Doctrine_Connection_Oracle_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @since 1.0 - * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org */ class Doctrine_Connection_Oracle_Exception extends Doctrine_Connection_Exception @@ -64,12 +59,9 @@ class Doctrine_Connection_Oracle_Exception extends Doctrine_Connection_Exception * converted into a portable code and then adds this * portable error code to $portableCode field. * - * @param array $errorInfo error info array - * - * @since 1.0 - * - * @return bool whether or not the error info processing was successfull - * (the process is successfull if portable error code was found) + * @param array $errorInfo error info array + * @return bool whether or not the error info processing was successfull + * (the process is successfull if portable error code was found) */ public function processErrorInfo(array $errorInfo) { diff --git a/lib/Doctrine/Connection/Pgsql.php b/lib/Doctrine/Connection/Pgsql.php index 0fa53589c..ac502a608 100644 --- a/lib/Doctrine/Connection/Pgsql.php +++ b/lib/Doctrine/Connection/Pgsql.php @@ -22,14 +22,10 @@ /** * Doctrine_Connection_Pgsql. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_Connection_Pgsql extends Doctrine_Connection_Common { @@ -117,11 +113,10 @@ public function convertBooleans($item) /** * Changes a query string for various DBMS specific reasons. * - * @param string $query query to modify - * @param int $limit limit the number of rows - * @param int $offset start reading from given offset - * @param bool $isManip if the query is a DML query - * + * @param string $query query to modify + * @param int $limit limit the number of rows + * @param int $offset start reading from given offset + * @param bool $isManip if the query is a DML query * @return string modified query */ public function modifyLimitQuery($query, $limit = false, $offset = false, $isManip = false) @@ -155,8 +150,7 @@ public function modifyLimitQuery($query, $limit = false, $offset = false, $isMan /** * return version information about the server. * - * @param string $native determines if the raw version string should be returned - * + * @param string $native determines if the raw version string should be returned * @return array|string an array or string with version information */ public function getServerVersion($native = false) @@ -195,9 +189,8 @@ public function getServerVersion($native = false) /** * Inserts a table row with specified data. * - * @param Doctrine_Table $table the table to insert data into - * - * @return int the number of affected rows. Boolean false if empty value array was given, + * @param Doctrine_Table $table the table to insert data into + * @return int the number of affected rows. Boolean false if empty value array was given, */ public function insert(Doctrine_Table $table, array $fields) { diff --git a/lib/Doctrine/Connection/Pgsql/Exception.php b/lib/Doctrine/Connection/Pgsql/Exception.php index 011c2804e..62cfd3c1e 100644 --- a/lib/Doctrine/Connection/Pgsql/Exception.php +++ b/lib/Doctrine/Connection/Pgsql/Exception.php @@ -22,17 +22,11 @@ /** * Doctrine_Connection_Pgsql_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org * * @author Konsta Vesterinen * @author Paul Cooper (PEAR MDB2 Pgsql driver) * @author Lukas Smith (PEAR MDB2 library) - * - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_Connection_Pgsql_Exception extends Doctrine_Connection_Exception { @@ -72,7 +66,6 @@ class Doctrine_Connection_Pgsql_Exception extends Doctrine_Connection_Exception * * @param array $errorInfo error info array * - * @since 1.0 * @see Doctrine_Core::ERR_* constants * @see Doctrine_Connection::$portableCode * diff --git a/lib/Doctrine/Connection/Profiler.php b/lib/Doctrine/Connection/Profiler.php index db4aec2aa..4226ff37f 100644 --- a/lib/Doctrine/Connection/Profiler.php +++ b/lib/Doctrine/Connection/Profiler.php @@ -23,12 +23,8 @@ * Doctrine_Connection_Profiler. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ */ class Doctrine_Connection_Profiler implements Doctrine_Overloadable, IteratorAggregate, Countable { diff --git a/lib/Doctrine/Connection/Profiler/Exception.php b/lib/Doctrine/Connection/Profiler/Exception.php index d446f08b1..8ae6ef395 100644 --- a/lib/Doctrine/Connection/Profiler/Exception.php +++ b/lib/Doctrine/Connection/Profiler/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine_Connection_Profiler_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 1345 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Connection/Sqlite.php b/lib/Doctrine/Connection/Sqlite.php index 1eb38a57b..efa8f155f 100644 --- a/lib/Doctrine/Connection/Sqlite.php +++ b/lib/Doctrine/Connection/Sqlite.php @@ -22,14 +22,10 @@ /** * Doctrine_Connection_Sqlite. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_Connection_Sqlite extends Doctrine_Connection_Common { diff --git a/lib/Doctrine/Connection/Sqlite/Exception.php b/lib/Doctrine/Connection/Sqlite/Exception.php index 658c7c2ad..9067e747b 100644 --- a/lib/Doctrine/Connection/Sqlite/Exception.php +++ b/lib/Doctrine/Connection/Sqlite/Exception.php @@ -22,14 +22,9 @@ /** * Doctrine_Connection_Sqlite_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @since 1.0 - * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org */ class Doctrine_Connection_Sqlite_Exception extends Doctrine_Connection_Exception @@ -60,7 +55,6 @@ class Doctrine_Connection_Sqlite_Exception extends Doctrine_Connection_Exception * * @param array $errorInfo error info array * - * @since 1.0 * @see Doctrine_Core::ERR_* constants * @see Doctrine_Connection::$portableCode * diff --git a/lib/Doctrine/Connection/Statement.php b/lib/Doctrine/Connection/Statement.php index 8a1a5afc5..330f8efb5 100644 --- a/lib/Doctrine/Connection/Statement.php +++ b/lib/Doctrine/Connection/Statement.php @@ -23,12 +23,8 @@ * Doctrine_Connection_Statement. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 1532 $ */ class Doctrine_Connection_Statement implements Doctrine_Adapter_Statement_Interface { @@ -94,13 +90,12 @@ public function getQuery() * bindColumn * Bind a column to a PHP variable. * - * @param mixed $column Number of the column (1-indexed) or name of the column in the result set. - * If using the column name, be aware that the name should match - * the case of the column, as returned by the driver. - * @param string $param name of the PHP variable to which the column will be bound - * @param int $type data type of the parameter, specified by the Doctrine_Core::PARAM_* constants - * - * @return bool Returns TRUE on success or FALSE on failure + * @param mixed $column Number of the column (1-indexed) or name of the column in the result set. + * If using the column name, be aware that the name should match + * the case of the column, as returned by the driver. + * @param string $param name of the PHP variable to which the column will be bound + * @param int $type data type of the parameter, specified by the Doctrine_Core::PARAM_* constants + * @return bool Returns TRUE on success or FALSE on failure */ public function bindColumn($column, $param, $type = null) { @@ -116,13 +111,12 @@ public function bindColumn($column, $param, $type = null) * Binds a value to a corresponding named or question mark * placeholder in the SQL statement that was use to prepare the statement. * - * @param mixed $param Parameter identifier. For a prepared statement using named placeholders, - * this will be a parameter name of the form :name. For a prepared statement - * using question mark placeholders, this will be the 1-indexed position of the parameter - * @param mixed $value the value to bind to the parameter - * @param int $type explicit data type for the parameter using the Doctrine_Core::PARAM_* constants - * - * @return bool returns TRUE on success or FALSE on failure + * @param mixed $param Parameter identifier. For a prepared statement using named placeholders, + * this will be a parameter name of the form :name. For a prepared statement + * using question mark placeholders, this will be the 1-indexed position of the parameter + * @param mixed $value the value to bind to the parameter + * @param int $type explicit data type for the parameter using the Doctrine_Core::PARAM_* constants + * @return bool returns TRUE on success or FALSE on failure */ public function bindValue($param, $value, $type = null) { @@ -145,14 +139,13 @@ public function bindValue($param, $value, $type = null) * of stored procedures that return data as output parameters, and some also as input/output * parameters that both send in data and are updated to receive it. * - * @param mixed $variable name of the PHP variable to bind to the SQL statement parameter - * @param int $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return - * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the - * Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter. - * @param int $length Length of the data type. To indicate that a parameter is an OUT parameter - * from a stored procedure, you must explicitly set the length. - * - * @return bool returns TRUE on success or FALSE on failure + * @param mixed $variable name of the PHP variable to bind to the SQL statement parameter + * @param int $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return + * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the + * Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter. + * @param int $length Length of the data type. To indicate that a parameter is an OUT parameter + * from a stored procedure, you must explicitly set the length. + * @return bool returns TRUE on success or FALSE on failure */ public function bindParam($column, &$variable, $type = null, $length = null, $driverOptions = array()) { @@ -223,10 +216,9 @@ public function errorInfo() * if any, of their associated parameter markers or pass an array of input-only * parameter values * - * @param array $params an array of values with as many elements as there are - * bound parameters in the SQL statement being executed - * - * @return bool returns TRUE on success or FALSE on failure + * @param array $params an array of values with as many elements as there are + * bound parameters in the SQL statement being executed + * @return bool returns TRUE on success or FALSE on failure */ public function execute($params = array()) { @@ -334,12 +326,11 @@ public function fetch( * fetchAll * Returns an array containing all of the result set rows. * - * @param int $fetchMode Controls how the next row will be returned to the caller. - * This value must be one of the Doctrine_Core::FETCH_* constants, - * defaulting to Doctrine_Core::FETCH_BOTH - * @param int $columnIndex Returns the indicated 0-indexed column when the value of $fetchStyle is - * Doctrine_Core::FETCH_COLUMN. Defaults to 0. - * + * @param int $fetchMode Controls how the next row will be returned to the caller. + * This value must be one of the Doctrine_Core::FETCH_* constants, + * defaulting to Doctrine_Core::FETCH_BOTH + * @param int $columnIndex Returns the indicated 0-indexed column when the value of $fetchStyle is + * Doctrine_Core::FETCH_COLUMN. Defaults to 0. * @return array */ public function fetchAll( @@ -372,10 +363,9 @@ public function fetchAll( * Returns a single column from the next row of a * result set or FALSE if there are no more rows. * - * @param int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no - * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() - * fetches the first column. - * + * @param int $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no + * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() + * fetches the first column. * @return string returns a single column in the next row of a result set */ public function fetchColumn($columnIndex = 0) @@ -390,11 +380,10 @@ public function fetchColumn($columnIndex = 0) * Fetches the next row and returns it as an object. This function is an alternative to * Doctrine_Adapter_Statement_Interface->fetch() with Doctrine_Core::FETCH_CLASS or Doctrine_Core::FETCH_OBJ style. * - * @param string $className name of the created class, defaults to stdClass - * @param array $args elements of this array are passed to the constructor - * - * @return mixed an instance of the required class with property names that correspond - * to the column names or FALSE in case of an error + * @param string $className name of the created class, defaults to stdClass + * @param array $args elements of this array are passed to the constructor + * @return mixed an instance of the required class with property names that correspond + * to the column names or FALSE in case of an error */ public function fetchObject($className = 'stdClass', $args = array()) { @@ -420,8 +409,7 @@ public function getAttribute($attribute) * getColumnMeta * Returns metadata for a column in a result set. * - * @param int $column the 0-indexed column in the result set - * + * @param int $column the 0-indexed column in the result set * @return array Associative meta data array with the following structure: * * native_type The PHP native type used to represent the column value. @@ -474,10 +462,9 @@ public function rowCount() * setAttribute * Set a statement attribute. * - * @param int $attribute - * @param mixed $value the value of given attribute - * - * @return bool returns TRUE on success or FALSE on failure + * @param int $attribute + * @param mixed $value the value of given attribute + * @return bool returns TRUE on success or FALSE on failure */ public function setAttribute($attribute, $value) { @@ -488,11 +475,10 @@ public function setAttribute($attribute, $value) * setFetchMode * Set the default fetch mode for this statement. * - * @param int $mode the fetch mode must be one of the Doctrine_Core::FETCH_* constants - * @param mixed|null $arg1 - * @param mixed|null $arg2 - * - * @return bool returns 1 on success or FALSE on failure + * @param int $mode the fetch mode must be one of the Doctrine_Core::FETCH_* constants + * @param mixed|null $arg1 + * @param mixed|null $arg2 + * @return bool returns 1 on success or FALSE on failure */ public function setFetchMode($mode, $arg1 = null, $arg2 = null) { diff --git a/lib/Doctrine/Connection/UnitOfWork.php b/lib/Doctrine/Connection/UnitOfWork.php index bdda47b5e..fbb0a359a 100644 --- a/lib/Doctrine/Connection/UnitOfWork.php +++ b/lib/Doctrine/Connection/UnitOfWork.php @@ -28,12 +28,7 @@ * * Referential integrity is currently not always ensured. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7684 $ * * @author Konsta Vesterinen * @author Roman Borschel @@ -284,8 +279,7 @@ private function _executeDeletions(array $deletions) * Builds the SQL condition to target multiple records who have a single-column * primary key. * - * @param int $numRecords the number of records that are going to be deleted - * + * @param int $numRecords the number of records that are going to be deleted * @return string The SQL condition "pk = ? OR pk = ? OR pk = ? ..." */ private function _buildSqlSingleKeyCondition($columnNames, $numRecords) @@ -298,8 +292,7 @@ private function _buildSqlSingleKeyCondition($columnNames, $numRecords) /** * Builds the SQL condition to target multiple records who have a composite primary key. * - * @param int $numRecords the number of records that are going to be deleted - * + * @param int $numRecords the number of records that are going to be deleted * @return string The SQL condition "(pk1 = ? AND pk2 = ?) OR (pk1 = ? AND pk2 = ?) ..." */ private function _buildSqlCompositeKeyCondition($columnNames, $numRecords) @@ -327,7 +320,6 @@ private function _buildSqlCompositeKeyCondition($columnNames, $numRecords) * make sure we have all of them. * * @param Doctrine_Record the record for which the delete operation will be cascaded - * * @throws PDOException If something went wrong at database level */ protected function _cascadeDelete(Doctrine_Record $record, array &$deletions) @@ -508,9 +500,8 @@ public function saveAll() /** * updates given record. * - * @param Doctrine_Record $record record to be updated - * - * @return bool whether or not the update was successful + * @param Doctrine_Record $record record to be updated + * @return bool whether or not the update was successful */ public function update(Doctrine_Record $record) { @@ -645,8 +636,7 @@ public function processSingleInsert(Doctrine_Record $record) * 'correct' order. Basically this means that the records of those * components can be saved safely in the order specified by the returned array. * - * @param array $tables an array of Doctrine_Table objects or component names - * + * @param array $tables an array of Doctrine_Table objects or component names * @return array an array of component names in flushing order */ public function buildFlushTree(array $tables) diff --git a/lib/Doctrine/Core.php b/lib/Doctrine/Core.php index 4674e8aa8..99ef76188 100644 --- a/lib/Doctrine/Core.php +++ b/lib/Doctrine/Core.php @@ -24,12 +24,8 @@ * * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ */ class Doctrine_Core { @@ -727,9 +723,8 @@ public static function loadModels($directory, $modelLoading = null, $classPrefix * If you do not specify $classes it will return all of the currently loaded Doctrine_Records * * @param classes Array of classes to filter through, otherwise uses get_declared_classes() - * @param mixed|null $classes - * - * @return array $loadedModels + * @param mixed|null $classes + * @return array $loadedModels */ public static function getLoadedModels($classes = null) { @@ -747,9 +742,8 @@ public static function getLoadedModels($classes = null) * the models generated by Doctrine generators and add them to the $models * array. * - * @param string $models - * - * @return array $models + * @param string $models + * @return array $models */ public static function initializeModels($models) { @@ -783,7 +777,6 @@ public static function initializeModels($models) * This will inflect the class, causing it to be loaded in to memory. * * @param classes Array of classes to filter through, otherwise uses get_declared_classes() - * * @return array $loadedModels */ public static function filterInvalidModels($classes) @@ -803,8 +796,7 @@ public static function filterInvalidModels($classes) * Checks if what is passed is a valid Doctrine_Record * Will load class in to memory in order to inflect it and find out information about the class. * - * @param mixed $class Can be a string named after the class, an instance of the class, or an instance of the class reflected - * + * @param mixed $class Can be a string named after the class, an instance of the class, or an instance of the class reflected * @return bool */ public static function isValidModelClass($class) @@ -833,8 +825,7 @@ public static function isValidModelClass($class) * Get the connection object for a table by the actual table name * FIXME: I think this method is flawed because a individual connections could have the same table name. * - * @param string $tableName - * + * @param string $tableName * @return Doctrine_Connection */ public static function getConnectionByTableName($tableName) @@ -855,12 +846,10 @@ public static function getConnectionByTableName($tableName) /** * Method for importing existing schema to Doctrine_Record classes. * - * @param string $directory Directory to write your models to - * @param array $connections Array of connection names to generate models for - * @param array $options Array of options - * + * @param string $directory Directory to write your models to + * @param array $connections Array of connection names to generate models for + * @param array $options Array of options * @return bool - * * @throws Exception */ public static function generateModelsFromDb($directory, array $connections = array(), array $options = array()) @@ -934,8 +923,7 @@ public static function createTablesFromArray($array) /** * Generate a array of sql for the passed array of models. * - * @param array $array - * + * @param array $array * @return array $sql */ public static function generateSqlFromArray($array) @@ -947,8 +935,7 @@ public static function generateSqlFromArray($array) * Generate a sql string to create the tables from all loaded models * or the models found in the passed directory. * - * @param string $directory - * + * @param string $directory * @return string $build String of sql queries. One query per line */ public static function generateSqlFromModels($directory = null) @@ -1027,12 +1014,10 @@ public static function loadData($yamlPath, $append = false, $charset = 'UTF-8') /** * Migrate database to specified $to version. Migrates from current to latest if you do not specify. * - * @param string $migrationsPath Path to migrations directory which contains your migration classes - * @param string $to version you wish to migrate to - * - * @return bool true - * - * @throws new Doctrine_Migration_Exception + * @param string $migrationsPath Path to migrations directory which contains your migration classes + * @param string $to version you wish to migrate to + * @return bool true + * @throws new Doctrine_Migration_Exception */ public static function migrate($migrationsPath, $to = null) { @@ -1057,9 +1042,8 @@ public static function generateMigrationClass($className, $migrationsPath) /** * Generate a set of migration classes from an existing database. * - * @param string $migrationsPath - * - * @throws new Doctrine_Migration_Exception + * @param string $migrationsPath + * @throws new Doctrine_Migration_Exception */ public static function generateMigrationsFromDb($migrationsPath) { @@ -1086,11 +1070,10 @@ public static function generateMigrationsFromModels($migrationsPath, $modelsPath * Generate a set of migration classes by generating differences between two sets * of schema information. * - * @param string $migrationsPath Path to your Doctrine migration classes - * @param string $from From schema information - * @param string $to To schema information - * - * @return array $changes + * @param string $migrationsPath Path to your Doctrine migration classes + * @param string $from From schema information + * @param string $to To schema information + * @return array $changes */ public static function generateMigrationsFromDiff($migrationsPath, $from, $to) { @@ -1102,8 +1085,7 @@ public static function generateMigrationsFromDiff($migrationsPath, $from, $to) /** * Get the Doctrine_Table object for the passed model. * - * @param string $componentName - * + * @param string $componentName * @return Doctrine_Table */ public static function getTable($componentName) @@ -1116,9 +1098,8 @@ public static function getTable($componentName) * including the compiled file instead of multiple files (in worst * cases dozens of files) can improve performance by an order of magnitude. * - * @param string $target - * @param array $includedDrivers - * + * @param string $target + * @param array $includedDrivers * @throws Doctrine_Exception */ public static function compile($target = null, $includedDrivers = array()) @@ -1130,8 +1111,7 @@ public static function compile($target = null, $includedDrivers = array()) * simple autoload function * returns true if the class was loaded, otherwise false. * - * @param string $className - * + * @param string $className * @return bool */ public static function autoload($className) @@ -1187,8 +1167,7 @@ public static function modelsAutoload($className) /** * Load classes from the Doctrine extensions directory/path. * - * @param string $className - * + * @param string $className * @return bool */ public static function extensionsAutoload($className) @@ -1217,10 +1196,9 @@ public static function extensionsAutoload($className) /** * dumps a given variable. * - * @param mixed $var a variable of any type - * @param bool $output whether to output the content - * @param string $indent indention string - * + * @param mixed $var a variable of any type + * @param bool $output whether to output the content + * @param string $indent indention string * @return void|string */ public static function dump($var, $output = true, $indent = '') diff --git a/lib/Doctrine/Data.php b/lib/Doctrine/Data.php index 46cc8d210..06566cee6 100644 --- a/lib/Doctrine/Data.php +++ b/lib/Doctrine/Data.php @@ -26,12 +26,8 @@ * Support formats are based on what formats are available in Doctrine_Parser such as yaml, xml, json, etc. * * @author Jonathan H. Wage - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 2552 $ */ class Doctrine_Data { @@ -161,9 +157,8 @@ public function getModels() * * Set/Get whether or not to export individual files * - * @param mixed|null $bool - * - * @return bool $_exportIndividualFiles + * @param mixed|null $bool + * @return bool $_exportIndividualFiles */ public function exportIndividualFiles($bool = null) { diff --git a/lib/Doctrine/Data/Exception.php b/lib/Doctrine/Data/Exception.php index 42cc76309..91a922f28 100644 --- a/lib/Doctrine/Data/Exception.php +++ b/lib/Doctrine/Data/Exception.php @@ -23,12 +23,8 @@ * Doctrine_Data_Exception. * * @author Jonathan H. Wage - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 2552 $ */ class Doctrine_Data_Exception extends Doctrine_Exception { diff --git a/lib/Doctrine/Data/Export.php b/lib/Doctrine/Data/Export.php index 9966c05c1..53da48080 100644 --- a/lib/Doctrine/Data/Export.php +++ b/lib/Doctrine/Data/Export.php @@ -23,12 +23,8 @@ * Doctrine_Data_Export. * * @author Jonathan H. Wage - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 2552 $ */ class Doctrine_Data_Export extends Doctrine_Data { @@ -139,8 +135,7 @@ public function dumpData(array $data) * * Prepare the raw data to be exported with the parser * - * @param string $data - * + * @param string $data * @return array */ public function prepareData($data) diff --git a/lib/Doctrine/Data/Import.php b/lib/Doctrine/Data/Import.php index d3436c1c1..d836fc4af 100644 --- a/lib/Doctrine/Data/Import.php +++ b/lib/Doctrine/Data/Import.php @@ -23,12 +23,8 @@ * Doctrine_Data_Import. * * @author Jonathan H. Wage - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 2552 $ */ class Doctrine_Data_Import extends Doctrine_Data { @@ -169,12 +165,10 @@ protected function _buildNestedSetRows($className, $data) * Get the unsaved object for a specified row key and validate that it is the valid object class * for the passed record and relation name. * - * @param string $rowKey - * @param string $relationName - * @param string $referringRowKey - * + * @param string $rowKey + * @param string $relationName + * @param string $referringRowKey * @return Doctrine_Record - * * @throws Doctrine_Data_Exception */ protected function _getImportedObject($rowKey, Doctrine_Record $record, $relationName, $referringRowKey) diff --git a/lib/Doctrine/DataDict.php b/lib/Doctrine/DataDict.php index 25bca80a8..4a82f76f1 100644 --- a/lib/Doctrine/DataDict.php +++ b/lib/Doctrine/DataDict.php @@ -22,12 +22,7 @@ /** * Doctrine_DataDict. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) @@ -39,8 +34,7 @@ class Doctrine_DataDict extends Doctrine_Connection_Module * parses a literal boolean value and returns * proper sql equivalent. * - * @param string $value boolean value to be parsed - * + * @param string $value boolean value to be parsed * @return string parsed boolean value */ public function parseBoolean($value) diff --git a/lib/Doctrine/DataDict/Exception.php b/lib/Doctrine/DataDict/Exception.php index edfad298c..4e4efc3ba 100644 --- a/lib/Doctrine/DataDict/Exception.php +++ b/lib/Doctrine/DataDict/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine_DataDict_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/DataDict/Mssql.php b/lib/Doctrine/DataDict/Mssql.php index 762badac8..9a641b3b4 100644 --- a/lib/Doctrine/DataDict/Mssql.php +++ b/lib/Doctrine/DataDict/Mssql.php @@ -20,16 +20,12 @@ */ /** - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * @author Frank M. Kromann (PEAR MDB2 Mssql driver) * @author David Coallier (PEAR MDB2 Mssql driver) * - * @version $Revision: 7660 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_DataDict_Mssql extends Doctrine_DataDict { @@ -52,7 +48,6 @@ class Doctrine_DataDict_Mssql extends Doctrine_DataDict * notnull * Boolean flag that indicates whether this field is constrained * to not be set to null. - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ @@ -123,8 +118,7 @@ public function getNativeDeclaration($field) /** * Maps a native array description of a field to a MDB2 datatype and length. * - * @param array $field native field description - * + * @param array $field native field description * @return array containing the various possible types, length, sign, fixed */ public function getPortableDeclaration($field) @@ -240,7 +234,6 @@ public function getPortableDeclaration($field) * notnull * Boolean flag that indicates whether this field is * constrained to not be set to null. - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ diff --git a/lib/Doctrine/DataDict/Mysql.php b/lib/Doctrine/DataDict/Mysql.php index 067a26171..f7b5f4ac5 100644 --- a/lib/Doctrine/DataDict/Mysql.php +++ b/lib/Doctrine/DataDict/Mysql.php @@ -20,14 +20,10 @@ */ /** - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @version $Revision: 7635 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_DataDict_Mysql extends Doctrine_DataDict { @@ -127,7 +123,6 @@ class Doctrine_DataDict_Mysql extends Doctrine_DataDict * notnull * Boolean flag that indicates whether this field is constrained * to not be set to null. - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ @@ -269,8 +264,7 @@ public function getNativeDeclaration($field) /** * Maps a native array description of a field to a MDB2 datatype and length. * - * @param array $field native field description - * + * @param array $field native field description * @return array containing the various possible types, length, sign, fixed */ public function getPortableDeclaration(array $field) @@ -461,8 +455,7 @@ public function getPortableDeclaration(array $field) * Obtain DBMS specific SQL code portion needed to set the CHARACTER SET * of a field declaration to be used in statements like CREATE TABLE. * - * @param string $charset name of the charset - * + * @param string $charset name of the charset * @return string DBMS specific SQL code portion needed to set the CHARACTER SET * of a field declaration */ @@ -475,8 +468,7 @@ public function getCharsetFieldDeclaration($charset) * Obtain DBMS specific SQL code portion needed to set the COLLATION * of a field declaration to be used in statements like CREATE TABLE. * - * @param string $collation name of the collation - * + * @param string $collation name of the collation * @return string DBMS specific SQL code portion needed to set the COLLATION * of a field declaration */ @@ -507,7 +499,6 @@ public function getCollationFieldDeclaration($collation) * notnull * Boolean flag that indicates whether this field is * constrained to not be set to null. - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ diff --git a/lib/Doctrine/DataDict/Oracle.php b/lib/Doctrine/DataDict/Oracle.php index b7efae5f9..00fec49ff 100644 --- a/lib/Doctrine/DataDict/Oracle.php +++ b/lib/Doctrine/DataDict/Oracle.php @@ -20,13 +20,9 @@ */ /** - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_DataDict_Oracle extends Doctrine_DataDict { @@ -49,7 +45,6 @@ class Doctrine_DataDict_Oracle extends Doctrine_DataDict * notnull * Boolean flag that indicates whether this field is constrained * to not be set to null. - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ @@ -129,10 +124,8 @@ public function getNativeDeclaration(array $field) /** * Maps a native array description of a field to a doctrine datatype and length. * - * @param array $field native field description - * - * @return array containing the various possible types, length, sign, fixed - * + * @param array $field native field description + * @return array containing the various possible types, length, sign, fixed * @throws Doctrine_DataDict_Oracle_Exception */ public function getPortableDeclaration(array $field) diff --git a/lib/Doctrine/DataDict/Pgsql.php b/lib/Doctrine/DataDict/Pgsql.php index c8a554bc5..5a47f08c0 100644 --- a/lib/Doctrine/DataDict/Pgsql.php +++ b/lib/Doctrine/DataDict/Pgsql.php @@ -20,15 +20,11 @@ */ /** - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Paul Cooper * @author Lukas Smith (PEAR MDB2 library) * - * @version $Revision: 7641 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_DataDict_Pgsql extends Doctrine_DataDict { @@ -353,7 +349,6 @@ class Doctrine_DataDict_Pgsql extends Doctrine_DataDict * notnull * Boolean flag that indicates whether this field is constrained * to not be set to null. - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ @@ -445,8 +440,7 @@ public function getNativeDeclaration(array $field) /** * Maps a native array description of a field to a portable Doctrine datatype and length. * - * @param array $field native field description - * + * @param array $field native field description * @return array containing the various possible types, length, sign, fixed */ public function getPortableDeclaration(array $field) @@ -642,7 +636,6 @@ public function getPortableDeclaration(array $field) * notnull * Boolean flag that indicates whether this field is constrained * to not be set to null. - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ @@ -686,8 +679,7 @@ public function getIntegerDeclaration($name, $field) * parses a literal boolean value and returns * proper sql equivalent. * - * @param string $value boolean value to be parsed - * + * @param string $value boolean value to be parsed * @return string parsed boolean value */ public function parseBoolean($value) diff --git a/lib/Doctrine/DataDict/Sqlite.php b/lib/Doctrine/DataDict/Sqlite.php index a4cef8016..d5b7bdf59 100644 --- a/lib/Doctrine/DataDict/Sqlite.php +++ b/lib/Doctrine/DataDict/Sqlite.php @@ -20,14 +20,10 @@ */ /** - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * - * @version $Revision: 7490 $ - * * @see www.doctrine-project.org - * @since 1.0 */ class Doctrine_DataDict_Sqlite extends Doctrine_DataDict { @@ -135,8 +131,7 @@ public function getNativeDeclaration(array $field) /** * Maps a native array description of a field to Doctrine datatype and length. * - * @param array $field native field description - * + * @param array $field native field description * @return array containing the various possible types, length, sign, fixed */ public function getPortableDeclaration(array $field) @@ -295,7 +290,6 @@ public function getPortableDeclaration(array $field) * notnull * Boolean flag that indicates whether this field is * constrained to not be set to null. - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ diff --git a/lib/Doctrine/Event.php b/lib/Doctrine/Event.php index af5a32faa..ef12ffcd3 100644 --- a/lib/Doctrine/Event.php +++ b/lib/Doctrine/Event.php @@ -23,12 +23,8 @@ * Doctrine_Event. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ */ class Doctrine_Event { @@ -252,9 +248,8 @@ public function skipOperation() * setOption * sets the value of an option. * - * @param string $option the name of the option - * @param mixed $value the value of the given option - * + * @param string $option the name of the option + * @param mixed $value the value of the given option * @return Doctrine_Event this object */ public function __set($option, $value) @@ -268,9 +263,8 @@ public function __set($option, $value) * setOption * sets the value of an option by reference. * - * @param string $option the name of the option - * @param mixed $value the value of the given option - * + * @param string $option the name of the option + * @param mixed $value the value of the given option * @return Doctrine_Event this object */ public function set($option, &$value) diff --git a/lib/Doctrine/EventListener.php b/lib/Doctrine/EventListener.php index 5b15e0c29..0bc908781 100644 --- a/lib/Doctrine/EventListener.php +++ b/lib/Doctrine/EventListener.php @@ -24,12 +24,8 @@ * the empty methods allow child classes to only implement the methods they need to implement. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_EventListener implements Doctrine_EventListener_Interface { diff --git a/lib/Doctrine/EventListener/Chain.php b/lib/Doctrine/EventListener/Chain.php index 468b9796d..910cc71e6 100644 --- a/lib/Doctrine/EventListener/Chain.php +++ b/lib/Doctrine/EventListener/Chain.php @@ -25,12 +25,8 @@ * useful for having multiple listeners listening the events at the same time. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_EventListener_Chain extends Doctrine_Access implements Doctrine_EventListener_Interface { diff --git a/lib/Doctrine/EventListener/Exception.php b/lib/Doctrine/EventListener/Exception.php index 4c463e852..ecc42990f 100644 --- a/lib/Doctrine/EventListener/Exception.php +++ b/lib/Doctrine/EventListener/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine_EventListener_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 1344 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/EventListener/Interface.php b/lib/Doctrine/EventListener/Interface.php index bc8488f18..c3c937949 100644 --- a/lib/Doctrine/EventListener/Interface.php +++ b/lib/Doctrine/EventListener/Interface.php @@ -24,12 +24,8 @@ * the empty methods allow child classes to only implement the methods they need to implement. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ interface Doctrine_EventListener_Interface { diff --git a/lib/Doctrine/Exception.php b/lib/Doctrine/Exception.php index 84c10f097..6cedb2a57 100644 --- a/lib/Doctrine/Exception.php +++ b/lib/Doctrine/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ @@ -77,9 +72,8 @@ class Doctrine_Exception extends Exception * @param int|array integer error code, * null to get the current error code-message map, * or an array with a new error code-message map - * @param mixed|null $value - * - * @return string error message + * @param mixed|null $value + * @return string error message */ public function errorMessage($value = null) { diff --git a/lib/Doctrine/Export.php b/lib/Doctrine/Export.php index 68d6b591a..22d0b60a2 100644 --- a/lib/Doctrine/Export.php +++ b/lib/Doctrine/Export.php @@ -24,12 +24,8 @@ * * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7653 $ */ class Doctrine_Export extends Doctrine_Connection_Module { @@ -71,8 +67,7 @@ public function dropDatabaseSql($database) * dropTableSql * drop an existing table. * - * @param string $table name of table that should be dropped from the database - * + * @param string $table name of table that should be dropped from the database * @return string */ public function dropTableSql($table) @@ -105,9 +100,8 @@ public function dropIndex($table, $name) /** * dropIndexSql. * - * @param string $table name of table that should be used in method - * @param string $name name of the index to be dropped - * + * @param string $table name of table that should be used in method + * @param string $name name of the index to be dropped * @return string SQL that is used for dropping an index */ public function dropIndexSql($table, $name) @@ -148,8 +142,7 @@ public function dropForeignKey($table, $name) * drop existing sequence * (this method is implemented by the drivers). * - * @param string $sequenceName name of the sequence to be dropped - * + * @param string $sequenceName name of the sequence to be dropped * @throws Doctrine_Connection_Exception if something fails at database level */ public function dropSequence($sequenceName) @@ -161,8 +154,7 @@ public function dropSequence($sequenceName) * dropSequenceSql * drop existing sequence. * - * @param string $sequenceName name of the sequence to be dropped - * + * @param string $sequenceName name of the sequence to be dropped * @throws Doctrine_Connection_Exception if something fails at database level */ public function dropSequenceSql($sequenceName) @@ -193,29 +185,28 @@ public function createDatabaseSql($database) /** * create a new table. * - * @param string $name Name of the database that should be created - * @param array $fields Associative array that contains the definition of each field of the new table - * The indexes of the array entries are the names of the fields of the table an - * the array entry values are associative arrays like those that are meant to be - * passed with the field definitions to get[Type]Declaration() functions. - * array( - * 'id' => array( - * 'type' => 'integer', - * 'unsigned' => 1 - * 'notnull' => 1 - * 'default' => 0 - * ), - * 'name' => array( - * 'type' => 'text', - * 'length' => 12 - * ), - * 'password' => array( - * 'type' => 'text', - * 'length' => 12 - * ) - * ); - * @param array $options An associative array of table options: - * + * @param string $name Name of the database that should be created + * @param array $fields Associative array that contains the definition of each field of the new table + * The indexes of the array entries are the names of the fields of the table an + * the array entry values are associative arrays like those that are meant to be + * passed with the field definitions to get[Type]Declaration() functions. + * array( + * 'id' => array( + * 'type' => 'integer', + * 'unsigned' => 1 + * 'notnull' => 1 + * 'default' => 0 + * ), + * 'name' => array( + * 'type' => 'text', + * 'length' => 12 + * ), + * 'password' => array( + * 'type' => 'text', + * 'length' => 12 + * ) + * ); + * @param array $options An associative array of table options: * @return string */ public function createTableSql($name, array $fields, array $options = array()) @@ -302,15 +293,14 @@ public function createTable($name, array $fields, array $options = array()) /** * create sequence. * - * @param string $seqName name of the sequence to be created - * @param string $start start value of the sequence; default is 1 - * @param array $options An associative array of table options: - * array( - * 'comment' => 'Foo', - * 'charset' => 'utf8', - * 'collate' => 'utf8_unicode_ci', - * ); - * + * @param string $seqName name of the sequence to be created + * @param string $start start value of the sequence; default is 1 + * @param array $options An associative array of table options: + * array( + * 'comment' => 'Foo', + * 'charset' => 'utf8', + * 'collate' => 'utf8_unicode_ci', + * ); * @throws Doctrine_Connection_Exception if something fails at database level */ public function createSequence($seqName, $start = 1, array $options = array()) @@ -322,17 +312,15 @@ public function createSequence($seqName, $start = 1, array $options = array()) * return RDBMS specific create sequence statement * (this method is implemented by the drivers). * - * @param string $seqName name of the sequence to be created - * @param string $start start value of the sequence; default is 1 - * @param array $options An associative array of table options: - * array( - * 'comment' => 'Foo', - * 'charset' => 'utf8', - * 'collate' => 'utf8_unicode_ci', - * ); - * + * @param string $seqName name of the sequence to be created + * @param string $start start value of the sequence; default is 1 + * @param array $options An associative array of table options: + * array( + * 'comment' => 'Foo', + * 'charset' => 'utf8', + * 'collate' => 'utf8_unicode_ci', + * ); * @return string - * * @throws Doctrine_Connection_Exception if something fails at database level */ public function createSequenceSql($seqName, $start = 1, array $options = array()) @@ -484,9 +472,8 @@ public function createIndexSql($table, $name, array $definition) /** * createForeignKeySql. * - * @param string $table name of the table on which the foreign key is to be created - * @param array $definition associative array that defines properties of the foreign key to be created - * + * @param string $table name of the table on which the foreign key is to be created + * @param array $definition associative array that defines properties of the foreign key to be created * @return string */ public function createForeignKeySql($table, array $definition) @@ -499,9 +486,8 @@ public function createForeignKeySql($table, array $definition) /** * createForeignKey. * - * @param string $table name of the table on which the foreign key is to be created - * @param array $definition associative array that defines properties of the foreign key to be created - * + * @param string $table name of the table on which the foreign key is to be created + * @param array $definition associative array that defines properties of the foreign key to be created * @return string */ public function createForeignKey($table, array $definition) @@ -589,7 +575,6 @@ public function alterTableSql($name, array $changes, $check = false) * Text value with the default COLLATION for this field. * unique * unique constraint - * * @return string */ public function getFieldDeclarationList(array $fields) @@ -635,7 +620,6 @@ public function getFieldDeclarationList(array $fields) * * check * column check constraint - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ @@ -677,8 +661,7 @@ public function getDeclaration($name, array $field) * Obtain DBMS specific SQL code portion needed to set a default value * declaration to be used in statements like CREATE TABLE. * - * @param array $field field definition array - * + * @param array $field field definition array * @return string DBMS specific SQL code portion needed to set a default value */ public function getDefaultFieldDeclaration($field) @@ -723,8 +706,7 @@ public function getNotNullFieldDeclaration(array $definition) * Obtain DBMS specific SQL code portion needed to set a CHECK constraint * declaration to be used in statements like CREATE TABLE. * - * @param array $definition check definition - * + * @param array $definition check definition * @return string DBMS specific SQL code portion needed to set a CHECK constraint */ public function getCheckDeclaration(array $definition) @@ -751,9 +733,8 @@ public function getCheckDeclaration(array $definition) * Obtain DBMS specific SQL code portion needed to set an index * declaration to be used in statements like CREATE TABLE. * - * @param string $name name of the index - * @param array $definition index definition - * + * @param string $name name of the index + * @param array $definition index definition * @return string DBMS specific SQL code portion needed to set an index */ public function getIndexDeclaration($name, array $definition) @@ -858,7 +839,6 @@ public function getTemporaryTableQuery() * omitting the ON DELETE or ON UPDATE clause. * * SET DEFAULT - * * @return string DBMS specific SQL code portion needed to set the FOREIGN KEY constraint * of a field declaration */ @@ -875,8 +855,7 @@ public function getForeignKeyDeclaration(array $definition) * Return the FOREIGN KEY query section dealing with non-standard options * as MATCH, INITIALLY DEFERRED, ON UPDATE, ... * - * @param array $definition foreign key definition - * + * @param array $definition foreign key definition * @return string */ public function getAdvancedForeignKeyOptions(array $definition) @@ -900,7 +879,6 @@ public function getAdvancedForeignKeyOptions(array $definition) * * @param string $action foreign key referential action * @param string foreign key referential action in uppercase - * * @throws Doctrine_Exception_Exception if unknown referential action given */ public function getForeignKeyReferentialAction($action) @@ -975,8 +953,7 @@ public function getUniqueFieldDeclaration() * Obtain DBMS specific SQL code portion needed to set the CHARACTER SET * of a field declaration to be used in statements like CREATE TABLE. * - * @param string $charset name of the charset - * + * @param string $charset name of the charset * @return string DBMS specific SQL code portion needed to set the CHARACTER SET * of a field declaration */ @@ -989,8 +966,7 @@ public function getCharsetFieldDeclaration($charset) * Obtain DBMS specific SQL code portion needed to set the COLLATION * of a field declaration to be used in statements like CREATE TABLE. * - * @param string $collation name of the collation - * + * @param string $collation name of the collation * @return string DBMS specific SQL code portion needed to set the COLLATION * of a field declaration */ @@ -1009,8 +985,7 @@ public function getCollationFieldDeclaration($collation) * Then it iterates through all declared classes and creates tables for the ones * that extend Doctrine_Record and are not abstract classes * - * @param string $directory optional directory parameter - * + * @param string $directory optional directory parameter * @throws Doctrine_Connection_Exception if some error other than Doctrine_Core::ERR_ALREADY_EXISTS * occurred during the create table operation */ @@ -1209,9 +1184,8 @@ public function exportClassesSql(array $classes) /** * fetches all generators recursively for given table. * - * @param Doctrine_Table $table table object to retrieve the generators from - * - * @return array an array of Doctrine_Record_Generator objects + * @param Doctrine_Table $table table object to retrieve the generators from + * @return array an array of Doctrine_Record_Generator objects */ public function getAllGenerators(Doctrine_Table $table) { @@ -1238,9 +1212,8 @@ public function getAllGenerators(Doctrine_Table $table) * exportGeneratorsSql * exports plugin tables for given table. * - * @param Doctrine_Table $table the table in which the generators belong to - * - * @return array an array of sql strings + * @param Doctrine_Table $table the table in which the generators belong to + * @return array an array of sql strings */ public function exportGeneratorsSql(Doctrine_Table $table) { @@ -1272,8 +1245,7 @@ public function exportGeneratorsSql(Doctrine_Table $table) * Then it iterates through all declared classes and creates tables for the ones * that extend Doctrine_Record and are not abstract classes * - * @param string $directory optional directory parameter - * + * @param string $directory optional directory parameter * @throws Doctrine_Connection_Exception if some error other than Doctrine_Core::ERR_ALREADY_EXISTS * occurred during the create table operation */ @@ -1292,9 +1264,8 @@ public function exportSql($directory = null) * exportTable * exports given table into database based on column and option definitions. * - * @return bool whether or not the export operation was successful - * false if table already existed in the database - * + * @return bool whether or not the export operation was successful + * false if table already existed in the database * @throws Doctrine_Connection_Exception if some error other than Doctrine_Core::ERR_ALREADY_EXISTS * occurred during the create table operation */ diff --git a/lib/Doctrine/Export/Exception.php b/lib/Doctrine/Export/Exception.php index 7a3926ac7..1c29cf93c 100644 --- a/lib/Doctrine/Export/Exception.php +++ b/lib/Doctrine/Export/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine_Export_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Export/Mssql.php b/lib/Doctrine/Export/Mssql.php index 521813f18..448dc36f8 100644 --- a/lib/Doctrine/Export/Mssql.php +++ b/lib/Doctrine/Export/Mssql.php @@ -25,12 +25,8 @@ * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) * @author Frank M. Kromann (PEAR MDB2 Mssql driver) - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7660 $ */ class Doctrine_Export_Mssql extends Doctrine_Export { @@ -263,15 +259,14 @@ public function alterTable($name, array $changes, $check = false) /** * create sequence. * - * @param string $seqName name of the sequence to be created - * @param string $start start value of the sequence; default is 1 - * @param array $options An associative array of table options: - * array( - * 'comment' => 'Foo', - * 'charset' => 'utf8', - * 'collate' => 'utf8_unicode_ci', - * ); - * + * @param string $seqName name of the sequence to be created + * @param string $start start value of the sequence; default is 1 + * @param array $options An associative array of table options: + * array( + * 'comment' => 'Foo', + * 'charset' => 'utf8', + * 'collate' => 'utf8_unicode_ci', + * ); * @return string */ public function createSequence($seqName, $start = 1, array $options = array()) @@ -313,29 +308,28 @@ public function dropSequenceSql($seqName) /** * create a new table. * - * @param string $name Name of the database that should be created - * @param array $fields Associative array that contains the definition of each field of the new table - * The indexes of the array entries are the names of the fields of the table an - * the array entry values are associative arrays like those that are meant to be - * passed with the field definitions to get[Type]Declaration() functions. - * array( - * 'id' => array( - * 'type' => 'integer', - * 'unsigned' => 1 - * 'notnull' => 1 - * 'default' => 0 - * ), - * 'name' => array( - * 'type' => 'text', - * 'length' => 12 - * ), - * 'password' => array( - * 'type' => 'text', - * 'length' => 12 - * ) - * ); - * @param array $options An associative array of table options: - * + * @param string $name Name of the database that should be created + * @param array $fields Associative array that contains the definition of each field of the new table + * The indexes of the array entries are the names of the fields of the table an + * the array entry values are associative arrays like those that are meant to be + * passed with the field definitions to get[Type]Declaration() functions. + * array( + * 'id' => array( + * 'type' => 'integer', + * 'unsigned' => 1 + * 'notnull' => 1 + * 'default' => 0 + * ), + * 'name' => array( + * 'type' => 'text', + * 'length' => 12 + * ), + * 'password' => array( + * 'type' => 'text', + * 'length' => 12 + * ) + * ); + * @param array $options An associative array of table options: * @return string */ public function createTableSql($name, array $fields, array $options = array()) @@ -421,8 +415,7 @@ public function getNotNullFieldDeclaration(array $definition) /** * @see Doctrine_Export::getDefaultFieldDeclaration * - * @param array $field field definition array - * + * @param array $field field definition array * @return string DBMS specific SQL code portion needed to set a default value */ public function getDefaultFieldDeclaration($field) diff --git a/lib/Doctrine/Export/Mysql.php b/lib/Doctrine/Export/Mysql.php index c7be961f8..2bb73ce0c 100644 --- a/lib/Doctrine/Export/Mysql.php +++ b/lib/Doctrine/Export/Mysql.php @@ -24,12 +24,8 @@ * * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7653 $ */ class Doctrine_Export_Mysql extends Doctrine_Export { @@ -66,8 +62,7 @@ public function createDatabaseSql($name) /** * drop an existing database. * - * @param string $name name of the database that should be dropped - * + * @param string $name name of the database that should be dropped * @return string */ public function dropDatabaseSql($name) @@ -252,7 +247,6 @@ public function createTableSql($name, array $fields, array $options = array()) * unique constraint * check * column check constraint - * * @return string DBMS specific SQL code portion that should be used to * declare the specified field */ @@ -311,10 +305,9 @@ public function getDeclaration($name, array $field) * should be set to another associative array with the properties * of the fields to be added. The properties of the fields should * be the same as defined by the Metabase parser. - * @param bool $check indicates whether the function should just check if the DBMS driver - * can perform the requested table alterations if the value is true or - * actually perform them otherwise - * + * @param bool $check indicates whether the function should just check if the DBMS driver + * can perform the requested table alterations if the value is true or + * actually perform them otherwise * @return bool */ public function alterTableSql($name, array $changes, $check = false) @@ -412,16 +405,15 @@ public function alterTableSql($name, array $changes, $check = false) /** * create sequence. * - * @param string $sequenceName name of the sequence to be created - * @param string $start start value of the sequence; default is 1 - * @param array $options An associative array of table options: - * array( - * 'comment' => 'Foo', - * 'charset' => 'utf8', - * 'collate' => 'utf8_unicode_ci', - * 'type' => 'innodb', - * ); - * + * @param string $sequenceName name of the sequence to be created + * @param string $start start value of the sequence; default is 1 + * @param array $options An associative array of table options: + * array( + * 'comment' => 'Foo', + * 'charset' => 'utf8', + * 'collate' => 'utf8_unicode_ci', + * 'type' => 'innodb', + * ); * @return bool */ public function createSequence($sequenceName, $start = 1, array $options = array()) @@ -517,7 +509,6 @@ public function createSequence($sequenceName, $start = 1, array $options = array * 'last_login' => array() * ) * ) - * * @throws PDOException */ public function createIndexSql($table, $name, array $definition) @@ -549,8 +540,7 @@ public function createIndexSql($table, $name, array $definition) * Obtain DBMS specific SQL code portion needed to set a default value * declaration to be used in statements like CREATE TABLE. * - * @param array $field field definition array - * + * @param array $field field definition array * @return string DBMS specific SQL code portion needed to set a default value */ public function getDefaultFieldDeclaration($field) @@ -588,8 +578,7 @@ public function getDefaultFieldDeclaration($field) * Obtain DBMS specific SQL code portion needed to set an index * declaration to be used in statements like CREATE TABLE. * - * @param array $definition index definition - * + * @param array $definition index definition * @return string DBMS specific SQL code portion needed to set an index */ public function getIndexDeclaration($name, array $definition) @@ -663,8 +652,7 @@ public function getIndexFieldDeclarationList(array $fields) /** * Returns a character set declaration. * - * @param string $charset A character set - * + * @param string $charset A character set * @return string A character set declaration */ public function getCharsetFieldDeclaration($charset) @@ -675,8 +663,7 @@ public function getCharsetFieldDeclaration($charset) /** * Returns a collation declaration. * - * @param string $collation A collation - * + * @param string $collation A collation * @return string A collation declaration */ public function getCollationFieldDeclaration($collation) @@ -724,8 +711,7 @@ public function dropIndexSql($table, $name) /** * dropTable. * - * @param string $table name of table that should be dropped from the database - * + * @param string $table name of table that should be dropped from the database * @throws PDOException */ public function dropTableSql($table) diff --git a/lib/Doctrine/Export/Oracle.php b/lib/Doctrine/Export/Oracle.php index 53a8802e4..bcee3d2ef 100644 --- a/lib/Doctrine/Export/Oracle.php +++ b/lib/Doctrine/Export/Oracle.php @@ -24,21 +24,16 @@ * * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_Export_Oracle extends Doctrine_Export { /** * create a new database. * - * @param string $name name of the database that should be created - * - * @return bool success of operation + * @param string $name name of the database that should be created + * @return bool success of operation */ public function createDatabase($name) { @@ -66,9 +61,8 @@ public function createDatabase($name) /** * drop an existing database. * - * @param string $name name of the database that should be dropped - * - * @return bool success of operation + * @param string $name name of the database that should be dropped + * @return bool success of operation */ public function dropDatabase($name) { @@ -99,10 +93,9 @@ public function dropDatabase($name) /** * add an autoincrement sequence + trigger. * - * @param string $name name of the PK field - * @param string $table name of the table - * @param string $start start value for the sequence - * + * @param string $name name of the PK field + * @param string $table name of the table + * @param string $start start value for the sequence * @return string Sql code */ public function _makeAutoincrement($name, $table, $start = 1) @@ -212,8 +205,7 @@ public function getTemporaryTableQuery() * Return the FOREIGN KEY query section dealing with non-standard options * as MATCH, INITIALLY DEFERRED, ON UPDATE, ... * - * @param array $definition foreign key definition - * + * @param array $definition foreign key definition * @return string */ public function getAdvancedForeignKeyOptions(array $definition) @@ -344,9 +336,8 @@ public function createTableSql($name, array $fields, array $options = array()) /** * create a comment on a table. * - * @param string $table Name of the table we are commenting - * @param string $comment The comment for the table - * + * @param string $table Name of the table we are commenting + * @param string $comment The comment for the table * @return string */ public function _createTableCommentSql($table, $comment) @@ -357,10 +348,9 @@ public function _createTableCommentSql($table, $comment) /** * create a comment on a column. * - * @param string $table Name of the table - * @param string $column Name of the column we are commenting - * @param string $comment The comment for the table - * + * @param string $table Name of the table + * @param string $column Name of the column we are commenting + * @param string $comment The comment for the table * @return string */ public function _createColumnCommentSql($table, $column, $comment) @@ -468,15 +458,14 @@ public function alterTable($name, array $changes, $check = false) /** * create sequence. * - * @param string $seqName name of the sequence to be created - * @param string $start start value of the sequence; default is 1 - * @param array $options An associative array of table options: - * array( - * 'comment' => 'Foo', - * 'charset' => 'utf8', - * 'collate' => 'utf8_unicode_ci', - * ); - * + * @param string $seqName name of the sequence to be created + * @param string $start start value of the sequence; default is 1 + * @param array $options An associative array of table options: + * array( + * 'comment' => 'Foo', + * 'charset' => 'utf8', + * 'collate' => 'utf8_unicode_ci', + * ); * @return string */ public function createSequenceSql($seqName, $start = 1, array $options = array()) @@ -491,8 +480,7 @@ public function createSequenceSql($seqName, $start = 1, array $options = array() /** * drop existing sequence. * - * @param string $seqName name of the sequence to be dropped - * + * @param string $seqName name of the sequence to be dropped * @return string */ public function dropSequenceSql($seqName) @@ -506,9 +494,8 @@ public function dropSequenceSql($seqName) * return Oracle's SQL code portion needed to set an index * declaration to be unsed in statements like CREATE TABLE. * - * @param string $name name of the index - * @param array $definition index definition - * + * @param string $name name of the index + * @param array $definition index definition * @return string Oracle's SQL code portion needed to set an index */ public function getIndexDeclaration($name, array $definition) diff --git a/lib/Doctrine/Export/Pgsql.php b/lib/Doctrine/Export/Pgsql.php index 6afbba5a5..69c74c315 100644 --- a/lib/Doctrine/Export/Pgsql.php +++ b/lib/Doctrine/Export/Pgsql.php @@ -24,12 +24,8 @@ * * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7680 $ */ class Doctrine_Export_Pgsql extends Doctrine_Export { @@ -48,8 +44,7 @@ public function createDatabaseSql($name) /** * drop an existing database. * - * @param string $name name of the database that should be dropped - * + * @param string $name name of the database that should be dropped * @throws PDOException */ public function dropDatabaseSql($name) @@ -62,8 +57,7 @@ public function dropDatabaseSql($name) * Return the FOREIGN KEY query section dealing with non-standard options * as MATCH, INITIALLY DEFERRED, ON UPDATE, ... * - * @param array $definition foreign key definition - * + * @param array $definition foreign key definition * @return string */ public function getAdvancedForeignKeyOptions(array $definition) @@ -199,12 +193,10 @@ public function alterTableSql($name, array $changes, $check = false) * should be set to another associative array with the properties * of the fields to be added. The properties of the fields should * be the same as defined by the Metabase parser. - * @param bool $check indicates whether the function should just check if the DBMS driver - * can perform the requested table alterations if the value is true or - * actually perform them otherwise - * + * @param bool $check indicates whether the function should just check if the DBMS driver + * can perform the requested table alterations if the value is true or + * actually perform them otherwise * @return bool - * * @throws Doctrine_Connection_Exception */ public function alterTable($name, array $changes, $check = false) @@ -220,16 +212,14 @@ public function alterTable($name, array $changes, $check = false) /** * return RDBMS specific create sequence statement. * - * @param string $start start value of the sequence; default is 1 - * @param array $options An associative array of table options: - * array( - * 'comment' => 'Foo', - * 'charset' => 'utf8', - * 'collate' => 'utf8_unicode_ci', - * ); - * + * @param string $start start value of the sequence; default is 1 + * @param array $options An associative array of table options: + * array( + * 'comment' => 'Foo', + * 'charset' => 'utf8', + * 'collate' => 'utf8_unicode_ci', + * ); * @return string - * * @throws Doctrine_Connection_Exception if something fails at database level */ public function createSequenceSql($sequenceName, $start = 1, array $options = array()) @@ -255,8 +245,7 @@ public function dropSequenceSql($sequenceName) /** * Creates a table. * - * @param unknown_type $name - * + * @param unknown_type $name * @return unknown */ public function createTableSql($name, array $fields, array $options = array()) diff --git a/lib/Doctrine/Export/Reporter.php b/lib/Doctrine/Export/Reporter.php index fc0b6c037..1950919fe 100644 --- a/lib/Doctrine/Export/Reporter.php +++ b/lib/Doctrine/Export/Reporter.php @@ -23,12 +23,8 @@ * Doctrine_Export_Reporter. * * @author Konsta Vesterinen - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_Export_Reporter implements IteratorAggregate { diff --git a/lib/Doctrine/Export/Schema.php b/lib/Doctrine/Export/Schema.php index 17436b3fd..41252433e 100644 --- a/lib/Doctrine/Export/Schema.php +++ b/lib/Doctrine/Export/Schema.php @@ -26,10 +26,6 @@ * * @see www.doctrine-project.org * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * - * @version $Revision: 1838 $ - * * @author Nicolas Bérard-Nault * @author Jonathan H. Wage */ diff --git a/lib/Doctrine/Export/Sqlite.php b/lib/Doctrine/Export/Sqlite.php index acaf5b3a7..9ace9891a 100644 --- a/lib/Doctrine/Export/Sqlite.php +++ b/lib/Doctrine/Export/Sqlite.php @@ -24,12 +24,8 @@ * * @author Konsta Vesterinen * @author Lukas Smith (PEAR MDB2 library) - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ */ class Doctrine_Export_Sqlite extends Doctrine_Export { @@ -38,8 +34,7 @@ class Doctrine_Export_Sqlite extends Doctrine_Export * * drop an existing database * - * @param string $databaseFile Path of the database that should be dropped - * + * @param string $databaseFile Path of the database that should be dropped * @throws Doctrine_Export_Exception if the database file does not exist * @throws Doctrine_Export_Exception if something failed during the removal of the database file */ @@ -96,7 +91,6 @@ public function createDatabase($databaseFile) * 'last_login' => array() * ) * ) - * * @throws PDOException */ public function createIndexSql($table, $name, array $definition) @@ -237,8 +231,7 @@ public function createTableSql($name, array $fields, array $options = array()) * Return the FOREIGN KEY query section dealing with non-standard options * as MATCH, INITIALLY DEFERRED, ON UPDATE, ... * - * @param array $definition foreign key definition - * + * @param array $definition foreign key definition * @return string */ public function getAdvancedForeignKeyOptions(array $definition) @@ -270,15 +263,14 @@ public function getAdvancedForeignKeyOptions(array $definition) /** * create sequence. * - * @param string $seqName name of the sequence to be created - * @param string $start start value of the sequence; default is 1 - * @param array $options An associative array of table options: - * array( - * 'comment' => 'Foo', - * 'charset' => 'utf8', - * 'collate' => 'utf8_unicode_ci', - * ); - * + * @param string $seqName name of the sequence to be created + * @param string $start start value of the sequence; default is 1 + * @param array $options An associative array of table options: + * array( + * 'comment' => 'Foo', + * 'charset' => 'utf8', + * 'collate' => 'utf8_unicode_ci', + * ); * @return bool */ public function createSequence($seqName, $start = 1, array $options = array()) @@ -312,8 +304,7 @@ public function createSequence($seqName, $start = 1, array $options = array()) /** * drop existing sequence. * - * @param string $sequenceName name of the sequence to be dropped - * + * @param string $sequenceName name of the sequence to be dropped * @return string */ public function dropSequenceSql($sequenceName) @@ -410,9 +401,8 @@ public function alterTableSql($name, array $changes, $check = false) * Sqlite does not support foreign keys so we are not even going to do anything if this function is called * to avoid any sql errors if a user tries to use this on sqlite * - * @param string $table name of the table on which the foreign key is to be created - * @param array $definition associative array that defines properties of the foreign key to be created - * + * @param string $table name of the table on which the foreign key is to be created + * @param array $definition associative array that defines properties of the foreign key to be created * @return string */ public function createForeignKey($table, array $definition) diff --git a/lib/Doctrine/Expression.php b/lib/Doctrine/Expression.php index 8c54606ce..9c0eee043 100644 --- a/lib/Doctrine/Expression.php +++ b/lib/Doctrine/Expression.php @@ -25,12 +25,7 @@ * This class manages abstractions of dql expressions like query parts * that use CONCAT(), MIN(), SUM(). * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ @@ -93,8 +88,7 @@ public function setExpression($clause) * Parses a single expressions and substitutes dql abstract functions * with their concrete sql counterparts for the given connection. * - * @param string $expr The expression to parse - * + * @param string $expr The expression to parse * @return string */ public function parseExpression($expr) @@ -122,8 +116,7 @@ public function parseExpression($expr) * * @see parseExpression() * - * @param string $clause The clause. Can be complex and parenthesised. - * + * @param string $clause The clause. Can be complex and parenthesised. * @return string the parsed clause */ public function parseClause($clause) diff --git a/lib/Doctrine/Expression/Driver.php b/lib/Doctrine/Expression/Driver.php index 49d2b440e..fcac1bdd6 100644 --- a/lib/Doctrine/Expression/Driver.php +++ b/lib/Doctrine/Expression/Driver.php @@ -22,12 +22,7 @@ /** * Doctrine_Expression_Driver. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ * * @author Konsta Vesterinen */ @@ -57,8 +52,7 @@ public function regexp() /** * Returns the average value of a column. * - * @param string $column the column to use - * + * @param string $column the column to use * @return string generated sql including an AVG aggregate function */ public function avg($column) @@ -74,9 +68,8 @@ public function avg($column) * If a '*' is used instead of a column the number of selected rows * is returned. * - * @param string|int $column the column to use - * - * @return string generated sql including a COUNT aggregate function + * @param string|int $column the column to use + * @return string generated sql including a COUNT aggregate function */ public function count($column) { @@ -88,8 +81,7 @@ public function count($column) /** * Returns the highest value of a column. * - * @param string $column the column to use - * + * @param string $column the column to use * @return string generated sql including a MAX aggregate function */ public function max($column) @@ -102,8 +94,7 @@ public function max($column) /** * Returns the lowest value of a column. * - * @param string $column the column to use - * + * @param string $column the column to use * @return string */ public function min($column) @@ -116,8 +107,7 @@ public function min($column) /** * Returns the total sum of a column. * - * @param string $column the column to use - * + * @param string $column the column to use * @return string */ public function sum($column) @@ -171,9 +161,8 @@ public function round($column, $decimals = 0) * Returns the remainder of the division operation * $expression1 / $expression2. * - * @param string $expression1 - * @param string $expression2 - * + * @param string $expression1 + * @param string $expression2 * @return string */ public function mod($expression1, $expression2) @@ -188,8 +177,7 @@ public function mod($expression1, $expression2) * trim * returns the string $str with leading and proceeding space characters removed. * - * @param string $str literal string or column name - * + * @param string $str literal string or column name * @return string */ public function trim($str) @@ -201,8 +189,7 @@ public function trim($str) * rtrim * returns the string $str with proceeding space characters removed. * - * @param string $str literal string or column name - * + * @param string $str literal string or column name * @return string */ public function rtrim($str) @@ -214,8 +201,7 @@ public function rtrim($str) * ltrim * returns the string $str with leading space characters removed. * - * @param string $str literal string or column name - * + * @param string $str literal string or column name * @return string */ public function ltrim($str) @@ -228,8 +214,7 @@ public function ltrim($str) * Returns the string $str with all characters changed to * uppercase according to the current character set mapping. * - * @param string $str literal string or column name - * + * @param string $str literal string or column name * @return string */ public function upper($str) @@ -242,8 +227,7 @@ public function upper($str) * Returns the string $str with all characters changed to * lowercase according to the current character set mapping. * - * @param string $str literal string or column name - * + * @param string $str literal string or column name * @return string */ public function lower($str) @@ -255,9 +239,8 @@ public function lower($str) * locate * returns the position of the first occurrence of substring $substr in string $str. * - * @param string $substr literal string to find - * @param string $str literal string - * + * @param string $substr literal string to find + * @param string $str literal string * @return int */ public function locate($str, $substr) @@ -282,8 +265,7 @@ public function now() * * The string "?000" is returned if the argument is NULL. * - * @param string $value - * + * @param string $value * @return string SQL soundex function with given parameter */ public function soundex($value) @@ -298,10 +280,9 @@ public function soundex($value) * * SQLite only supports the 2 parameter variant of this function * - * @param string $value an sql string literal or column name/alias - * @param mixed|null $len - * - * @return string SQL substring function with given parameters + * @param string $value an sql string literal or column name/alias + * @param mixed|null $len + * @return string SQL substring function with given parameters */ public function substring($value, $from, $len = null) { @@ -352,7 +333,6 @@ public function not($expression) * * @param string $type the type of operation, can be '+', '-', '*' or '/' * @param string|array(string) - * * @return string an expression */ private function basicMath($type, array $args) @@ -376,7 +356,6 @@ private function basicMath($type, array $args) * expressions. * * @param string|array(string) - * * @return string an expression */ public function add(array $args) @@ -392,7 +371,6 @@ public function add(array $args) * expressions. * * @param string|array(string) - * * @return string an expression */ public function sub(array $args) @@ -408,7 +386,6 @@ public function sub(array $args) * expressions. * * @param string|array(string) - * * @return string an expression */ public function mul(array $args) @@ -424,7 +401,6 @@ public function mul(array $args) * expressions. * * @param string|array(string) - * * @return string an expression */ public function div(array $args) @@ -435,9 +411,8 @@ public function div(array $args) /** * Returns the SQL to check if two values are equal. * - * @param string $value1 logical expression to compare - * @param string $value2 logical expression to compare with - * + * @param string $value1 logical expression to compare + * @param string $value2 logical expression to compare with * @return string logical expression */ public function eq($value1, $value2) @@ -451,9 +426,8 @@ public function eq($value1, $value2) /** * Returns the SQL to check if two values are unequal. * - * @param string $value1 logical expression to compare - * @param string $value2 logical expression to compare with - * + * @param string $value1 logical expression to compare + * @param string $value2 logical expression to compare with * @return string logical expression */ public function neq($value1, $value2) @@ -467,9 +441,8 @@ public function neq($value1, $value2) /** * Returns the SQL to check if one value is greater than another value. * - * @param string $value1 logical expression to compare - * @param string $value2 logical expression to compare with - * + * @param string $value1 logical expression to compare + * @param string $value2 logical expression to compare with * @return string logical expression */ public function gt($value1, $value2) @@ -484,9 +457,8 @@ public function gt($value1, $value2) * Returns the SQL to check if one value is greater than or equal to * another value. * - * @param string $value1 logical expression to compare - * @param string $value2 logical expression to compare with - * + * @param string $value1 logical expression to compare + * @param string $value2 logical expression to compare with * @return string logical expression */ public function gte($value1, $value2) @@ -500,9 +472,8 @@ public function gte($value1, $value2) /** * Returns the SQL to check if one value is less than another value. * - * @param string $value1 logical expression to compare - * @param string $value2 logical expression to compare with - * + * @param string $value1 logical expression to compare + * @param string $value2 logical expression to compare with * @return string logical expression */ public function lt($value1, $value2) @@ -517,9 +488,8 @@ public function lt($value1, $value2) * Returns the SQL to check if one value is less than or equal to * another value. * - * @param string $value1 logical expression to compare - * @param string $value2 logical expression to compare with - * + * @param string $value1 logical expression to compare + * @param string $value2 logical expression to compare with * @return string logical expression */ public function lte($value1, $value2) @@ -541,7 +511,6 @@ public function lte($value1, $value2) * * @param string $column the value that should be matched against * @param string|array(string) values that will be matched against $column - * * @return string logical expression */ public function in($column, $values) @@ -562,8 +531,7 @@ public function in($column, $values) /** * Returns SQL that checks if a expression is null. * - * @param string $expression the expression that should be compared to null - * + * @param string $expression the expression that should be compared to null * @return string logical expression */ public function isNull($expression) @@ -576,8 +544,7 @@ public function isNull($expression) /** * Returns SQL that checks if a expression is not null. * - * @param string $expression the expression that should be compared to null - * + * @param string $expression the expression that should be compared to null * @return string logical expression */ public function isNotNull($expression) @@ -597,10 +564,9 @@ public function isNotNull($expression) * http://www.w3schools.com/sql/sql_between.asp. If you want complete database * independence you should avoid using between(). * - * @param string $expression the value to compare to - * @param string $value1 the lower value to compare with - * @param string $value2 the higher value to compare with - * + * @param string $expression the value to compare to + * @param string $value1 the lower value to compare with + * @param string $value2 the higher value to compare with * @return string logical expression */ public function between($expression, $value1, $value2) diff --git a/lib/Doctrine/Expression/Exception.php b/lib/Doctrine/Expression/Exception.php index f5d432931..6f682698d 100644 --- a/lib/Doctrine/Expression/Exception.php +++ b/lib/Doctrine/Expression/Exception.php @@ -22,12 +22,7 @@ /** * Doctrine_Expression_Exception. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Expression/Mock.php b/lib/Doctrine/Expression/Mock.php index 9e995aee1..48ebda4e3 100644 --- a/lib/Doctrine/Expression/Mock.php +++ b/lib/Doctrine/Expression/Mock.php @@ -23,12 +23,7 @@ * Doctrine_Expression_Mock * Mock driver that is used for testing purposes. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision$ * * @author Konsta Vesterinen */ diff --git a/lib/Doctrine/Expression/Mssql.php b/lib/Doctrine/Expression/Mssql.php index b46e93e80..2a451bafb 100644 --- a/lib/Doctrine/Expression/Mssql.php +++ b/lib/Doctrine/Expression/Mssql.php @@ -22,12 +22,7 @@ /** * Doctrine_Expression_Mssql. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ @@ -56,9 +51,8 @@ public function now($type = 'timestamp') /** * return string to call a function to get a substring inside an SQL statement. * - * @param mixed|null $length - * - * @return string to call a function to get a substring + * @param mixed|null $length + * @return string to call a function to get a substring */ public function substring($value, $position, $length = null) { @@ -94,8 +88,7 @@ public function guid() /** * Returns the length of a text field. * - * @param string $column - * + * @param string $column * @return string */ public function length($column) diff --git a/lib/Doctrine/Expression/Mysql.php b/lib/Doctrine/Expression/Mysql.php index 8ed42e2ff..0bb4b4635 100644 --- a/lib/Doctrine/Expression/Mysql.php +++ b/lib/Doctrine/Expression/Mysql.php @@ -22,12 +22,7 @@ /** * Doctrine_Expression_Mysql. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ @@ -61,11 +56,10 @@ public function random() * WARNING: this function is experimental and may change signature at * any time until labelled as non-experimental * - * @param array $pattern even keys are strings, odd are patterns (% and _) - * @param string $operator optional pattern operator (LIKE, ILIKE and maybe others in the future) - * @param string $field optional field name that is being matched against - * (might be required when emulating ILIKE) - * + * @param array $pattern even keys are strings, odd are patterns (% and _) + * @param string $operator optional pattern operator (LIKE, ILIKE and maybe others in the future) + * @param string $field optional field name that is being matched against + * (might be required when emulating ILIKE) * @return string SQL pattern */ public function matchPattern($pattern, $operator = null, $field = null) @@ -114,8 +108,7 @@ public function guid() /** * Returns the year from dbms. * - * @param string $column - * + * @param string $column * @return string to get year from dbms */ public function year($column) @@ -128,8 +121,7 @@ public function year($column) /** * Returns the month from dbms. * - * @param string $column - * + * @param string $column * @return string to get month from dbms */ public function month($column) @@ -142,8 +134,7 @@ public function month($column) /** * Returns day from dbms. * - * @param string $column - * + * @param string $column * @return string to get day from dbms */ public function day($column) @@ -156,8 +147,7 @@ public function day($column) /** * Returns soundex from dbms. * - * @param string $column - * + * @param string $column * @return string to get soundex from dbms */ public function soundex($column) diff --git a/lib/Doctrine/Expression/Oracle.php b/lib/Doctrine/Expression/Oracle.php index 266181e57..6d7c82e4b 100644 --- a/lib/Doctrine/Expression/Oracle.php +++ b/lib/Doctrine/Expression/Oracle.php @@ -22,12 +22,7 @@ /** * Doctrine_Expression_Sqlite. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7490 $ * * @author Konsta Vesterinen */ @@ -53,10 +48,9 @@ public function concat() * * Note: Not SQL92, but common functionality. * - * @param string $value an sql string literal or column name/alias - * @param int $position where to start the substring portion - * @param int $length the substring portion length - * + * @param string $value an sql string literal or column name/alias + * @param int $position where to start the substring portion + * @param int $length the substring portion length * @return string SQL substring function with given parameters */ public function substring($value, $position, $length = null) diff --git a/lib/Doctrine/Expression/Pgsql.php b/lib/Doctrine/Expression/Pgsql.php index e3c1a68fe..37e529d59 100644 --- a/lib/Doctrine/Expression/Pgsql.php +++ b/lib/Doctrine/Expression/Pgsql.php @@ -22,12 +22,7 @@ /** * Doctrine_Expression_Pgsql. * - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * * @see www.doctrine-project.org - * @since 1.0 - * - * @version $Revision: 7685 $ * * @author Konsta Vesterinen */ @@ -63,10 +58,9 @@ public function md5($column) * * Note: Not SQL92, but common functionality. * - * @param string $value the target $value the string or the string column - * @param int $from extract from this characeter - * @param int $len extract this amount of characters - * + * @param string $value the target $value the string or the string column + * @param int $from extract from this characeter + * @param int $len extract this amount of characters * @return string sql that extracts part of a string */ public function substring($value, $from, $len = null) @@ -89,17 +83,15 @@ public function substring($value, $from, $len = null) * must contain an expression or an array with expressions. * * @param string|array(string) strings that will be concatinated - * @param mixed|null $timestamp2 - * + * @param mixed|null $timestamp2 * @return string */ /** * PostgreSQLs AGE( [, ]) function. * - * @param string $timestamp1 timestamp to subtract from NOW() - * @param string $timestamp2 optional; if given: subtract arguments - * + * @param string $timestamp1 timestamp to subtract from NOW() + * @param string $timestamp2 optional; if given: subtract arguments * @return string */ public function age($timestamp1, $timestamp2 = null) @@ -114,9 +106,8 @@ public function age($timestamp1, $timestamp2 = null) /** * PostgreSQLs DATE_PART( ,