Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove & in phpdoc #1232

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Core/Core.php
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ function str_contains(string $haystack, string $needle): bool {}
/**
* Return the current key and value pair from an array and advance the array cursor
* @link https://php.net/manual/en/function.each.php
* @param array|ArrayObject &$array <p>
* @param array|ArrayObject $array <p>
* The input array.
* </p>
* @return array the current key and value pair from the array
Expand Down
4 changes: 2 additions & 2 deletions PDO/PDO.php
Original file line number Diff line number Diff line change
Expand Up @@ -1346,7 +1346,7 @@ public function fetch(
* question mark placeholders, this will be the 1-indexed position of
* the parameter.
* </p>
* @param mixed &$var <p>
* @param mixed $var <p>
* Name of the PHP variable to bind to the SQL statement parameter.
* </p>
* @param int $type [optional] <p>
Expand Down Expand Up @@ -1382,7 +1382,7 @@ public function bindParam(
* If using the column name, be aware that the name should match the
* case of the column, as returned by the driver.
* </p>
* @param mixed &$var <p>
* @param mixed $var <p>
* Name of the PHP variable to which the column will be bound.
* </p>
* @param int $type [optional] <p>
Expand Down
2 changes: 1 addition & 1 deletion SPL/SPL_c1.php
Original file line number Diff line number Diff line change
Expand Up @@ -707,7 +707,7 @@ public function getCsvControl() {}
* <i>operation</i> is one of the following:
* <b>LOCK_SH</b> to acquire a shared lock (reader).
* </p>
* @param int &$wouldBlock [optional] <p>
* @param int $wouldBlock [optional] <p>
* Set to 1 if the lock would block (EWOULDBLOCK errno condition).
* </p>
* @return bool true on success or false on failure.
Expand Down
20 changes: 10 additions & 10 deletions SQLite/SQLite.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class SQLiteDatabase
* @link https://php.net/manual/en/function.sqlite-open.php
* @param string $filename <p>The filename of the SQLite database. If the file does not exist, SQLite will attempt to create it. PHP must have write permissions to the file if data is inserted, the database schema is modified or to create the database if it does not exist.</p>
* @param int $mode [optional] <p>The mode of the file. Intended to be used to open the database in read-only mode. Presently, this parameter is ignored by the sqlite library. The default value for mode is the octal value 0666 and this is the recommended value.</p>
* @param string &$error_message [optional] <p>Passed by reference and is set to hold a descriptive error message explaining why the database could not be opened if there was an error.</p>
* @param string $error_message [optional] <p>Passed by reference and is set to hold a descriptive error message explaining why the database could not be opened if there was an error.</p>
*/
final public function __construct($filename, $mode = 0666, &$error_message) {}

Expand All @@ -28,7 +28,7 @@ final public function __construct($filename, $mode = 0666, &$error_message) {}
* </p>
* @param int $result_type [optional]
* <p>The optional <i>result_type</i> parameter accepts a constant and determines how the returned array will be indexed. Using <b>SQLITE_ASSOC</b> will return only associative indices (named fields) while <b>SQLITE_NUM</b> will return only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> will return both associative and numerical indices. <b>SQLITE_BOTH</b> is the default for this function.</p>
* @param string &$error_message [optional] <p>The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the {@see sqlite_last_error()} function.</p>
* @param string $error_message [optional] <p>The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the {@see sqlite_last_error()} function.</p>
* @return resource|false <p>
* This function will return a result handle or <b>FALSE</b> on failure.
* For queries that return rows, the result handle can then be used with
Expand Down Expand Up @@ -60,7 +60,7 @@ public function query($query, $result_type, &$error_message) {}
* <p>
* Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}.
* </p>
* @param string &$error_message [optional] <p>The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the
* @param string $error_message [optional] <p>The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the
* {@see sqlite_last_error()} function.</p>
* @return bool <p>
* This function will return a boolean result; <b>TRUE</b> for success or <b>FALSE</b> for failure.
Expand Down Expand Up @@ -134,7 +134,7 @@ public function singleQuery($query, $first_row_only, $decode_binary) {}
* Using <b>SQLITE_ASSOC</b> will return only associative indices (named fields) while <b>SQLITE_NUM</b> will return only numerical indices (ordinal field numbers).
* <b>SQLITE_BOTH</b> will return both associative and numerical indices. <b>SQLITE_BOTH</b> is the default for this function.
* </p>
* @param string &$error_message [optional]
* @param string $error_message [optional]
* @return resource Returns a result handle or <b>FALSE</b> on failure.
* {@see sqlite_unbuffered_query()} returns a sequential forward-only result set that can only be used to read each row, one after the other.
*/
Expand Down Expand Up @@ -564,7 +564,7 @@ public function __toString() {}
* library. The default value for mode is the octal value
* 0666 and this is the recommended value.
* </p>
* @param string &$error_message [optional] <p>
* @param string $error_message [optional] <p>
* Passed by reference and is set to hold a descriptive error message
* explaining why the database could not be opened if there was an error.
* </p>
Expand All @@ -588,7 +588,7 @@ function sqlite_open($filename, $mode = null, &$error_message = null) {}
* library. The default value for mode is the octal value
* 0666 and this is the recommended value.
* </p>
* @param string &$error_message [optional] <p>
* @param string $error_message [optional] <p>
* Passed by reference and is set to hold a descriptive error message
* explaining why the database could not be opened if there was an error.
* </p>
Expand Down Expand Up @@ -627,7 +627,7 @@ function sqlite_close($dbhandle) {}
* only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b>
* will return both associative and numerical indices.
* <b>SQLITE_BOTH</b> is the default for this function.</p>
* @param string &$error_msg [optional] <p>
* @param string $error_msg [optional] <p>
* The specified variable will be filled if an error occurs. This is
* specially important because SQL syntax errors can't be fetched using
* the
Expand Down Expand Up @@ -669,7 +669,7 @@ function sqlite_query($query, $dbhandle, $result_type = SQLITE_BOTH, &$error_msg
* {@see sqlite_open()} when used procedurally. This parameter
* is not required when using the object-oriented method.
* </p>
* @param string &$error_msg [optional] <p>
* @param string $error_msg [optional] <p>
* The specified variable will be filled if an error occurs. This is
* specially important because SQL syntax errors can't be fetched using
* the
Expand Down Expand Up @@ -1079,7 +1079,7 @@ function sqlite_error_string($error_code) {}
* Data inside the query should be properly escaped.
* </p>
* @param int $result_type [optional]
* @param string &$error_msg [optional] <p>
* @param string $error_msg [optional] <p>
* The specified variable will be filled if an error occurs. This is
* specially important because SQL syntax errors can't be fetched using
* the sqlite_last_error function.
Expand Down Expand Up @@ -1152,7 +1152,7 @@ function sqlite_create_function($dbhandle, $function_name, $callback, $num_args
* library. The default value for mode is the octal value
* 0666 and this is the recommended value.
* </p>
* @param string &$error_message [optional] <p>
* @param string $error_message [optional] <p>
* Passed by reference and is set to hold a descriptive error message
* explaining why the database could not be opened if there was an error.
* </p>
Expand Down
38 changes: 19 additions & 19 deletions aerospike/aerospike.php
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ public function put(array $key, array $bins, int $ttl = 0, array $options = [])
* @link https://www.aerospike.com/docs/guide/kvs.html Key-Value Store
* @link https://www.aerospike.com/docs/guide/glossary.html Glossary
* @param array $key The key identifying the record. An array with keys `['ns','set','key']` or `['ns','set','digest']`
* @param array &$record a reference to a variable which will contain the retrieved record of `['key', metadata', 'bins]` with the structure:
* @param array $record a reference to a variable which will contain the retrieved record of `['key', metadata', 'bins]` with the structure:
* ```
* Array:
* key => Array
Expand Down Expand Up @@ -699,7 +699,7 @@ public function get(array $key, &$record, ?array $select = null, array $options
* ```
* @link https://www.aerospike.com/docs/guide/glossary.html Glossary
* @param array $key The key identifying the record. An array with keys `['ns','set','key']` or `['ns','set','digest']`
* @param array &$metadata a reference to a variable which will be filled with an array of `['ttl', 'generation']` values
* @param array $metadata a reference to a variable which will be filled with an array of `['ttl', 'generation']` values
* @param array $options an optional array of read policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
* * Aerospike::OPT_DESERIALIZE
Expand Down Expand Up @@ -1388,7 +1388,7 @@ public function prepend(array $key, string $bin, string $value, array $options =
*
* ```
*
* @param array &$returned a pass-by-reference array of bins retrieved by read operations. If multiple operations exist for a specific bin name, the last operation will be the one placed as the value
* @param array $returned a pass-by-reference array of bins retrieved by read operations. If multiple operations exist for a specific bin name, the last operation will be the one placed as the value
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_WRITE_TIMEOUT
* * Aerospike::OPT_TTL
Expand Down Expand Up @@ -1767,7 +1767,7 @@ public function operate(array $key, array $operations, &$returned, array $option
*
* ```
*
* @param array &$returned a pass-by-reference array of bins retrieved by read operations. If multiple operations exist for a specific bin name, the last operation will be the one placed as the value
* @param array $returned a pass-by-reference array of bins retrieved by read operations. If multiple operations exist for a specific bin name, the last operation will be the one placed as the value
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_WRITE_TIMEOUT
* * Aerospike::OPT_TTL
Expand Down Expand Up @@ -1811,7 +1811,7 @@ public function operateOrdered(array $key, array $operations, &$returned, array
* @version 3.7 Requires server >= 3.7
* @param array $key The key identifying the record. An array with keys `['ns','set','key']` or `['ns','set','digest']`
* @param string $bin
* @param int &$count pass-by-reference param
* @param int $count pass-by-reference param
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
* * Aerospike::OPT_POLICY_KEY
Expand Down Expand Up @@ -1980,7 +1980,7 @@ public function listInsertItems(array $key, $bin, $index, array $elements, array
* @param array $key The key identifying the record. An array with keys `['ns','set','key']` or `['ns','set','digest']`
* @param string $bin
* @param int $index
* @param mixed &$element pass-by-reference param
* @param mixed $element pass-by-reference param
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_WRITE_TIMEOUT
* * Aerospike::OPT_TTL
Expand Down Expand Up @@ -2018,7 +2018,7 @@ public function listPop(array $key, $bin, $index, &$element, array $options = []
* @param string $bin
* @param int $index
* @param int $count
* @param array &$elements pass-by-reference param. After the method call it will be an array holding the popped elements.
* @param array $elements pass-by-reference param. After the method call it will be an array holding the popped elements.
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_WRITE_TIMEOUT
* * Aerospike::OPT_TTL
Expand Down Expand Up @@ -2228,7 +2228,7 @@ public function listSet(array $key, $bin, $index, $value, array $options = []) {
* @param array $key The key identifying the record. An array with keys `['ns','set','key']` or `['ns','set','digest']`
* @param string $bin
* @param int $index
* @param array &$element pass-by-reference param which will hold the returned element.
* @param array $element pass-by-reference param which will hold the returned element.
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
* * Aerospike::OPT_POLICY_KEY
Expand Down Expand Up @@ -2263,7 +2263,7 @@ public function listGet(array $key, $bin, $index, array &$element, array $option
* @param string $bin
* @param int $index
* @param int $count
* @param array &$elements pass-by-reference param which will hold an array of returned elements from the specified list bin.
* @param array $elements pass-by-reference param which will hold an array of returned elements from the specified list bin.
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
* * Aerospike::OPT_POLICY_KEY
Expand Down Expand Up @@ -2484,7 +2484,7 @@ public function listGetRange(array $key, $bin, $index, $count, &$elements, array
* }
* ```
* @param array $keys an array of initialized keys, each key an array with keys `['ns','set','key']` or `['ns','set','digest']`
* @param array &$records a pass-by-reference variable which will hold an array of record values, each record an array of `['key', 'metadata', 'bins']`
* @param array $records a pass-by-reference variable which will hold an array of record values, each record an array of `['key', 'metadata', 'bins']`
* @param array $select only these bins out of the record (optional)
* @param array $options an optional array of read policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
Expand Down Expand Up @@ -2608,7 +2608,7 @@ public function getMany(array $keys, &$records, array $select = [], array $optio
* }
* ```
* @param array $keys an array of initialized keys, each key an array with keys `['ns','set','key']` or `['ns','set','digest']`
* @param array &$metadata a pass-by-reference array of metadata values, each an array of `['key', 'metadata']`
* @param array $metadata a pass-by-reference array of metadata values, each an array of `['key', 'metadata']`
* @param array $options an optional array of read policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
* * Aerospike::USE_BATCH_DIRECT
Expand Down Expand Up @@ -2923,7 +2923,7 @@ public static function predicateGeoWithinRadius(string $bin, float $long, float
*
* @param int $job_id The Job ID
* @param int $job_type The type of the job, either Aerospike::JOB_QUERY, or Aerospike::JOB_SCAN
* @param array &$info The status of the background job filled (by reference) as an array of
* @param array $info The status of the background job filled (by reference) as an array of
* ```
* [
* 'progress_pct' => progress percentage for the job
Expand Down Expand Up @@ -3026,7 +3026,7 @@ public function deregister($module, $options = []) {}
* }
* }
* ```
* @param array &$modules pass-by-reference param
* @param array $modules pass-by-reference param
* @param int $language
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
Expand Down Expand Up @@ -3073,7 +3073,7 @@ public function listRegistered(&$modules, $language = Aerospike::UDF_TYPE_LUA, $
* "
* ```
* @param string $module the name of the UDF module registered with the cluster
* @param string &$code pass-by-reference param
* @param string $code pass-by-reference param
* @param string $language
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
Expand Down Expand Up @@ -3115,7 +3115,7 @@ public function getRegistered($module, &$code, $language = Aerospike::UDF_TYPE_L
* @param string $module the name of the UDF module registered with the cluster
* @param string $function the name of the UDF
* @param array $args optional arguments for the UDF
* @param mixed &$returned pass-by-reference param
* @param mixed $returned pass-by-reference param
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_WRITE_TIMEOUT
* * Aerospike::OPT_POLICY_KEY
Expand Down Expand Up @@ -3166,7 +3166,7 @@ public function apply(array $key, string $module, string $function, array $args
* @param string $module the name of the UDF module registered with the cluster
* @param string $function the name of the UDF
* @param array $args optional arguments for the UDF
* @param int &$job_id pass-by-reference filled by the job ID of the scan
* @param int $job_id pass-by-reference filled by the job ID of the scan
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_WRITE_TIMEOUT
* * Aerospike::OPT_POLICY_DURABLE_DELETE
Expand Down Expand Up @@ -3233,7 +3233,7 @@ public function scanApply(string $ns, string $set, string $module, string $funct
* @param string $module the name of the UDF module registered with the cluster
* @param string $function the name of the UDF
* @param array $args optional arguments for the UDF
* @param int &$job_id pass-by-reference filled by the job ID of the scan
* @param int $job_id pass-by-reference filled by the job ID of the scan
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_WRITE_TIMEOUT
* * Aerospike::OPT_POLICY_DURABLE_DELETE
Expand Down Expand Up @@ -3371,7 +3371,7 @@ public function queryApply(string $ns, string $set, array $where, string $module
* @param string $module the name of the UDF module registered with the cluster
* @param string $function the name of the UDF
* @param array $args optional arguments for the UDF
* @param mixed &$returned pass-by-reference param
* @param mixed $returned pass-by-reference param
* @param array $options an optional array of policy options, whose keys include
* * Aerospike::OPT_READ_TIMEOUT
* * Aerospike::OPT_READ_TIMEOUT
Expand Down Expand Up @@ -3472,7 +3472,7 @@ public function dropIndex(string $ns, string $name, array $options = []) {}
* ```
* @link https://www.aerospike.com/docs/reference/info Info Command Reference
* @param string $request a formatted info command
* @param string &$response a formatted response from the server, filled by reference
* @param string $response a formatted response from the server, filled by reference
* @param null|array $host an array holding the cluster node connection information cluster
* and manage its connections to them. ```[ 'addr' => $addr , 'port' => $port ]```
* @param array $options an optional array of policy options, whose keys include
Expand Down
Loading