@@ -48,7 +48,7 @@ |
||
| 48 | 48 | * |
| 49 | 49 | * @param array|string|resource $streamOrUrl Stream or URL to open as a stream |
| 50 | 50 | * @param string|null $mode Mode, only applicable if a URL is given |
| 51 | - * @return void |
|
| 51 | + * @return null|Zend_Log_Writer_Abstract |
|
| 52 | 52 | * @throws Zend_Log_Exception |
| 53 | 53 | */ |
| 54 | 54 | public function __construct($streamOrUrl, $mode = null) |
@@ -5,10 +5,16 @@ |
||
| 5 | 5 | return parent::viewfile_getLocalFileByID($id); |
| 6 | 6 | } |
| 7 | 7 | |
| 8 | + /** |
|
| 9 | + * @param string $fileUrl |
|
| 10 | + */ |
|
| 8 | 11 | public function viewfile_getLocalFileByURL($fileUrl) { |
| 9 | 12 | return parent::viewfile_getLocalFileByURL($fileUrl); |
| 10 | 13 | } |
| 11 | 14 | |
| 15 | + /** |
|
| 16 | + * @param string $fileUrl |
|
| 17 | + */ |
|
| 12 | 18 | public function viewfile_getRemoteFileByURL($fileUrl) { |
| 13 | 19 | return parent::viewfile_getRemoteFileByURL($fileUrl); |
| 14 | 20 | } |
@@ -732,6 +732,9 @@ discard block |
||
| 732 | 732 | return $result; |
| 733 | 733 | } |
| 734 | 734 | |
| 735 | + /** |
|
| 736 | + * @param string $mode |
|
| 737 | + */ |
|
| 735 | 738 | protected function _get($dir, $mode, $tags = array()) |
| 736 | 739 | { |
| 737 | 740 | if (!is_dir($dir)) { |
@@ -819,6 +822,7 @@ discard block |
||
| 819 | 822 | /** |
| 820 | 823 | * Compute & return the expire time |
| 821 | 824 | * |
| 825 | + * @param integer $lifetime |
|
| 822 | 826 | * @return int expire time (unix timestamp) |
| 823 | 827 | */ |
| 824 | 828 | protected function _expireTime($lifetime) |
@@ -108,7 +108,7 @@ |
||
| 108 | 108 | * Return a date and time formatted as per a CMS user's settings. |
| 109 | 109 | * |
| 110 | 110 | * @param Member $member |
| 111 | - * @return boolean | string A time and date pair formatted as per user-defined settings. |
|
| 111 | + * @return false|string | string A time and date pair formatted as per user-defined settings. |
|
| 112 | 112 | */ |
| 113 | 113 | public function FormatFromSettings($member = null) { |
| 114 | 114 | require_once 'Zend/Date.php'; |
@@ -32,6 +32,10 @@ discard block |
||
| 32 | 32 | */ |
| 33 | 33 | protected $fieldCurrency = null; |
| 34 | 34 | |
| 35 | + /** |
|
| 36 | + * @param string $name |
|
| 37 | + * @param string $title |
|
| 38 | + */ |
|
| 35 | 39 | public function __construct($name, $title = null, $value = "") { |
| 36 | 40 | // naming with underscores to prevent values from actually being saved somewhere |
| 37 | 41 | $this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount')); |
@@ -135,6 +139,7 @@ discard block |
||
| 135 | 139 | /** |
| 136 | 140 | * @todo Implement removal of readonly state with $bool=false |
| 137 | 141 | * @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies() |
| 142 | + * @param boolean $bool |
|
| 138 | 143 | */ |
| 139 | 144 | public function setReadonly($bool) { |
| 140 | 145 | parent::setReadonly($bool); |
@@ -619,6 +619,11 @@ |
||
| 619 | 619 | 'ObjectTest_Extending_Extension' |
| 620 | 620 | ); |
| 621 | 621 | |
| 622 | + /** |
|
| 623 | + * @param integer $first |
|
| 624 | + * @param integer $second |
|
| 625 | + * @param integer $third |
|
| 626 | + */ |
|
| 622 | 627 | public function getResults(&$first, &$second, &$third) { |
| 623 | 628 | // Before extending should be invoked second |
| 624 | 629 | $this->beforeExtending('updateResult', function(&$first, &$second, &$third) { |
@@ -379,7 +379,7 @@ discard block |
||
| 379 | 379 | * |
| 380 | 380 | * Note that columns may be double quoted as per ANSI sql standard |
| 381 | 381 | * |
| 382 | - * @return DataList |
|
| 382 | + * @return ArrayList |
|
| 383 | 383 | * @see SS_List::sort() |
| 384 | 384 | * @example $list->sort('Name'); // default ASC sorting |
| 385 | 385 | * @example $list->sort('Name DESC'); // DESC sorting |
@@ -515,7 +515,7 @@ discard block |
||
| 515 | 515 | * $list = $list->filterAny(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43))); |
| 516 | 516 | * |
| 517 | 517 | * @param string|array See {@link filter()} |
| 518 | - * @return DataList |
|
| 518 | + * @return ArrayList |
|
| 519 | 519 | */ |
| 520 | 520 | public function filterAny() { |
| 521 | 521 | $keepUs = call_user_func_array(array($this, 'normaliseFilterArgs'), func_get_args()); |
@@ -582,6 +582,9 @@ discard block |
||
| 582 | 582 | return $this->filter('ID', $ids); |
| 583 | 583 | } |
| 584 | 584 | |
| 585 | + /** |
|
| 586 | + * @param integer $id |
|
| 587 | + */ |
|
| 585 | 588 | public function byID($id) { |
| 586 | 589 | $firstElement = $this->filter("ID", $id)->first(); |
| 587 | 590 | |
@@ -666,7 +669,6 @@ discard block |
||
| 666 | 669 | /** |
| 667 | 670 | * Returns whether an item with $key exists |
| 668 | 671 | * |
| 669 | - * @param mixed $key |
|
| 670 | 672 | * @return bool |
| 671 | 673 | */ |
| 672 | 674 | public function offsetExists($offset) { |
@@ -676,7 +678,6 @@ discard block |
||
| 676 | 678 | /** |
| 677 | 679 | * Returns item stored in list with index $key |
| 678 | 680 | * |
| 679 | - * @param mixed $key |
|
| 680 | 681 | * @return DataObject |
| 681 | 682 | */ |
| 682 | 683 | public function offsetGet($offset) { |
@@ -686,7 +687,6 @@ discard block |
||
| 686 | 687 | /** |
| 687 | 688 | * Set an item with the key in $key |
| 688 | 689 | * |
| 689 | - * @param mixed $key |
|
| 690 | 690 | * @param mixed $value |
| 691 | 691 | */ |
| 692 | 692 | public function offsetSet($offset, $value) { |
@@ -700,7 +700,6 @@ discard block |
||
| 700 | 700 | /** |
| 701 | 701 | * Unset an item with the key in $key |
| 702 | 702 | * |
| 703 | - * @param mixed $key |
|
| 704 | 703 | */ |
| 705 | 704 | public function offsetUnset($offset) { |
| 706 | 705 | unset($this->items[$offset]); |
@@ -146,7 +146,7 @@ |
||
| 146 | 146 | * Add a number of items to the relation. |
| 147 | 147 | * |
| 148 | 148 | * @param array $items Items to add, as either DataObjects or IDs. |
| 149 | - * @return DataList |
|
| 149 | + * @return UnsavedRelationList |
|
| 150 | 150 | */ |
| 151 | 151 | public function addMany($items) { |
| 152 | 152 | foreach($items as $item) { |
@@ -111,6 +111,8 @@ discard block |
||
| 111 | 111 | |
| 112 | 112 | /** |
| 113 | 113 | * Override the function that constructs the result arrays to also prepare a 'php' item in the array |
| 114 | + * @param string $matchrule |
|
| 115 | + * @param string $name |
|
| 114 | 116 | */ |
| 115 | 117 | function construct($matchrule, $name, $arguments = null) { |
| 116 | 118 | $res = parent::construct($matchrule, $name, $arguments); |
@@ -172,9 +174,9 @@ discard block |
||
| 172 | 174 | |
| 173 | 175 | /** |
| 174 | 176 | * Ensures that the arguments to addOpenBlock and addClosedBlock are valid |
| 175 | - * @param $name |
|
| 176 | - * @param $callable |
|
| 177 | - * @param $type |
|
| 177 | + * @param string $name |
|
| 178 | + * @param callable $callable |
|
| 179 | + * @param string $type |
|
| 178 | 180 | * @throws InvalidArgumentException |
| 179 | 181 | */ |
| 180 | 182 | protected function validateExtensionBlock($name, $callable, $type) { |
@@ -737,6 +739,7 @@ discard block |
||
| 737 | 739 | * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to |
| 738 | 740 | * get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj) |
| 739 | 741 | * depending on the context the lookup is used in. |
| 742 | + * @param string $method |
|
| 740 | 743 | */ |
| 741 | 744 | function Lookup_AddLookupStep(&$res, $sub, $method) { |
| 742 | 745 | $res['LookupSteps'][] = $sub; |
@@ -4691,8 +4694,8 @@ discard block |
||
| 4691 | 4694 | * Compiles some passed template source code into the php code that will execute as per the template source. |
| 4692 | 4695 | * |
| 4693 | 4696 | * @throws SSTemplateParseException |
| 4694 | - * @param $string The source of the template |
|
| 4695 | - * @param string $templateName The name of the template, normally the filename the template source was loaded from |
|
| 4697 | + * @param string $string The source of the template |
|
| 4698 | + * @param string string The name of the template, normally the filename the template source was loaded from |
|
| 4696 | 4699 | * @param bool $includeDebuggingComments True is debugging comments should be included in the output |
| 4697 | 4700 | * @param bool $topTemplate True if this is a top template, false if it's just a template |
| 4698 | 4701 | * @return mixed|string The php that, when executed (via include or exec) will behave as per the template source |
@@ -4732,6 +4735,7 @@ discard block |
||
| 4732 | 4735 | |
| 4733 | 4736 | /** |
| 4734 | 4737 | * @param string $code |
| 4738 | + * @param string $templateName |
|
| 4735 | 4739 | * @return string $code |
| 4736 | 4740 | */ |
| 4737 | 4741 | protected function includeDebuggingComments($code, $templateName) { |