silverstripe / silverstripe-framework

Forms/TimeField.php

Doc Comments +8 added lines, -1 removed lines

@@ -52,6 +52,10 @@ 
 
 	protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_TIME;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -213,7 +217,7 @@ 
 
 	/**
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed|array
+	 * @return string|null
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -230,6 +234,9 @@ 
 		return $this->castedCopy('TimeField_Readonly');
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = parent::castedCopy($class);
 		if($copy->hasMethod('setConfig')) {

Forms/TreeDropdownField.php

Doc Comments +2 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
 	 *
 	 * @param string $name the field name
 	 * @param string $title the field label
-	 * @param string|array $sourceObject The object-type to list in the tree. This could
+	 * @param string $sourceObject The object-type to list in the tree. This could
 	 * be one of the following:
 	 * - A DataObject class name with the {@link Hierarchy} extension.
 	 * - An array of key/value pairs, like a {@link DropdownField} source. In
@@ -221,7 +221,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/client/lang');

Forms/UploadField.php

Doc Comments +4 added lines, -4 removed lines

@@ -295,7 +295,7 @@ 
 	/**
 	 * Determine if the target folder for new uploads in is visible the field UI.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canPreviewFolder() {
 		if(!$this->isActive()) return false;
@@ -553,7 +553,7 @@ 
 	 * Customises a file with additional details suitable for rendering in the
 	 * UploadField.ss template
 	 *
-	 * @param ViewableData|AssetContainer $file
+	 * @param AssetContainer $file
 	 * @return ViewableData_Customised
 	 */
 	protected function customiseFile(AssetContainer $file) {
@@ -653,7 +653,7 @@ 
 	/**
 	 * Determine if the user has permission to upload.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canUpload() {
 		if(!$this->isActive()) return false;
@@ -677,7 +677,7 @@ 
 	 * Determine if the user has permission to attach existing files
 	 * By default returns true if the user has the CMS_ACCESS_AssetAdmin permission
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canAttachExisting() {
 		if(!$this->isActive()) return false;

i18n/i18n.php

Doc Comments +3 added lines, -1 removed lines

@@ -2161,6 +2161,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $name
 	 * @return Zend_Translate
 	 */
 	public static function get_translator($name) {
@@ -2200,6 +2201,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $name
 	 */
 	public static function unregister_translator($name) {
 		foreach (self::get_translators() as $priority => $translators) {
@@ -2302,7 +2304,7 @@ 
 	 *
 	 * @see get_locale_name()
 	 *
-	 * @param mixed $code Language code
+	 * @param string $code Language code
 	 * @param boolean $native If true, the native name will be returned
 	 * @return string Name of the language
 	 */

i18n/i18nTextCollector_Parser.php

Doc Comments +1 added lines

@@ -223,6 +223,7 @@
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;

ORM/ArrayLib.php

Doc Comments +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
 	 *
 	 * Actually only one array argument is supported.
 	 *
-	 * @param $f callback to apply
+	 * @param string $f callback to apply
 	 * @param $array array
 	 * @return array
 	 */

ORM/ArrayList.php

Doc Comments +1 added lines, -1 removed lines

@@ -700,7 +700,7 @@
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $offset
+	 * @param integer $offset
 	 * @return DataObject
 	 */
 	public function offsetGet($offset) {

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.