@@ -50,6 +50,10 @@ discard block |
||
| 50 | 50 | */ |
| 51 | 51 | protected $valueObj = null; |
| 52 | 52 | |
| 53 | + /** |
|
| 54 | + * @param string $name |
|
| 55 | + * @param string $title |
|
| 56 | + */ |
|
| 53 | 57 | public function __construct($name, $title = null, $value = ""){ |
| 54 | 58 | if(!$this->locale) { |
| 55 | 59 | $this->locale = i18n::get_locale(); |
@@ -228,6 +232,9 @@ discard block |
||
| 228 | 232 | return $this->castedCopy('TimeField_Readonly'); |
| 229 | 233 | } |
| 230 | 234 | |
| 235 | + /** |
|
| 236 | + * @param string $class |
|
| 237 | + */ |
|
| 231 | 238 | public function castedCopy($class) { |
| 232 | 239 | $copy = parent::castedCopy($class); |
| 233 | 240 | if($copy->hasMethod('setConfig')) { |
@@ -118,7 +118,7 @@ discard block |
||
| 118 | 118 | |
| 119 | 119 | /** |
| 120 | 120 | * Return an instance of the cache used for i18n data. |
| 121 | - * @return Zend_Cache |
|
| 121 | + * @return Zend_Cache_Core |
|
| 122 | 122 | */ |
| 123 | 123 | public static function get_cache() { |
| 124 | 124 | return SS_Cache::factory('i18n', 'Output', array('lifetime' => null, 'automatic_serialization' => true)); |
@@ -2156,6 +2156,7 @@ discard block |
||
| 2156 | 2156 | |
| 2157 | 2157 | /** |
| 2158 | 2158 | * @param String |
| 2159 | + * @param string $name |
|
| 2159 | 2160 | * @return Zend_Translate |
| 2160 | 2161 | */ |
| 2161 | 2162 | public static function get_translator($name) { |
@@ -2169,6 +2170,7 @@ discard block |
||
| 2169 | 2170 | * @param Zend_Translate Needs to implement {@link i18nTranslateAdapterInterface} |
| 2170 | 2171 | * @param String If left blank will override the default translator. |
| 2171 | 2172 | * @param Int |
| 2173 | + * @param string $name |
|
| 2172 | 2174 | */ |
| 2173 | 2175 | public static function register_translator($translator, $name, $priority = 10) { |
| 2174 | 2176 | if (!is_int($priority)) throw new InvalidArgumentException("register_translator expects an int priority"); |
@@ -2298,7 +2300,7 @@ discard block |
||
| 2298 | 2300 | * |
| 2299 | 2301 | * @see get_locale_name() |
| 2300 | 2302 | * |
| 2301 | - * @param mixed $code Language code |
|
| 2303 | + * @param string $code Language code |
|
| 2302 | 2304 | * @param boolean $native If true, the native name will be returned |
| 2303 | 2305 | * @return Name of the language |
| 2304 | 2306 | */ |
@@ -2455,6 +2457,7 @@ discard block |
||
| 2455 | 2457 | * |
| 2456 | 2458 | * Note: Does not check for {@link $allowed_locales}. |
| 2457 | 2459 | * |
| 2460 | + * @param string $locale |
|
| 2458 | 2461 | * @return boolean |
| 2459 | 2462 | */ |
| 2460 | 2463 | public static function validate_locale($locale) { |
@@ -712,7 +712,8 @@ discard block |
||
| 712 | 712 | * Input for langArrayCodeForEntitySpec() should be suitable for insertion |
| 713 | 713 | * into single-quoted strings, so needs to be escaped already. |
| 714 | 714 | * |
| 715 | - * @param string $entity The entity name, e.g. CMSMain.BUTTONSAVE |
|
| 715 | + * @param string $entitySpec The entity name, e.g. CMSMain.BUTTONSAVE |
|
| 716 | + * @param string $locale |
|
| 716 | 717 | */ |
| 717 | 718 | public function langArrayCodeForEntitySpec($entityFullName, $entitySpec, $locale) { |
| 718 | 719 | $php = ''; |
@@ -775,6 +776,9 @@ discard block |
||
| 775 | 776 | return true; |
| 776 | 777 | } |
| 777 | 778 | |
| 779 | + /** |
|
| 780 | + * @param string $locale |
|
| 781 | + */ |
|
| 778 | 782 | public function getYaml($entities, $locale) { |
| 779 | 783 | // Unflatten array |
| 780 | 784 | $entitiesNested = array(); |
@@ -843,6 +847,7 @@ discard block |
||
| 843 | 847 | |
| 844 | 848 | /** |
| 845 | 849 | * Parses a template and returns any translatable entities |
| 850 | + * @param string $template |
|
| 846 | 851 | */ |
| 847 | 852 | public static function GetTranslatables($template) { |
| 848 | 853 | self::$entities = array(); |
@@ -38,7 +38,6 @@ discard block |
||
| 38 | 38 | /** |
| 39 | 39 | * Injector injection point for database controller |
| 40 | 40 | * |
| 41 | - * @param SS_Database $connector |
|
| 42 | 41 | */ |
| 43 | 42 | public function setDatabase(SS_Database $database) { |
| 44 | 43 | $this->database = $database; |
@@ -104,6 +103,7 @@ discard block |
||
| 104 | 103 | * |
| 105 | 104 | * @var callable $callback |
| 106 | 105 | * @throws Exception |
| 106 | + * @param Closure $callback |
|
| 107 | 107 | */ |
| 108 | 108 | public function schemaUpdate($callback) { |
| 109 | 109 | // Begin schema update |
@@ -476,7 +476,7 @@ discard block |
||
| 476 | 476 | /** |
| 477 | 477 | * Given an index spec determines the index type |
| 478 | 478 | * |
| 479 | - * @param array|string $spec |
|
| 479 | + * @param string $spec |
|
| 480 | 480 | * @return string |
| 481 | 481 | */ |
| 482 | 482 | protected function determineIndexType($spec) { |
@@ -544,7 +544,7 @@ discard block |
||
| 544 | 544 | /** |
| 545 | 545 | * Returns true if the given table is exists in the current database |
| 546 | 546 | * |
| 547 | - * @param string $table Name of table to check |
|
| 547 | + * @param string $tableName Name of table to check |
|
| 548 | 548 | * @return boolean Flag indicating existence of table |
| 549 | 549 | */ |
| 550 | 550 | abstract public function hasTable($tableName); |
@@ -115,6 +115,9 @@ |
||
| 115 | 115 | $this->query("ALTER TABLE \"$tableName\" $alterations"); |
| 116 | 116 | } |
| 117 | 117 | |
| 118 | + /** |
|
| 119 | + * @param string $tableName |
|
| 120 | + */ |
|
| 118 | 121 | public function isView($tableName) { |
| 119 | 122 | $info = $this->query("SHOW /*!50002 FULL*/ TABLES LIKE '$tableName'")->record(); |
| 120 | 123 | return $info && strtoupper($info['Table_type']) == 'VIEW'; |
@@ -107,7 +107,7 @@ discard block |
||
| 107 | 107 | /** |
| 108 | 108 | * Gets the url to return to after build |
| 109 | 109 | * |
| 110 | - * @return string|null |
|
| 110 | + * @return string |
|
| 111 | 111 | */ |
| 112 | 112 | protected function getReturnURL() { |
| 113 | 113 | $url = $this->request->getVar('returnURL'); |
@@ -152,7 +152,7 @@ discard block |
||
| 152 | 152 | /** |
| 153 | 153 | * Returns the timestamp of the time that the database was last built |
| 154 | 154 | * |
| 155 | - * @return string Returns the timestamp of the time that the database was |
|
| 155 | + * @return integer|null Returns the timestamp of the time that the database was |
|
| 156 | 156 | * last built |
| 157 | 157 | */ |
| 158 | 158 | public static function lastBuilt() { |
@@ -47,6 +47,7 @@ |
||
| 47 | 47 | * |
| 48 | 48 | * @param DataObject (Optional) |
| 49 | 49 | * @param DataObject |
| 50 | + * @param DataObject|null $fromRecord |
|
| 50 | 51 | */ |
| 51 | 52 | public function __construct($fromRecord, DataObject $toRecord) { |
| 52 | 53 | if(!$toRecord) user_error("DataDifferencer constructed without a toRecord", E_USER_WARNING); |
@@ -217,9 +217,8 @@ discard block |
||
| 217 | 217 | * Given the database configuration, this method will create the correct |
| 218 | 218 | * subclass of {@link SS_Database}. |
| 219 | 219 | * |
| 220 | - * @param array $database A map of options. The 'type' is the name of the subclass of SS_Database to use. For the |
|
| 220 | + * @param array $databaseConfig A map of options. The 'type' is the name of the subclass of SS_Database to use. For the |
|
| 221 | 221 | * rest of the options, see the specific class. |
| 222 | - * @param string $name identifier for the connection |
|
| 223 | 222 | * |
| 224 | 223 | * @return SS_Database |
| 225 | 224 | */ |
@@ -413,7 +412,7 @@ discard block |
||
| 413 | 412 | |
| 414 | 413 | /** |
| 415 | 414 | * Create a new table. |
| 416 | - * @param string $tableName The name of the table |
|
| 415 | + * @param string $table The name of the table |
|
| 417 | 416 | * @param array$fields A map of field names to field types |
| 418 | 417 | * @param array $indexes A map of indexes |
| 419 | 418 | * @param array $options An map of additional options. The available keys are as follows: |
@@ -500,6 +499,8 @@ discard block |
||
| 500 | 499 | |
| 501 | 500 | /** |
| 502 | 501 | * @deprecated since version 4.0 Use DB::require_field instead |
| 502 | + * @param string $table |
|
| 503 | + * @param string $field |
|
| 503 | 504 | */ |
| 504 | 505 | public static function requireField($table, $field, $spec) { |
| 505 | 506 | Deprecation::notice('4.0', 'Use DB::require_field instead'); |
@@ -563,7 +564,7 @@ discard block |
||
| 563 | 564 | /** |
| 564 | 565 | * Checks a table's integrity and repairs it if necessary. |
| 565 | 566 | * |
| 566 | - * @param string $tableName The name of the table. |
|
| 567 | + * @param string $table The name of the table. |
|
| 567 | 568 | * @return boolean Return true if the table has integrity after the method is complete. |
| 568 | 569 | */ |
| 569 | 570 | public static function check_and_repair_table($table) { |
@@ -74,9 +74,6 @@ |
||
| 74 | 74 | * Given a list of assignments in any user-acceptible format, normalise the |
| 75 | 75 | * value to a common array('SQL' => array(parameters)) format |
| 76 | 76 | * |
| 77 | - * @param array $predicates List of assignments. |
|
| 78 | - * The key of this array should be the field name, and the value the assigned |
|
| 79 | - * literal value, or an array with parameterised information. |
|
| 80 | 77 | * @return array List of normalised assignments |
| 81 | 78 | */ |
| 82 | 79 | protected function normaliseAssignments(array $assignments) { |