diff options
-rw-r--r-- | core/API/DataTableManipulator/LabelFilter.php | 2 | ||||
-rw-r--r-- | core/API/DocumentationGenerator.php | 2 | ||||
-rw-r--r-- | core/Archive.php | 18 | ||||
-rw-r--r-- | core/Archive/DataCollection.php | 4 | ||||
-rw-r--r-- | core/Archive/DataTableFactory.php | 8 | ||||
-rw-r--r-- | core/Common.php | 2 | ||||
-rw-r--r-- | core/DataTable.php | 4 | ||||
-rw-r--r-- | core/DataTable/Filter/MetadataCallbackReplace.php | 2 | ||||
-rw-r--r-- | core/DataTable/Map.php | 6 | ||||
-rw-r--r-- | core/DataTable/Row.php | 6 | ||||
-rw-r--r-- | core/IP.php | 8 | ||||
-rw-r--r-- | core/Nonce.php | 2 | ||||
-rw-r--r-- | core/Option.php | 2 | ||||
-rw-r--r-- | core/Piwik.php | 2 | ||||
-rw-r--r-- | core/Session/SaveHandler/DbTable.php | 2 | ||||
-rw-r--r-- | core/Tracker/Action.php | 2 | ||||
-rw-r--r-- | core/Tracker/GoalManager.php | 2 | ||||
-rw-r--r-- | core/Tracker/Visit.php | 4 | ||||
-rw-r--r-- | core/UpdateCheck.php | 2 | ||||
-rw-r--r-- | core/Url.php | 4 | ||||
-rw-r--r-- | core/functions.php | 2 |
21 files changed, 43 insertions, 43 deletions
diff --git a/core/API/DataTableManipulator/LabelFilter.php b/core/API/DataTableManipulator/LabelFilter.php index fdc5114c98..45ca278fc1 100644 --- a/core/API/DataTableManipulator/LabelFilter.php +++ b/core/API/DataTableManipulator/LabelFilter.php @@ -64,7 +64,7 @@ class LabelFilter extends DataTableManipulator * * @param array $labelParts * @param DataTable $dataTable - * @return Row|false + * @return Row|bool */ private function doFilterRecursiveDescend($labelParts, $dataTable) { diff --git a/core/API/DocumentationGenerator.php b/core/API/DocumentationGenerator.php index ae1b1557bf..c80dbd4711 100644 --- a/core/API/DocumentationGenerator.php +++ b/core/API/DocumentationGenerator.php @@ -123,7 +123,7 @@ class DocumentationGenerator * @param string $class the class * @param string $methodName the method * @param array $parametersToSet parameters to set - * @return string|false when not possible + * @return string|bool when not possible */ public function getExampleUrl($class, $methodName, $parametersToSet = array()) { diff --git a/core/Archive.php b/core/Archive.php index 1d7d226f33..6e060cc2da 100644 --- a/core/Archive.php +++ b/core/Archive.php @@ -169,9 +169,9 @@ class Archive * * @param string|array $names One or more archive names, eg, 'nb_visits', 'Referers_distinctKeywords', * etc. - * @return numeric|array|false False if no value with the given name, numeric if only one site - * and date and we're not forcing an index, and array if multiple - * sites/dates are queried. + * @return mixed False if no value with the given name, numeric if only one site + * and date and we're not forcing an index, and array if multiple + * sites/dates are queried. */ public function getNumeric($names) { @@ -200,7 +200,7 @@ class Archive * * @param string|array $names One or more archive names, eg, 'Referers_keywordBySearchEngine'. * @param null $idSubtable - * @return string|array|false False if no value with the given name, numeric if only one site + * @return string|array|bool False if no value with the given name, numeric if only one site * and date and we're not forcing an index, and array if multiple * sites/dates are queried. */ @@ -217,9 +217,9 @@ class Archive * * @param string|array $names One or more archive names, eg, 'nb_visits', 'Referers_distinctKeywords', * etc. - * @return DataTable|false False if no value with the given names. Based on the number - * of sites/periods, the result can be a DataTable_Array, which - * contains DataTable instances. + * @return DataTable|DataTable\Map|bool False if no value with the given names. Based on the number + * of sites/periods, the result can be a DataTable_Array, which + * contains DataTable instances. */ public function getDataTableFromNumeric($names) { @@ -237,7 +237,7 @@ class Archive * * @param string $name The name of the record to get. * @param int|string|null $idSubtable The subtable ID (if any) or 'all' if requesting every datatable. - * @return DataTable|false + * @return DataTable|DataTable\Map|bool */ public function getDataTable($name, $idSubtable = null) { @@ -320,7 +320,7 @@ class Archive * @param array|string $archiveNames * @param $archiveDataType * @param null|int $idSubtable - * @return DataCollection + * @return Archive\DataCollection */ private function get($archiveNames, $archiveDataType, $idSubtable = null) { diff --git a/core/Archive/DataCollection.php b/core/Archive/DataCollection.php index 4b05615c21..65b33a3765 100644 --- a/core/Archive/DataCollection.php +++ b/core/Archive/DataCollection.php @@ -204,7 +204,7 @@ class DataCollection * by the metadata specified here. * * Eg, array('site' => 'idSite', 'period' => 'Date') - * @return \Piwik\DataTable|Set + * @return DataTable|DataTable\Map */ public function getDataTable($resultIndices) { @@ -232,7 +232,7 @@ class DataCollection * @param bool $addMetadataSubtableId Whether to add the DB subtable ID as metadata * to each datatable, or not. * @throws Exception - * @return \Piwik\DataTable|Set + * @return DataTable|DataTable\Map */ public function getExpandedDataTable($resultIndices, $idSubtable = null, $addMetadataSubtableId = false) { diff --git a/core/Archive/DataTableFactory.php b/core/Archive/DataTableFactory.php index d571b06d60..4fc42d662c 100644 --- a/core/Archive/DataTableFactory.php +++ b/core/Archive/DataTableFactory.php @@ -126,7 +126,7 @@ class DataTableFactory * @param array $index @see DataCollection * @param array $resultIndices an array mapping metadata names with pretty metadata * labels. - * @return DataTable|Set + * @return DataTable|DataTable\Map */ public function make($index, $resultIndices) { @@ -160,7 +160,7 @@ class DataTableFactory * the created DataTable's subtables will be expanded. * * @param array $blobRow - * @return DataTable|Set + * @return DataTable|DataTable\Map */ private function makeFromBlobRow($blobRow) { @@ -237,7 +237,7 @@ class DataTableFactory * @param array $index @see DataCollection * @param array $resultIndices @see make * @param array $keyMetadata The metadata to add to the table when it's created. - * @return Set + * @return DataTable\Map */ private function createDataTableArrayFromIndex($index, $resultIndices, $keyMetadata = array()) { @@ -267,7 +267,7 @@ class DataTableFactory /** * Creates a DataTable instance from an index row. * - * @param array|false $data An archive data row. + * @param array $data An archive data row. * @param array $keyMetadata The metadata to add to the table(s) when created. * @return DataTable|DataTable\Map */ diff --git a/core/Common.php b/core/Common.php index 0fbf8f8ddf..291aad33f7 100644 --- a/core/Common.php +++ b/core/Common.php @@ -1211,7 +1211,7 @@ class Common * * @see unit tests in /tests/core/Common.test.php * @param string $referrerUrl URL referer URL, eg. $_SERVER['HTTP_REFERER'] - * @return array|false false if a keyword couldn't be extracted, + * @return array|bool false if a keyword couldn't be extracted, * or array( * 'name' => 'Google', * 'keywords' => 'my searched keywords') diff --git a/core/DataTable.php b/core/DataTable.php index e655587652..ac867e7c23 100644 --- a/core/DataTable.php +++ b/core/DataTable.php @@ -470,7 +470,7 @@ class DataTable * Returns the Row that has a column 'label' with the value $label * * @param string $label Value of the column 'label' of the row to return - * @return \Piwik\DataTable\Row|false The row if found, false otherwise + * @return \Piwik\DataTable\Row|bool The row if found, false otherwise */ public function getRowFromLabel($label) { @@ -564,7 +564,7 @@ class DataTable * Returns a row that has the subtable ID matching the parameter * * @param int $idSubTable - * @return \Piwik\DataTable\Row|false if not found + * @return \Piwik\DataTable\Row|bool false if not found */ public function getRowFromIdSubDataTable($idSubTable) { diff --git a/core/DataTable/Filter/MetadataCallbackReplace.php b/core/DataTable/Filter/MetadataCallbackReplace.php index affbc6f4ab..e10119c9fe 100644 --- a/core/DataTable/Filter/MetadataCallbackReplace.php +++ b/core/DataTable/Filter/MetadataCallbackReplace.php @@ -49,7 +49,7 @@ class MetadataCallbackReplace extends ColumnCallbackReplace /** * @param Row $row * @param string $metadataToFilter - * @return array|false|mixed + * @return array|bool|mixed */ protected function getElementToReplace($row, $metadataToFilter) { diff --git a/core/DataTable/Map.php b/core/DataTable/Map.php index 76a2c642f8..ea35f0365d 100644 --- a/core/DataTable/Map.php +++ b/core/DataTable/Map.php @@ -290,7 +290,7 @@ class Map * This function can be used, for example, to smoosh IndexedBySite archive * query results into one DataTable w/ different rows differentiated by site ID. * - * @return DataTable|Set + * @return DataTable|Map */ public function mergeChildren() { @@ -367,7 +367,7 @@ class Map * * @see DataTable::mergeSubtables * - * @return Set + * @return Map */ public function mergeSubtables() { @@ -382,7 +382,7 @@ class Map * Returns a new DataTable_Array w/o any child DataTables, but with * the same key name as this instance. * - * @return Set + * @return Map */ public function getEmptyClone() { diff --git a/core/DataTable/Row.php b/core/DataTable/Row.php index 3b4a0d6df9..0e86ef0f95 100644 --- a/core/DataTable/Row.php +++ b/core/DataTable/Row.php @@ -202,7 +202,7 @@ class Row * Returns the given column * * @param string $name Column name - * @return mixed|false The column value + * @return mixed|bool The column value or false if it doesn't exist */ public function getColumn($name) { @@ -217,7 +217,7 @@ class Row * or the specified metadata * * @param string $name Metadata name - * @return mixed|array|false + * @return mixed */ public function getMetadata($name = null) { @@ -261,7 +261,7 @@ class Row /** * Returns the associated subtable, if one exists. * - * @return DataTable|false + * @return DataTable|bool false if no subtable loaded */ public function getSubtable() { diff --git a/core/IP.php b/core/IP.php index e4a87cb9ee..2940884ba8 100644 --- a/core/IP.php +++ b/core/IP.php @@ -39,7 +39,7 @@ class IP * Sanitize human-readable IP address. * * @param string $ipString IP address - * @return string|false + * @return string */ public static function sanitizeIp($ipString) { @@ -87,7 +87,7 @@ class IP * - wildcards, e.g., 192.168.0.* * * @param string $ipRangeString IP address range - * @return string|false IP address range in CIDR notation + * @return string|bool IP address range in CIDR notation OR false */ public static function sanitizeIpRange($ipRangeString) { @@ -261,7 +261,7 @@ class IP * Get low and high IP addresses for a specified range. * * @param array $ipRange An IP address range in presentation format - * @return array|false Array ($lowIp, $highIp) in network address format, or false if failure + * @return array|bool Array ($lowIp, $highIp) in network address format, or false if failure */ public static function getIpsForRange($ipRange) { @@ -449,7 +449,7 @@ class IP * @link http://php.net/inet_ntop * * @param string $in_addr 32-bit IPv4 or 128-bit IPv6 address - * @return string|false string representation of address or false on failure + * @return string|bool string representation of address or false on failure */ static public function php_compat_inet_ntop($in_addr) { diff --git a/core/Nonce.php b/core/Nonce.php index 8f876b1890..d7606854f9 100644 --- a/core/Nonce.php +++ b/core/Nonce.php @@ -103,7 +103,7 @@ class Nonce /** * Get ORIGIN header, false if not found * - * @return string|false + * @return string|bool */ static public function getOrigin() { diff --git a/core/Option.php b/core/Option.php index 653363bfc1..dab41eac1e 100644 --- a/core/Option.php +++ b/core/Option.php @@ -61,7 +61,7 @@ class Option * Returns the option value for the requested option $name, fetching from database, if not in cache. * * @param string $name Key - * @return string|false Value or false, if not found + * @return string|bool Value or false, if not found */ public function get($name) { diff --git a/core/Piwik.php b/core/Piwik.php index de54f033ad..140f191129 100644 --- a/core/Piwik.php +++ b/core/Piwik.php @@ -909,7 +909,7 @@ class Piwik * compile-time default, so ini_get('memory_limit') may return false. * * @see http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes - * @return int|false memory limit in megabytes, or false if there is no limit + * @return int|bool memory limit in megabytes, or false if there is no limit */ static public function getMemoryLimitValue() { diff --git a/core/Session/SaveHandler/DbTable.php b/core/Session/SaveHandler/DbTable.php index 3f1d53a08f..60f5c77d9d 100644 --- a/core/Session/SaveHandler/DbTable.php +++ b/core/Session/SaveHandler/DbTable.php @@ -134,7 +134,7 @@ class DbTable implements Zend_Session_SaveHandler_Interface * than $maxlifetime (in seconds) * * @param int $maxlifetime timestamp in seconds - * @return true + * @return bool always true */ public function gc($maxlifetime) { diff --git a/core/Tracker/Action.php b/core/Tracker/Action.php index 3d9e290876..ee434789ec 100644 --- a/core/Tracker/Action.php +++ b/core/Tracker/Action.php @@ -713,7 +713,7 @@ class Action implements ActionInterface /** * Returns the ID of the newly created record in the log_link_visit_action table * - * @return int | false + * @return int */ public function getIdLinkVisitAction() { diff --git a/core/Tracker/GoalManager.php b/core/Tracker/GoalManager.php index 56c989ffa9..aebba94c7d 100644 --- a/core/Tracker/GoalManager.php +++ b/core/Tracker/GoalManager.php @@ -411,7 +411,7 @@ class GoalManager /** * Returns Items read from the request string - * @return array|false + * @return array|bool */ protected function getEcommerceItemsFromRequest() { diff --git a/core/Tracker/Visit.php b/core/Tracker/Visit.php index 3590b4c319..7a791c41a3 100644 --- a/core/Tracker/Visit.php +++ b/core/Tracker/Visit.php @@ -603,7 +603,7 @@ class Visit implements Tracker\VisitInterface /** * Returns visitor cookie * - * @return binary + * @return string binary */ protected function getVisitorIdcookie() { @@ -631,7 +631,7 @@ class Visit implements Tracker\VisitInterface /** * Returns the visitor's IP address * - * @return long + * @return string */ protected function getVisitorIp() { diff --git a/core/UpdateCheck.php b/core/UpdateCheck.php index 2c30124676..08e4c02a1a 100644 --- a/core/UpdateCheck.php +++ b/core/UpdateCheck.php @@ -83,7 +83,7 @@ class UpdateCheck /** * Returns version number of a newer Piwik release. * - * @return string|false false if current version is the latest available, + * @return string|bool false if current version is the latest available, * or the latest version number if a newest release is available */ public static function isNewestVersionAvailable() diff --git a/core/Url.php b/core/Url.php index 80923d972c..d3a22688d6 100644 --- a/core/Url.php +++ b/core/Url.php @@ -250,7 +250,7 @@ class Url * * @param bool $checkIfTrusted Whether to do trusted host check. Should ALWAYS be true, * except in Controller. - * @return string|false + * @return string|bool false if no host found */ static public function getHost($checkIfTrusted = true) { @@ -408,7 +408,7 @@ class Url /** * Returns the HTTP_REFERER header, false if not found. * - * @return string|false + * @return string|bool */ static public function getReferer() { diff --git a/core/functions.php b/core/functions.php index 25dfaedf9b..98c27e322a 100644 --- a/core/functions.php +++ b/core/functions.php @@ -97,7 +97,7 @@ namespace { * Returns the option value for the requested option $name * * @param string $name Key - * @return string|false Value or false, if not found + * @return string|bool Value or false, if not found */ function Piwik_GetOption($name) { |