silverstripe / silverstripe-framework

forms/gridfield/GridFieldExportButton.php

Doc Comments +3 added lines, -1 removed lines

@@ -82,6 +82,7 @@ 
 
 	/**
 	 * Handle the export, for both the action button and the URL
+ 	 * @param GridField $gridField
  	 */
 	public function handleExport($gridField, $request = null) {
 		$now = Date("d-m-Y-H-i");
@@ -96,7 +97,7 @@ 
 	 * Generate export fields for CSV.
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string
 	 */
 	public function generateExportFileData($gridField) {
 		$separator = $this->csvSeparator;
@@ -206,6 +207,7 @@ 
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setCsvHasHeader($bool) {
 		$this->csvHasHeader = $bool;

i18n/i18nTextCollector.php

Doc Comments +6 added lines, -1 removed lines

@@ -709,7 +709,8 @@ 
 	 * Input for langArrayCodeForEntitySpec() should be suitable for insertion
 	 * into single-quoted strings, so needs to be escaped already.
 	 *
-	 * @param string $entity The entity name, e.g. CMSMain.BUTTONSAVE
+	 * @param string $entitySpec The entity name, e.g. CMSMain.BUTTONSAVE
+	 * @param string $locale
 	 */
 	public function langArrayCodeForEntitySpec($entityFullName, $entitySpec, $locale) {
 		$php = '';
@@ -772,6 +773,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	public function getYaml($entities, $locale) {
 		// Use the Zend copy of this script to prevent class conflicts when RailsYaml is included
 		require_once 'thirdparty/zend_translate_railsyaml/library/Translate/Adapter/thirdparty/sfYaml/lib'
@@ -846,6 +850,7 @@ 
 
 	/**
 	 * Parses a template and returns any translatable entities
+	 * @param string $template
 	 */
 	public static function GetTranslatables($template) {
 		self::$entities = array();

model/Aggregate.php

Doc Comments +2 added lines, -1 removed lines

@@ -47,6 +47,7 @@ 
 	/**
 	 * Clear the aggregate cache for a given type, or pass nothing to clear all aggregate caches.
 	 * {@link $class} is just effective if the cache backend supports tags.
+	 * @param string $class
 	 */
 	public static function flushCache($class=null) {
 		$cache = self::cache();
@@ -85,7 +86,7 @@ 
 	 * Build the SQLSelect to calculate the aggregate
 	 * This is a seperate function so that subtypes of Aggregate can change just this bit
 	 * @param string $attr - the SQL field statement for selection (i.e. "MAX(LastUpdated)")
-	 * @return SQLSelect
+	 * @return DataList
 	 */
 	protected function query($attr) {
 		$query = DataList::create($this->type)->where($this->filter);

model/DataQuery.php

Doc Comments +10 added lines, -2 removed lines

@@ -44,6 +44,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;
@@ -166,7 +167,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 SQLQuery The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -664,7 +665,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
 	 * @return The model class of the related item
 	 */
 	public function applyRelation($relation) {
@@ -844,6 +845,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];
@@ -878,6 +880,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -887,6 +892,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

model/fieldtypes/Currency.php

Doc Comments +6 added lines

@@ -23,6 +23,9 @@ 
 	 */
 	private static $currency_symbol = '$';
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
 		parent::__construct($name, $wholeSize, $decimalSize, $defaultValue);
 	}
@@ -46,6 +49,9 @@ 
 		else return $val;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	public function setValue($value, $record = null) {
 		$matches = null;
 		if(is_numeric($value)) {

model/fieldtypes/Date.php

Doc Comments +5 added lines, -2 removed lines

@@ -28,6 +28,9 @@ 
 	private static $nice_format = 'd/m/Y';
 
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value, $record = null) {
 		if($value === false || $value === null || (is_string($value) && !strlen($value))) {
 			// don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be
@@ -110,7 +113,7 @@ 
 
 	/**
 	 * Returns the day of the month.
-	 * @param boolean $includeOrdinals Include ordinal suffix to day, e.g. "th" or "rd"
+	 * @param boolean $includeOrdinal Include ordinal suffix to day, e.g. "th" or "rd"
 	 * @return string
 	 */
 	public function DayOfMonth($includeOrdinal = false) {
@@ -164,7 +167,7 @@ 
 	 * Return a date formatted as per a CMS user's settings.
 	 *
 	 * @param Member $member
-	 * @return boolean | string A date formatted as per user-defined settings.
+	 * @return false|string | string A date formatted as per user-defined settings.
 	 */
 	public function FormatFromSettings($member = null) {
 		require_once 'Zend/Date.php';

model/fieldtypes/DBField.php

Doc Comments +3 added lines

@@ -209,6 +209,9 @@
 
 	}
 
+	/**
+	 * @param string $tableName
+	 */
 	public function setTable($tableName) {
 		$this->tableName = $tableName;
 	}

model/URLSegmentFilter.php

Doc Comments +1 added lines

@@ -129,6 +129,7 @@
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setAllowMultibyte($bool) {
 		$this->allowMultibyte = $bool;

thirdparty/jstree/_demo/_inc/class._database_i.php

Doc Comments +3 added lines

@@ -92,6 +92,9 @@
 		return $return;
 	}
 
+	/**
+	 * @param boolean $index
+	 */
 	function f($index) {
 		return stripslashes($this->row[$index]);
 	}