[CLEANUP] Add phpDoc to properties in several extensions 90/33890/2
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 7 Nov 2014 18:46:46 +0000 (19:46 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 8 Nov 2014 15:00:15 +0000 (16:00 +0100)
* func
* func_wizards
* lang
* lowlevel
* opendocs
* openid
* recordlist

Resolves: #62772
Releases: master
Change-Id: I62727931a3747d2935e9d3e7ebda7e0a7bcc9e73
Reviewed-on: http://review.typo3.org/33890
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
12 files changed:
typo3/sysext/func/Classes/Controller/PageFunctionsController.php
typo3/sysext/func_wizards/Classes/Controller/WebFunctionWizardsBaseController.php
typo3/sysext/info/Classes/Controller/InfoModuleController.php
typo3/sysext/lang/Classes/Command/LanguageCommandController.php
typo3/sysext/lowlevel/Classes/View/ConfigurationView.php
typo3/sysext/lowlevel/Classes/View/DatabaseIntegrityView.php
typo3/sysext/opendocs/Classes/Controller/OpendocsController.php
typo3/sysext/openid/Classes/OpenidService.php
typo3/sysext/openid/Classes/Wizard.php
typo3/sysext/recordlist/Classes/RecordList.php
typo3/sysext/recordlist/Classes/RecordList/AbstractDatabaseRecordList.php
typo3/sysext/recordlist/Classes/RecordList/RecordListHookInterface.php

index da5c4e6..f57b321 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Backend\Utility\BackendUtility;
 class PageFunctionsController extends \TYPO3\CMS\Backend\Module\BaseScriptClass {
 
        /**
+        * @var array
         * @internal
         */
        public $pageinfo;
index 99778fa..9f7ace8 100644 (file)
@@ -22,6 +22,9 @@ namespace TYPO3\CMS\FuncWizards\Controller;
  */
 class WebFunctionWizardsBaseController extends \TYPO3\CMS\Backend\Module\AbstractFunctionModule {
 
+       /**
+        * @var string
+        */
        public $function_key = 'wiz';
 
        /**
index 7a1a8e7..6ef46fe 100644 (file)
@@ -24,6 +24,9 @@ use TYPO3\CMS\Backend\Utility\BackendUtility;
  */
 class InfoModuleController extends \TYPO3\CMS\Backend\Module\BaseScriptClass {
 
+       /**
+        * @var array
+        */
        public $pageinfo;
 
        /**
index 7743b95..ba92d70 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Lang\Command;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 use TYPO3\CMS\Core\Package\PackageInterface;
 use TYPO3\CMS\Core\Package\PackageManager;
 
index d426b58..595a3f9 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
  * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 class ConfigurationView {
+
        /**
         * @var \TYPO3\CMS\Fluid\View\StandaloneView
         */
@@ -34,10 +35,19 @@ class ConfigurationView {
         */
        protected $flashMessageQueue;
 
+       /**
+        * @var array
+        */
        public $MCONF = array();
 
+       /**
+        * @var array
+        */
        public $MOD_MENU = array();
 
+       /**
+        * @var array
+        */
        public $MOD_SETTINGS = array();
 
        /**
@@ -47,8 +57,14 @@ class ConfigurationView {
         */
        public $doc;
 
+       /**
+        * @var array
+        */
        public $include_once = array();
 
+       /**
+        * @var string
+        */
        public $content;
 
        /**
index 6252094..2b6993b 100644 (file)
@@ -24,10 +24,19 @@ use TYPO3\CMS\Backend\Utility\BackendUtility;
  */
 class DatabaseIntegrityView {
 
+       /**
+        * @var array
+        */
        public $MCONF = array();
 
+       /**
+        * @var array
+        */
        public $MOD_MENU = array();
 
+       /**
+        * @var array
+        */
        public $MOD_SETTINGS = array();
 
        /**
@@ -37,10 +46,19 @@ class DatabaseIntegrityView {
         */
        public $doc;
 
+       /**
+        * @var string
+        */
        public $content;
 
+       /**
+        * @var array
+        */
        public $menu;
 
+       /**
+        * @var string
+        */
        protected $formName = 'queryform';
 
        /**
index ccfa580..dae1068 100644 (file)
@@ -29,10 +29,19 @@ class OpendocsController implements \TYPO3\CMS\Backend\Toolbar\ToolbarItemHookIn
         */
        protected $backendReference;
 
+       /**
+        * @var aray
+        */
        protected $openDocs;
 
+       /**
+        * @var aray
+        */
        protected $recentDocs;
 
+       /**
+        * @var string
+        */
        protected $EXTKEY = 'opendocs';
 
        /**
index 119b50e..db182e3 100644 (file)
@@ -28,17 +28,23 @@ class OpenidService extends \TYPO3\CMS\Core\Service\AbstractService {
 
        /**
         * The extension key
+        *
+        * @var string
         */
        public $extKey = 'openid';
 
        /**
         * Login data as passed to initAuth()
+        *
+        * @var array
         */
        protected $loginData = array();
 
        /**
         * Additional authentication information provided by AbstractUserAuthentication.
         * We use it to decide what database table contains user records.
+        *
+        * @var array
         */
        protected $authenticationInformation = array();
 
@@ -64,6 +70,8 @@ class OpenidService extends \TYPO3\CMS\Core\Service\AbstractService {
 
        /**
         * If set to TRUE, than libraries are already included.
+        *
+        * @var bool
         */
        static protected $openIDLibrariesIncluded = FALSE;
 
index 3e32fb3..2291de9 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * @author Christian Weiske <cweiske@cweiske.de>
  */
 class Wizard extends OpenidService {
+
        /**
         * OpenID of the user after authentication
         *
index f69ed67..fa1ee09 100644 (file)
@@ -24,51 +24,102 @@ use TYPO3\CMS\Backend\Utility\BackendUtility;
  */
 class RecordList {
 
-       // Internal, GPvars:
-       // Page Id for which to make the listing
        /**
+        * Page Id for which to make the listing
+        *
         * @var int
         */
        public $id;
 
-       // Pointer - for browsing list of records.
+       /**
+        * Pointer - for browsing list of records.
+        *
+        * @var int
+        */
        public $pointer;
 
-       // Thumbnails or not
+       /**
+        * Thumbnails or not
+        *
+        * @var string
+        */
        public $imagemode;
 
-       // Which table to make extended listing for
+       /**
+        * Which table to make extended listing for
+        *
+        * @var string
+        */
        public $table;
 
-       // Search-fields
+       /**
+        * Search-fields
+        *
+        * @var string
+        */
        public $search_field;
 
-       // Search-levels
+       /**
+        * Search-levels
+        *
+        * @var int
+        */
        public $search_levels;
 
-       // Show-limit
+       /**
+        * Show-limit
+        *
+        * @var int
+        */
        public $showLimit;
 
-       // Return URL
+       /**
+        * Return URL
+        *
+        * @var string
+        */
        public $returnUrl;
 
-       // Clear-cache flag - if set, clears page cache for current id.
+       /**
+        * Clear-cache flag - if set, clears page cache for current id.
+        *
+        * @var bool
+        */
        public $clear_cache;
 
-       // Command: Eg. "delete" or "setCB" (for TCEmain / clipboard operations)
+       /**
+        * Command: Eg. "delete" or "setCB" (for TCEmain / clipboard operations)
+        *
+        * @var string
+        */
        public $cmd;
 
-       // Table on which the cmd-action is performed.
+       /**
+        * Table on which the cmd-action is performed.
+        *
+        * @var string
+        */
        public $cmd_table;
 
-       // Internal, static:
-       // Page select perms clause
+       /**
+        * Page select perms clause
+        *
+        * @var int
+        */
        public $perms_clause;
 
-       // Module TSconfig
+       /**
+        * Module TSconfig
+        *
+        * @var array
+        */
        public $modTSconfig;
 
-       // Current ids page record
+       /**
+        * Current ids page record
+        *
+        * @var array
+        */
        public $pageinfo;
 
        /**
@@ -78,17 +129,32 @@ class RecordList {
         */
        public $doc;
 
-       // Module configuration
+       /**
+        * Module configuration
+        *
+        * @var array
+        */
        public $MCONF = array();
 
-       // Menu configuration
+       /**
+        * Menu configuration
+        *
+        * @var array
+        */
        public $MOD_MENU = array();
 
-       // Module settings (session variable)
+       /**
+        * Module settings (session variable)
+        *
+        * @var array
+        */
        public $MOD_SETTINGS = array();
 
-       // Internal, dynamic:
-       // Module output accumulation
+       /**
+        * Module output accumulation
+        *
+        * @var string
+        */
        public $content;
 
        /**
index 1cd9899..91aa70f 100644 (file)
@@ -26,135 +26,288 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class AbstractDatabaseRecordList extends \TYPO3\CMS\Backend\RecordList\AbstractRecordList {
 
-       // External, static:
-       // Specify a list of tables which are the only ones allowed to be displayed.
+       /**
+        * Specify a list of tables which are the only ones allowed to be displayed.
+        *
+        * @var string
+        */
        public $tableList = '';
 
-       // Return URL
+       /**
+        * Return URL
+        *
+        * @var string
+        */
        public $returnUrl = '';
 
-       // Boolean. Thumbnails on records containing files (pictures)
+       /**
+        * Thumbnails on records containing files (pictures)
+        *
+        * @var bool
+        */
        public $thumbs = 0;
 
-       // default Max items shown per table in "multi-table mode", may be overridden by tables.php
+       /**
+        * default Max items shown per table in "multi-table mode", may be overridden by tables.php
+        *
+        * @var int
+        */
        public $itemsLimitPerTable = 20;
 
-       // default Max items shown per table in "single-table mode", may be overridden by tables.php
+       /**
+        * default Max items shown per table in "single-table mode", may be overridden by tables.php
+        *
+        * @var int
+        */
        public $itemsLimitSingleTable = 100;
 
+       /**
+        * @var string
+        */
        public $widthGif = '<img src="clear.gif" width="1" height="4" hspace="160" alt="" />';
 
-       // Current script name
+       /**
+        * Current script name
+        *
+        * @var string
+        */
        public $script = 'index.php';
 
-       // Indicates if all available fields for a user should be selected or not.
+       /**
+        * Indicates if all available fields for a user should be selected or not.
+        *
+        * @var int
+        */
        public $allFields = 0;
 
-       // Whether to show localization view or not.
+       /**
+        * Whether to show localization view or not
+        *
+        * @var bool
+        */
        public $localizationView = FALSE;
 
-       // Internal, static: GPvar:
-       // If set, csvList is outputted.
+       /**
+        * If set, csvList is outputted.
+        *
+        * @var bool
+        */
        public $csvOutput = FALSE;
 
-       // Field, to sort list by
+       /**
+        * Field, to sort list by
+        *
+        * @var string
+        */
        public $sortField;
 
-       // Field, indicating to sort in reverse order.
+       /**
+        * Field, indicating to sort in reverse order.
+        *
+        * @var bool
+        */
        public $sortRev;
 
-       // Array, containing which fields to display in extended mode
+       /**
+        * Containing which fields to display in extended mode
+        *
+        * @var array
+        */
        public $displayFields;
 
-       // String, can contain the field name from a table which must have duplicate values marked.
+       /**
+        * String, can contain the field name from a table which must have duplicate values marked.
+        *
+        * @var string
+        */
        public $duplicateField;
 
-       // Internal, static:
-       // Page id
+       /**
+        * Page id
+        *
+        * @var int
+        */
        public $id;
 
-       // Tablename if single-table mode
+       /**
+        * Tablename if single-table mode
+        *
+        * @var string
+        */
        public $table = '';
 
-       // If TRUE, records are listed only if a specific table is selected.
+       /**
+        * If TRUE, records are listed only if a specific table is selected.
+        *
+        * @var bool
+        */
        public $listOnlyInSingleTableMode = FALSE;
 
-       // Pointer for browsing list
+       /**
+        * Pointer for browsing list
+        *
+        * @var int
+        */
        public $firstElementNumber = 0;
 
-       // Search string
+       /**
+        * Search string
+        *
+        * @var string
+        */
        public $searchString = '';
 
-       // Levels to search down.
+       /**
+        * Levels to search down.
+        *
+        * @var int
+        */
        public $searchLevels = '';
 
-       // Number of records to show
+       /**
+        * Number of records to show
+        *
+        * @var int
+        */
        public $showLimit = 0;
 
-       // Query part for either a list of ids "pid IN (1,2,3)" or a single id "pid = 123" from
-       // which to select/search etc. (when search-levels are set high). See start()
+       /**
+        * Query part for either a list of ids "pid IN (1,2,3)" or a single id "pid = 123" from
+        * which to select/search etc. (when search-levels are set high). See start()
+        *
+        * @var string
+        */
        public $pidSelect = '';
 
-       // Page select permissions
+       /**
+        * Page select permissions
+        *
+        * @var string
+        */
        public $perms_clause = '';
 
-       // Some permissions...
+       /**
+        * Some permissions...
+        *
+        * @var int
+        */
        public $calcPerms = 0;
 
-       // Mode for what happens when a user clicks the title of a record.
+       /**
+        * Mode for what happens when a user clicks the title of a record.
+        *
+        * @var string
+        */
        public $clickTitleMode = '';
 
-       // Shared module configuration, used by localization features
+       /**
+        * Shared module configuration, used by localization features
+        *
+        * @var array
+        */
        public $modSharedTSconfig = array();
 
-       // Loaded with page record with version overlay if any.
+       /**
+        * Loaded with page record with version overlay if any.
+        *
+        * @var array
+        */
        public $pageRecord = array();
 
-       // Tables which should not get listed
+       /**
+        * Tables which should not get listed
+        *
+        * @var string
+        */
        public $hideTables = '';
 
        /**
         * Tables which should not list their translations
         *
-        * @var $hideTranslations string
+        * @var string
         */
        public $hideTranslations = '';
 
-       //TSconfig which overwrites TCA-Settings
+       /**
+        * TSconfig which overwrites TCA-Settings
+        *
+        * @var array
+        */
        public $tableTSconfigOverTCA = array();
 
-       // Array of collapsed / uncollapsed tables in multi table view
+       /**
+        * Array of collapsed / uncollapsed tables in multi table view
+        *
+        * @var array
+        */
        public $tablesCollapsed = array();
 
-       // Internal, dynamic:
-       // JavaScript code accumulation
+       /**
+        * JavaScript code accumulation
+        *
+        * @var string
+        */
        public $JScode = '';
 
-       // HTML output
+       /**
+        * HTML output
+        *
+        * @var string
+        */
        public $HTMLcode = '';
 
-       // "LIMIT " in SQL...
+       /**
+        * "LIMIT " in SQL...
+        *
+        * @var int
+        */
        public $iLimit = 0;
 
-       // Counting the elements no matter what...
+       /**
+        * Counting the elements no matter what...
+        *
+        * @var int
+        */
        public $eCounter = 0;
 
-       // Set to the total number of items for a table when selecting.
+       /**
+        * Set to the total number of items for a table when selecting.
+        *
+        * @var string
+        */
        public $totalItems = '';
 
-       // Cache for record path
+       /**
+        * Cache for record path
+        *
+        * @var array
+        */
        public $recPath_cache = array();
 
-       // Fields to display for the current table
+       /**
+        * Fields to display for the current table
+        *
+        * @var array
+        */
        public $setFields = array();
 
-       // Used for tracking next/prev uids
+       /**
+        * Used for tracking next/prev uids
+        *
+        * @var array
+        */
        public $currentTable = array();
 
-       // Used for tracking duplicate values of fields
+       /**
+        * Used for tracking duplicate values of fields
+        *
+        * @var array
+        */
        public $duplicateStack = array();
 
-       // module configuratio
+       /**
+        * @var array Module configuration
+        */
        public $modTSconfig;
 
        /**
index 4648781..070cc14 100644 (file)
@@ -13,13 +13,14 @@ namespace TYPO3\CMS\Recordlist\RecordList;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Interface for classes which hook into localRecordList and modify clip-icons
  *
  * @author Bernhard Kraft <kraftb@kraftb.at>
  */
-interface RecordListHookInterface
-{
+interface RecordListHookInterface {
+
        /**
         * Modifies Web>List clip icons (copy, cut, paste, etc.) of a displayed row
         *