Browse Source

Remove unnecessary @return tags in constructor and deconstructor docblocks.

ndm2 12 years ago
parent
commit
307719973f

+ 0 - 1
src/Collection/Collection.php

@@ -32,7 +32,6 @@ class Collection extends IteratorIterator implements JsonSerializable {
  * Constructor. You can provide an array or any traversable object
  *
  * @param array|\Traversable $items
- * @return void
  * @throws InvalidArgumentException if passed incorrect type for items.
  */
 	public function __construct($items) {

+ 0 - 1
src/Collection/Iterator/ExtractIterator.php

@@ -49,7 +49,6 @@ class ExtractIterator extends Collection {
  * @param array|\Traversable $items The list of values to iterate
  * @param string $path a dot separated string symbolizing the path to follow
  * inside the hierarchy of each value so that the column can be extracted.
- * @return void
  */
 	public function __construct($items, $path) {
 		$this->_path = explode('.', $path);

+ 0 - 1
src/Collection/Iterator/FilterIterator.php

@@ -35,7 +35,6 @@ class FilterIterator extends Collection {
  *
  * @param Iterator $items the items to be filtered
  * @param callable $callback
- * @return void
  */
 	public function __construct(Iterator $items, callable $callback) {
 		$wrapper = new CallbackFilterIterator($items, $callback);

+ 0 - 1
src/Collection/Iterator/MapReduce.php

@@ -109,7 +109,6 @@ class MapReduce implements IteratorAggregate {
  * The first one is the list of values inside a bucket, second one is the name
  * of the bucket that was created during the mapping phase and third one is an
  * instance of this class.
- * @return void
  */
 	public function __construct(\Traversable $data, callable $mapper, callable $reducer = null) {
 		$this->_data = $data;

+ 0 - 1
src/Collection/Iterator/ReplaceIterator.php

@@ -39,7 +39,6 @@ class ReplaceIterator extends Collection {
  *
  * @param array|\Traversable $items the items to be filtered
  * @param callable $callback
- * @return void
  */
 	public function __construct($items, callable $callback) {
 		$this->_callback = $callback;

+ 0 - 1
src/Collection/Iterator/SortIterator.php

@@ -86,7 +86,6 @@ class SortIterator extends SplHeap {
  * @param integer $dir either SORT_DESC or SORT_ASC
  * @param integer $type the type of comparison to perform, either SORT_STRING
  * SORT_NUMERIC or SORT_NATURAL
- * @return void
  */
 	public function __construct($items, $c, $dir = SORT_DESC, $type = SORT_NUMERIC) {
 		$this->_items = $items;

+ 0 - 2
src/Database/Connection.php

@@ -103,8 +103,6 @@ class Connection {
  * Destructor
  *
  * Disconnects the driver to release the connection.
- *
- * @return void
  */
 	public function __destruct() {
 		unset($this->_driver);

+ 0 - 3
src/Database/Driver.php

@@ -50,7 +50,6 @@ abstract class Driver {
  * Constructor
  *
  * @param array $config The configuration for the driver.
- * @return void
  */
 	public function __construct($config = []) {
 		$config += $this->_baseConfig;
@@ -246,8 +245,6 @@ abstract class Driver {
 
 /**
  * Destructor
- *
- * @return void
  */
 	public function __destruct() {
 		$this->_connection = null;

+ 0 - 1
src/Database/Expression/Comparison.php

@@ -53,7 +53,6 @@ class Comparison extends QueryExpression {
  * @param mixed $value the value to be used in comparison
  * @param string $type the type name used to cast the value
  * @param string $conjunction the operator used for comparing field and value
- * @return void
  */
 	public function __construct($field, $value, $type, $conjuntion) {
 		$this->field($field);

+ 0 - 1
src/Database/Expression/FunctionExpression.php

@@ -57,7 +57,6 @@ class FunctionExpression extends QueryExpression {
  * If associative the key would be used as argument when value is 'literal'
  * @param array types associative array of types to be associated with the
  * passed arguments
- * @return void
  */
 	public function __construct($name, $params = [], $types = []) {
 		$this->_name = $name;

+ 0 - 1
src/Database/Expression/IdentifierExpression.php

@@ -36,7 +36,6 @@ class IdentifierExpression implements ExpressionInterface {
  * Constructor
  *
  * @param string $identifier The identifier this expression represents
- * @return void
  */
 	public function __construct($identifier) {
 		$this->setIdentifier($identifier);

+ 0 - 1
src/Database/Expression/QueryExpression.php

@@ -57,7 +57,6 @@ class QueryExpression implements ExpressionInterface, Countable {
  * @param string $conjunction the glue that will join all the string conditions at this
  * level of the expression tree. For example "AND", "OR", "XOR"...
  * @see QueryExpression::add() for more details on $conditions and $types
- * @return void
  */
 	public function __construct($conditions = [], $types = [], $conjunction = 'AND') {
 		$this->type(strtoupper($conjunction));

+ 0 - 1
src/Database/Expression/TupleComparison.php

@@ -32,7 +32,6 @@ class TupleComparison extends Comparison {
  * @param array $types the types names to use for casting each of the values, only
  * one type per position in the value array in needed
  * @param string $conjunction the operator used for comparing field and value
- * @return void
  */
 	public function __construct($fields, $values, $types = [], $conjuntion = '=') {
 		parent::__construct($fields, $values, $types, $conjuntion);

+ 0 - 1
src/Database/Expression/ValuesExpression.php

@@ -61,7 +61,6 @@ class ValuesExpression implements ExpressionInterface {
  *
  * @param array $columns The list of columns that are going to be part of the values.
  * @param array $types A dictionary of column -> type names
- * @return void
  */
 	public function __construct(array $columns, array $types = []) {
 		$this->_columns = $columns;

+ 0 - 1
src/Database/IdentifierQuoter.php

@@ -37,7 +37,6 @@ class IdentifierQuoter {
  * Constructor
  *
  * @param \Cake\Database\Driver The driver instance used to do the identifier quoting
- * @return void
  */
 	public function __construct(Driver $driver) {
 		$this->_driver = $driver;

+ 0 - 2
src/Database/Query.php

@@ -157,8 +157,6 @@ class Query implements ExpressionInterface, IteratorAggregate {
  *
  * @param \Cake\Database\Connection $connection The connection
  * object to be used for transforming and executing this query
- *
- * @return void
  */
 	public function __construct($connection) {
 		$this->connection($connection);

+ 0 - 1
src/Database/Schema/BaseSchema.php

@@ -38,7 +38,6 @@ abstract class BaseSchema {
  * Constructor
  *
  * @param \Cake\Database\Driver $driver The driver to use.
- * @return void
  */
 	public function __construct(Driver $driver) {
 		$this->_driver = $driver;

+ 0 - 1
src/Database/Statement/BufferedStatement.php

@@ -55,7 +55,6 @@ class BufferedStatement extends StatementDecorator {
  *
  * @param \Cake\Database\Driver instance $driver
  * @param Statement implementation such as PDOStatement
- * @return void
  */
 	public function __construct($statement = null, $driver = null) {
 		parent::__construct($statement, $driver);

+ 0 - 1
src/Database/Statement/PDOStatement.php

@@ -30,7 +30,6 @@ class PDOStatement extends StatementDecorator {
  *
  * @param \PDOStatement original statement to be decorated
  * @param \Cake\Database\Driver instance $driver
- * @return void
  */
 	public function __construct(Statement $statement = null, $driver = null) {
 		$this->_statement = $statement;

+ 0 - 1
src/Database/Statement/StatementDecorator.php

@@ -52,7 +52,6 @@ class StatementDecorator implements StatementInterface, \Countable, \IteratorAgg
  *
  * @param Statement implementation such as PDOStatement
  * @param \Cake\Database\Driver instance $driver
- * @return void
  */
 	public function __construct($statement = null, $driver = null) {
 		$this->_statement = $statement;

+ 0 - 1
src/Database/Type.php

@@ -78,7 +78,6 @@ class Type {
  * Constructor
  *
  * @param string $name The name identifying this type
- * @return void
  */
 	public function __construct($name = null) {
 		$this->_name = $name;

+ 0 - 1
src/Network/Http/FormData/Part.php

@@ -77,7 +77,6 @@ class Part {
  * @param string $name The name of the data.
  * @param string $value The value of the data.
  * @param string $disposition The type of disposition to use, defaults to form-data.
- * @return void
  */
 	public function __construct($name, $value, $disposition = 'form-data') {
 		$this->_name = $name;

+ 0 - 1
src/ORM/Association.php

@@ -167,7 +167,6 @@ abstract class Association {
  *
  * @param string $name The name given to the association
  * @param array $options A list of properties to be set on this object
- * @return void
  */
 	public function __construct($name, array $options = []) {
 		$defaults = [

+ 0 - 1
src/ORM/ResultSet.php

@@ -125,7 +125,6 @@ class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
  *
  * @param Query from where results come
  * @param \Cake\Database\StatementInterface $statement
- * @return void
  */
 	public function __construct($query, $statement) {
 		$this->_query = $query;

+ 0 - 1
src/ORM/Table.php

@@ -187,7 +187,6 @@ class Table implements RepositoryInterface, EventListener {
  * - behaviors: A BehaviorRegistry. Generally not used outside of tests.
  *
  * @param array config Lsit of options for this table
- * @return void
  */
 	public function __construct(array $config = []) {
 		if (!empty($config['table'])) {

+ 0 - 1
src/TestSuite/Fixture/FixtureInjector.php

@@ -41,7 +41,6 @@ class FixtureInjector implements PHPUnit_Framework_TestListener {
  * Constructor. Save internally the reference to the passed fixture manager
  *
  * @param \Cake\TestSuite\Fixture\FixtureManager $manager
- * @return void
  */
 	public function __construct(FixtureManager $manager) {
 		$this->_fixtureManager = $manager;

+ 0 - 1
src/TestSuite/TestPermutationDecorator.php

@@ -41,7 +41,6 @@ class TestPermutationDecorator extends PHPUnit_Extensions_TestDecorator {
  * @param \PHPUnit_Framework_Test The test or suite to decorate
  * @param array $permutation  An array containing callable methods that will
  * be executed before the test suite is run
- * @return void
  */
 	public function __construct(PHPUnit_Framework_Test $test, array $permutations) {
 		parent::__construct($test);

+ 0 - 2
tests/test_app/Plugin/TestPlugin/Datasource/TestSource.php

@@ -13,8 +13,6 @@ class TestSource {
 
 /**
  * Constructor
- *
- * @return void
  */
 	public function __construct(array $settings) {
 		$this->settings = $settings;

+ 0 - 2
tests/test_app/TestApp/Controller/AuthTestController.php

@@ -49,8 +49,6 @@ class AuthTestController extends Controller {
 
 /**
  * construct method
- *
- * @return void
  */
 	public function __construct($request = null, $response = null) {
 		$request->addParams(Router::parse('/auth_test'));