silverstripe / silverstripe-framework

core/ClassInfo.php

Doc Comments +6 added lines, -1 removed lines

@@ -43,6 +43,7 @@ 
 
 	/**
 	 * @todo Move this to SS_Database or DB
+	 * @param string $class
 	 */
 	public static function hasTable($class) {
 		// Cache the list of all table names to reduce on DB traffic
@@ -80,7 +81,7 @@ 
 	 *
 	 * @todo Move this into {@see DataObjectSchema}
 	 *
-	 * @param string|object $class
+	 * @param string $class
 	 * @return array
 	 */
 	public static function dataClassesFor($class) {
@@ -205,6 +206,7 @@ 
 
 	/**
 	 * Returns true if the given class implements the given interface
+	 * @param string $interfaceName
 	 */
 	public static function classImplements($className, $interfaceName) {
 		return in_array($className, self::implementorsOf($interfaceName));
@@ -255,6 +257,9 @@ 
 
 	private static $method_from_cache = array();
 
+	/**
+	 * @param string $method
+	 */
 	public static function has_method_from($class, $method, $compclass) {
 		$lClass = strtolower($class);
 		$lMethod = strtolower($method);

dev/FixtureBlueprint.php

Doc Comments +6 added lines

@@ -260,6 +260,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function invokeCallbacks($type, $args = array()) {
 		foreach($this->callbacks[$type] as $callback) {
 			call_user_func_array($callback, $args);
@@ -299,6 +302,9 @@ 
 		$obj->$name = $this->parseValue($value, $fixtures);
 	}
 
+	/**
+	 * @param string $fieldName
+	 */
 	protected function overrideField($obj, $fieldName, $value, $fixtures = null) {
 		$class = get_class($obj);
 		$table = DataObject::getSchema()->tableForField($class, $fieldName);

dev/BulkLoader.php

Doc Comments +6 added lines, -6 removed lines

@@ -211,7 +211,7 @@ 
 	 *
 	 * @todo Mix in custom column mappings
 	 *
-	 * @return array
+	 * @return string
 	 **/
 	public function getImportSpec() {
 		$spec = array();
@@ -237,7 +237,7 @@ 
 	 * so this is mainly a customization method.
 	 *
 	 * @param mixed $val
-	 * @param string $field Name of the field as specified in the array-values for {@link self::$columnMap}.
+	 * @param string $fieldName Name of the field as specified in the array-values for {@link self::$columnMap}.
 	 * @return boolean
 	 */
 	protected function isNullValue($val, $fieldName = null) {
@@ -361,7 +361,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addCreated($obj, $message = null) {
 		$this->created[] = $this->lastChange = array(
@@ -374,7 +374,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addUpdated($obj, $message = null) {
 		$this->updated[] = $this->lastChange = array(
@@ -386,8 +386,8 @@ 
 	}
 
 	/**
-	 * @param $obj DataObject
-	 * @param $message string
+	 * @param DataObject|null $obj DataObject
+	 * @param string $message string
 	 */
 	public function addDeleted($obj, $message = null) {
 		$data = $obj->toMap();

core/Convert.php

Doc Comments +4 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
 	 *
 	 * @param array|string $val String to escape, or array of strings
 	 *
-	 * @return array|string
+	 * @return string
 	 */
 	public static function raw2htmlname($val) {
 		if(is_array($val)) {
@@ -176,7 +176,7 @@ 
 	 * table, or column name. Supports encoding of multi identfiers separated by
 	 * a delimiter (e.g. ".")
 	 *
-	 * @param string|array $identifier The identifier to escape. E.g. 'SiteTree.Title' or list of identifiers
+	 * @param string $identifier The identifier to escape. E.g. 'SiteTree.Title' or list of identifiers
 	 * to be joined via the separator.
 	 * @param string $separator The string that delimits subsequent identifiers
 	 * @return string The escaped identifier. E.g. '"SiteTree"."Title"'
@@ -257,6 +257,7 @@ 
 	 * call this function directly, Please use {@link Convert::xml2array()}
 	 *
 	 * @param SimpleXMLElement
+	 * @param SimpleXMLElement $xml
 	 *
 	 * @return mixed
 	 */
@@ -450,7 +451,7 @@ 
 	 * - IDField => idField
 	 * - iDField => iDField
 	 *
-	 * @param $str
+	 * @param string $str
 	 * @return string
 	 */
 	public static function upperCamelToLowerCamel($str) {

admin/code/CampaignAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -337,7 +337,7 @@
 	/**
 	 * Gets viewable list of campaigns
 	 *
-	 * @return SS_List
+	 * @return SilverStripe\ORM\ArrayList
 	 */
 	protected function getListItems() {
 		return ChangeSet::get()

filesystem/FileMigrationHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
 	/**
 	 * Get list of File dataobjects to import
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	protected function getFileQuery() {
 		// Select all records which have a Filename value, but not FileFilename.

filesystem/Folder.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
 	 * Find the given folder or create it as a database record
 	 *
 	 * @param string $folderPath Directory path relative to assets root
-	 * @return Folder|null
+	 * @return null|SilverStripe\ORM\DataObject
 	 */
 	public static function find_or_make($folderPath) {
 		// replace leading and trailing slashes
@@ -149,7 +149,7 @@ 
 	/**
 	 * Returns all children of this folder
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function myChildren() {
 		return File::get()->filter("ParentID", $this->ID);
@@ -200,7 +200,7 @@ 
 	/**
 	 * Get the children of this folder that are also folders.
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function ChildFolders() {
 		return Folder::get()->filter('ParentID', $this->ID);

filesystem/ImageManipulation.php

Doc Comments +1 added lines, -1 removed lines

@@ -513,7 +513,7 @@
 	/**
 	 * Get HTML for img containing the icon for this file
 	 *
-	 * @return DBHTMLText
+	 * @return DBField
 	 */
 	public function IconTag() {
 		return DBField::create_field(

forms/gridfield/GridField.php

Doc Comments +4 added lines, -4 removed lines

@@ -193,7 +193,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList
+	 * @return SilverStripe\ORM\ArrayList
 	 */
 	public function getComponents() {
 		return $this->config->getComponents();
@@ -204,7 +204,7 @@ 
 	 *
 	 * @todo refactor this into GridFieldComponent
 	 *
-	 * @param mixed $value
+	 * @param string $value
 	 * @param string|array $castingDefinition
 	 *
 	 * @return mixed
@@ -291,7 +291,7 @@ 
 	 *
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function FieldHolder($properties = array()) {
 		Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
@@ -605,7 +605,7 @@ 
 	/**
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		$this->extend('onBeforeRender', $this);