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/Core/Core.php

Doc Comments +4 added lines, -7 removed lines

@@ -136,6 +136,9 @@ 
     return Injector::inst()->get($className);
 }
 
+/**
+ * @return string
+ */
 function project()
 {
     global $project;
@@ -152,12 +155,6 @@ 
      * @param string $entity Entity that identifies the string. It must be in the form
      * "Namespace.Entity" where Namespace will be usually the class name where this
      * string is used and Entity identifies the string inside the namespace.
-     * @param mixed $arg,... Additional arguments are parsed as such:
-     *  - Next string argument is a default. Pass in a `|` pipe-delimeted value with `{count}`
-     *    to do pluralisation.
-     *  - Any other string argument after default is context for i18nTextCollector
-     *  - Any array argument in any order is an injection parameter list. Pass in a `count`
-     *    injection parameter to pluralise.
      * @return string
      */
 function _t($entity, $arg = null)
@@ -171,7 +168,7 @@ 
  * Only increases up to the maximum defined in {@link set_increase_memory_limit_max()},
  * and defaults to the 'memory_limit' setting in the PHP configuration.
  *
- * @param string|int $memoryLimit A memory limit string, such as "64M".  If omitted, unlimited memory will be set.
+ * @param integer $memoryLimit A memory limit string, such as "64M".  If omitted, unlimited memory will be set.
  * @return Boolean TRUE indicates a successful change, FALSE a denied change.
  */
 function increase_memory_limit_to($memoryLimit = -1)

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/ORM/DataObjectSchema.php

Doc Comments +1 added lines, -1 removed lines

@@ -701,7 +701,7 @@
      * @param string $parentClass Parent class name
      * @param string $component ManyMany name
      * @param string|array $specification Declaration of many_many relation type
-     * @return array
+     * @return string[]
      */
     protected function parseManyManyComponent($parentClass, $component, $specification)
     {

src/Security/CMSSecurity.php

Doc Comments +6 added lines

@@ -41,6 +41,9 @@ 
         Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/client/dist/js/vendor.js');
     }
 
+    /**
+     * @param string $action
+     */
     public function Link($action = null)
     {
         /** @skipUpgrade */
@@ -60,6 +63,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $title
+     */
     public function getResponseController($title)
     {
         // Use $this to prevent use of Page to render underlying templates

src/Forms/DatetimeField.php

Doc Comments +17 added lines, -1 removed lines

@@ -54,6 +54,10 @@ 
      */
     protected $dateTimeOrder = '{date} {time}';
 
+    /**
+     * @param string $name
+     * @param string $title
+     */
     public function __construct($name, $title = null, $value = "")
     {
         $this->timeField = TimeField::create($name . '[time]', false);
@@ -61,6 +65,9 @@ 
         parent::__construct($name, $title, $value);
     }
 
+    /**
+     * @param Form $form
+     */
     public function setForm($form)
     {
         parent::setForm($form);
@@ -69,6 +76,9 @@ 
         return $this;
     }
 
+    /**
+     * @param string $name
+     */
     public function setName($name)
     {
         parent::setName($name);
@@ -152,7 +162,7 @@ 
     /**
      * Assign value from iso8601 string
      *
-     * @param mixed $value
+     * @param string $value
      * @param mixed $data
      * @return $this
      */
@@ -260,6 +270,9 @@ 
         return $this;
     }
 
+    /**
+     * @param boolean $bool
+     */
     public function setReadonly($bool)
     {
         parent::setReadonly($bool);
@@ -345,6 +358,9 @@ 
         return $this->dateField->getLocale();
     }
 
+    /**
+     * @param RequiredFields $validator
+     */
     public function validate($validator)
     {
         $dateValid = $this->dateField->validate($validator);

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.