silverstripe / silverstripe-framework

ORM/Connect/DBSchemaManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -295,7 +295,7 @@ 
 	 *   - array('fields' => array('A','B','C'), 'type' => 'index/unique/fulltext'): This gives you full
 	 *     control over the index.
 	 * @param boolean $hasAutoIncPK A flag indicating that the primary key on this table is an autoincrement type
-	 * @param array $options Create table options (ENGINE, etc.)
+	 * @param string|null $options Create table options (ENGINE, etc.)
 	 * @param array|bool $extensions List of extensions
 	 */
 	public function requireTable($table, $fieldSchema = null, $indexSchema = null, $hasAutoIncPK = true,
@@ -480,7 +480,7 @@ 
 	/**
 	 * Given an index spec determines the index type
 	 *
-	 * @param array|string $spec
+	 * @param string $spec
 	 * @return string
 	 */
 	protected function determineIndexType($spec) {
@@ -575,7 +575,7 @@ 
 	 *
 	 * @param string $table The table name.
 	 * @param string $field The field name.
-	 * @param array|string $spec The field specification. If passed in array syntax, the specific database
+	 * @param string $spec The field specification. If passed in array syntax, the specific database
 	 * 	driver takes care of the ALTER TABLE syntax. If passed as a string, its assumed to
 	 * 	be prepared as a direct SQL framgment ready for insertion into ALTER TABLE. In this case you'll
 	 * 	need to take care of database abstraction in your DBField subclass.

ORM/DataObject.php

Doc Comments +7 added lines, -6 removed lines

@@ -2716,6 +2716,7 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $field
 	 */
 	public function castingHelper($field) {
 		if ($fieldSpec = $this->db($field)) {
@@ -2920,7 +2921,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canView($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2932,7 +2933,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canEdit($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2944,7 +2945,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canDelete($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2958,7 +2959,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);
@@ -3062,7 +3063,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) {
@@ -3132,7 +3133,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/Filters/SearchFilter.php

Doc Comments +4 added lines, -3 removed lines

@@ -62,7 +62,7 @@ 
 	 *  column. Can contain a relation name in dot notation, which will automatically join
 	 *  the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and
 	 *  search the "Name" column when applying this filter to a SiteTree class).
-	 * @param mixed $value
+	 * @param string $value
 	 * @param array $modifiers
 	 */
 	public function __construct($fullName = null, $value = false, array $modifiers = array()) {
@@ -142,7 +142,7 @@ 
 	/**
 	 * Gets supported modifiers for this filter
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getSupportedModifiers()
 	{
@@ -187,6 +187,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $name
 	 */
 	public function setFullName($name) {
 		$this->fullName = $name;
@@ -323,7 +324,7 @@ 
 	/**
 	 * Determines case sensitivity based on {@link getModifiers()}.
 	 *
-	 * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
+	 * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
 	 */
 	protected function getCaseSensitive() {
 		$modifiers = $this->getModifiers();

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

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.

tests/forms/GridFieldTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	/**
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('addto');