silverstripe / silverstripe-framework

security/Security.php

Doc Comments +4 added lines, -5 removed lines

@@ -496,7 +496,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return HTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -676,7 +676,6 @@ 
 	 * - t: plaintext token
 	 *
 	 * @param Member $member Member object associated with this link.
-	 * @param string $autoLoginHash The auto login token.
 	 */
 	public static function getPasswordResetLink($member, $autologinToken) {
 		$autologinToken      = urldecode($autologinToken);
@@ -767,7 +766,7 @@ 
 	/**
 	 * Factory method for the lost password form
 	 *
-	 * @return Form Returns the lost password form
+	 * @return Security Returns the lost password form
 	 */
 	public function ChangePasswordForm() {
 		return SS_Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
@@ -951,7 +950,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');
@@ -1106,7 +1105,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;

view/SSViewer.php

Doc Comments +18 added lines, -5 removed lines

@@ -365,7 +365,6 @@ 
 	/**
 	 * Returns the modulus of the numerical position of the item in the data set.
 	 * The count starts from $startIndex, which defaults to 1.
-	 * @param int $Mod The number to perform Mod operation to.
 	 * @param int $startIndex Number to start count from.
 	 * @return int
 	 */
@@ -415,6 +414,10 @@ 
 	 */
 	protected $underlay;
 
+	/**
+	 * @param SS_Object $item
+	 * @param SS_Object $inheritedScope
+	 */
 	public function __construct($item, $overlay = null, $underlay = null, $inheritedScope = null) {
 		parent::__construct($item, $inheritedScope);
 
@@ -439,6 +442,10 @@ 
 		$this->underlay = $underlay ? $underlay : array();
 	}
 
+	/**
+	 * @param string $interfaceToQuery
+	 * @param string $variableMethod
+	 */
 	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
 		$implementers = ClassInfo::implementorsOf($interfaceToQuery);
 		if($implementers) foreach($implementers as $implementer) {
@@ -851,7 +858,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1254,9 +1261,9 @@ 
 	 * Used by the <% include %> template tag to process templates.
 	 *
 	 * @param string $template Template name
-	 * @param mixed $data Data context
+	 * @param SS_Object $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return HTMLText Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1282,6 +1289,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1310,7 +1320,7 @@ 
 	 * Return an appropriate base tag for the given template.
 	 * It will be closed on an XHTML document, and unclosed on an HTML document.
 	 *
-	 * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
+	 * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
 	 * the DOCTYPE declaration.
 	 */
 	public static function get_base_tag($contentGeneratedSoFar) {
@@ -1351,6 +1361,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

api/RestfulService.php

Doc Comments +2 added lines, -2 removed lines

@@ -335,8 +335,8 @@
 	/**
 	 * Extracts the response body and headers from a full curl response
 	 *
-	 * @param curl_handle $ch The curl handle for the request
-	 * @param string $rawResponse The raw response text
+	 * @param resource $ch The curl handle for the request
+	 * @param string $rawHeaders
 	 *
 	 * @return RestfulService_Response The response object
 	 */

control/CookieJar.php

Doc Comments +2 added lines, -2 removed lines

@@ -144,13 +144,13 @@
 	 * @see http://uk3.php.net/manual/en/function.setcookie.php
 	 *
 	 * @param string $name The name of the cookie
-	 * @param string|array|false $value The value for the cookie to hold
+	 * @param false|string $value The value for the cookie to hold
 	 * @param int $expiry The number of days until expiry
 	 * @param string $path The path to save the cookie on (falls back to site base)
 	 * @param string $domain The domain to make the cookie available on
 	 * @param boolean $secure Can the cookie only be sent over SSL?
 	 * @param boolean $httpOnly Prevent the cookie being accessible by JS
-	 * @return boolean If the cookie was set or not; doesn't mean it's accepted by the browser
+	 * @return boolean|null If the cookie was set or not; doesn't mean it's accepted by the browser
 	 */
 	protected function outputCookie(
 		$name, $value, $expiry = 90, $path = null, $domain = null, $secure = false, $httpOnly = true

model/DataObject.php

Doc Comments +14 added lines, -6 removed lines

@@ -385,6 +385,7 @@ 
 	/**
 	 * Returns a list of all the composite if the given db field on the class is a composite field.
 	 * Will check all applicable ancestor classes and aggregate results.
+	 * @param string $class
 	 */
 	public static function composite_fields($class, $aggregated = true) {
 		if(!isset(DataObject::$_cache_composite_fields[$class])) self::cache_composite_fields($class);
@@ -552,7 +553,7 @@ 
 	 * The destinationObject must be written to the database already and have an ID. Writing is performed
 	 * automatically when adding the new relations.
 	 *
-	 * @param $sourceObject the source object to duplicate from
+	 * @param DataObject $sourceObject the source object to duplicate from
 	 * @param $destinationObject the destination object to populate with the duplicated relations
 	 * @return DataObject with the new many_many relations copied in
 	 */
@@ -959,6 +960,7 @@ 
 	 * @param $includeRelations Boolean Merge any existing relations (optional)
 	 * @param $overwriteWithEmpty Boolean Overwrite existing left values with empty right values.
 	 *                            Only applicable with $priority='right'. (optional)
+	 * @param DataObject|null $rightObj
 	 * @return Boolean
 	 */
 	public function merge($rightObj, $priority = 'right', $includeRelations = true, $overwriteWithEmpty = false) {
@@ -1582,10 +1584,10 @@ 
 	 *
 	 * @param string $componentName Name of the component
 	 * @param string|null $filter Deprecated. A filter to be inserted into the WHERE clause
-	 * @param string|null|array $sort Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted,
+	 * @param string $sort Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted,
 	 *                                the static field $default_sort on the component class will be used.
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
-	 * @param string|null|array $limit Deprecated. A limit expression to be inserted into the LIMIT clause
+	 * @param string $limit Deprecated. A limit expression to be inserted into the LIMIT clause
 	 *
 	 * @return HasManyList The components of the one-to-many relationship.
 	 */
@@ -2211,6 +2213,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2678,7 +2681,7 @@ 
 	 * can be saved into the Image table.
 	 *
 	 * @param string $fieldName Name of the field
-	 * @param mixed $value New field value
+	 * @param mixed $val New field value
 	 * @return DataObject $this
 	 */
 	public function setCastedField($fieldName, $val) {
@@ -2698,6 +2701,7 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $field
 	 */
 	public function castingHelper($field) {
 		if ($fieldSpec = $this->db($field)) {
@@ -3062,6 +3066,7 @@ 
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
 	 * @param $fieldPath string
+	 * @param string $fieldName
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3130,7 +3135,7 @@ 
 	 * @param string $callerClass The class of objects to be returned
 	 * @param string|array $filter A filter to be inserted into the WHERE clause.
 	 * Supports parameterised queries. See SQLQuery::addWhere() for syntax examples.
-	 * @param string|array $sort A sort expression to be inserted into the ORDER
+	 * @param string $sort A sort expression to be inserted into the ORDER
 	 * BY clause.  If omitted, self::$default_sort will be used.
 	 * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
 	 * @param string|array $limit A limit expression to be inserted into the LIMIT clause.
@@ -3181,6 +3186,7 @@ 
 
 	/**
 	 * @deprecated
+	 * @param string $class
 	 */
 	public function Aggregate($class = null) {
 		Deprecation::notice('4.0', 'Call aggregate methods on a DataList directly instead. In templates'
@@ -3202,6 +3208,7 @@ 
 
 	/**
 	 * @deprecated
+	 * @param string $relationship
 	 */
 	public function RelationshipAggregate($relationship) {
 		Deprecation::notice('4.0', 'Call aggregate methods on a relationship directly instead.');
@@ -3370,6 +3377,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {
@@ -3433,7 +3441,7 @@ 
 	 * Parses a specified column into a sort field and direction
 	 *
 	 * @param string $column String to parse containing the column name
-	 * @return array Resolved table and column.
+	 * @return string[] Resolved table and column.
 	 */
 	protected function parseSortColumn($column) {
 		// Parse column specification, considering possible ansi sql quoting

control/Session.php

Doc Comments +3 added lines, -1 removed lines

@@ -265,7 +265,6 @@ 
 	 *
 	 * @deprecated 4.0 Use the "Session.timeout_ips" config setting instead
 	 *
-	 * @param array $session_ips Array of IPv4 rules.
 	 */
 	public static function set_timeout_ips($ips) {
 		Deprecation::notice('4.0', 'Use the "Session.timeout_ips" config setting instead');
@@ -462,6 +461,9 @@ 
 		$diffVar[sizeof($var)-1] = $val;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function inst_get($name) {
 		// Quicker execution path for "."-free names
 		if(strpos($name,'.') === false) {

forms/gridfield/GridFieldExportButton.php

Doc Comments +2 added lines

@@ -91,6 +91,7 @@ 
 
 	/**
 	 * Handle the export, for both the action button and the URL
+ 	 * @param GridField $gridField
  	 */
 	public function handleExport($gridField, $request = null) {
 		$now = Date("d-m-Y-H-i");
@@ -248,6 +249,7 @@ 
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setCsvHasHeader($bool) {
 		$this->csvHasHeader = $bool;

forms/FormAction.php

Doc Comments +3 added lines, -2 removed lines

@@ -76,7 +76,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge(
@@ -93,7 +93,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function FieldHolder($properties = array()) {
 		return $this->Field($properties);
@@ -157,6 +157,7 @@ 
 	 * Enable or disable the rendering of this action as a `<button />`
 	 *
 	 * @param boolean
+	 * @param boolean $bool
 	 * @return $this
 	 */
 	public function setUseButtonTag($bool) {

admin/code/CMSMenu.php

Doc Comments +5 added lines, -3 removed lines

@@ -86,7 +86,7 @@ 
 	 *                          left.
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean The result of the operation.
+	 * @return boolean|null The result of the operation.
 	 */
 	public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null) {
 		return self::add_menu_item($code, $menuTitle, $url, null, $priority, $attributes);
@@ -107,7 +107,7 @@ 
 	 * @param int $priority
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function add_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 											$attributes = null) {
@@ -239,7 +239,7 @@ 
 	 * @param int $priority
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function replace_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 												$attributes = null) {
@@ -258,6 +258,8 @@ 
 
 	/**
 	 * Add a previously built menu item object to the menu
+	 * @param string $code
+	 * @param CMSMenuItem $cmsMenuItem
 	 */
 	protected static function add_menu_item_obj($code, $cmsMenuItem) {
 		self::$menu_item_changes[] = array(