@@ -123,7 +123,7 @@ discard block |
||
| 123 | 123 | * |
| 124 | 124 | * @since Symphony 2.2.4 |
| 125 | 125 | * @param string $name |
| 126 | - * @return array|string|null |
|
| 126 | + * @return string |
|
| 127 | 127 | * If `$name` is omitted this function returns array. |
| 128 | 128 | * If `$name` is not set, this fucntion returns `null` |
| 129 | 129 | * If `$name` is set, this function returns string |
@@ -259,7 +259,7 @@ discard block |
||
| 259 | 259 | * Localizes the output, if true, defaults to true |
| 260 | 260 | * @param string $timezone (optional) |
| 261 | 261 | * The timezone associated with the timestamp |
| 262 | - * @return string|boolean |
|
| 262 | + * @return false|string |
|
| 263 | 263 | * The formatted date, or if the date could not be parsed, false. |
| 264 | 264 | */ |
| 265 | 265 | public static function format($string = 'now', $format = DateTime::ISO8601, $localize = true, $timezone = null) |
@@ -567,7 +567,7 @@ discard block |
||
| 567 | 567 | * result in the current time being used |
| 568 | 568 | * @param string $timezone (optional) |
| 569 | 569 | * The timezone associated with the timestamp |
| 570 | - * @return string|boolean |
|
| 570 | + * @return false|string |
|
| 571 | 571 | * The formatted date, of if the date could not be parsed, false. |
| 572 | 572 | */ |
| 573 | 573 | public static function get($format, $timestamp = 'now', $timezone = null) |
@@ -28,7 +28,7 @@ discard block |
||
| 28 | 28 | * @param array $fields |
| 29 | 29 | * Associative array of field names => values for the Author object |
| 30 | 30 | * @throws DatabaseException |
| 31 | - * @return integer|boolean |
|
| 31 | + * @return false|string |
|
| 32 | 32 | * Returns an Author ID of the created Author on success, false otherwise. |
| 33 | 33 | */ |
| 34 | 34 | public static function add(array $fields) |
@@ -53,7 +53,7 @@ discard block |
||
| 53 | 53 | * This array does need to contain every value for the author object, it |
| 54 | 54 | * can just be the changed values. |
| 55 | 55 | * @throws DatabaseException |
| 56 | - * @return boolean |
|
| 56 | + * @return PDOStatement |
|
| 57 | 57 | */ |
| 58 | 58 | public static function edit($id, array $fields) |
| 59 | 59 | { |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | * @param integer $id |
| 67 | 67 | * The ID of the Author that should be deleted |
| 68 | 68 | * @throws DatabaseException |
| 69 | - * @return boolean |
|
| 69 | + * @return PDOStatement |
|
| 70 | 70 | */ |
| 71 | 71 | public static function delete($id) |
| 72 | 72 | { |
@@ -711,7 +711,7 @@ |
||
| 711 | 711 | * Returns the last insert ID from the previous query. This is |
| 712 | 712 | * the value from an auto_increment field. |
| 713 | 713 | * |
| 714 | - * @return integer |
|
| 714 | + * @return string |
|
| 715 | 715 | * The last interested row's ID |
| 716 | 716 | */ |
| 717 | 717 | public function getInsertID() |
@@ -164,7 +164,7 @@ discard block |
||
| 164 | 164 | * |
| 165 | 165 | * @param string $name |
| 166 | 166 | * The gateway to look for |
| 167 | - * @return string|boolean |
|
| 167 | + * @return string |
|
| 168 | 168 | * @todo fix return if gateway does not exist. |
| 169 | 169 | */ |
| 170 | 170 | public static function __getDriverPath($name) |
@@ -177,7 +177,7 @@ discard block |
||
| 177 | 177 | * Does not check if the gateway exists. |
| 178 | 178 | * |
| 179 | 179 | * @param string $filename |
| 180 | - * @return string|boolean |
|
| 180 | + * @return string |
|
| 181 | 181 | */ |
| 182 | 182 | public static function __getHandleFromFilename($filename) |
| 183 | 183 | { |
@@ -145,7 +145,7 @@ |
||
| 145 | 145 | * |
| 146 | 146 | * @see toolkit.MySQL#getInsertID() |
| 147 | 147 | * @throws DatabaseException |
| 148 | - * @return integer |
|
| 148 | + * @return null|string |
|
| 149 | 149 | */ |
| 150 | 150 | public function assignEntryId() |
| 151 | 151 | { |
@@ -475,7 +475,7 @@ discard block |
||
| 475 | 475 | * |
| 476 | 476 | * @param integer $entry_id |
| 477 | 477 | * The ID of the Entry to return it's section |
| 478 | - * @return integer |
|
| 478 | + * @return string |
|
| 479 | 479 | * The Section ID for this Entry's section |
| 480 | 480 | */ |
| 481 | 481 | public static function fetchEntrySectionID($entry_id) |
@@ -654,7 +654,7 @@ discard block |
||
| 654 | 654 | * by providing an array of field names. Defaults to null, which will load data |
| 655 | 655 | * from all fields in a section. |
| 656 | 656 | * @throws Exception |
| 657 | - * @return array |
|
| 657 | + * @return integer|null |
|
| 658 | 658 | * Either an array of Entry objects, or an associative array containing |
| 659 | 659 | * the total entries, the start position, the entries per page and the |
| 660 | 660 | * Entry objects |
@@ -725,7 +725,7 @@ discard block |
||
| 725 | 725 | * Any custom JOIN's |
| 726 | 726 | * @param boolean $group |
| 727 | 727 | * Whether the entries need to be grouped by Entry ID or not |
| 728 | - * @return integer |
|
| 728 | + * @return false|string |
|
| 729 | 729 | */ |
| 730 | 730 | public static function fetchCount($section_id = null, $where = null, $joins = null, $group = false) |
| 731 | 731 | { |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | * edit an event but it's `allowEditorToParse()` returns `false`. If this is not implemented by |
| 92 | 92 | * the event, a default Symphony message will appear. |
| 93 | 93 | * |
| 94 | - * @return string|XMLElement |
|
| 94 | + * @return string |
|
| 95 | 95 | */ |
| 96 | 96 | public static function documentation() |
| 97 | 97 | { |
@@ -106,7 +106,7 @@ discard block |
||
| 106 | 106 | * |
| 107 | 107 | * @param string $language |
| 108 | 108 | * Language used in system |
| 109 | - * @return mixed |
|
| 109 | + * @return string|false |
|
| 110 | 110 | * String, which is the path to the template if the template is found, |
| 111 | 111 | * false otherwise |
| 112 | 112 | */ |
@@ -570,7 +570,7 @@ discard block |
||
| 570 | 570 | * The name of the Extension Class minus the extension prefix. |
| 571 | 571 | * @param string $file_version |
| 572 | 572 | * The version of the extension from the **file**, not the Database. |
| 573 | - * @return string|boolean |
|
| 573 | + * @return false|string |
|
| 574 | 574 | * If the given extension (by $name) requires updating, the installed |
| 575 | 575 | * version is returned, otherwise, if the extension doesn't require |
| 576 | 576 | * updating, false. |
@@ -744,7 +744,7 @@ discard block |
||
| 744 | 744 | * An extension object |
| 745 | 745 | * @throws SymphonyErrorPage |
| 746 | 746 | * @throws Exception |
| 747 | - * @return boolean |
|
| 747 | + * @return boolean|null |
|
| 748 | 748 | */ |
| 749 | 749 | private static function __canUninstallOrDisable(Extension $obj) |
| 750 | 750 | { |
@@ -1223,7 +1223,7 @@ discard block |
||
| 1223 | 1223 | * If the date type is set, only the calendar will be shown in the suggestion dropdown. |
| 1224 | 1224 | * |
| 1225 | 1225 | * @since Symphony 2.6.0 |
| 1226 | - * @return array |
|
| 1226 | + * @return string[] |
|
| 1227 | 1227 | */ |
| 1228 | 1228 | public function fetchSuggestionTypes() |
| 1229 | 1229 | { |
@@ -1449,7 +1449,7 @@ discard block |
||
| 1449 | 1449 | * @link http://dev.mysql.com/doc/refman/5.5/en/regexp.html |
| 1450 | 1450 | * @param string $filter |
| 1451 | 1451 | * The full filter, eg. `regexp: ^[a-d]` |
| 1452 | - * @param array $columns |
|
| 1452 | + * @param string[] $columns |
|
| 1453 | 1453 | * The array of columns that need the given `$filter` applied to. The conditions |
| 1454 | 1454 | * will be added using `OR`. |
| 1455 | 1455 | * @param string $joins |
@@ -1564,7 +1564,7 @@ discard block |
||
| 1564 | 1564 | * The data for this field from it's `tbl_entry_data_{id}` table |
| 1565 | 1565 | * @param integer $entry_id |
| 1566 | 1566 | * The optional id of this field entry instance |
| 1567 | - * @return string|array |
|
| 1567 | + * @return string |
|
| 1568 | 1568 | * The formatted value to be used as the parameter. Note that this can be |
| 1569 | 1569 | * an array or a string. When returning multiple values use array, otherwise |
| 1570 | 1570 | * use string. |