sminnee / silverstripe-framework

model/DataExtension.php

Doc Comments +6 added lines

@@ -82,9 +82,15 @@
 	public function can($member) {
 	}
 
+	/**
+	 * @param \Member $member
+	 */
 	public function canEdit($member) {
 	}
 
+	/**
+	 * @param \Member $member
+	 */
 	public function canDelete($member) {
 	}
 

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SilverStripe\Filesystem\ImageManipulation;
 use SilverStripe\Filesystem\Storage\AssetContainer;
 use SilverStripe\Filesystem\Storage\AssetStore;
-
 use Injector;
 use AssetField;
 use File;

model/DataObject.php

Doc Comments +8 added lines, -4 removed lines

@@ -573,8 +573,8 @@ 
 
 	/**
 	 * Helper function to duplicate relations from one object to another
-	 * @param $sourceObject the source object to duplicate from
-	 * @param $destinationObject the destination object to populate with the duplicated relations
+	 * @param DataObject $sourceObject the source object to duplicate from
+	 * @param DataObject $destinationObject the destination object to populate with the duplicated relations
 	 * @param $name the name of the relation to duplicate (e.g. members)
 	 */
 	private function duplicateRelations($sourceObject, $destinationObject, $name) {
@@ -972,6 +972,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) {
@@ -2257,6 +2258,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -3066,7 +3068,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) {
@@ -3135,7 +3137,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.
@@ -3345,6 +3347,7 @@ 
 	/**
 	 * @see $sourceQueryParams
 	 * @param array
+	 * @param string $key
 	 */
 	public function setSourceQueryParam($key, $value) {
 		$this->sourceQueryParams[$key] = $value;
@@ -3352,6 +3355,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

Unused Use Statements -3 removed lines

@@ -2,10 +2,8 @@ 
 
 namespace SilverStripe\Model;
 
-use SilverStripe\Model\FieldType\DBPolymorphicForeignKey;
 use SilverStripe\Model\FieldType\DBField;
 use SilverStripe\Model\FieldType\DBDatetime;
-use SilverStripe\Model\FieldType\DBPrimaryKey;
 use SilverStripe\Model\FieldType\DBComposite;
 use SilverStripe\Model\FieldType\DBClassName;
 use Object;
@@ -14,7 +12,6 @@ 
 use i18nEntityProvider;
 use Config;
 use FieldList;
-
 use SQLSelect;
 
 

model/DataQuery.php

Doc Comments +11 added lines, -3 removed lines

@@ -54,6 +54,7 @@ 
 	 * 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;
@@ -176,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) {
@@ -365,7 +366,7 @@ 
 	/**
 	 * Execute the query and return the result as {@link SS_Query} object.
 	 *
-	 * @return SS_Query
+	 * @return Connect\SS_Query
 	 */
 	public function execute() {
 		return $this->getFinalisedQuery()->execute();
@@ -651,7 +652,7 @@ 
 	 * 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
 	 * @param bool $linearOnly Set to true to restrict to linear relations only. Set this
 	 * if this relation will be used for sorting, and should not include duplicate rows.
 	 * @return The model class of the related item
@@ -927,6 +928,7 @@ 
 
 	/**
 	 * Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.
+	 * @param string $key
 	 */
 	public function getQueryParam($key) {
 		if(isset($this->queryParams[$key])) return $this->queryParams[$key];
@@ -959,6 +961,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -968,6 +973,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SilverStripe\Filesystem\ImageManipulation;
 use SilverStripe\Filesystem\Storage\AssetContainer;
 use SilverStripe\Filesystem\Storage\AssetStore;
-
 use Injector;
 use AssetField;
 use File;

model/DB.php

Doc Comments +10 added lines, -9 removed lines

@@ -93,7 +93,7 @@ 
 	 *
 	 * @param string $name An optional name given to a connection in the DB::setConn() call.  If omitted,
 	 * the default connection is returned.
-	 * @return DBSchemaManager
+	 * @return Connect\DBSchemaManager|null
 	 */
 	public static function get_schema($name = 'default') {
 		$connection = self::get_conn($name);
@@ -103,7 +103,7 @@ 
 	/**
 	 * Builds a sql query with the specified connection
 	 *
-	 * @param SQLExpression $expression The expression object to build from
+	 * @param \SQLExpression $expression The expression object to build from
 	 * @param array $parameters Out parameter for the resulting query parameters
 	 * @param string $name An optional name given to a connection in the DB::setConn() call.  If omitted,
 	 * the default connection is returned.
@@ -124,7 +124,7 @@ 
 	 *
 	 * @param string $name An optional name given to a connection in the DB::setConn() call.  If omitted,
 	 * the default connection is returned.
-	 * @return DBConnector
+	 * @return Connect\DBConnector|null
 	 */
 	public static function get_connector($name = 'default') {
 		$connection = self::get_conn($name);
@@ -227,9 +227,8 @@ 
 	 * Given the database configuration, this method will create the correct
 	 * subclass of {@link SS_Database}.
 	 *
-	 * @param array $database A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
+	 * @param array $databaseConfig A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
 	 *                        rest of the options, see the specific class.
-	 * @param string $name identifier for the connection
 	 *
 	 * @return SS_Database
 	 */
@@ -278,7 +277,7 @@ 
 	 * Execute the given SQL query.
 	 * @param string $sql The SQL query to execute
 	 * @param int $errorLevel The level of error reporting to enable for the query
-	 * @return SS_Query
+	 * @return Connect\SS_Query
 	 */
 	public static function query($sql, $errorLevel = E_USER_ERROR) {
 		self::$lastQuery = $sql;
@@ -313,7 +312,7 @@ 
 	 * @param string $sql The SQL query to execute. The ? character will denote parameters.
 	 * @param array $parameters An ordered list of arguments.
 	 * @param int $errorLevel The level of error reporting to enable for the query
-	 * @return SS_Query
+	 * @return Connect\SS_Query
 	 */
 	public static function prepared_query($sql, $parameters, $errorLevel = E_USER_ERROR) {
 		self::$lastQuery = $sql;
@@ -423,7 +422,7 @@ 
 
 	/**
 	 * Create a new table.
-	 * @param string $tableName The name of the table
+	 * @param string $table The name of the table
 	 * @param array$fields A map of field names to field types
 	 * @param array $indexes A map of indexes
 	 * @param array $options An map of additional options.  The available keys are as follows:
@@ -510,6 +509,8 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::require_field instead
+	 * @param string $table
+	 * @param string $field
 	 */
 	public static function requireField($table, $field, $spec) {
 		Deprecation::notice('4.0', 'Use DB::require_field instead');
@@ -573,7 +574,7 @@ 
 	/**
 	 * Checks a table's integrity and repairs it if necessary.
 	 *
-	 * @param string $tableName The name of the table.
+	 * @param string $table The name of the table.
 	 * @return boolean Return true if the table has integrity after the method is complete.
 	 */
 	public static function check_and_repair_table($table) {

model/FieldType/DBComposite.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SilverStripe\Filesystem\ImageManipulation;
 use SilverStripe\Filesystem\Storage\AssetContainer;
 use SilverStripe\Filesystem\Storage\AssetStore;
-
 use Injector;
 use AssetField;
 use File;

model/FieldType/DBForeignKey.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SilverStripe\Filesystem\ImageManipulation;
 use SilverStripe\Filesystem\Storage\AssetContainer;
 use SilverStripe\Filesystem\Storage\AssetStore;
-
 use Injector;
 use AssetField;
 use File;

model/FieldType/DBInt.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SilverStripe\Filesystem\ImageManipulation;
 use SilverStripe\Filesystem\Storage\AssetContainer;
 use SilverStripe\Filesystem\Storage\AssetStore;
-
 use Injector;
 use AssetField;
 use File;

model/FieldType/DBPolymorphicForeignKey.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 
 
-use ClassInfo;
 use SilverStripe\Model\DataObject;
 
 

model/FieldType/DBPrimaryKey.php

Unused Use Statements -3 removed lines

@@ -3,9 +3,6 @@
 namespace SilverStripe\Model\FieldType;
 
 
-use DropdownField;
-
-
 use SilverStripe\Model\DB;
 use SilverStripe\Model\DataObject;