silverstripe / silverstripe-framework

model/DataQuery.php

Doc Comments +10 added lines, -2 removed lines

@@ -44,6 +44,7 @@ 
 	 * Create a new DataQuery.
 	 *
 	 * @param String The name of the DataObject class that you wish to query
+	 * @param string $dataClass
 	 */
 	public function __construct($dataClass) {
 		$this->dataClass = $dataClass;
@@ -166,7 +167,7 @@ 
 	/**
 	 * Ensure that the query is ready to execute.
 	 *
-	 * @param array|null $queriedColumns Any columns to filter the query by
+	 * @param string[] $queriedColumns Any columns to filter the query by
 	 * @return SQLSelect The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -641,7 +642,7 @@ 
 	 * mappings to the query object state. This has to be called
 	 * in any overloaded {@link SearchFilter->apply()} methods manually.
 	 *
-	 * @param String|array $relation The array/dot-syntax relation to follow
+	 * @param string $relation The array/dot-syntax relation to follow
 	 * @param bool $linearOnly Set to true to restrict to linear relations only. Set this
 	 * if this relation will be used for sorting, and should not include duplicate rows.
 	 * @return The model class of the related item
@@ -917,6 +918,7 @@ 
 
 	/**
 	 * Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.
+	 * @param string $key
 	 */
 	public function getQueryParam($key) {
 		if(isset($this->queryParams[$key])) return $this->queryParams[$key];
@@ -949,6 +951,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -958,6 +963,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

model/queries/SQLSelect.php

Doc Comments +2 added lines, -5 removed lines

@@ -61,7 +61,7 @@ 
 	/**
 	 * Construct a new SQLSelect.
 	 *
-	 * @param array|string $select An array of SELECT fields.
+	 * @param string $select An array of SELECT fields.
 	 * @param array|string $from An array of FROM clauses. The first one should be just the table name.
 	 * Each should be ANSI quoted.
 	 * @param array $where An array of WHERE clauses.
@@ -115,7 +115,6 @@ 
 	 * </code>
 	 *
 	 * @param string|array $fields Field names should be ANSI SQL quoted. Array keys should be unquoted.
-	 * @param boolean $clear Clear existing select fields?
 	 * @return $this Self reference
 	 */
 	public function setSelect($fields) {
@@ -352,7 +351,7 @@ 
 	 *
 	 * @param string $value
 	 * @param string $defaultDirection
-	 * @return array A two element array: array($column, $direction)
+	 * @return string[] A two element array: array($column, $direction)
 	 */
 	private function getDirectionFromString($value, $defaultDirection = null) {
 		if(preg_match('/^(.*)(asc|desc)$/i', $value, $matches)) {
@@ -447,7 +446,6 @@ 
 	 * @see SQLSelect::addWhere() for syntax examples
 	 *
 	 * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $having,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setHaving($having) {
@@ -462,7 +460,6 @@ 
 	 * @see SQLSelect::addWhere() for syntax examples
 	 *
 	 * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $having,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addHaving($having) {

control/RequestHandler.php

Doc Comments +7 added lines, -1 removed lines

@@ -121,6 +121,7 @@ 
 
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -238,6 +239,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -271,7 +275,7 @@ 
 	 *
 	 * Must not raise SS_HTTPResponse_Exceptions - instead it should return
 	 *
-	 * @param $request
+	 * @param SS_HTTPRequest $request
 	 * @param $action
 	 * @return SS_HTTPResponse
 	 */
@@ -384,6 +388,7 @@ 
 
 	/**
 	 * Return the class that defines the given action, so that we know where to check allowed_actions.
+	 * @return string|null
 	 */
 	protected function definingClassForAction($actionOrigCasing) {
 		$action = strtolower($actionOrigCasing);
@@ -493,6 +498,7 @@ 
 	 * or {@link handleRequest()}, but in some based we want to set it manually.
 	 *
 	 * @param SS_HTTPRequest
+	 * @param SS_HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$this->request = $request;

forms/htmleditor/HtmlEditorField.php

Doc Comments +12 added lines, -5 removed lines

@@ -49,7 +49,7 @@ 
 	/**
 	 * Assign a new configuration instance or identifier
 	 *
-	 * @param string|HtmlEditorConfig $config
+	 * @param string $config
 	 * @return $this
 	 */
 	public function setEditorConfig($config) {
@@ -63,7 +63,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) {
@@ -104,6 +104,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);
@@ -171,6 +174,10 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param Controller $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -189,7 +196,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(
@@ -467,7 +474,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getanchors() {
 		$id = (int)$this->getRequest()->getVar('PageID');
@@ -1025,7 +1032,7 @@ 
 	/**
 	 * Get OEmbed type
 	 *
-	 * @return string
+	 * @return boolean
 	 */
 	public function getType() {
 		return $this->oembed->type;

forms/Form.php

Doc Comments +12 added lines, -6 removed lines

@@ -498,7 +498,7 @@ 
 	 * The callback can opt out of handling specific responses by returning NULL,
 	 * in which case the default form behaviour will kick in.
 	 *
-	 * @param $callback
+	 * @param Closure $callback
 	 * @return self
 	 */
 	public function setValidationResponseCallback($callback) {
@@ -558,7 +558,7 @@ 
 	/**
 	 * Fields can have action to, let's check if anyone of the responds to $funcname them
 	 *
-	 * @param SS_List|array $fields
+	 * @param FieldList|null $fields
 	 * @param callable $funcName
 	 * @return FormField
 	 */
@@ -697,6 +697,7 @@ 
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 */
 	public function setValidationExemptActions($actions) {
 		$this->validationExemptActions = $actions;
@@ -836,6 +837,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string $name
 	 */
 	public function getAttribute($name) {
@@ -870,6 +872,7 @@ 
 	 *
 	 * @param array Custom attributes to process. Falls back to {@link getAttributes()}.
 	 * If at least one argument is passed as a string, all arguments act as excludes by name.
+	 * @param string $attrs
 	 *
 	 * @return string HTML attributes, ready for insertion into an HTML tag
 	 */
@@ -1077,7 +1080,7 @@ 
 	 * If set to false (the default), then the form method is only used to construct the default
 	 * form.
 	 *
-	 * @param $bool boolean
+	 * @param boolean $bool boolean
 	 * @return $this
 	 */
 	public function setStrictFormMethodCheck($bool) {
@@ -1592,7 +1595,7 @@ 
 	 * This is returned when you access a form as $FormObject rather
 	 * than <% with FormObject %>
 	 *
-	 * @return HTML
+	 * @return DBField
 	 */
 	public function forTemplate() {
 		$return = $this->renderWith(array_merge(
@@ -1612,7 +1615,7 @@ 
 	 * It triggers slightly different behaviour, such as disabling the rewriting
 	 * of # links.
 	 *
-	 * @return HTML
+	 * @return DBField
 	 */
 	public function forAjaxTemplate() {
 		$view = new SSViewer(array(
@@ -1635,7 +1638,7 @@ 
 	 * and _form_enctype.  These are the attributes of the form.  These fields
 	 * can be used to send the form to Ajax.
 	 *
-	 * @return HTML
+	 * @return string
 	 */
 	public function formHtmlContent() {
 		$this->IncludeFormTag = false;
@@ -1896,6 +1899,9 @@ 
 
 	protected $form;
 
+	/**
+	 * @param Form $form
+	 */
 	public function __construct($form) {
 		$this->form = $form;
 		parent::__construct();

forms/ListboxField.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
 	 * Returns a <select> tag containing all the appropriate <option> tags
 	 *
 	 * @param array $properties
-	 * @return string
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(

forms/MoneyField.php

Doc Comments +6 added lines, -1 removed lines

@@ -36,6 +36,10 @@ 
 	 */
 	protected $fieldCurrency = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = "") {
 		// naming with underscores to prevent values from actually being saved somewhere
 		$this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount'));
@@ -46,7 +50,7 @@ 
 
 	/**
 	 * @param array
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		return DBField::create_field('HTMLText',
@@ -139,6 +143,7 @@ 
 	/**
 	 * @todo Implement removal of readonly state with $bool=false
 	 * @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies()
+	 * @param boolean $bool
 	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);

filesystem/File.php

Doc Comments +3 added lines, -3 removed lines

@@ -248,7 +248,7 @@ 
 	 *
 	 * @param array $args Array of input shortcode arguments
 	 * @param int $errorCode If the file is not found, or is inaccessible, this will be assigned to a HTTP error code.
-	 * @return File|null The File DataObject, if it can be found.
+	 * @return null|DataObject The File DataObject, if it can be found.
 	 */
 	public static function find_shortcode_record($args, &$errorCode = null) {
 		// Validate shortcode
@@ -617,7 +617,7 @@ 
 	 *
 	 * @param string $condition The PHP condition to be evaluated.  The page will be called $item
 	 * @param array $collator An array, passed by reference, to collect all of the matching descendants.
-	 * @return true|null
+	 * @return boolean|null
 	 */
 	public function collateDescendants($condition, &$collator) {
 		if($children = $this->Children()) {
@@ -978,6 +978,7 @@ 
 	 *
 	 * @param String File extension, without dot prefix. Use an asterisk ('*')
 	 * to specify a generic fallback if no mapping is found for an extension.
+	 * @param string $ext
 	 * @return String Classname for a subclass of {@link File}
 	 */
 	public static function get_class_for_file_extension($ext) {
@@ -1115,7 +1116,6 @@ 
 	 * Note that the result will not have a leading slash, and should not be used
 	 * with local file paths.
 	 *
-	 * @param string $part,... Parts
 	 * @return string
 	 */
 	public static function join_paths() {

core/Extension.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
 	/**
 	 * Set the owner of this extension.
 	 *
-	 * @param Object $owner The owner object,
+	 * @param null|DataObject $owner The owner object,
 	 * @param string $ownerBaseClass The base class that the extension is applied to; this may be
 	 * the class of owner, or it may be a parent.  For example, if Versioned was applied to SiteTree,
 	 * and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass