sminnee / silverstripe-framework

ORM/DataObject.php

Doc Comments +7 added lines, -6 removed lines

@@ -2712,6 +2712,7 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $field
 	 */
 	public function castingHelper($field) {
 		if ($fieldSpec = $this->db($field)) {
@@ -2916,7 +2917,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canView($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2928,7 +2929,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canEdit($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2940,7 +2941,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canDelete($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2954,7 +2955,7 @@ 
 	 * @param Member $member
 	 * @param array $context Additional context-specific data which might
 	 * affect whether (or where) this object could be created.
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canCreate($member = null, $context = array()) {
 		$extended = $this->extendedCan(__FUNCTION__, $member, $context);
@@ -3058,7 +3059,7 @@ 
 	 * Traverses to a field referenced by relationships between data objects, returning the value
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
-	 * @param $fieldName string
+	 * @param string $fieldName string
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3128,7 +3129,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 SQLSelect::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.

ORM/DataQuery.php

Doc Comments +2 added lines, -2 removed lines

@@ -98,7 +98,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
@@ -177,7 +177,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) {

ORM/Filters/PartialMatchFilter.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use SilverStripe\ORM\DataQuery;
 use SilverStripe\ORM\DB;
-use InvalidArgumentException;
 
 /**
  * Matches textual content with a LIKE '%keyword%' construct.

ORM/HasManyList.php

Doc Comments +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
 	 *
 	 * It does so by setting the relationFilters.
 	 *
-	 * @param DataObject|int $item The DataObject to be added, or its ID
+	 * @param DataObject $item The DataObject to be added, or its ID
 	 */
 	public function add($item) {
 		if(is_numeric($item)) {

ORM/Queries/SQLSelect.php

Doc Comments +2 added lines, -4 removed lines

@@ -65,7 +65,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.
@@ -355,7 +355,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)) {
@@ -450,7 +450,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 $this Self reference
 	 */
 	public function setHaving($having) {
@@ -465,7 +464,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 $this Self reference
 	 */
 	public function addHaving($having) {

ORM/Versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -1065,7 +1065,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1185,7 +1185,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param Member|null $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1295,7 +1295,7 @@ 
 	 * 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
@@ -1371,7 +1371,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -1436,7 +1436,7 @@ 
 	/**
 	 * Determines if the current draft version is the same as live
 	 *
-	 * @return bool
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -2433,7 +2433,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {

Security/PasswordValidator.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
 	 * Eg: $this->characterStrength(3, array("lowercase", "uppercase", "digits", "punctuation"))
 	 *
 	 * @param int $minScore The minimum number of character tests that must pass
-	 * @param array $testNames The names of the tests to perform
+	 * @param string[] $testNames The names of the tests to perform
 	 * @return $this
 	 */
 	public function characterStrength($minScore, $testNames) {

Security/Permission.php

Doc Comments +2 added lines, -2 removed lines

@@ -121,7 +121,7 @@ 
 	 *  will be checked for the current user
 	 * @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|string 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.
 	 */
@@ -159,7 +159,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|string 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.
 	 */

Security/Permission_Group.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,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.