sminnee / silverstripe-framework

model/queries/SQLSelect.php

Doc Comments +1 added lines, -4 removed lines

@@ -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) {

model/UnsavedRelationList.php

Doc Comments +2 added lines, -2 removed lines

@@ -50,6 +50,7 @@ 
 	 * Create a new UnsavedRelationList
 	 *
 	 * @param string $dataClass The DataObject class used in the relation
+	 * @param string $relationName
 	 */
 	public function __construct($baseClass, $relationName, $dataClass) {
 		$this->baseClass = $baseClass;
@@ -142,7 +143,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) {
@@ -177,7 +178,6 @@ 
 	/**
 	 * Remove the items from this list with the given IDs
 	 *
-	 * @param array $idList
 	 */
 	public function removeMany($items) {
 		$this->items = array_diff($this->items, $items);

model/URLSegmentFilter.php

Doc Comments +2 added lines, -1 removed lines

@@ -106,7 +106,7 @@ 
 	protected $transliterator;
 
 	/**
-	 * @return SS_Transliterator|NULL
+	 * @return SS_Transliterator
 	 */
 	public function getTransliterator() {
 		if($this->transliterator === null && $this->config()->default_use_transliterator) {
@@ -129,6 +129,7 @@ 
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setAllowMultibyte($bool) {
 		$this->allowMultibyte = $bool;

oembed/Oembed.php

Doc Comments +5 added lines

@@ -46,6 +46,7 @@ 
 	 *
 	 * @param $url Human-readable URL.
 	 * @returns string/bool URL of an endpoint, or false if no matching provider exists.
+	 * @return string
 	 */
 	protected static function find_endpoint($url) {
 		foreach(self::get_providers() as $scheme=>$endpoint) {
@@ -261,6 +262,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getOembedURL() {
 		return $this->url;
 	}
@@ -319,6 +323,7 @@ 
 
 	/**
 	 * Wrap the check for looking into Oembed JSON within $this->data.
+	 * @param string $field
 	 */
 	public function hasField($field) {
 		$this->loadData();

search/filters/ComparisonFilter.php

Doc Comments +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
 	 * Handles SQL escaping for both numeric and string values
 	 *
 	 * @param DataQuery $query
-	 * @return $this|DataQuery
+	 * @return DataQuery
 	 */
 	protected function applyOne(DataQuery $query) {
 		$this->model = $query->applyRelation($this->relation);
@@ -50,7 +50,7 @@ 
 	 * Handles SQL escaping for both numeric and string values
 	 *
 	 * @param DataQuery $query
-	 * @return $this|DataQuery
+	 * @return DataQuery
 	 */
 	protected function excludeOne(DataQuery $query) {
 		$this->model = $query->applyRelation($this->relation);

security/Authenticator.php

Doc Comments +3 added lines, -2 removed lines

@@ -43,7 +43,7 @@ 
 	/**
 	 * Method that creates the login form for this authentication method
 	 *
-	 * @param Controller The parent controller, necessary to create the
+	 * @param Controller Controller parent controller, necessary to create the
 	 *                   appropriate form action tag
 	 * @return Form Returns the login form to use with this authentication
 	 *              method
@@ -121,7 +121,7 @@ 
 	 * Remove a previously registered authenticator
 	 *
 	 * @param string $authenticator Name of the authenticator class to register
-	 * @return bool Returns TRUE on success, FALSE otherwise.
+	 * @return boolean|null Returns TRUE on success, FALSE otherwise.
 	 */
 	public static function unregister_authenticator($authenticator) {
 		if(call_user_func(array($authenticator, 'on_unregister')) === true) {
@@ -164,6 +164,7 @@ 
 	 * Set a default authenticator (shows first in tabs)
 	 *
 	 * @param string
+	 * @param string $authenticator
 	 */
 	public static function set_default_authenticator($authenticator) {
 		self::$default_authenticator = $authenticator;

security/CMSSecurity.php

Doc Comments +9 added lines

@@ -42,6 +42,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		return Controller::join_links(Director::baseURL(), "CMSSecurity", $action);
 	}
@@ -57,6 +60,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $title
+	 */
 	public function getResponseController($title) {
 		// Use $this to prevent use of Page to render underlying templates
 		return $this;
@@ -172,6 +178,9 @@ 
 		user_error('Passed invalid authentication method', E_USER_ERROR);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function getTemplatesFor($action) {
 		return array("CMSSecurity_{$action}", "CMSSecurity")
 			+ parent::getTemplatesFor($action);

security/Group.php

Doc Comments +1 added lines

@@ -331,6 +331,7 @@
 	 * Overloaded to ensure the code is always descent.
 	 *
 	 * @param string
+	 * @param string $val
 	 */
 	public function setCode($val){
 		$this->setField("Code", Convert::raw2url($val));

security/Member.php

Doc Comments +3 added lines, -1 removed lines

@@ -588,6 +588,8 @@ 
 
 	/**
 	 * Utility for generating secure password hashes for this member.
+	 * @param string $string
+	 * @return string
 	 */
 	public function encryptWithUserSettings($string) {
 		if (!$string) return null;
@@ -738,7 +740,7 @@ 
 	/**
 	 * Returns the current logged in user
 	 *
-	 * @return Member|null
+	 * @return DataObject|null
 	 */
 	public static function currentUser() {
 		$id = Member::currentUserID();