Permalink
Browse files

Correct doc block return types.

  • Loading branch information...
dereuromark committed Nov 5, 2014
1 parent 96b82e4 commit 768f2c809cadde25941050875f89d0a7f64f1ef4
@@ -154,7 +154,7 @@ protected function _getDigest() {
* Parse the digest authentication headers and split them up.
*
* @param string $digest The raw digest authentication headers.
- * @return array An array of digest authentication headers
+ * @return array|null An array of digest authentication headers
*/
public function parseAuthData($digest) {
if (substr($digest, 0, 7) === 'Digest ') {
@@ -643,7 +643,7 @@ public function logout() {
* cookies + sessions will be used.
*
* @param string $key field to retrieve. Leave null to get entire User record
- * @return mixed User record. or null if no user is logged in.
+ * @return array|null User record. or null if no user is logged in.
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#accessing-the-logged-in-user
*/
public static function user($key = null) {
@@ -262,7 +262,7 @@ public function write($key, $value = null, $encrypt = true, $expires = null) {
* $this->Cookie->read(Name.key);
*
* @param string $key Key of the value to be obtained. If none specified, obtain map key => values
- * @return string or null, value for specified key
+ * @return string|null Value for specified key
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::read
*/
public function read($key = null) {
@@ -405,7 +405,7 @@ protected function _formatAttachFiles() {
* Find the specified attachment in the list of file paths
*
* @param string $attachment Attachment file name to find
- * @return string Path to located file
+ * @return string|null Path to located file
*/
protected function _findFiles($attachment) {
if (file_exists($attachment)) {
@@ -162,7 +162,7 @@ protected function _setExtension() {
$accepts = $this->response->mapType($accept);
$preferedTypes = current($accepts);
if (array_intersect($preferedTypes, array('html', 'xhtml'))) {
- return null;
+ return;
}
$extensions = Router::extensions();
@@ -724,7 +724,7 @@ public function mapType($cType) {
* Maps a content type alias back to its mime-type(s)
*
* @param string|array $alias String alias to convert back into a content type. Or an array of aliases to map.
- * @return string Null on an undefined alias. String value of the mapped alias type. If an
+ * @return string|null Null on an undefined alias. String value of the mapped alias type. If an
* alias maps to more than one content type, the first one will be returned.
*/
public function mapAlias($alias) {
@@ -355,7 +355,7 @@ protected function _requireMethod($method, $actions = array()) {
* Check if HTTP methods are required
*
* @param Controller $controller Instantiating controller
- * @return bool true if $method is required
+ * @return bool|null True if $method is required
*/
protected function _methodsRequired(Controller $controller) {
foreach (array('Post', 'Get', 'Put', 'Delete') as $method) {
@@ -378,7 +378,7 @@ protected function _methodsRequired(Controller $controller) {
* Check if access requires secure connection
*
* @param Controller $controller Instantiating controller
- * @return bool true if secure connection required
+ * @return bool|null True if secure connection required
*/
protected function _secureRequired(Controller $controller) {
if (is_array($this->requireSecure) && !empty($this->requireSecure)) {
@@ -399,7 +399,7 @@ protected function _secureRequired(Controller $controller) {
* Check if authentication is required
*
* @param Controller $controller Instantiating controller
- * @return bool true if authentication required
+ * @return bool|null True if authentication required
*/
protected function _authRequired(Controller $controller) {
if (is_array($this->requireAuth) && !empty($this->requireAuth) && !empty($this->request->data)) {
@@ -1017,7 +1017,7 @@ public function flash($message, $url, $pause = 1, $layout = 'flash') {
* @param string $bool SQL boolean operator: AND, OR, XOR, etc.
* @param bool $exclusive If true, and $op is an array, fields not included in $op will not be
* included in the returned conditions
- * @return array An array of model conditions
+ * @return array|null An array of model conditions
* @deprecated 3.0.0 Will be removed in 3.0.
*/
public function postConditions($data = array(), $op = null, $bool = 'AND', $exclusive = false) {
View
@@ -575,7 +575,7 @@ public static function load($className) {
* Returns the package name where a class was defined to be located at
*
* @param string $className name of the class to obtain the package name from
- * @return string package name or null if not declared
+ * @return string|null Package name, or null if not declared
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::location
*/
public static function location($className) {
@@ -824,7 +824,7 @@ protected static function _codepoint($decimal) {
*
* @param int $char decimal value of character
* @param string $type Type 'lower' or 'upper'. Defaults to 'lower'.
- * @return array
+ * @return array|null
*/
protected static function _find($char, $type = 'lower') {
$found = array();
@@ -73,7 +73,7 @@ public function setup(Model $model, $config = array()) {
* @param Model $model Model using this behavior.
* @param string|array|Model $ref Array with 'model' and 'foreign_key', model object, or string value
* @param string $type Only needed when Acl is set up as 'both', specify 'Aro' or 'Aco' to get the correct node
- * @return array
+ * @return array|null
* @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/acl.html#node
*/
public function node(Model $model, $ref = null, $type = null) {
@@ -443,7 +443,7 @@ public function getParentNode(Model $Model, $id = null, $fields = null, $recursi
* @param int|string $id The ID of the record to read
* @param string|array $fields Either a single string of a field name, or an array of field names
* @param int $recursive The number of levels deep to fetch associated records
- * @return array Array of nodes from top most parent to current node
+ * @return array|null Array of nodes from top most parent to current node
* @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::getPath
*/
public function getPath(Model $Model, $id = null, $fields = null, $recursive = null) {
@@ -126,7 +126,7 @@ public static function sourceList() {
* Gets a DataSource name from an object reference.
*
* @param DataSource $source DataSource object
- * @return string Datasource name, or null if source is not present
+ * @return string|null Datasource name, or null if source is not present
* in the ConnectionManager.
*/
public static function getSourceName($source) {
@@ -145,8 +145,8 @@ public static function getSourceName($source) {
* Loads the DataSource class for the given connection name
*
* @param string|array $connName A string name of the connection, as defined in app/Config/database.php,
- * or an array containing the filename (without extension) and class name of the object,
- * to be found in app/Model/Datasource/ or lib/Cake/Model/Datasource/.
+ * or an array containing the filename (without extension) and class name of the object,
+ * to be found in app/Model/Datasource/ or lib/Cake/Model/Datasource/.
* @return bool True on success, null on failure or false if the class is already loaded
* @throws MissingDatasourceException
*/
@@ -184,10 +184,10 @@ public static function loadDataSource($connName) {
}
/**
- * Return a list of connections
+ * Returns a list of connections
*
* @return array An associative array of elements where the key is the connection name
- * (as defined in Connections), and the value is an array with keys 'filename' and 'classname'.
+ * (as defined in Connections), and the value is an array with keys 'filename' and 'classname'.
*/
public static function enumConnectionObjects() {
if (empty(self::$_init)) {
@@ -201,7 +201,7 @@ public static function enumConnectionObjects() {
*
* @param string $name The DataSource name
* @param array $config The DataSource configuration settings
- * @return DataSource A reference to the DataSource object, or null if creation failed
+ * @return DataSource|null A reference to the DataSource object, or null if creation failed
*/
public static function create($name = '', $config = array()) {
if (empty(self::$_init)) {
@@ -90,7 +90,7 @@ public function __construct($config = array()) {
* Caches/returns cached results for child instances
*
* @param mixed $data Unused in this class.
- * @return array Array of sources available in this datasource.
+ * @return array|null Array of sources available in this datasource.
*/
public function listSources($data = null) {
if ($this->cacheSources === false) {
@@ -117,7 +117,7 @@ public function listSources($data = null) {
* Returns a Model description (metadata) or null if none found.
*
* @param Model|string $model The model to describe.
- * @return array Array of Metadata for the $model
+ * @return array|null Array of Metadata for the $model
*/
public function describe($model) {
if ($this->cacheSources === false) {
@@ -407,7 +407,7 @@ public function resolveKey(Model $Model, $key) {
/**
* Returns the schema name. Override this in subclasses.
*
- * @return string schema name
+ * @return string|null schema name
*/
public function getSchemaName() {
return null;
View
@@ -1362,7 +1362,7 @@ public function deconstruct($field, $data) {
* $field => keys(type, null, default, key, length, extra)
*
* @param bool|string $field Set to true to reload schema, or a string to return a specific field
- * @return array Array of table metadata
+ * @return array|null Array of table metadata
*/
public function schema($field = false) {
if ($this->useTable !== false && (!is_array($this->_schema) || $field === true)) {
@@ -2904,7 +2904,7 @@ public function hasAny($conditions = null) {
*
* @param string $type Type of find operation (all / first / count / neighbors / list / threaded)
* @param array $query Option fields (conditions / fields / joins / limit / offset / order / page / group / callbacks)
- * @return array Array of records, or Null on failure.
+ * @return array|null Array of records, or Null on failure.
* @link http://book.cakephp.org/2.0/en/models/retrieving-your-data.html
*/
public function find($type = 'first', $query = array()) {
@@ -2963,7 +2963,7 @@ protected function _readDataSource($type, $query) {
*
* @param string $type Type of find operation (all / first / count / neighbors / list / threaded)
* @param array $query Option fields (conditions / fields / joins / limit / offset / order / page / group / callbacks)
- * @return array Query array or null if it could not be build for some reasons
+ * @return array|null Query array or null if it could not be build for some reasons
* @see Model::find()
*/
public function buildQuery($type = 'first', $query = array()) {
@@ -3582,7 +3582,7 @@ public function associations() {
* Gets all the models with which this model is associated.
*
* @param string $type Only result associations of this type
- * @return array Associations
+ * @return array|null Associations
*/
public function getAssociated($type = null) {
if (!$type) {
@@ -318,7 +318,7 @@ public function getMethods() {
* params are passed then it returns an array with all CakeValidationSet objects for each field
*
* @param string $name [optional] The fieldname to fetch. Defaults to null.
- * @return CakeValidationSet|array
+ * @return CakeValidationSet|array|null
*/
public function getField($name = null) {
$this->_parseRules();
@@ -300,7 +300,7 @@ public function reset() {
* Returns passed options for this rule
*
* @param string|int $key Array index
- * @return array
+ * @return array|null
*/
public function getOptions($key) {
if (!isset($this->_passedOptions[$key])) {
@@ -241,7 +241,7 @@ public function addresses() {
/**
* Get the last error as a string.
*
- * @return string Last error
+ * @return string|null Last error
*/
public function lastError() {
if (!empty($this->lastError)) {
View
@@ -97,7 +97,7 @@ public static function pushDiff($array, $array2) {
*
* @param string $class A class name of the type of object to map to
* @param string $tmp A temporary class name used as $class if $class is an array
- * @return object Hierarchical object
+ * @return object|null Hierarchical object
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/set.html#Set::map
*/
public static function map($class = 'stdClass', $tmp = 'stdClass') {
View
@@ -406,7 +406,7 @@ public function assetTimestamp($path) {
* content is the best way to prevent all possible attacks.
*
* @param string|array $output Either an array of strings to clean or a single string to clean.
- * @return string|array cleaned content for output
+ * @return string|array|null Cleaned content for output
* @deprecated 3.0.0 This method will be removed in 3.0
*/
public function clean($output) {
@@ -141,7 +141,7 @@ public function __construct(View $View, $settings = array()) {
* or get an already created instance of the model
*
* @param string $model Model name.
- * @return Model model instance
+ * @return Model|null Model instance
*/
protected function _getModel($model) {
$object = null;
@@ -198,7 +198,7 @@ public function addCrumb($name, $link = null, $options = null) {
* - xhtml11: XHTML1.1.
*
* @param string $type Doctype to use.
- * @return string Doctype string
+ * @return string|null Doctype string
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::docType
*/
public function docType($type = 'html5') {
@@ -613,7 +613,6 @@ public function scriptStart($options = array()) {
$options += array('safe' => true, 'inline' => true);
$this->_scriptBlockOptions = $options;
ob_start();
- return null;
}
/**
@@ -675,7 +674,7 @@ public function style($data, $oneline = true) {
* @param string $separator Text to separate crumbs.
* @param string|array|bool $startText This will be the first crumb, if false it defaults to first crumb in array. Can
* also be an array, see above for details.
- * @return string Composed bread crumbs
+ * @return string|null Composed bread crumbs
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper
*/
public function getCrumbs($separator = '»', $startText = false) {
@@ -709,7 +708,7 @@ public function getCrumbs($separator = '»', $startText = false) {
* @param array $options Array of html attributes to apply to the generated list elements.
* @param string|array|bool $startText This will be the first crumb, if false it defaults to first crumb in array. Can
* also be an array, see `HtmlHelper::getCrumbs` for details.
- * @return string breadcrumbs html list
+ * @return string|null breadcrumbs html list
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper
*/
public function getCrumbList($options = array(), $startText = false) {
@@ -120,7 +120,7 @@ public function beforeRender($viewFile) {
* Gets the current paging parameters from the resultset for the given model
*
* @param string $model Optional model name. Uses the default if none is specified.
- * @return array The array of paging parameters for the paginated resultset.
+ * @return array|null The array of paging parameters for the paginated resultset.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::params
*/
public function params($model = null) {
@@ -207,7 +207,7 @@ public function current($model = null) {
*
* @param string $model Optional model name. Uses the default if none is specified.
* @param array $options Options for pagination links. See #options for list of keys.
- * @return string The name of the key by which the recordset is being sorted, or
+ * @return string|null The name of the key by which the recordset is being sorted, or
* null if the results are not currently sorted.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::sortKey
*/
@@ -481,7 +481,7 @@ protected function _convertUrlKeys($url, $type) {
* @param array $options Options list.
* @param string $disabledTitle Disabled link title.
* @param array $disabledOptions Disabled link options.
- * @return string
+ * @return string|null
*/
protected function _pagingLink($which, $title = null, $options = array(), $disabledTitle = null, $disabledOptions = array()) {
$check = 'has' . $which;
@@ -594,7 +594,7 @@ protected function _hasPage($model, $page) {
/**
* Gets the default model of the paged sets
*
- * @return string Model name or null if the pagination isn't initialized.
+ * @return string|null Model name or null if the pagination isn't initialized.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::defaultModel
*/
public function defaultModel() {
@@ -707,7 +707,7 @@ public function counter($options = array()) {
* - `currentTag` Tag to use for current page number, defaults to null
*
* @param array $options Options for the numbers, (before, after, model, modulus, separator)
- * @return string numbers string.
+ * @return string|bool numbers string.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::numbers
*/
public function numbers($options = array()) {
@@ -849,7 +849,7 @@ public function numbers($options = array()) {
* @param string|int $first if string use as label for the link. If numeric, the number of page links
* you want at the beginning of the range.
* @param array $options An array of options.
- * @return string numbers string.
+ * @return string|bool numbers string.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::first
*/
public function first($first = '<< first', $options = array()) {
@@ -912,7 +912,7 @@ public function first($first = '<< first', $options = array()) {
*
* @param string|int $last if string use as label for the link, if numeric print page numbers
* @param array $options Array of options
- * @return string numbers string.
+ * @return string|bool numbers string.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html#PaginatorHelper::last
*/
public function last($last = 'last >>', $options = array()) {
@@ -83,7 +83,7 @@ public function __set($name, $value) {
* Magic isset check for deprecated attributes.
*
* @param string $name Name of the attribute to check.
- * @return bool
+ * @return bool|null
*/
public function __isset($name) {
if (isset($this->{$name})) {
Oops, something went wrong.

0 comments on commit 768f2c8

Please sign in to comment.