silverstripe / silverstripe-framework

view/Requirements.php

Doc Comments +3 added lines, -1 removed lines

@@ -65,6 +65,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->setSuffixRequirements($var);
@@ -336,7 +337,7 @@ 
 	 * </code>
 	 *
 	 * @param string $combinedFileName Filename of the combined file relative to docroot
-	 * @param array  $files            Array of filenames relative to docroot
+	 * @param string[]  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 *
 	 * @return bool|void
@@ -761,6 +762,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 * @return $this
 	 */
 	public function setForceJSToBottom($var) {

forms/gridfield/GridField.php

Doc Comments +3 added lines, -3 removed lines

@@ -199,7 +199,7 @@ 
 	 *
 	 * @todo refactor this into GridFieldComponent
 	 *
-	 * @param mixed $value
+	 * @param string $value
 	 * @param string|array $castingDefinition
 	 *
 	 * @return mixed
@@ -286,7 +286,7 @@ 
 	 *
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function FieldHolder($properties = array()) {
 		Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
@@ -600,7 +600,7 @@ 
 	/**
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		$this->extend('onBeforeRender', $this);

model/ArrayList.php

Doc Comments +5 added lines, -6 removed lines

@@ -379,7 +379,7 @@ 
 	 *
 	 * Note that columns may be double quoted as per ANSI sql standard
 	 *
-	 * @return DataList
+	 * @return ArrayList
 	 * @see SS_List::sort()
 	 * @example $list->sort('Name'); // default ASC sorting
 	 * @example $list->sort('Name DESC'); // DESC sorting
@@ -515,7 +515,7 @@ 
 	 *          $list = $list->filterAny(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43)));
 	 *
 	 * @param string|array See {@link filter()}
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function filterAny() {
 		$keepUs = call_user_func_array(array($this, 'normaliseFilterArgs'), func_get_args());
@@ -582,6 +582,9 @@ 
 		return $this->filter('ID', $ids);
 	}
 
+	/**
+	 * @param integer $id
+	 */
 	public function byID($id) {
 		$firstElement = $this->filter("ID", $id)->first();
 
@@ -666,7 +669,6 @@ 
 	/**
 	 * Returns whether an item with $key exists
 	 *
-	 * @param mixed $key
 	 * @return bool
 	 */
 	public function offsetExists($offset) {
@@ -676,7 +678,6 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
 	 * @return DataObject
 	 */
 	public function offsetGet($offset) {
@@ -686,7 +687,6 @@ 
 	/**
 	 * Set an item with the key in $key
 	 *
-	 * @param mixed $key
 	 * @param mixed $value
 	 */
 	public function offsetSet($offset, $value) {
@@ -700,7 +700,6 @@ 
 	/**
 	 * Unset an item with the key in $key
 	 *
-	 * @param mixed $key
 	 */
 	public function offsetUnset($offset) {
 		unset($this->items[$offset]);

admin/code/LeftAndMain.php

Doc Comments +7 added lines, -3 removed lines

@@ -186,7 +186,7 @@ 
 	/**
 	 * Gets the combined configuration of all LeafAndMain subclasses required by the client app.
 	 *
-	 * @return array
+	 * @return string
 	 *
 	 * WARNING: Experimental API
 	 */
@@ -876,6 +876,7 @@ 
 	 * Return a list of appropriate templates for this class, with the given suffix using
 	 * {@link SSViewer::get_templates_by_class()}
 	 *
+	 * @param string $suffix
 	 * @return array
 	 */
 	public function getTemplatesWithSuffix($suffix) {
@@ -1745,7 +1746,7 @@ 
 	 * The controller might not have any previewable content, in which case
 	 * this method returns FALSE.
 	 *
-	 * @return String|boolean
+	 * @return boolean
 	 */
 	public function LinkPreview() {
 		return false;
@@ -1932,7 +1933,7 @@ 
 	}
 
 	/**
-	 * @return String
+	 * @return DBField
 	 */
 	public function Locale() {
 		return DBField::create_field('Locale', i18n::get_locale());
@@ -2098,6 +2099,9 @@ 
 		return (parent::isFinished() || $this->isFinished);
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setIsFinished($bool) {
 		$this->isFinished = $bool;
 	}

model/UnsavedRelationList.php

Doc Comments +1 added lines, -1 removed lines

@@ -146,7 +146,7 @@
 	 * Add a number of items to the relation.
 	 *
 	 * @param array $items Items to add, as either DataObjects or IDs.
-	 * @return DataList
+	 * @return UnsavedRelationList
 	 */
 	public function addMany($items) {
 		foreach($items as $item) {

forms/htmleditor/HTMLEditorConfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 	 * Get the current value of an option
      *
 	 * @param string $key The key of the option to get
-	 * @return mixed The value of the specified option
+	 * @return string The value of the specified option
 	 */
 	abstract public function getOption($key);
 

forms/HTMLEditorSanitiser.php

Doc Comments +2 added lines, -1 removed lines

@@ -39,7 +39,7 @@ 
 	/**
 	 * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
 	 *
-	 * @param $str - The TinyMCE pattern
+	 * @param string|null $str - The TinyMCE pattern
 	 * @return string - The equivalent regex
 	 */
 	protected function patternToRegex($str) {
@@ -180,6 +180,7 @@ 
 	/**
 	 * Given an attribute name, return the rule structure for that attribute
 	 * @param string $name - The attribute name
+	 * @param stdClass $elementRule
 	 * @return stdClass - The attribute rule
 	 */
 	protected function getRuleForAttribute($elementRule, $name) {

view/SSTemplateParser.php.inc

Doc Comments +9 added lines, -5 removed lines

@@ -111,6 +111,8 @@ 
 
 	/**
 	 * Override the function that constructs the result arrays to also prepare a 'php' item in the array
+	 * @param string $matchrule
+	 * @param string $name
 	 */
 	function construct($matchrule, $name, $arguments = null) {
 		$res = parent::construct($matchrule, $name, $arguments);
@@ -172,9 +174,9 @@ 
 
 	/**
 	 * Ensures that the arguments to addOpenBlock and addClosedBlock are valid
-	 * @param $name
-	 * @param $callable
-	 * @param $type
+	 * @param string $name
+	 * @param callable $callable
+	 * @param string $type
 	 * @throws InvalidArgumentException
 	 */
 	protected function validateExtensionBlock($name, $callable, $type) {
@@ -737,6 +739,7 @@ 
 	 * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to
 	 * get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj)
 	 * depending on the context the lookup is used in.
+	 * @param string $method
 	 */
 	function Lookup_AddLookupStep(&$res, $sub, $method) {
 		$res['LookupSteps'][] = $sub;
@@ -4691,8 +4694,8 @@ 
 	 * Compiles some passed template source code into the php code that will execute as per the template source.
 	 *
 	 * @throws SSTemplateParseException
-	 * @param  $string The source of the template
-	 * @param string $templateName The name of the template, normally the filename the template source was loaded from
+	 * @param  string $string The source of the template
+	 * @param string string The name of the template, normally the filename the template source was loaded from
 	 * @param bool $includeDebuggingComments True is debugging comments should be included in the output
 	 * @param bool $topTemplate True if this is a top template, false if it's just a template
 	 * @return mixed|string The php that, when executed (via include or exec) will behave as per the template source
@@ -4732,6 +4735,7 @@ 
 
 	/**
 	 * @param string $code
+	 * @param string $templateName
 	 * @return string $code
 	 */
 	protected function includeDebuggingComments($code, $templateName) {

forms/htmleditor/HTMLEditorField.php

Doc Comments +12 added lines, -5 removed lines

@@ -60,7 +60,7 @@ 
 	/**
 	 * Assign a new configuration instance or identifier
 	 *
-	 * @param string|HTMLEditorConfig $config
+	 * @param string $config
 	 * @return $this
 	 */
 	public function setEditorConfig($config) {
@@ -74,7 +74,7 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The human-readable field label.
-	 * @param mixed $value The value of the field.
+	 * @param integer $value The value of the field.
 	 * @param string $config HTMLEditorConfig identifier to be used. Default to the active one.
 	 */
 	public function __construct($name, $title = null, $value = '', $config = null) {
@@ -115,6 +115,9 @@ 
 		$record->{$this->name} = $htmlValue->getContent();
 	}
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value) {
 		// Regenerate links prior to preview, so that the editor can see them.
 		$value = Image::regenerate_html_links($value);
@@ -182,6 +185,10 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param Controller|null $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -200,7 +207,7 @@ 
 	/**
 	 * Searches the SiteTree for display in the dropdown
 	 *
-	 * @return callback
+	 * @return DataList
 	 */
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -580,7 +587,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 * @throws SS_HTTPResponse_Exception
 	 */
 	public function getanchors() {
@@ -1156,7 +1163,7 @@ 
 	}
 
 	/**
-	 * @return AdapterInterface
+	 * @return Embed
 	 */
 	public function getEmbed() {
 		return $this->embed;