Inspection of "Merge pull request #9110 from open-sausages/pulls/..." - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.7 ( d8014d...8c41db )

by Robbie

created 2019-07-19 12:38 UTC

Status

Doc Comments +3 added lines patch added patch discarded remove patch

@@ -52,6 +52,9 @@
 block discarded – undo
 		return 0;
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	public function prepValueForDB($value) {
 		if($value === true) {
 			return 1;

Please login to merge, or discard this patch.

model/Versioned.php 1 patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

@@ -765,7 +765,7 @@  discard block
 block discarded – undo
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -839,7 +839,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -905,7 +905,7 @@  discard block
 block discarded – undo
 	/**
 	 * Is the latest version of the object published?
 	 *
-	 * @return bool
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -1029,7 +1029,7 @@  discard block
 block discarded – undo
 	 * @param string $limit
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
 	 * @param string $having
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function Versions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
 		return $this->allVersions($filter, $sort, $limit, $join, $having);
@@ -1043,7 +1043,7 @@  discard block
 block discarded – undo
 	 * @param  string $limit
 	 * @param  string $join Deprecated, use leftJoin($table, $joinClause) instead
 	 * @param  string $having
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function allVersions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
 		// Make sure the table names are not postfixed (e.g. _Live)
@@ -1361,7 +1361,7 @@  discard block
 block discarded – undo
 	 * @param string     $filter         A filter to be inserted into the WHERE clause.
 	 * @param string     $sort           A sort expression to be inserted into the ORDER BY clause.
 	 * @param string     $join           Deprecated, use leftJoin($table, $joinClause) instead
-	 * @param string|int $limit          A limit on the number of records returned from the database.
+	 * @param integer $limit          A limit on the number of records returned from the database.
 	 * @param string     $containerClass The container class for the result set (default is DataList)
 	 *
 	 * @return DataList A modified DataList designated to the specified stage

Please login to merge, or discard this patch.

tests/forms/RequirementsTest.php 1 patch

Doc Comments +14 added lines patch added patch discarded remove patch

@@ -51,6 +51,9 @@  discard block
 block discarded – undo
 		);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 */
 	protected function setupCombinedRequirements($backend) {
 		$basePath = $this->getCurrentRelativePath();
 
@@ -76,6 +79,9 @@  discard block
 block discarded – undo
 		);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 */
 	protected function setupCombinedNonrequiredRequirements($backend) {
 			$basePath = $this->getCurrentRelativePath();
 
@@ -482,6 +488,10 @@  discard block
 block discarded – undo
 		$this->assertContains('var myvar="<head></head>";', $backend->includeInHTML(false, $template));
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileIncluded($backend, $type, $files) {
 		$type = strtolower($type);
 		switch (strtolower($type)) {
@@ -526,6 +536,10 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileNotIncluded($backend, $type, $files) {
 		$type = strtolower($type);
 		switch ($type) {

Please login to merge, or discard this patch.

forms/gridfield/GridFieldFilterHeader.php 1 patch

Doc Comments +2 added lines patch added patch discarded remove patch

@@ -23,6 +23,7 @@  discard block
 block discarded – undo
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -38,6 +39,7 @@  discard block
 block discarded – undo
 	/**
 	 * Check that this dataList is of the right data type.
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
+	 * @param SS_List $dataList
 	 */
 	protected function checkDataType($dataList) {
 		if($dataList instanceof SS_Filterable) {

Please login to merge, or discard this patch.

model/DataQuery.php 1 patch

Doc Comments +9 added lines, -2 removed lines patch added patch discarded remove patch

@@ -44,6 +44,7 @@  discard block
 block discarded – undo
 	 * 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;
@@ -175,7 +176,7 @@  discard block
 block discarded – undo
 	/**
 	 * 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 SQLQuery The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -693,7 +694,7 @@  discard block
 block discarded – undo
 	 * 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
 	 * @return string The model class of the related item
 	 */
 	public function applyRelation($relation) {
@@ -935,6 +936,9 @@  discard block
 block discarded – undo
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -944,6 +948,9 @@  discard block
 block discarded – undo
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

Please login to merge, or discard this patch.

security/MemberAuthenticator.php 1 patch

Doc Comments +2 added lines, -2 removed lines patch added patch discarded remove patch

@@ -145,7 +145,7 @@  discard block
 block discarded – undo
 	 * @param Form $form Optional: If passed, better error messages can be
 	 *                             produced by using
 	 *                             {@link Form::sessionMessage()}
-	 * @return bool|Member Returns FALSE if authentication fails, otherwise
+	 * @return Member|null Returns FALSE if authentication fails, otherwise
 	 *                     the member object
 	 * @see Security::setDefaultAdmin()
 	 */
@@ -186,7 +186,7 @@  discard block
 block discarded – undo
 	/**
 	 * 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 MemberLoginForm Returns the login form to use with this authentication
 	 *              method

Please login to merge, or discard this patch.

dev/Backtrace.php 1 patch

Doc Comments +2 added lines, -2 removed lines patch added patch discarded remove patch

@@ -115,7 +115,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param unknown_type $returnVal
 	 * @param unknown_type $ignoreAjax
-	 * @return unknown
+	 * @return string|null
 	 */
 	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
 		$plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax);
@@ -132,7 +132,7 @@  discard block
 block discarded – undo
 	 * shown
 	 *
 	 * @param SS_Object $item
-	 * @param boolean $showArg
+	 * @param boolean $showArgs
 	 * @param Int $argCharLimit
 	 * @return String
 	 */

Please login to merge, or discard this patch.

security/Security.php 1 patch

Doc Comments +4 added lines, -5 removed lines patch added patch discarded remove patch

@@ -496,7 +496,7 @@  discard block
 block discarded – undo
 	 * 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 @@  discard block
 block discarded – undo
 	 * - 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 @@  discard block
 block discarded – undo
 	/**
 	 * 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 @@  discard block
 block discarded – undo
 	 * @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 @@  discard block
 block discarded – undo
 	/**
 	 * 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;

Please login to merge, or discard this patch.

view/SSViewer.php 1 patch

Doc Comments +18 added lines, -5 removed lines patch added patch discarded remove patch

@@ -365,7 +365,6 @@  discard block
 block discarded – undo
 	/**
 	 * 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 @@  discard block
 block discarded – undo
 	 */
 	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 @@  discard block
 block discarded – undo
 		$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 @@  discard block
 block discarded – undo
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1254,9 +1261,9 @@  discard block
 block discarded – undo
 	 * 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 @@  discard block
 block discarded – undo
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1310,7 +1320,7 @@  discard block
 block discarded – undo
 	 * 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 @@  discard block
 block discarded – undo
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

Please login to merge, or discard this patch.

		@@ -145,7 +145,7 @@ discard block
		block discarded – undo
145	145	* @param Form $form Optional: If passed, better error messages can be
146	146	* produced by using
147	147	* {@link Form::sessionMessage()}
148		- * @return bool\|Member Returns FALSE if authentication fails, otherwise
	148	+ * @return Member\|null Returns FALSE if authentication fails, otherwise
149	149	* the member object
150	150	* @see Security::setDefaultAdmin()
151	151	*/
		@@ -186,7 +186,7 @@ discard block
		block discarded – undo
186	186	/**
187	187	* Method that creates the login form for this authentication method
188	188	*
189		- * @param Controller The parent controller, necessary to create the
	189	+ * @param Controller Controller parent controller, necessary to create the
190	190	* appropriate form action tag
191	191	* @return MemberLoginForm Returns the login form to use with this authentication
192	192	* method

		@@ -365,7 +365,6 @@ discard block
		block discarded – undo
365	365	/**
366	366	* Returns the modulus of the numerical position of the item in the data set.
367	367	* The count starts from $startIndex, which defaults to 1.
368		- * @param int $Mod The number to perform Mod operation to.
369	368	* @param int $startIndex Number to start count from.
370	369	* @return int
371	370	*/
		@@ -415,6 +414,10 @@ discard block
		block discarded – undo
415	414	*/
416	415	protected $underlay;
417	416
	417	+ /**
	418	+ * @param SS_Object $item
	419	+ * @param SS_Object $inheritedScope
	420	+ */
418	421	public function __construct($item, $overlay = null, $underlay = null, $inheritedScope = null) {
419	422	parent::__construct($item, $inheritedScope);
420	423
		@@ -439,6 +442,10 @@ discard block
		block discarded – undo
439	442	$this->underlay = $underlay ? $underlay : array();
440	443	}
441	444
	445	+ /**
	446	+ * @param string $interfaceToQuery
	447	+ * @param string $variableMethod
	448	+ */
442	449	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
443	450	$implementers = ClassInfo::implementorsOf($interfaceToQuery);
444	451	if($implementers) foreach($implementers as $implementer) {
		@@ -851,7 +858,7 @@ discard block
		block discarded – undo
851	858	*
852	859	* @param $className string - valid class name
853	860	* @param $suffix string
854		- * @param $baseClass string
	861	+ * @param string $baseClass string
855	862	*
856	863	* @return array
857	864	*/
		@@ -1254,9 +1261,9 @@ discard block
		block discarded – undo
1254	1261	* Used by the <% include %> template tag to process templates.
1255	1262	*
1256	1263	* @param string $template Template name
1257		- * @param mixed $data Data context
	1264	+ * @param SS_Object $data Data context
1258	1265	* @param array $arguments Additional arguments
1259		- * @return string Evaluated result
	1266	+ * @return HTMLText Evaluated result
1260	1267	*/
1261	1268	public static function execute_template($template, $data, $arguments = null, $scope = null) {
1262	1269	$v = new SSViewer($template);
		@@ -1282,6 +1289,9 @@ discard block
		block discarded – undo
1282	1289	return $v->process($data, $arguments);
1283	1290	}
1284	1291
	1292	+ /**
	1293	+ * @param string $content
	1294	+ */
1285	1295	public function parseTemplateContent($content, $template="") {
1286	1296	return $this->getParser()->compileString(
1287	1297	$content,
		@@ -1310,7 +1320,7 @@ discard block
		block discarded – undo
1310	1320	* Return an appropriate base tag for the given template.
1311	1321	* It will be closed on an XHTML document, and unclosed on an HTML document.
1312	1322	*
1313		- * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
	1323	+ * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
1314	1324	* the DOCTYPE declaration.
1315	1325	*/
1316	1326	public static function get_base_tag($contentGeneratedSoFar) {
		@@ -1351,6 +1361,9 @@ discard block
		block discarded – undo
1351	1361	*/
1352	1362	protected $cacheTemplate;
1353	1363
	1364	+ /**
	1365	+ * @param string $content
	1366	+ */
1354	1367	public function __construct($content, TemplateParser $parser = null) {
1355	1368	if ($parser) {
1356	1369	$this->setParser($parser);

		@@ -52,6 +52,9 @@
		block discarded – undo
52	52	return 0;
53	53	}
54	54
	55	+ /**
	56	+ * @param integer $value
	57	+ */
55	58	public function prepValueForDB($value) {
56	59	if($value === true) {
57	60	return 1;

		@@ -765,7 +765,7 @@ discard block
		block discarded – undo
765	765	* Extend permissions to include additional security for objects that are not published to live.
766	766	*
767	767	* @param Member $member
768		- * @return bool\|null
	768	+ * @return false\|null
769	769	*/
770	770	public function canView($member = null) {
771	771	// Invoke default version-gnostic canView
		@@ -839,7 +839,7 @@ discard block
		block discarded – undo
839	839	*
840	840	* @param string $stage
841	841	* @param Member $member
842		- * @return bool
	842	+ * @return boolean\|string
843	843	*/
844	844	public function canViewStage($stage = 'Live', $member = null) {
845	845	$oldMode = Versioned::get_reading_mode();
		@@ -905,7 +905,7 @@ discard block
		block discarded – undo
905	905	/**
906	906	* Is the latest version of the object published?
907	907	*
908		- * @return bool
	908	+ * @return string
909	909	*/
910	910	public function latestPublished() {
911	911	// Get the root data object class - this will have the version field
		@@ -1029,7 +1029,7 @@ discard block
		block discarded – undo
1029	1029	* @param string $limit
1030	1030	* @param string $join Deprecated, use leftJoin($table, $joinClause) instead
1031	1031	* @param string $having
1032		- * @return DataList
	1032	+ * @return ArrayList
1033	1033	*/
1034	1034	public function Versions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
1035	1035	return $this->allVersions($filter, $sort, $limit, $join, $having);
		@@ -1043,7 +1043,7 @@ discard block
		block discarded – undo
1043	1043	* @param string $limit
1044	1044	* @param string $join Deprecated, use leftJoin($table, $joinClause) instead
1045	1045	* @param string $having
1046		- * @return DataList
	1046	+ * @return ArrayList
1047	1047	*/
1048	1048	public function allVersions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
1049	1049	// Make sure the table names are not postfixed (e.g. _Live)
		@@ -1361,7 +1361,7 @@ discard block
		block discarded – undo
1361	1361	* @param string $filter A filter to be inserted into the WHERE clause.
1362	1362	* @param string $sort A sort expression to be inserted into the ORDER BY clause.
1363	1363	* @param string $join Deprecated, use leftJoin($table, $joinClause) instead
1364		- * @param string\|int $limit A limit on the number of records returned from the database.
	1364	+ * @param integer $limit A limit on the number of records returned from the database.
1365	1365	* @param string $containerClass The container class for the result set (default is DataList)
1366	1366	*
1367	1367	* @return DataList A modified DataList designated to the specified stage

		@@ -51,6 +51,9 @@ discard block
		block discarded – undo
51	51	);
52	52	}
53	53
	54	+ /**
	55	+ * @param Requirements_Backend $backend
	56	+ */
54	57	protected function setupCombinedRequirements($backend) {
55	58	$basePath = $this->getCurrentRelativePath();
56	59
		@@ -76,6 +79,9 @@ discard block
		block discarded – undo
76	79	);
77	80	}
78	81
	82	+ /**
	83	+ * @param Requirements_Backend $backend
	84	+ */
79	85	protected function setupCombinedNonrequiredRequirements($backend) {
80	86	$basePath = $this->getCurrentRelativePath();
81	87
		@@ -482,6 +488,10 @@ discard block
		block discarded – undo
482	488	$this->assertContains('var myvar="<head></head>";', $backend->includeInHTML(false, $template));
483	489	}
484	490
	491	+ /**
	492	+ * @param Requirements_Backend $backend
	493	+ * @param string $type
	494	+ */
485	495	public function assertFileIncluded($backend, $type, $files) {
486	496	$type = strtolower($type);
487	497	switch (strtolower($type)) {
		@@ -526,6 +536,10 @@ discard block
		block discarded – undo
526	536	}
527	537	}
528	538
	539	+ /**
	540	+ * @param Requirements_Backend $backend
	541	+ * @param string $type
	542	+ */
529	543	public function assertFileNotIncluded($backend, $type, $files) {
530	544	$type = strtolower($type);
531	545	switch ($type) {

		@@ -23,6 +23,7 @@ discard block
		block discarded – undo
23	23	*
24	24	* By default, this is set to true so that it's clearer what's happening, but the predefined
25	25	* {@link GridFieldConfig} subclasses set this to false for flexibility.
	26	+ * @param boolean $throwExceptionOnBadDataType
26	27	*/
27	28	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
28	29	$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
		@@ -38,6 +39,7 @@ discard block
		block discarded – undo
38	39	/**
39	40	* Check that this dataList is of the right data type.
40	41	* Returns false if it's a bad data type, and if appropriate, throws an exception.
	42	+ * @param SS_List $dataList
41	43	*/
42	44	protected function checkDataType($dataList) {
43	45	if($dataList instanceof SS_Filterable) {

		@@ -44,6 +44,7 @@ discard block
		block discarded – undo
44	44	* Create a new DataQuery.
45	45	*
46	46	* @param string The name of the DataObject class that you wish to query
	47	+ * @param string $dataClass
47	48	*/
48	49	public function __construct($dataClass) {
49	50	$this->dataClass = $dataClass;
		@@ -175,7 +176,7 @@ discard block
		block discarded – undo
175	176	/**
176	177	* Ensure that the query is ready to execute.
177	178	*
178		- * @param array\|null $queriedColumns Any columns to filter the query by
	179	+ * @param string[] $queriedColumns Any columns to filter the query by
179	180	* @return SQLQuery The finalised sql query
180	181	*/
181	182	public function getFinalisedQuery($queriedColumns = null) {
		@@ -693,7 +694,7 @@ discard block
		block discarded – undo
693	694	* mappings to the query object state. This has to be called
694	695	* in any overloaded {@link SearchFilter->apply()} methods manually.
695	696	*
696		- * @param string\|array $relation The array/dot-syntax relation to follow
	697	+ * @param string $relation The array/dot-syntax relation to follow
697	698	* @return string The model class of the related item
698	699	*/
699	700	public function applyRelation($relation) {
		@@ -935,6 +936,9 @@ discard block
		block discarded – undo
935	936	*/
936	937	protected $whereQuery;
937	938
	939	+ /**
	940	+ * @param string $connective
	941	+ */
938	942	public function __construct(DataQuery $base, $connective) {
939	943	$this->dataClass = $base->dataClass;
940	944	$this->query = $base->query;
		@@ -944,6 +948,9 @@ discard block
		block discarded – undo
944	948	$base->where($this);
945	949	}
946	950
	951	+ /**
	952	+ * @param string $filter
	953	+ */
947	954	public function where($filter) {
948	955	if($filter) {
949	956	$this->whereQuery->addWhere($filter);

		@@ -115,7 +115,7 @@ discard block
		block discarded – undo
115	115	*
116	116	* @param unknown_type $returnVal
117	117	* @param unknown_type $ignoreAjax
118		- * @return unknown
	118	+ * @return string\|null
119	119	*/
120	120	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
121	121	$plainText = Director::is_cli() \|\| (Director::is_ajax() && !$ignoreAjax);
		@@ -132,7 +132,7 @@ discard block
		block discarded – undo
132	132	* shown
133	133	*
134	134	* @param SS_Object $item
135		- * @param boolean $showArg
	135	+ * @param boolean $showArgs
136	136	* @param Int $argCharLimit
137	137	* @return String
138	138	*/

		@@ -496,7 +496,7 @@ discard block
		block discarded – undo
496	496	* Combine the given forms into a formset with a tabbed interface
497	497	*
498	498	* @param array $forms List of LoginForm instances
499		- * @return string
	499	+ * @return HTMLText
500	500	*/
501	501	protected function generateLoginFormSet($forms) {
502	502	$viewData = new ArrayData(array(
		@@ -676,7 +676,6 @@ discard block
		block discarded – undo
676	676	* - t: plaintext token
677	677	*
678	678	* @param Member $member Member object associated with this link.
679		- * @param string $autoLoginHash The auto login token.
680	679	*/
681	680	public static function getPasswordResetLink($member, $autologinToken) {
682	681	$autologinToken = urldecode($autologinToken);
		@@ -767,7 +766,7 @@ discard block
		block discarded – undo
767	766	/**
768	767	* Factory method for the lost password form
769	768	*
770		- * @return Form Returns the lost password form
	769	+ * @return Security Returns the lost password form
771	770	*/
772	771	public function ChangePasswordForm() {
773	772	return SS_Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
		@@ -951,7 +950,7 @@ discard block
		block discarded – undo
951	950	* @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
952	951	* @param string $algorithm One of the available password encryption
953	952	* algorithms determined by {@link Security::get_encryption_algorithms()}
954		- * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
	953	+ * @return boolean\|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
955	954	*/
956	955	public static function set_password_encryption_algorithm($algorithm) {
957	956	Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
		@@ -1106,7 +1105,7 @@ discard block
		block discarded – undo
1106	1105	/**
1107	1106	* Set to true to ignore access to disallowed actions, rather than returning permission failure
1108	1107	* Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
1109		- * @param $flag True or false
	1108	+ * @param boolean $flag True or false
1110	1109	*/
1111	1110	public static function set_ignore_disallowed_actions($flag) {
1112	1111	self::$ignore_disallowed_actions = $flag;

silverstripe / silverstripe-framework

Push — 3.7 ( d8014d...8c41db )

Status

Category

Doc Comments +3 added lines patch added patch discarded remove patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

Doc Comments +14 added lines patch added patch discarded remove patch

Doc Comments +2 added lines patch added patch discarded remove patch

Doc Comments +9 added lines, -2 removed lines patch added patch discarded remove patch

Doc Comments +2 added lines, -2 removed lines patch added patch discarded remove patch

Doc Comments +2 added lines, -2 removed lines patch added patch discarded remove patch

Doc Comments +4 added lines, -5 removed lines patch added patch discarded remove patch

Doc Comments +18 added lines, -5 removed lines patch added patch discarded remove patch