silverstripe / silverstripe-framework

thirdparty/php-peg/Parser.php

Doc Comments +28 added lines

@@ -9,6 +9,10 @@ 
  *  the bracket if a failed match + restore has moved the current position backwards - so we have to check that too.
  */
 class ParserRegexp {
+
+	/**
+	 * @param Parser $parser
+	 */
 	function __construct( $parser, $rx ) {
 		$this->parser = $parser ;
 		$this->rx = $rx . 'Sx' ;
@@ -83,6 +87,9 @@ 
 		return FALSE ;
 	}
 
+ 	/**
+ 	 * @param string $token
+ 	 */
  	function literal( $token ) {
  		/* Debugging: * / print( "Looking for token '$token' @ '" . substr( $this->string, $this->pos ) . "'\n" ) ; /* */
  		$toklen = strlen( $token ) ;
@@ -94,11 +101,17 @@ 
 		return FALSE ;
 	}
 
+	/**
+	 * @param string $rx
+	 */
 	function rx( $rx ) {
 		if ( !isset( $this->regexps[$rx] ) ) $this->regexps[$rx] = new ParserRegexp( $this, $rx ) ;
 		return $this->regexps[$rx]->match() ;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function expression( $result, $stack, $value ) {
 		$stack[] = $result; $rv = false;
 		
@@ -120,14 +133,26 @@ 
 		return is_array($rv) ? $rv['text'] : ($rv ? $rv : '');
 	}
 	
+	/**
+	 * @param string $key
+	 * @param integer $pos
+	 */
 	function packhas( $key, $pos ) {
 		return false ;
 	}
 
+	/**
+	 * @param string $key
+	 * @param integer $pos
+	 */
 	function packread( $key, $pos ) {
 		throw new \Exception('PackRead after PackHas=>false in Parser.php');
 	}
 
+	/**
+	 * @param string $key
+	 * @param integer $pos
+	 */
 	function packwrite( $key, $pos, $res ) {
 		return $res ;
 	}
@@ -164,6 +189,9 @@ 
 		return $result ;
 	}
 
+	/**
+	 * @param string $storetag
+	 */
 	function store ( &$result, $subres, $storetag = NULL ) {
 		$result['text'] .= $subres['text'] ;
 

src/Forms/FieldList.php

Doc Comments +6 added lines, -2 removed lines

@@ -89,6 +89,9 @@ 
         $this->sequentialSaveableSet = null;
     }
 
+    /**
+     * @param FormField[] $list
+     */
     protected function collateDataFields(&$list, $saveableOnly = false)
     {
         if (!isset($list)) {
@@ -198,7 +201,7 @@ 
      * Removes a number of fields from a Tab/TabSet within this FieldList.
      *
      * @param string $tabName The name of the Tab or TabSet field
-     * @param array $fields A list of fields, e.g. array('Name', 'Email')
+     * @param string[] $fields A list of fields, e.g. array('Name', 'Email')
      */
     public function removeFieldsFromTab($tabName, $fields)
     {
@@ -625,7 +628,7 @@ 
     }
 
     /**
-     * @param $field
+     * @param CompositeField $field
      * @return $this
      */
     public function setContainerField($field)
@@ -707,6 +710,7 @@ 
      * the children collection. Doesn't work recursively.
      *
      * @param string|FormField
+     * @param string $field
      * @return int Position in children collection (first position starts with 0).
      * Returns FALSE if the field can't be found.
      */

src/Forms/GridField/GridFieldPrintButton.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
      *
      * @param GridField
      *
-     * @return array
+     * @return string[]
      */
     public function getActions($gridField)
     {

src/Forms/FormField.php

Doc Comments +2 added lines, -2 removed lines

@@ -1222,7 +1222,7 @@ 
     /**
      * @param FormTransformation $transformation
      *
-     * @return mixed
+     * @return FormField
      */
     public function transform(FormTransformation $transformation)
     {
@@ -1333,7 +1333,7 @@ 
      * This function is used by the template processor. If you refer to a field as a $ variable, it
      * will return the $Field value.
      *
-     * @return string
+     * @return DBHTMLText
      */
     public function forTemplate()
     {

src/Forms/HTMLEditor/HTMLEditorField.php

Doc Comments +5 added lines, -2 removed lines

@@ -79,7 +79,7 @@ 
     /**
      * Assign a new configuration instance or identifier
      *
-     * @param string|HTMLEditorConfig $config
+     * @param string $config
      * @return $this
      */
     public function setEditorConfig($config)
@@ -94,7 +94,7 @@ 
      *
      * @param string $name The internal field name, passed to forms.
      * @param string $title The human-readable field label.
-     * @param mixed $value The value of the field.
+     * @param integer $value The value of the field.
      * @param string $config HTMLEditorConfig identifier to be used. Default to the active one.
      */
     public function __construct($name, $title = null, $value = '', $config = null)
@@ -142,6 +142,9 @@ 
         $record->{$this->name} = $htmlValue->getContent();
     }
 
+    /**
+     * @param string|null $value
+     */
     public function setValue($value, $data = null)
     {
         // Regenerate links prior to preview, so that the editor can see them.

src/Forms/MoneyField.php

Doc Comments +9 added lines, -2 removed lines

@@ -57,6 +57,10 @@ 
         return $this->fieldAmount;
     }
 
+    /**
+     * @param string $name
+     * @param string $title
+     */
     public function __construct($name, $title = null, $value = "")
     {
         $this->setName($name);
@@ -210,7 +214,7 @@ 
      *
      * (see @link MoneyFieldTest_CustomSetter_Object for more information)
      *
-     * @param DataObjectInterface|Object $dataObject
+     * @param DataObjectInterface $dataObject
      */
     public function saveInto(DataObjectInterface $dataObject)
     {
@@ -238,6 +242,9 @@ 
         return $clone;
     }
 
+    /**
+     * @param boolean $bool
+     */
     public function setReadonly($bool)
     {
         parent::setReadonly($bool);
@@ -261,7 +268,7 @@ 
     /**
      * Set list of currencies. Currencies should be in the 3-letter ISO 4217 currency code.
      *
-     * @param array $currencies
+     * @param string[] $currencies
      * @return $this
      */
     public function setAllowedCurrencies($currencies)

src/Forms/NumericField.php

Doc Comments +1 added lines, -1 removed lines

@@ -279,7 +279,7 @@
      * Get number of digits to show to the right of the decimal point.
      * 0 for integer, any number for floating point, or null to flexible
      *
-     * @return int|null
+     * @return string
      */
     public function getScale()
     {

src/Forms/SelectionGroup_Item.php

Doc Comments +6 added lines

@@ -37,6 +37,9 @@ 
         return $this->title;
     }
 
+    /**
+     * @param string $title
+     */
     function setTitle($title)
     {
         $this->title = $title;
@@ -48,6 +51,9 @@ 
         return $this->value;
     }
 
+    /**
+     * @param string $Value
+     */
     function setValue($Value, $data = null)
     {
         $this->value = $Value;

src/ORM/FieldType/DBTime.php

Doc Comments +3 added lines

@@ -26,6 +26,9 @@
      */
     const ISO_TIME = 'HH:mm:ss';
 
+    /**
+     * @param string $value
+     */
     public function setValue($value, $record = null, $markChanged = true)
     {
         $value = $this->parseTime($value);