silverstripe / silverstripe-framework

src/ORM/DataObject.php

Doc Comments +9 added lines, -8 removed lines

@@ -2176,7 +2176,7 @@ 
      * Called by {@link __get()} and any getFieldName() methods you might create.
      *
      * @param string $field The name of the field
-     * @return mixed The field value
+     * @return string|null The field value
      */
     public function getField($field)
     {
@@ -2458,6 +2458,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $field
      */
     public function castingHelper($field)
     {
@@ -2563,7 +2564,7 @@ 
      * </code>
      *
      * @param string $methodName Method on the same object, e.g. {@link canEdit()}
-     * @param Member|int $member
+     * @param null|Member $member
      * @param array $context Optional context
      * @return boolean|null
      */
@@ -2586,7 +2587,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -2599,7 +2600,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -2612,7 +2613,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {
@@ -2627,7 +2628,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())
     {
@@ -2742,7 +2743,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)
@@ -2820,7 +2821,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.

src/Security/InheritedPermissions.php

Doc Comments +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
     /**
      * Global permissions required to edit
      *
-     * @param array $permissions
+     * @param string[] $permissions
      * @return $this
      */
     public function setGlobalEditPermissions($permissions)

tests/php/Core/Manifest/ManifestFileFinderTest.php

Doc Comments +5 added lines

@@ -19,6 +19,11 @@
         parent::__construct();
     }
 
+    /**
+     * @param ManifestFileFinder $finder
+     * @param null|string $base
+     * @param string[] $expect
+     */
     public function assertFinderFinds($finder, $base, $expect, $message = null)
     {
         if (!$base) {

tests/php/Security/InheritedPermissionsTest/TestPermissionNode.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
         return Injector::inst()->get(PermissionChecker::class.'.testpermissions');
     }
 
+    /**
+     * @param DataObject $member
+     */
     public function canEdit($member = null)
     {
         if (!$member) {

tests/php/View/SSViewerTest.php

Doc Comments +13 added lines

@@ -159,6 +159,10 @@ 
         ]);
     }
 
+    /**
+     * @param \SilverStripe\ORM\FieldType\DBHTMLText $result
+     * @param string[] $expected
+     */
     private function assertExpectedStrings($result, $expected)
     {
         foreach ($expected as $expectedStr) {
@@ -1089,6 +1093,10 @@ 
         $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
     }
 
+    /**
+     * @param string $a
+     * @param string $b
+     */
     public function assertEqualIgnoringWhitespace($a, $b, $message = '')
     {
         $this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b), $message);
@@ -1817,6 +1825,11 @@ 
             $this->_renderWithSourceFileComments('SSViewerTestComments/'.$template['name'], $template['expected']);
         }
     }
+
+    /**
+     * @param string $name
+     * @param string $expected
+     */
     private function _renderWithSourceFileComments($name, $expected)
     {
         $viewer = new SSViewer(array($name));

tests/php/Forms/ValidatorTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
     /**
      * Common method for setting up form, since that will always be a dependency for the validator.
      *
-     * @param    array $fieldNames
+     * @param    string[] $fieldNames
      * @return    Form
      */
     protected function getForm(array $fieldNames = array())

src/Core/ClassInfo.php

Doc Comments +3 added lines

@@ -310,6 +310,9 @@
 
     private static $method_from_cache = array();
 
+    /**
+     * @param string $method
+     */
     public static function has_method_from($class, $method, $compclass)
     {
         $lClass = strtolower($class);

src/ORM/DataQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -190,7 +190,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)

src/ORM/Connect/DBSchemaManager.php

Doc Comments +2 added lines, -2 removed lines

@@ -331,7 +331,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(
@@ -595,7 +595,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.