[TASK] Clean up the phpDoc of t3lib/tceforms/
authorWouter Wolters <typo3@wouterwolters.nl>
Mon, 28 May 2012 21:00:33 +0000 (23:00 +0200)
committerGeorg Ringer <mail@ringerge.org>
Tue, 29 May 2012 05:12:39 +0000 (07:12 +0200)
Clean up the phpDoc of t3lib/tceforms/

So I made a patch doing mostly:

* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)
* CGLify method signatures (the first line of the method)

Change-Id: I7d2db45a13287b500349e5a5d34a3d74f82a67e9
Resolves: #37557
Releases: 6.0
Reviewed-on: http://review.typo3.org/11670
Reviewed-by: Oliver Klee
Reviewed-by: Georg Ringer
Tested-by: Georg Ringer
t3lib/tceforms/class.t3lib_tceforms_flexforms.php
t3lib/tceforms/class.t3lib_tceforms_suggest.php
t3lib/tceforms/class.t3lib_tceforms_suggest_defaultreceiver.php
t3lib/tceforms/class.t3lib_tceforms_tree.php
t3lib/tceforms/class.t3lib_tceforms_valueslider.php

index b8c4b5c..1123e7b 100644 (file)
@@ -25,7 +25,6 @@
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * Contains FlexForm manipulation methods as part of the TCEforms
  *
@@ -77,7 +76,8 @@ class t3lib_TCEforms_Flexforms extends t3lib_TCEforms {
                $metaConf = (!empty($dataStructure['meta']) ? $dataStructure['meta'] : array());
                $sheetConf = array();
 
-                       // Get extension identifier (uses second pointer field if it's value is not empty, "list" or "*", else it must be a plugin and first one will be used)
+                       // Get extension identifier (uses second pointer field if it's value is not empty,
+                       // "list" or "*", else it must be a plugin and first one will be used)
                $pointerFields = (!empty($tableConf['config']['ds_pointerField']) ? $tableConf['config']['ds_pointerField'] : 'list_type,CType');
                $pointerFields = t3lib_div::trimExplode(',', $pointerFields);
                $flexformIdentifier = (!empty($tableRow[$pointerFields[0]]) ? $tableRow[$pointerFields[0]] : '');
index 7ef4967..b9eab20 100644 (file)
  */
 
 class t3lib_TCEforms_Suggest {
-               // count the number of ajax selectors used
+               // Count the number of ajax selectors used
        public $suggestCount = 0;
        public $cssClass = 'typo3-TCEforms-suggest';
-       public $TCEformsObj; // reference to t3lib_tceforms
-
+               // Reference to t3lib_tceforms
+       public $TCEformsObj;
 
        /**
         * Initialize an instance of t3lib_TCEforms_suggest
         *
-        * @param  t3lib_TCEforms  $tceForms  Reference to an TCEforms instance
+        * @param t3lib_TCEforms $tceForms Reference to an TCEforms instance
         * @return void
         */
        public function init(&$tceForms) {
@@ -82,17 +82,17 @@ class t3lib_TCEforms_Suggest {
 
                </div>';
 
-                       // get minimumCharacters from TCA
+                       // Get minimumCharacters from TCA
                if (isset($config['fieldConf']['config']['wizards']['suggest']['default']['minimumCharacters'])) {
                        $minChars = intval($config['fieldConf']['config']['wizards']['suggest']['default']['minimumCharacters']);
                }
-                       // overwrite it with minimumCharacters from TSConfig (TCEFORM) if given
+                       // Overwrite it with minimumCharacters from TSConfig (TCEFORM) if given
                if (isset($config['fieldTSConfig']['suggest.']['default.']['minimumCharacters'])) {
                        $minChars = intval($config['fieldTSConfig']['suggest.']['default.']['minimumCharacters']);
                }
                $minChars = ($minChars > 0 ? $minChars : 2);
 
-                       // replace "-" with ucwords for the JS object name
+                       // Replace "-" with ucwords for the JS object name
                $jsObj = str_replace(' ', '', ucwords(str_replace('-', ' ', t3lib_div::strtolower($suggestId))));
                $this->TCEformsObj->additionalJS_post[] = '
                        var ' . $jsObj . ' = new TCEForms.Suggest("' . $fieldname . '", "' . $table . '", "' . $field .
@@ -112,7 +112,7 @@ class t3lib_TCEforms_Suggest {
         */
        public function processAjaxRequest($params, &$ajaxObj) {
 
-                       // get parameters from $_GET/$_POST
+                       // Get parameters from $_GET/$_POST
                $search = t3lib_div::_GP('value');
                $table = t3lib_div::_GP('table');
                $field = t3lib_div::_GP('field');
index e878e1f..9f5566f 100644 (file)
@@ -83,7 +83,7 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        /**
         * The list of pages that are allowed to perform the search for records on
         *
-        * @var array of PIDs
+        * @var array Array of PIDs
         */
        protected $allowedPages = array();
 
@@ -99,7 +99,6 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
         */
        protected $params = array();
 
-
        /**
         * The constructor of this class
         *
@@ -151,8 +150,8 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
         * this function itself
         *
         * @param array $params
-        * @param object $ref The parent object
-        * @return mixed array of rows or FALSE if nothing found
+        * @param integer $ref The parent object
+        * @return array Array of rows or FALSE if nothing found
         */
        public function queryTable(&$params, $recursionCounter = 0) {
                $rows = array();
@@ -333,6 +332,10 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
 
        /**
         *  Selects whether the logged in Backend User is allowed to read a specific record
+        *
+        * @param array $row
+        * @param integer $uid
+        * @return boolean
         */
        protected function checkRecordAccess($row, $uid) {
                $retValue = TRUE;
@@ -358,7 +361,7 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
         * @return void (passed by reference)
         */
        protected function makeWorkspaceOverlay(&$row) {
-                       // check for workspace-versions
+                       // Check for workspace-versions
                if ($GLOBALS['BE_USER']->workspace != 0 && $GLOBALS['TCA'][$this->table]['ctrl']['versioningWS'] == TRUE) {
                        t3lib_BEfunc::workspaceOL(($this->mmForeignTable ? $this->mmForeignTable : $this->table), $row);
                }
@@ -381,8 +384,8 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
         *
         * The path is returned uncut, cutting has to be done by calling function.
         *
-        * @param  array        $row The row
-        * @param  array        $record The record
+        * @param array $row The row
+        * @param array $record The record
         * @return string The record-path
         */
        protected function getRecordPath(&$row, $uid) {
@@ -390,7 +393,8 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
 
                if (($this->mmForeignTable ? $this->mmForeignTable : $this->table) == 'pages') {
                        $path = t3lib_BEfunc::getRecordPath($uid, '', $titleLimit);
-                               // for pages we only want the first (n-1) parts of the path, because the n-th part is the page itself
+                               // For pages we only want the first (n-1) parts of the path,
+                               // because the n-th part is the page itself
                        $path = substr($path, 0, strrpos($path, '/', -2)) . '/';
                } else {
                        $path = t3lib_BEfunc::getRecordPath($row['pid'], '', $titleLimit);
@@ -419,7 +423,7 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
         * @return array The rendered entry (will be put into a <li> later on
         */
        protected function renderRecord($row, $entry) {
-                       // call renderlet if available (normal pages etc. usually don't have one)
+                       // Call renderlet if available (normal pages etc. usually don't have one)
                if ($this->config['renderFunc'] != '') {
                        $params = array(
                                'table' => $this->table,
@@ -434,4 +438,4 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        }
 }
 
-?>
+?>
\ No newline at end of file
index 482fe25..f13eb63 100644 (file)
@@ -53,13 +53,13 @@ class t3lib_TCEforms_Tree {
        /**
         * renders the tree as replacement for the selector
         *
-        * @param string The table name of the record
-        * @param string The field name which this element is supposed to edit
-        * @param array The record data array where the value(s) for the field can be found
-        * @param array An array with additional configuration options.
-        * @param array (Redundant) content of $PA['fieldConf']['config'] (for convenience)
-        * @param array Items available for selection
-        * @param string Label for no-matching-value
+        * @param string $table The table name of the record
+        * @param string $field The field name which this element is supposed to edit
+        * @param array $row The record data array where the value(s) for the field can be found
+        * @param array $PA An array with additional configuration options.
+        * @param array $config (Redundant) content of $PA['fieldConf']['config'] (for convenience)
+        * @param array $possibleSelectboxItems Items available for selection
+        * @param string $noMatchLabel Label for no-matching-value
         * @return string The HTML code for the TCEform field
         */
        public function renderField($table, $field, $row, &$PA, $config, $possibleSelectboxItems, $noMatchLabel) {
@@ -224,4 +224,4 @@ class t3lib_TCEforms_Tree {
        }
 }
 
-?>
+?>
\ No newline at end of file
index 3155d6e..0804228 100644 (file)
@@ -116,4 +116,4 @@ class t3lib_TCEforms_ValueSlider {
        }
 }
 
-?>
+?>
\ No newline at end of file