Fixed bug #12007: Docblock comments in TCEforms suggest class are wrong (Thanks to...
authorBenni Mack <benni.mack@typo3.org>
Fri, 19 Feb 2010 17:09:43 +0000 (17:09 +0000)
committerBenni Mack <benni.mack@typo3.org>
Fri, 19 Feb 2010 17:09:43 +0000 (17:09 +0000)
git-svn-id: https://svn.typo3.org/TYPO3v4/Core/trunk@6914 709f56b5-9817-0410-a4d7-c38de5d9e867

ChangeLog
t3lib/tceforms/class.t3lib_tceforms_suggest.php
t3lib/tceforms/class.t3lib_tceforms_suggest_defaultreceiver.php

index e865a26..7b7bf6f 100755 (executable)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,6 @@
 2010-02-19  Benjamin Mack  <benni@typo3.org>
 
+       * Fixed bug #12007: Docblock comments in TCEforms suggest class are wrong (Thanks to Andreas Wolf)
        * Fixed bug #12870: Login News missing styling for links (Thanks to Steffen Gebert)
        * Added feature #13131: Add API to add stylesheet directories (Thanks to Steffen Gebert)
 
index 6c320af..16ce07a 100644 (file)
@@ -53,12 +53,12 @@ class t3lib_TCEforms_Suggest {
        /**
         * Renders an ajax-enabled text field. Also adds required JS
         *
-        * @param  string  $fieldname   The fieldname in the form
-        * @param  string  $table       The table we render this selector for
-        * @param  string  $field       The field we render this selector for
-        * @param  array   $row         The row which is currently edited
-        * @param  array   $config      The TSconfig of the field
-        * @return string  The HTML code for the selector
+        * @param string $fieldname The fieldname in the form
+        * @param string $table The table we render this selector for
+        * @param string $field The field we render this selector for
+        * @param array $row The row which is currently edited
+        * @param array $config The TSconfig of the field
+        * @return string The HTML code for the selector
         */
        public function renderSuggestSelector($fieldname, $table, $field, array $row, array $config) {
                $this->suggestCount++;
@@ -99,18 +99,13 @@ class t3lib_TCEforms_Suggest {
        }
 
        /**
-        * Ajax handler for the "suggest" feature in TCEforms
-        * compiles together the different results from
+        * Ajax handler for the "suggest" feature in TCEforms.
         *
-        * @param  string  $search    The string to search for in the database
-        * @param  string  $table     The table which is currently edited
-        * @param  string  $field     The field which is currently edited
-        * @param  integer $uid       The uid of the record which is currently edited (may be NEWxxxxxx)
-        * @param  integer $pid       The pid of the record which is currently edited (always numeric
-        * @param  string  $formfield The field which is edited
+        * @param array $params The parameters from the AJAX call
+        * @param TYPO3AJAX $ajaxObj The AJAX object representing the AJAX call
         * @return void
         */
-       public function processAjaxRequest($params,  &$ajaxObj) {
+       public function processAjaxRequest($params, &$ajaxObj) {
 
                        // get parameters from $_GET/$_POST
                $search = t3lib_div::_GP('value');
index fc459f3..3d2a45e 100644 (file)
@@ -98,8 +98,8 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        /**
         * The constructor of this class
         *
-        * @param  string $table
-        * @param  array  $config  The configuration (TCA overlayed with TSconfig) to use for this selector
+        * @param string $table The table to query
+        * @param array $config The configuration (TCA overlayed with TSconfig) to use for this selector
         * @return void
         */
        public function __construct($table, $config) {
@@ -141,9 +141,9 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
         * If you subclass this class, you will most likely only want to overwrite the functions called from here, but not
         * this function itself
         *
-        * @param  array  $params
-        * @param  object $ref  the parent object
-        * @return array  array of rows
+        * @param array $params
+        * @param object $ref The parent object
+        * @return mixed array of rows or false if nothing found
         */
        public function queryTable(&$params, $recursionCounter = 0) {
                $rows = array();
@@ -223,7 +223,7 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
         * Prepare the statement for selecting the records which will be returned to the selector. May also return some
         * other records (e.g. from a mm-table) which will be used later on to select the real records
         *
-        * @return  void
+        * @return void
         */
        protected function prepareSelectStatement() {
                $searchWholePhrase = $this->config['searchWholePhrase'];
@@ -271,8 +271,8 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        /**
         * Selects all subpages of one page, optionally only upto a certain level
         *
-        * @param  integer $uid
-        * @param  integer $depth
+        * @param integer $uid The uid of the page
+        * @param integer $depth The depth to select upto. Defaults to 99
         * @return array of page IDs
         */
        protected function getAllSubpagesOfPage($uid, $depth = 99) {
@@ -314,7 +314,7 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        /**
         * Manipulate a record before using it to render the selector; may be used to replace a MM-relation etc.
         *
-        * @param  array $row
+        * @param array $row
         */
        protected function manipulateRecord(&$row) {
        }
@@ -340,8 +340,8 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        /**
         * Overlay the given record with its workspace-version, if any
         *
-        * @param       array   the record to get the workspace version for
-        * @return  void (passed by reference)
+        * @param array The record to get the workspace version for
+        * @return void (passed by reference)
         */
        protected function makeWorkspaceOverlay(&$row) {
                        // check for workspace-versions
@@ -353,7 +353,7 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        /**
         * Return the icon for a record - just a wrapper for two functions from t3lib_iconWorks
         *
-        * @param  array  $row The record to get the icon for
+        * @param array $row The record to get the icon for
         * @return string The path to the icon
         */
        protected function getIcon($row) {
@@ -367,9 +367,9 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
         *
         * The path is returned uncut, cutting has to be done by calling function.
         *
-        * @param  array   $row The row
-        * @param  integer $uid The records uid
-        * @return string  The record-path
+        * @param  array        $row The row
+        * @param  array        $record The record
+        * @return string The record-path
         */
        protected function getRecordPath(&$row, $uid) {
                $titleLimit = max($this->config['maxPathTitleLength'], 0);
@@ -388,8 +388,8 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        /**
         * Returns a label for a given record; usually only a wrapper for t3lib_BEfunc::getRecordTitle
         *
-        * @param  array $row
-        * @return The label for the record
+        * @param array $row The record to get the label for
+        * @return string The label
         */
        protected function getLabel($row) {
                return t3lib_BEfunc::getRecordTitle(($this->mmForeignTable ? $this->mmForeignTable : $this->table), $row, true);
@@ -398,10 +398,10 @@ class t3lib_TCEforms_Suggest_DefaultReceiver {
        /**
         * Calls a user function for rendering the page.
         *
-        * This user function should manipulate $entry, especially $entry['text']
+        * This user function should manipulate $entry, especially $entry['text'].
         *
-        * @param  array $row   The row
-        * @param  array $entry The entry to render
+        * @param array $row The row
+        * @param array $entry The entry to render
         * @return array The rendered entry (will be put into a <li> later on
         */
        protected function renderRecord($row, $entry) {