[TASK] Clean up the phpDoc of t3lib/extjs/
authorWouter Wolters <typo3@wouterwolters.nl>
Thu, 31 May 2012 16:28:20 +0000 (18:28 +0200)
committerGeorg Ringer <mail@ringerge.org>
Fri, 1 Jun 2012 06:27:23 +0000 (08:27 +0200)
Clean up the phpDoc of t3lib/extjs/

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: I1bb9da4538f0f04e179e2eb9cf382c6ea988f63e
Resolves: #37651
Releases: 6.0
Reviewed-on: http://review.typo3.org/11771
Reviewed-by: Georg Ringer
Tested-by: Georg Ringer
t3lib/extjs/class.t3lib_extjs_extdirectapi.php
t3lib/extjs/class.t3lib_extjs_extdirectdebug.php
t3lib/extjs/class.t3lib_extjs_extdirectrouter.php
t3lib/extjs/dataprovider/class.extdirect_dataprovider_backendlivesearch.php
t3lib/extjs/dataprovider/class.extdirect_dataprovider_beusersettings.php
t3lib/extjs/dataprovider/class.extdirect_dataprovider_contexthelp.php
t3lib/extjs/dataprovider/class.extdirect_dataprovider_state.php

index 4df40c6..6a7c7fe 100644 (file)
 /**
  * Ext Direct API Generator
  *
- * @author     Sebastian Kurfürst <sebastian@typo3.org>
- * @author     Stefan Galinski <stefan.galinski@gmail.com>
- * @package    TYPO3
+ * @author Sebastian Kurfürst <sebastian@typo3.org>
+ * @author Stefan Galinski <stefan.galinski@gmail.com>
+ * @package TYPO3
+ * @subpackage t3lib
  */
 class t3lib_extjs_ExtDirectApi {
        /**
@@ -57,7 +58,7 @@ class t3lib_extjs_ExtDirectApi {
         * the API and are required by ExtDirect. The result is cached to improve the overall
         * performance.
         *
-        * @param array $ajaxParams ajax parameters
+        * @param array $ajaxParams Ajax parameters
         * @param TYPO3AJAX $ajaxObj typo3ajax instance
         * @return void
         */
@@ -68,13 +69,13 @@ class t3lib_extjs_ExtDirectApi {
        /**
         * Get the API for a given nameapace
         *
-        * @throws InvalidArgumentException
-        * @param  array $filterNamespaces
+        * @param array $filterNamespaces
         * @return string
+        * @throws InvalidArgumentException
         */
        public function getApiPhp(array $filterNamespaces) {
                $javascriptNamespaces = $this->getExtDirectApi($filterNamespaces);
-                       // return the generated javascript API configuration
+                       // Return the generated javascript API configuration
                if (count($javascriptNamespaces)) {
                        return '
                                if (!Ext.isObject(Ext.app.ExtDirectAPI)) {
@@ -97,8 +98,8 @@ class t3lib_extjs_ExtDirectApi {
         * Generates the API that is configured inside the ExtDirect configuration
         * array "$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ExtDirect']".
         *
-        * @param array $filerNamespace namespace that should be loaded like array('TYPO3.Backend')
-        * @return array javascript API configuration
+        * @param array $filerNamespace Namespace that should be loaded like array('TYPO3.Backend')
+        * @return array Javascript API configuration
         */
        protected function generateAPI(array $filterNamespaces) {
                $javascriptNamespaces = array();
@@ -108,7 +109,7 @@ class t3lib_extjs_ExtDirectApi {
                                $javascriptObjectName = array_pop($splittedJavascriptName);
                                $javascriptNamespace = implode('.', $splittedJavascriptName);
 
-                                       // only items inside the wanted namespace
+                                       // Only items inside the wanted namespace
                                if (!$this->findNamespace($javascriptNamespace, $filterNamespaces)) {
                                        continue;
                                }
@@ -170,8 +171,8 @@ class t3lib_extjs_ExtDirectApi {
        /**
         * Generates the API or reads it from cache
         *
-        * @param  array $filterNamespaces
-        * @param bool $checkGetParam
+        * @param array $filterNamespaces
+        * @param boolean $checkGetParam
         * @return string $javascriptNamespaces
         */
        protected function getExtDirectApi(array $filterNamespaces) {
@@ -182,15 +183,15 @@ class t3lib_extjs_ExtDirectApi {
                );
                $noCache = t3lib_div::_GET('no_cache') ? TRUE : $noCache;
 
-                       // look up into the cache
+                       // Look up into the cache
                $cacheIdentifier = 'ExtDirectApi';
                $cacheHash = md5($cacheIdentifier . implode(',', $filterNamespaces) . t3lib_div::getIndpEnv('TYPO3_SSL') .
                        serialize($this->settings) . TYPO3_MODE . t3lib_div::getIndpEnv('HTTP_HOST'));
 
-                       // with no_cache always generate the javascript content
+                       // With no_cache always generate the javascript content
                $cacheContent = $noCache ? '' : t3lib_pageSelect::getHash($cacheHash);
 
-                       // generate the javascript content if it wasn't found inside the cache and cache it!
+                       // Generate the javascript content if it wasn't found inside the cache and cache it!
                if (!$cacheContent) {
                        $javascriptNamespaces = $this->generateAPI($filterNamespaces);
                        if (count($javascriptNamespaces)) {
@@ -210,18 +211,18 @@ class t3lib_extjs_ExtDirectApi {
        /**
         * Generates the error message
         *
-        * @param  array $filterNamespaces
+        * @param array $filterNamespaces
         * @return string $errorMessage
         */
        protected function getNamespaceError(array $filterNamespaces) {
                if (count($filterNamespaces)) {
-                               // namespace error
+                               // Namespace error
                        $errorMessage = sprintf($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:ExtDirect.namespaceError'),
                                                                        __CLASS__, implode(',', $filterNamespaces)
                        );
                }
                else {
-                               // no namespace given
+                               // No namespace given
                        $errorMessage = sprintf($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:ExtDirect.noNamespace'),
                                                                        __CLASS__
                        );
@@ -233,9 +234,9 @@ class t3lib_extjs_ExtDirectApi {
        /**
         * Looks if the given namespace is present in $filterNamespaces
         *
-        * @param  string $namespace
+        * @param string $namespace
         * @param array $filterNamespaces
-        * @return bool
+        * @return boolean
         */
        protected function findNamespace($namespace, array $filterNamespaces) {
                if ($filterNamespaces === array('TYPO3')) {
index 900ff6f..1b10af1 100644 (file)
@@ -28,8 +28,9 @@
 /**
  * Ext Direct Debug
  *
- * @author     Stefan Galinski <stefan.galinski@gmail.com>
- * @package    TYPO3
+ * @author Stefan Galinski <stefan.galinski@gmail.com>
+ * @package TYPO3
+ * @subpackage t3lib
  */
 class t3lib_extjs_ExtDirectDebug {
        /**
@@ -39,7 +40,6 @@ class t3lib_extjs_ExtDirectDebug {
         */
        protected $debugMessages = array();
 
-
        /**
         * destructor
         *
@@ -50,11 +50,9 @@ class t3lib_extjs_ExtDirectDebug {
         * @see http://forge.typo3.org/issues/25278
         */
        public function __destruct() {
-
-       /* currently empty */
+               // Currently empty
        }
 
-
        /**
         * Adds a new message of any data type to the internal debug message array.
         *
index 3fcee46..ddd2ac9 100644 (file)
 /**
  * Ext Direct Router
  *
- * @author     Sebastian Kurfürst <sebastian@typo3.org>
- * @author     Stefan Galinski <stefan.galinski@gmail.com>
- * @package    TYPO3
+ * @author Sebastian Kurfürst <sebastian@typo3.org>
+ * @author Stefan Galinski <stefan.galinski@gmail.com>
+ * @package TYPO3
+ * @subpackage t3lib
  */
 class t3lib_extjs_ExtDirectRouter {
        /**
         * Dispatches the incoming calls to methods about the ExtDirect API.
         *
-        * @param aray $ajaxParams ajax parameters
+        * @param aray $ajaxParams Ajax parameters
         * @param TYPO3AJAX $ajaxObj typo3ajax instance
         * @return void
         */
@@ -138,8 +139,8 @@ class t3lib_extjs_ExtDirectRouter {
         *
         * @param object $singleRequest request object from extJS
         * @param string $namespace namespace like TYPO3.Backend
-        * @throws UnexpectedValueException if the remote method couldn't be found
         * @return mixed return value of the called method
+        * @throws UnexpectedValueException if the remote method couldn't be found
         */
        protected function processRpc($singleRequest, $namespace) {
                $endpointName = $namespace . '.' . $singleRequest->action;
index a6799f4..2efad87 100644 (file)
@@ -67,7 +67,6 @@ class extDirect_dataProvider_BackendLiveSearch {
 
        /**
         *
-        *
         * @param stdClass $command
         *
         * @return array
@@ -77,7 +76,7 @@ class extDirect_dataProvider_BackendLiveSearch {
                $this->liveSearch->setLimitCount($command->limit);
                $this->liveSearch->setQueryString($command->query);
 
-                       // jump & edit - find page and retrieve an edit link (this is only for pages
+                       // Jump & edit - find page and retrieve an edit link (this is only for pages
                if ($this->queryParser->isValidPageJump($command->query)) {
                        $this->searchResults['pageJump'] = $this->liveSearch->findPage($command->query);
                        $commandQuery = $this->queryParser->getCommandForPageJump($command->query);
@@ -86,7 +85,7 @@ class extDirect_dataProvider_BackendLiveSearch {
                        }
                }
 
-                       // search through the database and find records who match to the given search string
+                       // Search through the database and find records who match to the given search string
                $resultArray = $this->liveSearch->find($command->query);
 
                foreach ($resultArray as $resultFromTable) {
@@ -97,7 +96,6 @@ class extDirect_dataProvider_BackendLiveSearch {
 
                return $this->searchResults;
        }
-
 }
 
 ?>
\ No newline at end of file
index e8f0e8f..35ff07b 100644 (file)
 
 /**
  * ExtDirect DataProvider for BE User Settings
+ *
+ * @author Steffen Kamper <steffen@typo3.org>
+ * @package TYPO3
+ * @subpackage t3lib
  */
 class extDirect_DataProvider_BackendUserSettings {
 
@@ -35,8 +39,8 @@ class extDirect_DataProvider_BackendUserSettings {
         *
         * Returns all user settings, if $key is not specified, otherwise it retuns the value for $key
         *
-        * @param  string $key  identifier, allows also dotted notation for subarrays
-        * @return mixed value associated
+        * @param string $key Identifier, allows also dotted notation for subarrays
+        * @return mixed Value associated
         */
        public function get($key = '') {
                if (strpos($key, '.') !== FALSE) {
@@ -50,8 +54,8 @@ class extDirect_DataProvider_BackendUserSettings {
        /**
         * Sets user settings by key/value pair
         *
-        * @param  string $key
-        * @param  mixed $value
+        * @param string $key
+        * @param mixed $value
         * @return void
         */
        public function set($key, $value) {
@@ -136,7 +140,7 @@ class extDirect_DataProvider_BackendUserSettings {
        /**
         * Computes the subarray from dotted notation
         *
-        * @param  $key dotted notation of subkeys like moduleData.module1.general.checked
+        * @param $key Dotted notation of subkeys like moduleData.module1.general.checked
         * @return mixed $array value of the settings
         */
        protected function getFromDottedNotation($key) {
@@ -151,8 +155,8 @@ class extDirect_DataProvider_BackendUserSettings {
        /**
         * Sets the value of a key written in dotted notation
         *
-        * @param  string $key
-        * @param  mixed $value
+        * @param string $key
+        * @param mixed $value
         * @return void
         */
        protected function setFromDottedNotation($key, $value) {
index ba6bbdf..fd302f0 100644 (file)
 
 /**
  * ExtDirect DataProvider for ContextHelp
+ *
+ * @author Steffen Kamper <steffen@typo3.org>
+ * @package TYPO3
+ * @subpackage t3lib
  */
 class extDirect_DataProvider_ContextHelp {
 
        /**
         * Fetch the context help for the given table/field parameters
         *
-        * @param  string $table table identifier
-        * @param  string $field field identifier
-        * @return array complete help information
+        * @param  string $table Table identifier
+        * @param  string $field Field identifier
+        * @return array complete Help information
         */
        public function getContextHelp($table, $field) {
                $helpTextArray = t3lib_befunc::helpTextArray($table, $field);
@@ -52,8 +56,8 @@ class extDirect_DataProvider_ContextHelp {
        /**
         * Fetch the context help for the given table
         *
-        * @param  string $table table identifier
-        * @return array complete help information
+        * @param string $table Table identifier
+        * @return array Complete help information
         */
        public function getTableContextHelp($table) {
                $output = array();
@@ -70,17 +74,17 @@ class extDirect_DataProvider_ContextHelp {
                                        'id' => $table . '.' . $field,
                                );
 
-                                       // add alternative title, if defined
+                                       // Add alternative title, if defined
                                if ($data['alttitle']) {
                                        $output[$field]['title'] = $data['alttitle'];
                                }
 
-                                       // if we have more information to show
+                                       // If we have more information to show
                                if ($data['image_descr'] || $data['seeAlso'] || $data['details'] || $data['syntax']) {
                                        $output[$field]['moreInfo'] = TRUE;
                                }
 
-                                       // add description
+                                       // Add description
                                if ($data['description']) {
                                        $output[$field]['description'] = $data['description'] . ($output[$field]['moreInfo'] ? $arrow : '');
                                }
index 6b97af0..16f7788 100644 (file)
 
 /**
  * ExtDirect DataProvider for State
+ *
+ * @author Steffen Kamper <steffen@typo3.org>
+ * @package TYPO3
+ * @subpackage t3lib
  */
 class extDirect_DataProvider_State {
 
@@ -39,14 +43,14 @@ class extDirect_DataProvider_State {
         * @return void
         */
        public function __construct() {
-                       //all data is saved in BE_USER->uc
+                       // All data is saved in BE_USER->uc
                $this->userSettings = t3lib_div::makeInstance('extDirect_DataProvider_BackenduserSettings');
        }
 
        /**
         * Gets state for given key
         *
-        * @param  stdClass $parameter
+        * @param stdClass $parameter
         * @return array
         */
        public function getState($parameter) {
@@ -62,7 +66,7 @@ class extDirect_DataProvider_State {
        /**
         * Save the state for a given key
         *
-        * @param  stdClass $parameter
+        * @param stdClass $parameter
         * @return array
         */
        public function setState($parameter) {