silverstripe / silverstripe-framework

ORM/DataQuery.php

Doc Comments +8 added lines, -2 removed lines

@@ -90,7 +90,7 @@ 
 	/**
 	 * Remove a filter from the query
 	 *
-	 * @param string|array $fieldExpression The predicate of the condition to remove
+	 * @param string|null $fieldExpression The predicate of the condition to remove
 	 * (ignoring parameters). The expression will be considered a match if it's
 	 * contained within any other predicate.
 	 * @return DataQuery Self reference
@@ -169,7 +169,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) {
@@ -1033,6 +1033,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		parent::__construct($base->dataClass);
 		$this->query = $base->query;
@@ -1042,6 +1045,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

admin/code/MemberImportForm.php

Doc Comments +5 added lines, -1 removed lines

@@ -27,6 +27,10 @@ 
 	 */
 	protected $group;
 
+	/**
+	 * @param SecurityAdmin $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name, $fields = null, $actions = null, $validator = null) {
 		if(!$fields) {
 			$helpHtml = _t(
@@ -113,7 +117,7 @@ 
 	}
 
 	/**
-	 * @param $group Group
+	 * @param \SilverStripe\ORM\DataObject $group Group
 	 */
 	public function setGroup($group) {
 		$this->group = $group;

admin/code/ModelAdmin.php

Doc Comments +4 added lines, -1 removed lines

@@ -141,6 +141,9 @@ 
 		Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/client/dist/js/ModelAdmin.js');
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		if(!$action) $action = $this->sanitiseClassName($this->modelClass);
 		return parent::Link($action);
@@ -194,7 +197,7 @@ 
 	}
 
 	/**
-	 * @return SearchContext
+	 * @return Controller
 	 */
 	public function getSearchContext() {
 		$context = singleton($this->modelClass)->getDefaultSearchContext();

admin/code/SecurityAdmin.php

Doc Comments +3 added lines, -3 removed lines

@@ -66,7 +66,7 @@ 
 	 * Shortcut action for setting the correct active tab.
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return SS_HTTPResponse
+	 * @return \SS_HTTPResponse
 	 */
 	public function users($request) {
 		return $this->index($request);
@@ -76,7 +76,7 @@ 
 	 * Shortcut action for setting the correct active tab.
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return SS_HTTPResponse
+	 * @return \SS_HTTPResponse
 	 */
 	public function groups($request) {
 		return $this->index($request);
@@ -86,7 +86,7 @@ 
 	 * Shortcut action for setting the correct active tab.
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return SS_HTTPResponse
+	 * @return \SS_HTTPResponse
 	 */
 	public function roles($request) {
 		return $this->index($request);

core/manifest/ConfigManifest.php

Doc Comments +5 added lines, -2 removed lines

@@ -110,7 +110,7 @@ 
 
 	/**
 	 * Provides a hook for mock unit tests despite no DI
-	 * @return Zend_Cache_Frontend
+	 * @return Zend_Cache_Core
 	 */
 	protected function getCache()
 	{
@@ -244,6 +244,9 @@ 
 	 * splt/complete before and after matchers)
 	 *
 	 * Public so that ManifestFileFinder can call it. Not for general use.
+	 * @param string $basename
+	 * @param string $pathname
+	 * @param boolean $depth
 	 */
 	public function addYAMLConfigFile($basename, $pathname, $depth) {
 		if (!preg_match('{/([^/]+)/_config/}', $pathname, $match)) return;
@@ -467,7 +470,7 @@ 
 	 * Returns false if the prefilterable parts of the rule aren't met, and true if they are
 	 *
 	 * @param  $rules array - A hash of rules as allowed in the only or except portion of a config fragment header
-	 * @return bool - True if the rules are met, false if not. (Note that depending on whether we were passed an
+	 * @return boolean|string - True if the rules are met, false if not. (Note that depending on whether we were passed an
 	 *                only or an except rule,
 	 * which values means accept or reject a fragment
 	 */

forms/gridfield/GridFieldDetailForm.php

Doc Comments +12 added lines

@@ -307,6 +307,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		return Controller::join_links($this->gridField->Link('item'),
 			$this->record->ID ? $this->record->ID : 'new', $action);
@@ -335,6 +338,9 @@ 
 		}
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	public function edit($request) {
 		$controller = $this->getToplevelController();
 		$form = $this->ItemEditForm($this->gridField, $request);
@@ -536,6 +542,9 @@ 
 		return $c;
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function getBackLink(){
 		// TODO Coupling with CMS
 		$backlink = '';
@@ -637,6 +646,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $errorCode
+	 */
 	public function httpError($errorCode, $errorMessage = null) {
 		$controller = $this->getToplevelController();
 		return $controller->httpError($errorCode, $errorMessage);

ORM/Hierarchy/Hierarchy.php

Doc Comments +2 added lines, -2 removed lines

@@ -379,7 +379,7 @@ 
 	/**
 	 * Return the IDs of all the marked nodes.
 	 *
-	 * @return array
+	 * @return integer[]
 	 */
 	public function markedNodeIDs() {
 		return array_keys($this->markedNodes);
@@ -756,7 +756,7 @@ 
 	 * Get the next node in the tree of the type. If there is no instance of the className descended from this node,
 	 * then search the parents.
 	 * @param string     $className Class name of the node to find.
-	 * @param string|int $root      ID/ClassName of the node to limit the search to
+	 * @param integer $root      ID/ClassName of the node to limit the search to
 	 * @param DataObject $afterNode Used for recursive calls to this function
 	 * @return DataObject
 	 */

Security/CMSSecurity.php

Doc Comments +6 added lines

@@ -52,6 +52,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		/** @skipUpgrade */
 		return Controller::join_links(Director::baseURL(), "CMSSecurity", $action);
@@ -68,6 +71,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $title
+	 */
 	public function getResponseController($title) {
 		// Use $this to prevent use of Page to render underlying templates
 		return $this;

Security/Security.php

Doc Comments +4 added lines, -4 removed lines

@@ -508,7 +508,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -893,7 +893,7 @@ 
 	 *
 	 * @param string $username The user name
 	 * @param string $password The password (in cleartext)
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function setDefaultAdmin($username, $password) {
 		// don't overwrite if already set
@@ -980,7 +980,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1148,7 +1148,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;