silverstripe / silverstripe-framework

thirdparty/Zend/Translate/Adapter/Tbx.php

Doc Comments +4 added lines, -1 removed lines

@@ -48,7 +48,7 @@ 
      * @param  string  $locale    Locale/Language to add data for, identical with locale identifier,
      *                            see Zend_Locale for more information
      * @param  string  $filename  XMLTM file to add, full path must be given for access
-     * @param  array   $option    OPTIONAL Options to use
+     * @param  array   $options    OPTIONAL Options to use
      * @throws Zend_Translation_Exception
      * @return array
      */
@@ -116,6 +116,9 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     */
     private function _findEncoding($filename)
     {
         $file = file_get_contents($filename, null, null, 0, 100);

thirdparty/Zend/Translate/Adapter/Xliff.php

Doc Comments +4 added lines, -1 removed lines

@@ -48,7 +48,7 @@ 
      * @param  string  $locale    Locale/Language to add data for, identical with locale identifier,
      *                            see Zend_Locale for more information
      * @param  string  $filename  XMLTM file to add, full path must be given for access
-     * @param  array   $option    OPTIONAL Options to use
+     * @param  array   $options    OPTIONAL Options to use
      * @throws Zend_Translation_Exception
      * @return array
      */
@@ -116,6 +116,9 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     */
     private function _findEncoding($filename)
     {
         $file = file_get_contents($filename, null, null, 0, 100);

core/ClassInfo.php

Doc Comments +5 added lines

@@ -38,6 +38,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
@@ -219,6 +220,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));
@@ -269,6 +271,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);

thirdparty/Zend/Cache/Backend/File.php

Doc Comments +4 added lines

@@ -732,6 +732,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $mode
+     */
     protected function _get($dir, $mode, $tags = array())
     {
         if (!is_dir($dir)) {
@@ -819,6 +822,7 @@ 
     /**
      * Compute & return the expire time
      *
+     * @param integer $lifetime
      * @return int expire time (unix timestamp)
      */
     protected function _expireTime($lifetime)

forms/DatetimeField.php

Doc Comments +19 added lines, -4 removed lines

@@ -59,6 +59,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -71,6 +75,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -81,6 +88,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -93,7 +103,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -108,7 +118,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css');
@@ -243,6 +253,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -268,6 +279,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -306,7 +318,7 @@ 
 	 * to set field-specific config options.
 	 *
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 */
 	public function setConfig($name, $val) {
 		$this->config[$name] = $val;
@@ -324,7 +336,7 @@ 
 	 * to get field-specific config options.
 	 *
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -334,6 +346,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

forms/gridfield/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -76,7 +76,7 @@ 
 	 * @param DataObject $record
 	 * @param string $columnName
 	 *
-	 * @return string - the HTML for the column
+	 * @return DBField - the HTML for the column
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		// No permission checks, handled through GridFieldDetailForm,

forms/InlineFormAction.php

Doc Comments +3 added lines, -3 removed lines

@@ -17,7 +17,7 @@ 
 
 	/**
 	 * Create a new action button.
-	 * @param action The method to call when the button is clicked
+	 * @param action string method to call when the button is clicked
 	 * @param title The label on the button
 	 * @param extraClass A CSS class to apply to the button in addition to 'action'
 	 */
@@ -32,7 +32,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		if($this->includeDefaultJS) {
@@ -78,7 +78,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		return DBField::create_field('HTMLText',

security/PermissionCheckboxSetField.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/css/CheckboxSetField.css');

security/Security.php

Doc Comments +5 added lines, -6 removed lines

@@ -465,7 +465,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return DBField
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -645,7 +645,6 @@ 
 	 * - t: plaintext token
 	 *
 	 * @param Member $member Member object associated with this link.
-	 * @param string $autoLoginHash The auto login token.
 	 */
 	public static function getPasswordResetLink($member, $autologinToken) {
 		$autologinToken = urldecode($autologinToken);
@@ -736,7 +735,7 @@ 
 	/**
 	 * Factory method for the lost password form
 	 *
-	 * @return Form Returns the lost password form
+	 * @return Security Returns the lost password form
 	 */
 	public function ChangePasswordForm() {
 		return Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
@@ -746,7 +745,7 @@ 
 	 * Gets the template for an include used for security.
 	 * For use in any subclass.
 	 *
-	 * @return string|array Returns the template(s) for rendering
+	 * @return string[] Returns the template(s) for rendering
 	 */
 	public function getIncludeTemplate($name) {
 		return array('Security_' . $name);
@@ -920,7 +919,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1075,7 +1074,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;