silverstripe / silverstripe-framework

security/Permission.php

Doc Comments +3 added lines, -3 removed lines

@@ -152,7 +152,7 @@ 
 	 * @param string $arg Optional argument (e.g. a permissions for a specific page)
 	 * @param bool $strict Use "strict" checking (which means a permission
 	 *  will be granted if the key does not exist at all)?
-	 * @return int|bool The ID of the permission record if the permission
+	 * @return boolean The ID of the permission record if the permission
 	 *  exists; FALSE otherwise. If "strict" checking is
 	 *  disabled, TRUE will be returned if the permission does not exist at all.
 	 */
@@ -656,7 +656,7 @@ 
 	 * Recursively traverse the nested list of declared permissions and create
 	 * a linear list.
 	 *
-	 * @param aeeay $declared Nested structure of permissions.
+	 * @param boolean $declared Nested structure of permissions.
 	 * @param $list List of permissions in the structure. The result will be
 	 *              written to this array.
 	 */
@@ -744,7 +744,7 @@ 
 	/**
 	 * Get permissions
 	 *
-	 * @return array Associative array of permissions in this permission
+	 * @return string Associative array of permissions in this permission
 	 *               group. The array indicies are the permission codes as
 	 *               used in {@link Permission::check()}. The value is
 	 *               suitable for using in an interface.

view/ArrayData.php

Doc Comments +2 added lines, -8 removed lines

@@ -50,14 +50,7 @@ 
 	/**
 	 * Gets a field from this object.
 	 *
-	 * @param string $field
-	 *
-	 * If the value is an object but not an instance of
-	 * ViewableData, it will be converted recursively to an
-	 * ArrayData.
-	 *
-	 * If the value is an associative array, it will likewise be
-	 * converted recursively to an ArrayData.
+	 * @param string $f
 	 */
 	public function getField($f) {
 		$value = $this->array[$f];
@@ -83,6 +76,7 @@ 
 	 * Check array to see if field isset
 	 *
 	 * @param string Field Key
+	 * @param string $f
 	 * @return bool
 	 */
 	public function hasField($f) {

admin/code/ModelAdmin.php

Doc Comments +4 added lines

@@ -113,6 +113,9 @@ 
 		Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/javascript/dist/ModelAdmin.js');
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		if(!$action) $action = $this->sanitiseClassName($this->modelClass);
 		return parent::Link($action);
@@ -255,6 +258,7 @@ 
 
 	/**
 	 * Unsanitise a model class' name from a URL param
+	 * @param string $class
 	 * @return string
 	 */
 	protected function unsanitiseClassName($class) {

core/Extensible.php

Doc Comments +1 added lines, -1 removed lines

@@ -369,7 +369,7 @@
 	 *
 	 * @param string $method the method name to call
 	 * @param mixed $a1
-	 * @param mixed $a2
+	 * @param string $a2
 	 * @param mixed $a3
 	 * @param mixed $a4
 	 * @param mixed $a5

model/DataExtension.php

Doc Comments +6 added lines

@@ -7,6 +7,9 @@ 
 
 	protected static $fixture_file = 'MemberDatetimeOptionsetFieldTest.yml';
 
+	/**
+	 * @param DataObject|null $member
+	 */
 	protected function createDateFormatFieldForMember($member) {
 		require_once 'Zend/Date.php';
 		$defaultDateFormat = Zend_Locale_Format::getDateFormat($member->Locale);
@@ -26,6 +29,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param DataObject|null $member
+	 */
 	protected function createTimeFormatFieldForMember($member) {
 		require_once 'Zend/Date.php';
 		$defaultTimeFormat = Zend_Locale_Format::getTimeFormat($member->Locale);

security/RememberLoginHash.php

Doc Comments +6 added lines, -2 removed lines

@@ -76,6 +76,9 @@ 
 		return $this->token;
 	}
 
+	/**
+	 * @param string $token
+	 */
 	public function setToken($token) {
 		$this->token = $token;
 	}
@@ -92,7 +95,7 @@ 
 	/**
 	 * Creates a new random token and hashes it using the
 	 * member information
-	 * @param Member The logged in user
+	 * @param Member Member logged in user
 	 * @return string The hash to be stored in the database
 	 */
 	public function getNewHash(Member $member){
@@ -106,7 +109,7 @@ 
 	 * The device is assigned a globally unique device ID
 	 * The returned login hash stores the hashed token in the
 	 * database, for this device and this member
-	 * @param Member The logged in user
+	 * @param Member Member logged in user
 	 * @return RememberLoginHash The generated login hash
 	 */
 	public static function generate(Member $member) {
@@ -149,6 +152,7 @@ 
 	 * Deletes existing tokens for this member
 	 * if logout_across_devices is true, all tokens are deleted, otherwise
 	 * only the token for the provided device ID will be removed
+	 * @param string $alcDevice
 	 */
 	public static function clear(Member $member, $alcDevice = null) {
 		if(!$member->exists()) { return; }

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/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();