Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

- Patch #648744 by Crell: specified more @return type definitions for auto-completion in IDEs.

merge-requests/26/head
Dries Buytaert 2009-12-04 16:31:04 +00:00
parent 99128df8d0
commit 1b01b241ae
13 changed files with 88 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
includes/archiver.inc
View File

@ -27,7 +27,7 @@ interface ArchiverInterface {
* @param $file_path * @param $file_path
* The full system path of the file or directory to add. Only local files * The full system path of the file or directory to add. Only local files
* and directories are supported. * and directories are supported.
* @return * @return ArchiverInterface
* The called object. * The called object.
*/ */
public function add($file_path); public function add($file_path);
@ -37,7 +37,7 @@ interface ArchiverInterface {
* *
* @param $path * @param $path
* The file name relative to the root of the archive to remove. * The file name relative to the root of the archive to remove.
* @return * @return ArchiverInterface
* The called object. * The called object.
*/ */
public function remove($path); public function remove($path);
@ -51,7 +51,7 @@ interface ArchiverInterface {
* Optionally specify a list of files to be extracted. Files are * Optionally specify a list of files to be extracted. Files are
* relative to the root of the archive. If not specified, all files * relative to the root of the archive. If not specified, all files
* in the archive will be extracted * in the archive will be extracted
* @return * @return ArchiverInterface
* The called object. * The called object.
*/ */
public function extract($path, Array $files = array()); public function extract($path, Array $files = array());

2
includes/cache.inc
View File

@ -12,6 +12,8 @@
* *
* @param $bin * @param $bin
* The cache bin for which the cache object should be returned. * The cache bin for which the cache object should be returned.
* @return DrupalCacheInterface
* The cache object associated with the specified bin.
*/ */
function _cache_get_object($bin) { function _cache_get_object($bin) {
// We do not use drupal_static() here because we do not want to change the // We do not use drupal_static() here because we do not want to change the

28
includes/database/database.inc
View File

@ -446,7 +446,7 @@ abstract class DatabaseConnection extends PDO {
* Whether or not to cache the prepared statement for later reuse in this * Whether or not to cache the prepared statement for later reuse in this
* same request. Usually we want to, but queries that require preprocessing * same request. Usually we want to, but queries that require preprocessing
* cannot be safely cached. * cannot be safely cached.
* @return * @return DatabaseStatementInterface
* A PDO prepared statement ready for its execute() method. * A PDO prepared statement ready for its execute() method.
*/ */
public function prepareQuery($query, $cache = TRUE) { public function prepareQuery($query, $cache = TRUE) {
@ -499,7 +499,7 @@ abstract class DatabaseConnection extends PDO {
/** /**
* Get the current logging object for this connection. * Get the current logging object for this connection.
* *
* @return * @return DatabaseLog
* The current logging object for this connection. If there isn't one, * The current logging object for this connection. If there isn't one,
* NULL is returned. * NULL is returned.
*/ */
@ -548,7 +548,7 @@ abstract class DatabaseConnection extends PDO {
* @param $options * @param $options
* An associative array of options to control how the query is run. See * An associative array of options to control how the query is run. See
* the documentation for DatabaseConnection::defaultOptions() for details. * the documentation for DatabaseConnection::defaultOptions() for details.
* @return * @return DatabaseStatementInterface
* This method will return one of: The executed statement, the number of * This method will return one of: The executed statement, the number of
* rows affected by the query (not the number matched), or the generated * rows affected by the query (not the number matched), or the generated
* insert id of the last query, depending on the value of $options['return']. * insert id of the last query, depending on the value of $options['return'].
@ -670,7 +670,7 @@ abstract class DatabaseConnection extends PDO {
* The alias of the base table of this query. * The alias of the base table of this query.
* @param $options * @param $options
* An array of options on the query. * An array of options on the query.
* @return * @return SelectQueryInterface
* A new SelectQuery object. * A new SelectQuery object.
*/ */
public function select($table, $alias = NULL, array $options = array()) { public function select($table, $alias = NULL, array $options = array()) {
@ -694,7 +694,7 @@ abstract class DatabaseConnection extends PDO {
* @see InsertQuery * @see InsertQuery
* @param $options * @param $options
* An array of options on the query. * An array of options on the query.
* @return * @return InsertQuery
* A new InsertQuery object. * A new InsertQuery object.
*/ */
public function insert($table, array $options = array()) { public function insert($table, array $options = array()) {
@ -714,7 +714,7 @@ abstract class DatabaseConnection extends PDO {
* @see MergeQuery * @see MergeQuery
* @param $options * @param $options
* An array of options on the query. * An array of options on the query.
* @return * @return MergeQuery
* A new MergeQuery object. * A new MergeQuery object.
*/ */
public function merge($table, array $options = array()) { public function merge($table, array $options = array()) {
@ -735,7 +735,7 @@ abstract class DatabaseConnection extends PDO {
* @see UpdateQuery * @see UpdateQuery
* @param $options * @param $options
* An array of options on the query. * An array of options on the query.
* @return * @return UpdateQuery
* A new UpdateQuery object. * A new UpdateQuery object.
*/ */
public function update($table, array $options = array()) { public function update($table, array $options = array()) {
@ -755,7 +755,7 @@ abstract class DatabaseConnection extends PDO {
* @see DeleteQuery * @see DeleteQuery
* @param $options * @param $options
* An array of options on the query. * An array of options on the query.
* @return * @return DeleteQuery
* A new DeleteQuery object. * A new DeleteQuery object.
*/ */
public function delete($table, array $options = array()) { public function delete($table, array $options = array()) {
@ -775,7 +775,7 @@ abstract class DatabaseConnection extends PDO {
* @see TruncateQuery * @see TruncateQuery
* @param $options * @param $options
* An array of options on the query. * An array of options on the query.
* @return * @return TruncateQuery
* A new DeleteQuery object. * A new DeleteQuery object.
*/ */
public function truncate($table, array $options = array()) { public function truncate($table, array $options = array()) {
@ -794,7 +794,7 @@ abstract class DatabaseConnection extends PDO {
* *
* This method will lazy-load the appropriate schema library file. * This method will lazy-load the appropriate schema library file.
* *
* @return * @return DatabaseSchema
* The DatabaseSchema object for this connection. * The DatabaseSchema object for this connection.
*/ */
public function schema() { public function schema() {
@ -1015,7 +1015,7 @@ abstract class DatabaseConnection extends PDO {
* The maximum number of result rows to return. * The maximum number of result rows to return.
* @param $options * @param $options
* An array of options on the query. * An array of options on the query.
* @return * @return DatabaseStatementInterface
* A database query result resource, or NULL if the query was not executed * A database query result resource, or NULL if the query was not executed
* correctly. * correctly.
*/ */
@ -1257,7 +1257,7 @@ abstract class Database {
* The logging key to log. * The logging key to log.
* @param $key * @param $key
* The database connection key for which we want to log. * The database connection key for which we want to log.
* @return * @return DatabaseLog
* The query log object. Note that the log object does support richer * The query log object. Note that the log object does support richer
* methods than the few exposed through the Database class, so in some * methods than the few exposed through the Database class, so in some
* cases it may be desirable to access it directly. * cases it may be desirable to access it directly.
@ -1323,7 +1323,7 @@ abstract class Database {
* The logging key to log. * The logging key to log.
* @param $key * @param $key
* The database connection key for which we want to log. * The database connection key for which we want to log.
* @return * @return array
* The query log for the specified logging key and connection. * The query log for the specified logging key and connection.
*/ */
final public static function getLog($logging_key, $key = 'default') { final public static function getLog($logging_key, $key = 'default') {
@ -1343,7 +1343,7 @@ abstract class Database {
* @param $key * @param $key
* The database connection key. Defaults to NULL which means the active * The database connection key. Defaults to NULL which means the active
* key. * key.
* @return * @return DatabaseConnection
* The corresponding connection object. * The corresponding connection object.
*/ */
final public static function getConnection($target = 'default', $key = NULL) { final public static function getConnection($target = 'default', $key = NULL) {

2
includes/database/prefetch.inc
View File

@ -221,7 +221,7 @@ class DatabaseStatementPrefetch implements Iterator, DatabaseStatementInterface
* The query. * The query.
* @param array $args * @param array $args
* An array of arguments. * An array of arguments.
* @return * @return PDOStatement
* A PDOStatement object. * A PDOStatement object.
*/ */
protected function getStatement($query, &$args = array()) { protected function getStatement($query, &$args = array()) {

40
includes/database/query.inc
View File

@ -33,7 +33,7 @@ interface QueryConditionInterface {
* The comparison operator, such as =, <, or >=. It also accepts more complex * The comparison operator, such as =, <, or >=. It also accepts more complex
* options such as IN, LIKE, or BETWEEN. Defaults to IN if $value is an array * options such as IN, LIKE, or BETWEEN. Defaults to IN if $value is an array
* = otherwise. * = otherwise.
* @return * @return QueryConditionInterface
* The called object. * The called object.
*/ */
public function condition($field, $value = NULL, $operator = NULL); public function condition($field, $value = NULL, $operator = NULL);
@ -46,7 +46,7 @@ interface QueryConditionInterface {
* not ? placeholders. * not ? placeholders.
* @param $args * @param $args
* An associative array of arguments. * An associative array of arguments.
* @return * @return QueryConditionInterface
* The called object. * The called object.
*/ */
public function where($snippet, $args = array()); public function where($snippet, $args = array());
@ -56,7 +56,7 @@ interface QueryConditionInterface {
* *
* @param $field * @param $field
* The name of the field to check. * The name of the field to check.
* @return * @return QueryConditionInterface
* The called object. * The called object.
*/ */
public function isNull($field); public function isNull($field);
@ -66,7 +66,7 @@ interface QueryConditionInterface {
* *
* @param $field * @param $field
* The name of the field to check. * The name of the field to check.
* @return * @return QueryConditionInterface
* The called object. * The called object.
*/ */
public function isNotNull($field); public function isNotNull($field);
@ -135,7 +135,7 @@ interface QueryAlterableInterface {
* *
* @param $tag * @param $tag
* The tag to add. * The tag to add.
* @return * @return QueryAlterableInterface
* The called object. * The called object.
*/ */
public function addTag($tag); public function addTag($tag);
@ -183,7 +183,7 @@ interface QueryAlterableInterface {
* follows the same rules as any other PHP identifier. * follows the same rules as any other PHP identifier.
* @param $object * @param $object
* The additional data to add to the query. May be any valid PHP variable. * The additional data to add to the query. May be any valid PHP variable.
* @return * @return QueryAlterableInterface
* The called object. * The called object.
*/ */
public function addMetaData($key, $object); public function addMetaData($key, $object);
@ -203,8 +203,12 @@ interface QueryAlterableInterface {
* Interface for a query that accepts placeholders. * Interface for a query that accepts placeholders.
*/ */
interface QueryPlaceholderInterface { interface QueryPlaceholderInterface {
/** /**
* Returns the next placeholder for the query. * Returns the next placeholder ID for the query.
*
* @return
* The next available placeholder ID as an integer.
*/ */
function nextPlaceholder(); function nextPlaceholder();
} }
@ -339,7 +343,7 @@ class InsertQuery extends Query {
* @param $values * @param $values
* An array of fields to insert into the database. The values must be * An array of fields to insert into the database. The values must be
* specified in the same order as the $fields array. * specified in the same order as the $fields array.
* @return * @return InsertQuery
* The called object. * The called object.
*/ */
public function fields(array $fields, array $values = array()) { public function fields(array $fields, array $values = array()) {
@ -369,7 +373,7 @@ class InsertQuery extends Query {
* *
* @param $values * @param $values
* An array of values to add to the query. * An array of values to add to the query.
* @return * @return InsertQuery
* The called object. * The called object.
*/ */
public function values(array $values) { public function values(array $values) {
@ -402,7 +406,7 @@ class InsertQuery extends Query {
* @param $fields * @param $fields
* An array of values for which to use the default values * An array of values for which to use the default values
* specified in the table definition. * specified in the table definition.
* @return * @return InsertQuery
* The called object. * The called object.
*/ */
public function useDefaults(array $fields) { public function useDefaults(array $fields) {
@ -429,7 +433,7 @@ class InsertQuery extends Query {
* *
* @param $delay * @param $delay
* If TRUE, this query is delay-safe and will run delayed on supported databases. * If TRUE, this query is delay-safe and will run delayed on supported databases.
* @return * @return InsertQuery
* The called object. * The called object.
*/ */
public function delay($delay = TRUE) { public function delay($delay = TRUE) {
@ -628,7 +632,7 @@ class MergeQuery extends Query {
* @param $values * @param $values
* An array of fields to set into the database. The values must be * An array of fields to set into the database. The values must be
* specified in the same order as the $fields array. * specified in the same order as the $fields array.
* @return * @return MergeQuery
* The called object. * The called object.
*/ */
public function fields(array $fields, array $values = array()) { public function fields(array $fields, array $values = array()) {
@ -662,7 +666,7 @@ class MergeQuery extends Query {
* @param $values * @param $values
* An array of fields to set into the database. The values must be * An array of fields to set into the database. The values must be
* specified in the same order as the $fields array. * specified in the same order as the $fields array.
* @return * @return MergeQuery
* The called object. * The called object.
*/ */
public function key(array $fields, array $values = array()) { public function key(array $fields, array $values = array()) {
@ -686,7 +690,7 @@ class MergeQuery extends Query {
* @param $values * @param $values
* An array of fields to set into the database. The values must be * An array of fields to set into the database. The values must be
* specified in the same order as the $fields array. * specified in the same order as the $fields array.
* @return * @return MergeQuery
* The called object. * The called object.
*/ */
public function update(array $fields, array $values = array()) { public function update(array $fields, array $values = array()) {
@ -715,7 +719,7 @@ class MergeQuery extends Query {
* specified by the fields() method. * specified by the fields() method.
* Alternatively, the fields may be specified as a variable number of string * Alternatively, the fields may be specified as a variable number of string
* parameters. * parameters.
* @return * @return MergeQuery
* The called object. * The called object.
*/ */
public function updateExcept($exclude_fields) { public function updateExcept($exclude_fields) {
@ -742,7 +746,7 @@ class MergeQuery extends Query {
* @param $arguments * @param $arguments
* If specified, this is an array of key/value pairs for named placeholders * If specified, this is an array of key/value pairs for named placeholders
* corresponding to the expression. * corresponding to the expression.
* @return * @return MergeQuery
* The called object. * The called object.
*/ */
public function expression($field, $expression, array $arguments = NULL) { public function expression($field, $expression, array $arguments = NULL) {
@ -1059,7 +1063,7 @@ class UpdateQuery extends Query implements QueryConditionInterface {
* @param $fields * @param $fields
* An associative array of fields to write into the database. The array keys * An associative array of fields to write into the database. The array keys
* are the field names while the values are the values to which to set them. * are the field names while the values are the values to which to set them.
* @return * @return UpdateQuery
* The called object. * The called object.
*/ */
public function fields(array $fields) { public function fields(array $fields) {
@ -1081,7 +1085,7 @@ class UpdateQuery extends Query implements QueryConditionInterface {
* @param $arguments * @param $arguments
* If specified, this is an array of key/value pairs for named placeholders * If specified, this is an array of key/value pairs for named placeholders
* corresponding to the expression. * corresponding to the expression.
* @return * @return UpdateQuery
* The called object. * The called object.
*/ */
public function expression($field, $expression, array $arguments = NULL) { public function expression($field, $expression, array $arguments = NULL) {

2
includes/database/schema.inc
View File

@ -183,7 +183,7 @@ abstract class DatabaseSchema implements QueryPlaceholderInterface {
* The name of the table to explode. * The name of the table to explode.
* @param $operator * @param $operator
* The operator to apply on the 'table' part of the condition. * The operator to apply on the 'table' part of the condition.
* @return * @return QueryConditionInterface
* A DatabaseCondition object. * A DatabaseCondition object.
*/ */
protected function buildTableNameCondition($table_name, $operator = '=') { protected function buildTableNameCondition($table_name, $operator = '=') {

21
includes/database/select.inc
View File

@ -26,7 +26,7 @@ interface QueryExtendableInterface {
* against the current database connection to allow driver-specific subclasses * against the current database connection to allow driver-specific subclasses
* as well, using the same logic as the query objects themselves. For example, * as well, using the same logic as the query objects themselves. For example,
* PagerDefault_mysql is the MySQL-specific override for PagerDefault. * PagerDefault_mysql is the MySQL-specific override for PagerDefault.
* @return * @return QueryExtendableInterface
* The extender object, which now contains a reference to this object. * The extender object, which now contains a reference to this object.
*/ */
public function extend($extender_name); public function extend($extender_name);
@ -149,7 +149,7 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
* *
* @param $distinct * @param $distinct
* TRUE to flag this query DISTINCT, FALSE to disable it. * TRUE to flag this query DISTINCT, FALSE to disable it.
* @return * @return SelectQueryInterface
* The called object. * The called object.
*/ */
public function distinct($distinct = TRUE); public function distinct($distinct = TRUE);
@ -191,7 +191,7 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
* An indexed array of fields present in the specified table that should be * An indexed array of fields present in the specified table that should be
* included in this query. If not specified, $table_alias.* will be generated * included in this query. If not specified, $table_alias.* will be generated
* without any aliases. * without any aliases.
* @return * @return SelectQueryInterface
* The called object. * The called object.
*/ */
public function fields($table_alias, array $fields = array()); public function fields($table_alias, array $fields = array());
@ -342,7 +342,7 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
* The field on which to order. * The field on which to order.
* @param $direction * @param $direction
* The direction to sort. Legal values are "ASC" and "DESC". * The direction to sort. Legal values are "ASC" and "DESC".
* @return * @return SelectQueryInterface
* The called object. * The called object.
*/ */
public function orderBy($field, $direction = 'ASC'); public function orderBy($field, $direction = 'ASC');
@ -364,7 +364,7 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
* *
* for an example of such an alternate sorting mechanism. * for an example of such an alternate sorting mechanism.
* *
* @return * @return SelectQueryInterface
* The called object * The called object
*/ */
public function orderRandom(); public function orderRandom();
@ -380,7 +380,7 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
* range directives that are set. * range directives that are set.
* @param $limit * @param $limit
* The number of records to return from the result set. * The number of records to return from the result set.
* @return * @return SelectQueryInterface
* The called object. * The called object.
*/ */
public function range($start = NULL, $length = NULL); public function range($start = NULL, $length = NULL);
@ -405,7 +405,7 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
* @param $type * @param $type
* The type of UNION to add to the query. Defaults to plain * The type of UNION to add to the query. Defaults to plain
* UNION. * UNION.
* @return * @return SelectQueryInterface
* The called object. * The called object.
*/ */
public function union(SelectQueryInterface $query, $type = ''); public function union(SelectQueryInterface $query, $type = '');
@ -415,7 +415,7 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
* *
* @param $field * @param $field
* The field on which to group. This should be the field as aliased. * The field on which to group. This should be the field as aliased.
* @return * @return SelectQueryInterface
* The called object. * The called object.
*/ */
public function groupBy($field); public function groupBy($field);
@ -423,13 +423,16 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
/** /**
* Get the equivalent COUNT query of this query as a new query object. * Get the equivalent COUNT query of this query as a new query object.
* *
* @return * @return SelectQueryInterface
* A new SelectQuery object with no fields or expressions besides COUNT(*). * A new SelectQuery object with no fields or expressions besides COUNT(*).
*/ */
public function countQuery(); public function countQuery();
/** /**
* Indicates if preExecute() has already been called on that object. * Indicates if preExecute() has already been called on that object.
*
* @return
* TRUE is this query has already been prepared, FALSE otherwise.
*/ */
public function isPrepared(); public function isPrepared();

13
includes/filetransfer/filetransfer.inc
View File

@ -27,10 +27,11 @@ abstract class FileTransfer {
abstract static function factory($jail, $settings); abstract static function factory($jail, $settings);
/** /**
* Implementation of the magic __get() method. If the connection isn't set to * Implementation of the magic __get() method.
* anything, this will call the connect() method and set it to and return the *
* result; afterwards, the connection will be returned directly without using * If the connection isn't set to anything, this will call the connect() method
* this method. * and set it to and return the result; afterwards, the connection will be
* returned directly without using this method.
*/ */
function __get($name) { function __get($name) {
if ($name == 'connection') { if ($name == 'connection') {
@ -156,7 +157,7 @@ abstract class FileTransfer {
* @param $path * @param $path
* @param $strip_chroot * @param $strip_chroot
* *
* @return string; * @return string
*/ */
protected final function fixRemotePath($path, $strip_chroot = TRUE) { protected final function fixRemotePath($path, $strip_chroot = TRUE) {
$path = $this->sanitizePath($path); $path = $this->sanitizePath($path);
@ -173,7 +174,7 @@ abstract class FileTransfer {
* Changes backslahes to slashes, also removes a trailing slash. * Changes backslahes to slashes, also removes a trailing slash.
* *
* @param string $path * @param string $path
* @return string; * @return string
*/ */
function sanitizePath($path) { function sanitizePath($path) {
$path = str_replace('\\', '/', $path); // Windows path sanitiation. $path = str_replace('\\', '/', $path); // Windows path sanitiation.

2
includes/filetransfer/ftp.inc
View File

@ -19,7 +19,7 @@ abstract class FileTransferFTP extends FileTransfer {
* *
* @param string $jail * @param string $jail
* @param array $settings * @param array $settings
* @return * @return FileTransferFTP
* The appropriate FileTransferFTP subclass based on the available * The appropriate FileTransferFTP subclass based on the available
* options. If the FTP PHP extension is available, use it. Otherwise, we * options. If the FTP PHP extension is available, use it. Otherwise, we
* try to use the FTP file stream support. * try to use the FTP file stream support.

1
includes/mail.inc
View File

@ -218,6 +218,7 @@ function drupal_mail($module, $key, $to, $language, $params = array(), $from = N
* @param $key * @param $key
* A key to identify the e-mail sent. The final e-mail ID for the e-mail * A key to identify the e-mail sent. The final e-mail ID for the e-mail
* alter hook in drupal_mail() would have been {$module}_{$key}. * alter hook in drupal_mail() would have been {$module}_{$key}.
* @return MailSystemInterface
*/ */
function drupal_mail_system($module, $key) { function drupal_mail_system($module, $key) {
$instances = &drupal_static(__FUNCTION__, array()); $instances = &drupal_static(__FUNCTION__, array());

4
includes/pager.inc
View File

@ -127,8 +127,8 @@ class PagerDefault extends SelectQueryExtender {
* The count query may be specified manually or, by default, taken from the * The count query may be specified manually or, by default, taken from the
* query we are extending. * query we are extending.
* *
* @return * @return SelectQueryInterface
* A count SelectQueryInterface object. * A count query object.
*/ */
protected function getCountQuery() { protected function getCountQuery() {
if ($this->customCountQuery) { if ($this->customCountQuery) {

2
includes/tablesort.inc
View File

@ -37,6 +37,8 @@ class TableSort extends SelectQueryExtender {
* @see theme_table() * @see theme_table()
* @param $header * @param $header
* Table header array. * Table header array.
* @return SelectQueryInterface
* The called object.
*/ */
public function orderByHeader(Array $header) { public function orderByHeader(Array $header) {
$this->header = $header; $this->header = $header;

5
includes/updater.inc
View File

@ -36,7 +36,8 @@ interface DrupalUpdaterInterface {
public static function getProjectName($directory); public static function getProjectName($directory);
/** /**
* @return string an absolute path to the default install location. * @return string
* An absolute path to the default install location.
*/ */
public function getInstallDirectory(); public function getInstallDirectory();
@ -87,7 +88,7 @@ class Updater {
* @param string $source * @param string $source
* Directory of a Drupal project. * Directory of a Drupal project.
* *
* @return object Updater * @return Updater
*/ */
public static function factory($source) { public static function factory($source) {
if (is_dir($source)) { if (is_dir($source)) {