[CLEANUP] Add phpDoc to properties in ext:backend/Controller classes 29/33729/2
authorWouter Wolters <typo3@wouterwolters.nl>
Sun, 2 Nov 2014 22:25:06 +0000 (23:25 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Mon, 3 Nov 2014 02:53:29 +0000 (03:53 +0100)
Resolves: #62634
Releases: master
Change-Id: Iece95781c1c0b1d50364f308d1aabb1ac0f0ec85
Reviewed-on: http://review.typo3.org/33729
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Markus Klein <klein.t3@reelworx.at>
Tested-by: Markus Klein <klein.t3@reelworx.at>
21 files changed:
typo3/sysext/backend/Classes/Controller/ClickMenuController.php
typo3/sysext/backend/Classes/Controller/ContentElement/MoveElementController.php
typo3/sysext/backend/Classes/Controller/ContentElement/NewContentElementController.php
typo3/sysext/backend/Classes/Controller/EditDocumentController.php
typo3/sysext/backend/Classes/Controller/File/CreateFolderController.php
typo3/sysext/backend/Classes/Controller/File/EditFileController.php
typo3/sysext/backend/Classes/Controller/File/FileController.php
typo3/sysext/backend/Classes/Controller/File/FileUploadController.php
typo3/sysext/backend/Classes/Controller/LoginController.php
typo3/sysext/backend/Classes/Controller/NewRecordController.php
typo3/sysext/backend/Classes/Controller/NoDocumentsOpenController.php
typo3/sysext/backend/Classes/Controller/PageLayoutController.php
typo3/sysext/backend/Classes/Controller/PageTreeNavigationController.php
typo3/sysext/backend/Classes/Controller/SimpleDataHandlerController.php
typo3/sysext/backend/Classes/Controller/Wizard/AddController.php
typo3/sysext/backend/Classes/Controller/Wizard/ColorpickerController.php
typo3/sysext/backend/Classes/Controller/Wizard/EditController.php
typo3/sysext/backend/Classes/Controller/Wizard/FormsController.php
typo3/sysext/backend/Classes/Controller/Wizard/ListController.php
typo3/sysext/backend/Classes/Controller/Wizard/RteController.php
typo3/sysext/backend/Classes/Controller/Wizard/TableController.php

index 237bf9f..750c8cf 100644 (file)
@@ -24,24 +24,35 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class ClickMenuController {
 
-       // Internal, static: GPvar:
-       // Back path.
+       /**
+        * @var string
+        */
        public $backPath;
 
-       // Definition of which item the click menu should be made for.
-       public $item;
-
-       // Defines the name of the document object for which to reload the URL.
+       /**
+        * Defines the name of the document object for which to reload the URL.
+        *
+        * @var int
+        */
        public $reloadListFrame;
 
-       // Internal:
-       // Content accumulation
+       /**
+        * Content accumulation
+        *
+        * @var string
+        */
        public $content = '';
 
-       // Template object
+       /**
+        * @var \TYPO3\CMS\Backend\Template\DocumentTemplate
+        */
        public $doc;
 
-       // Internal array of classes for extending the clickmenu
+       /**
+        * Internal array of classes for extending the clickmenu
+        *
+        * @var array
+        */
        public $extClassArray = array();
 
        /**
@@ -62,7 +73,6 @@ class ClickMenuController {
        protected function init() {
                // Setting GPvars:
                $this->backPath = GeneralUtility::_GP('backPath');
-               $this->item = GeneralUtility::_GP('item');
                $this->reloadListFrame = GeneralUtility::_GP('reloadListFrame');
                // Setting pseudo module name
                $this->MCONF['name'] = 'xMOD_alt_clickmenu.php';
index 7e17627..5ebd4e3 100644 (file)
@@ -25,7 +25,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class MoveElementController {
 
-       // Internal, static (eg. from GPvars):
        /**
         * @var int
         */
@@ -68,15 +67,16 @@ class MoveElementController {
         */
        public $doc;
 
-       // Pages-select clause
        /**
+        * Pages-select clause
+        *
         * @var string
         */
        public $perms_clause;
 
-       // Internal, dynamic:
-       // Content for module accumulated here.
        /**
+        * Content for module accumulated here.
+        *
         * @var string
         */
        public $content;
index f6c23cb..a6d8b54 100644 (file)
@@ -25,27 +25,30 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class NewContentElementController {
 
-       // Internal, static (from GPvars):
-       // Page id
        /**
+        * Page id
+        *
         * @var int
         */
        public $id;
 
-       // Sys language
        /**
+        * Sys language
+        *
         * @var int
         */
        public $sys_language = 0;
 
-       // Return URL.
        /**
+        * Return URL.
+        *
         * @var string
         */
        public $R_URI = '';
 
-       // If set, the content is destined for a specific column.
        /**
+        * If set, the content is destined for a specific column.
+        *
         * @var int|null
         */
        public $colPos;
@@ -55,9 +58,9 @@ class NewContentElementController {
         */
        public $uid_pid;
 
-       // Internal, static:
-       // Module TSconfig.
        /**
+        * Module TSconfig.
+        *
         * @var array
         */
        public $modTSconfig = array();
@@ -69,27 +72,30 @@ class NewContentElementController {
         */
        public $doc;
 
-       // Internal, dynamic:
-       // Includes a list of files to include between init() and main() - see init()
        /**
+        * Includes a list of files to include between init() and main() - see init()
+        *
         * @var array
         */
        public $include_once = array();
 
-       // Used to accumulate the content of the module.
        /**
+        * Used to accumulate the content of the module.
+        *
         * @var string
         */
        public $content;
 
-       // Access boolean.
        /**
+        * Access boolean.
+        *
         * @var bool
         */
        public $access;
 
-       // config of the wizard
        /**
+        * config of the wizard
+        *
         * @var array
         */
        public $config;
index 56a873d..3d45d58 100644 (file)
@@ -30,86 +30,173 @@ use TYPO3\CMS\Core\Utility\MathUtility;
  */
 class EditDocumentController {
 
-       // Internal, static: GPvars:
-       // GPvar "edit": Is an array looking approx like [tablename][list-of-ids]=command, eg.
-       // "&edit[pages][123]=edit". See \TYPO3\CMS\Backend\Utility\BackendUtility::editOnClick(). Value can be seen modified
-       // internally (converting NEW keyword to id, workspace/versioning etc).
+       /**
+        * GPvar "edit": Is an array looking approx like [tablename][list-of-ids]=command, eg.
+        * "&edit[pages][123]=edit". See \TYPO3\CMS\Backend\Utility\BackendUtility::editOnClick(). Value can be seen modified
+        * internally (converting NEW keyword to id, workspace/versioning etc).
+        *
+        * @var array
+        */
        public $editconf;
 
-       // Commalist of fieldnames to edit. The point is IF you specify this list, only those
-       // fields will be rendered in the form. Otherwise all (available) fields in the record
-       // is shown according to the types configuration in $GLOBALS['TCA']
+       /**
+        * Commalist of fieldnames to edit. The point is IF you specify this list, only those
+        * fields will be rendered in the form. Otherwise all (available) fields in the record
+        * is shown according to the types configuration in $GLOBALS['TCA']
+        *
+        * @var bool
+        */
        public $columnsOnly;
 
-       // Default values for fields (array with tablenames, fields etc. as keys).
-       // Can be seen modified internally.
+       /**
+        * Default values for fields (array with tablenames, fields etc. as keys).
+        * Can be seen modified internally.
+        *
+        * @var array
+        */
        public $defVals;
 
-       // Array of values to force being set (as hidden fields). Will be set as $this->defVals
-       // IF defVals does not exist.
+       /**
+        * Array of values to force being set (as hidden fields). Will be set as $this->defVals
+        * IF defVals does not exist.
+        *
+        * @var array
+        */
        public $overrideVals;
 
-       // If set, this value will be set in $this->retUrl (which is used quite many places
-       // as the return URL). If not set, "dummy.php" will be set in $this->retUrl
+       /**
+        * If set, this value will be set in $this->retUrl (which is used quite many places
+        * as the return URL). If not set, "dummy.php" will be set in $this->retUrl
+        *
+        * @var string
+        */
        public $returnUrl;
 
-       // Close-document command. Not really sure of all options...
+       /**
+        * Close-document command. Not really sure of all options...
+        *
+        * @var int
+        */
        public $closeDoc;
 
-       // Quite simply, if this variable is set, then the processing of incoming data will be performed
-       // - as if a save-button is pressed. Used in the forms as a hidden field which can be set through
-       // JavaScript if the form is somehow submitted by JavaScript).
+       /**
+        * Quite simply, if this variable is set, then the processing of incoming data will be performed
+        * as if a save-button is pressed. Used in the forms as a hidden field which can be set through
+        * JavaScript if the form is somehow submitted by JavaScript).
+        *
+        * @var bool
+        */
        public $doSave;
 
-       // GPvar (for processing only) : The data array from which the data comes...
+       /**
+        * The data array from which the data comes...
+        *
+        * @var array
+        */
        public $data;
 
-       // GPvar (for processing only) : ?
+       /**
+        * @var array
+        */
        public $mirror;
 
-       // GPvar (for processing only) : Clear-cache cmd.
+       /**
+        * Clear-cache cmd.
+        *
+        * @var string
+        */
        public $cacheCmd;
 
-       // GPvar (for processing only) : Redirect (not used???)
+       /**
+        * Redirect (not used???)
+        *
+        * @var string
+        */
        public $redirect;
 
-       // GPvar (for processing only) : Boolean: If set, then the GET var "&id=" will be added to the
-       // retUrl string so that the NEW id of something is returned to the script calling the form.
+       /**
+        * Boolean: If set, then the GET var "&id=" will be added to the
+        * retUrl string so that the NEW id of something is returned to the script calling the form.
+        *
+        * @var bool
+        */
        public $returnNewPageId;
 
-       // GPvar (for processing only) : Verification code, internal stuff.
+       /**
+        * @var string
+        */
        public $vC;
 
-       // GPvar : update BE_USER->uc
+       /**
+        * update BE_USER->uc
+        *
+        * @var array
+        */
        public $uc;
 
-       // GPvar (module) : ID for displaying the page in the frontend (used for SAVE/VIEW operations)
+       /**
+        * ID for displaying the page in the frontend (used for SAVE/VIEW operations)
+        *
+        * @var int
+        */
        public $popViewId;
 
-       // GPvar (module) : Additional GET vars for the link, eg. "&L=xxx"
+       /**
+        * Additional GET vars for the link, eg. "&L=xxx"
+        *
+        * @var string
+        */
        public $popViewId_addParams;
 
-       // GPvar (module) : Alternative URL for viewing the frontend pages.
+       /**
+        * Alternative URL for viewing the frontend pages.
+        *
+        * @var string
+        */
        public $viewUrl;
 
-       // If this is pointing to a page id it will automatically load all content elements
-       // (NORMAL column/default language) from that page into the form!
+       /**
+        * If this is pointing to a page id it will automatically load all content elements
+        * (NORMAL column/default language) from that page into the form!
+        *
+        * @var int
+        */
        public $editRegularContentFromId;
 
-       // Alternative title for the document handler.
+       /**
+        * Alternative title for the document handler.
+        *
+        * @var string
+        */
        public $recTitle;
 
-       // Disable help... ?
+       /**
+        * Disable help... ?
+        *
+        * @var bool
+        */
        public $disHelp;
 
-       // If set, then no SAVE/VIEW button is printed
+       /**
+        * If set, then no SAVE/VIEW button is printed
+        *
+        * @var bool
+        */
        public $noView;
 
-       // If set, the $this->editconf array is returned to the calling script
-       // (used by wizard_add.php for instance)
+       /**
+        * If set, the $this->editconf array is returned to the calling script
+        * (used by wizard_add.php for instance)
+        *
+        * @var bool
+        */
        public $returnEditConf;
 
-       // GP var, localization mode for TCEforms (eg. "text")
+       /**
+        * localization mode for TCEforms (eg. "text")
+        *
+        * @var string
+        */
        public $localizationMode;
 
        /**
@@ -119,7 +206,6 @@ class EditDocumentController {
         */
        protected $workspace;
 
-       // Internal, static:
        /**
         * document template object
         *
@@ -127,73 +213,148 @@ class EditDocumentController {
         */
        public $doc;
 
-       // a static HTML template, usually in templates/alt_doc.html
+       /**
+        * a static HTML template, usually in templates/alt_doc.html
+        *
+        * @var string
+        */
        public $template;
 
-       // Content accumulation
+       /**
+        * Content accumulation
+        *
+        * @var string
+        */
        public $content;
 
-       // Return URL script, processed. This contains the script (if any) that we should
-       // RETURN TO from the alt_doc.php script IF we press the close button. Thus this
-       // variable is normally passed along from the calling script so we can properly return if needed.
+       /**
+        * Return URL script, processed. This contains the script (if any) that we should
+        * RETURN TO from the alt_doc.php script IF we press the close button. Thus this
+        * variable is normally passed along from the calling script so we can properly return if needed.
+        *
+        * @var string
+        */
        public $retUrl;
 
-       // Contains the parts of the REQUEST_URI (current url). By parts we mean the result of resolving
-       // REQUEST_URI (current url) by the parse_url() function. The result is an array where eg. "path"
-       // is the script path and "query" is the parameters...
+       /**
+        * Contains the parts of the REQUEST_URI (current url). By parts we mean the result of resolving
+        * REQUEST_URI (current url) by the parse_url() function. The result is an array where eg. "path"
+        * is the script path and "query" is the parameters...
+        *
+        * @var array
+        */
        public $R_URL_parts;
 
-       // Contains the current GET vars array; More specifically this array is the foundation for creating
-       // the R_URI internal var (which becomes the "url of this script" to which we submit the forms etc.)
+       /**
+        * Contains the current GET vars array; More specifically this array is the foundation for creating
+        * the R_URI internal var (which becomes the "url of this script" to which we submit the forms etc.)
+        *
+        * @var array
+        */
        public $R_URL_getvars;
 
-       // Set to the URL of this script including variables which is needed to re-display the form. See main()
+       /**
+        * Set to the URL of this script including variables which is needed to re-display the form. See main()
+        *
+        * @var string
+        */
        public $R_URI;
 
-       // Is loaded with the "title" of the currently "open document" - this is used in the
-       // Document Selector box. (see makeDocSel())
+       /**
+        * Is loaded with the "title" of the currently "open document" - this is used in the
+        * Document Selector box. (see makeDocSel())
+        *
+        * @var string
+        */
        public $storeTitle;
 
-       // Contains an array with key/value pairs of GET parameters needed to reach the
-       // current document displayed - used in the Document Selector box. (see compileStoreDat())
+       /**
+        * Contains an array with key/value pairs of GET parameters needed to reach the
+        * current document displayed - used in the Document Selector box. (see compileStoreDat())
+        *
+        * @var array
+        */
        public $storeArray;
 
-       // Contains storeArray, but imploded into a GET parameter string (see compileStoreDat())
+       /**
+        * Contains storeArray, but imploded into a GET parameter string (see compileStoreDat())
+        *
+        * @var string
+        */
        public $storeUrl;
 
-       // Hashed value of storeURL (see compileStoreDat())
+       /**
+        * Hashed value of storeURL (see compileStoreDat())
+        *
+        * @var string
+        */
        public $storeUrlMd5;
 
-       // Module session data
+       /**
+        * Module session data
+        *
+        * @var array
+        */
        public $docDat;
 
-       // An array of the "open documents" - keys are md5 hashes (see $storeUrlMd5) identifying
-       // the various documents on the GET parameter list needed to open it. The values are
-       // arrays with 0,1,2 keys with information about the document (see compileStoreDat()).
-       // The docHandler variable is stored in the $docDat session data, key "0".
+       /**
+        * An array of the "open documents" - keys are md5 hashes (see $storeUrlMd5) identifying
+        * the various documents on the GET parameter list needed to open it. The values are
+        * arrays with 0,1,2 keys with information about the document (see compileStoreDat()).
+        * The docHandler variable is stored in the $docDat session data, key "0".
+        *
+        * @var array
+        */
        public $docHandler;
 
-       // Internal: Related to the form rendering:
-       // Array of the elements to create edit forms for.
+       /**
+        * Array of the elements to create edit forms for.
+        *
+        * @var array
+        */
        public $elementsData;
 
-       // Pointer to the first element in $elementsData
+       /**
+        * Pointer to the first element in $elementsData
+        *
+        * @var array
+        */
        public $firstEl;
 
-       // Counter, used to count the number of errors (when users do not have edit permissions)
+       /**
+        * Counter, used to count the number of errors (when users do not have edit permissions)
+        *
+        * @var int
+        */
        public $errorC;
 
-       // Counter, used to count the number of new record forms displayed
+       /**
+        * Counter, used to count the number of new record forms displayed
+        *
+        * @var int
+        */
        public $newC;
 
-       // Is set to the pid value of the last shown record - thus indicating which page to
-       // show when clicking the SAVE/VIEW button
+       /**
+        * Is set to the pid value of the last shown record - thus indicating which page to
+        * show when clicking the SAVE/VIEW button
+        *
+        * @var int
+        */
        public $viewId;
 
-       // Is set to additional parameters (like "&L=xxx") if the record supports it.
+       /**
+        * Is set to additional parameters (like "&L=xxx") if the record supports it.
+        *
+        * @var string
+        */
        public $viewId_addParams;
 
-       // Module TSconfig, loaded from main() based on the page id value of viewId
+       /**
+        * Module TSconfig, loaded from main() based on the page id value of viewId
+        *
+        * @var array
+        */
        public $modTSconfig;
 
        /**
@@ -203,11 +364,18 @@ class EditDocumentController {
         */
        public $tceforms;
 
-       // Contains the root-line path of the currently edited record(s) - for display.
+       /**
+        * Contains the root-line path of the currently edited record(s) - for display.
+        *
+        * @var string
+        */
        public $generalPathOfForm;
 
-       // Internal, dynamic:
-       // Used internally to disable the storage of the document reference (eg. new records)
+       /**
+        * Used internally to disable the storage of the document reference (eg. new records)
+        *
+        * @var bool
+        */
        public $dontStoreDocumentRef;
 
        /**
index 3d604cf..77a527f 100644 (file)
@@ -24,10 +24,11 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class CreateFolderController {
 
-       // External, static:
+       /**
+        * @var int
+        */
        public $folderNumber = 10;
 
-       // Internal, static:
        /**
         * document template object
         *
@@ -35,13 +36,23 @@ class CreateFolderController {
         */
        public $doc;
 
-       // Name of the filemount
+       /**
+        * Name of the filemount
+        *
+        * @var string
+        */
        public $title;
 
-       // Internal, static (GPVar):
+       /**
+        * @var int
+        */
        public $number;
 
-       // Set with the target path inputted in &target
+       /**
+        * Set with the target path inputted in &target
+        *
+        * @var string
+        */
        public $target;
 
        /**
@@ -51,11 +62,18 @@ class CreateFolderController {
         */
        protected $folderObject;
 
-       // Return URL of list module.
+       /**
+        * Return URL of list module.
+        *
+        * @var string
+        */
        public $returnUrl;
 
-       // Internal, dynamic:
-       // Accumulating content
+       /**
+        * Accumulating content
+        *
+        * @var string
+        */
        public $content;
 
        /**
index feee930..ee25178 100644 (file)
@@ -25,9 +25,16 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class EditFileController {
 
-       // Module content accumulated.
+       /**
+        * Module content accumulated.
+        *
+        * @var string
+        */
        public $content;
 
+       /**
+        * @var string
+        */
        public $title;
 
        /**
@@ -37,14 +44,25 @@ class EditFileController {
         */
        public $doc;
 
-       // Internal, static: GPvar
-       // Original input target
+       /**
+        * Original input target
+        *
+        * @var string
+        */
        public $origTarget;
 
-       // The original target, but validated.
+       /**
+        * The original target, but validated.
+        *
+        * @var string
+        */
        public $target;
 
-       // Return URL of list module.
+       /**
+        * Return URL of list module.
+        *
+        * @var string
+        */
        public $returnUrl;
 
        /**
index 2bd4b4e..a4618b8 100644 (file)
@@ -28,21 +28,40 @@ use TYPO3\CMS\Backend\Utility\BackendUtility;
  */
 class FileController {
 
-       // Internal, static: GPvar:
-       // Array of file-operations.
+       /**
+        * Array of file-operations.
+        *
+        * @var array
+        */
        protected $file;
 
-       // Clipboard operations array
+       /**
+        * Clipboard operations array
+        *
+        * @var array
+        */
        protected $CB;
 
-       // If existing files should be overridden.
+       /**
+        * If existing files should be overridden.
+        *
+        * @var bool
+        */
        protected $overwriteExistingFiles;
 
-       // VeriCode - a hash of server specific value and other things which
-       // identifies if a submission is OK. (see $GLOBALS['BE_USER']->veriCode())
+       /**
+        * VeriCode - a hash of server specific value and other things which
+        * identifies if a submission is OK. (see $GLOBALS['BE_USER']->veriCode())
+        *
+        * @var string
+        */
        protected $vC;
 
-       // the page where the user should be redirected after everything is done
+       /**
+        * The page where the user should be redirected after everything is done
+        *
+        * @var string
+        */
        protected $redirect;
 
        /**
@@ -53,7 +72,11 @@ class FileController {
         */
        protected $fileProcessor;
 
-       // the result array from the file processor
+       /**
+        * The result array from the file processor
+        *
+        * @var array
+        */
        protected $fileData;
 
        /**
index ac4154e..dbca096 100644 (file)
@@ -24,7 +24,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class FileUploadController {
 
-       // Internal, static:
        /**
         * Document template object
         *
@@ -32,28 +31,30 @@ class FileUploadController {
         */
        public $doc;
 
-       // Name of the filemount
        /**
+        * Name of the filemount
+        *
         * @var string
         */
        public $title;
 
-       // Internal, static (GPVar):
-       // Set with the target path inputted in &target
        /**
+        * Set with the target path inputted in &target
+        *
         * @var string
         */
        public $target;
 
-       // Return URL of list module.
        /**
+        * Return URL of list module.
+        *
         * @var string
         */
        public $returnUrl;
 
-       // Internal, dynamic:
-       // Accumulating content
        /**
+        * Accumulating content
+        *
         * @var string
         */
        public $content;
index 43c5a89..4063e9e 100644 (file)
@@ -30,56 +30,113 @@ class LoginController {
 
        const SIGNAL_RenderLoginForm = 'renderLoginForm';
 
-       // Internal, GPvars:
-       // GPvar: redirect_url; The URL to redirect to after login.
+       /**
+        * The URL to redirect to after login.
+        *
+        * @var string
+        */
        public $redirect_url;
 
-       // GPvar: Defines which interface to load (from interface selector)
+       /**
+        * Defines which interface to load (from interface selector)
+        *
+        * @var string
+        */
        public $GPinterface;
 
-       // GPvar: preset username
+       /**
+        * preset username
+        *
+        * @var string
+        */
        public $u;
 
-       // GPvar: preset password
+       /**
+        * preset password
+        *
+        * @var string
+        */
        public $p;
 
        /**
         * OpenID URL submitted by form
+        *
+        * @var string
         */
        protected $openIdUrl;
 
-       // GPvar: If "L" is "OUT", then any logged in used is logged out. If redirect_url is given, we redirect to it
+       /**
+        * If "L" is "OUT", then any logged in used is logged out. If redirect_url is given, we redirect to it
+        *
+        * @var string
+        */
        public $L;
 
-       // Login-refresh boolean; The backend will call this script with this value set when the login is close to being expired and the form needs to be redrawn.
+       /**
+        * Login-refresh boolean; The backend will call this script
+        * with this value set when the login is close to being expired
+        * and the form needs to be redrawn.
+        *
+        * @var bool
+        */
        public $loginRefresh;
 
-       // Value of forms submit button for login.
+       /**
+        * Value of forms submit button for login.
+        *
+        * @var string
+        */
        public $commandLI;
 
-       // Internal, static:
-       // Set to the redirect URL of the form (may be redirect_url or "backend.php")
+       /**
+        * Set to the redirect URL of the form (may be redirect_url or "backend.php")
+        *
+        * @var string
+        */
        public $redirectToURL;
 
-       // Internal, dynamic:
-       // Content accumulation
+       /**
+        * Content accumulation
+        *
+        * @var string
+        */
        public $content;
 
-       // A selector box for selecting value for "interface" may be rendered into this variable
+       /**
+        * A selector box for selecting value for "interface" may be rendered into this variable
+        *
+        * @var string
+        */
        public $interfaceSelector;
 
-       // A selector box for selecting value for "interface" may be rendered into this variable
-       // this will have an onchange action which will redirect the user to the selected interface right away
+       /**
+        * A selector box for selecting value for "interface" may be rendered into this variable
+        * this will have an onchange action which will redirect the user to the selected interface right away
+        *
+        * @var string
+        */
        public $interfaceSelector_jump;
 
-       // A hidden field, if the interface is not set.
+       /**
+        * A hidden field, if the interface is not set.
+        *
+        * @var string
+        */
        public $interfaceSelector_hidden;
 
-       // Additional hidden fields to be placed at the login form
+       /**
+        * Additional hidden fields to be placed at the login form
+        *
+        * @var string
+        */
        public $addFields_hidden = '';
 
-       // sets the level of security. *'normal' = clear-text. 'challenged' = hashed
-       // password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
+       /**
+        * Sets the level of security. *'normal' = clear-text. 'challenged' = hashed
+        * password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
+        *
+        * @var string
+        */
        public $loginSecurityLevel = 'superchallenged';
 
        /**
index cd3f2d7..83181c4 100644 (file)
@@ -98,27 +98,23 @@ class NewRecordController {
         */
        public $R_URI;
 
-       // Internal, static: GPvar
-       // see init()
        /**
         * @var int
         */
        public $id;
 
-       // Return url.
        /**
         * @var string
         */
        public $returnUrl;
 
-       // pagesOnly flag.
        /**
+        * pagesOnly flag.
+        *
         * @var int
         */
        public $pagesOnly;
 
-       // Internal
-       // see init()
        /**
         * @var string
         */
@@ -131,8 +127,9 @@ class NewRecordController {
         */
        public $doc;
 
-       // Accumulated HTML output
        /**
+        * Accumulated HTML output
+        *
         * @var string
         */
        public $content;
index 087970a..99457b2 100644 (file)
@@ -23,8 +23,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class NoDocumentsOpenController {
 
-       // Internal:
-       // Content accumulation
        /**
         * @var string
         */
index 2d6c018..1a2ff23 100644 (file)
@@ -28,45 +28,97 @@ use TYPO3\CMS\Core\Utility\MathUtility;
  */
 class PageLayoutController {
 
-       // 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;
 
-       // 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;
 
-       // PopView id - for opening a window with the page
+       /**
+        * PopView id - for opening a window with the page
+        *
+        * @var bool
+        */
        public $popView;
 
-       // QuickEdit: Variable, that tells quick edit what to show/edit etc. Format is [tablename]:[uid] with some exceptional values for both parameters (with special meanings).
+       /**
+        * QuickEdit: Variable, that tells quick edit what to show/edit etc.
+        * Format is [tablename]:[uid] with some exceptional values for both parameters (with special meanings).
+        *
+        * @var string
+        */
        public $edit_record;
 
-       // QuickEdit: If set, this variable tells quick edit that the last edited record had this value as UID and we should look up the new, real uid value in sys_log.
+       /**
+        * QuickEdit: If set, this variable tells quick edit that the last edited record had
+        * this value as UID and we should look up the new, real uid value in sys_log.
+        *
+        * @var string
+        */
        public $new_unique_uid;
 
-       // Internal, static:
-       // Page select perms clause
+       /**
+        * Page select perms clause
+        *
+        * @var string
+        */
        public $perms_clause;
 
-       // Module TSconfig
+       /**
+        * Module TSconfig
+        *
+        * @var array
+        */
        public $modTSconfig;
 
        /**
@@ -76,7 +128,11 @@ class PageLayoutController {
         */
        public $modSharedTSconfig;
 
-       // Current ids page record
+       /**
+        * Current ids page record
+        *
+        * @var array
+        */
        public $pageinfo;
 
        /**
@@ -86,49 +142,97 @@ class PageLayoutController {
         */
        public $doc;
 
-       // Back path of the module
+       /**
+        * Back path of the module
+        *
+        * @var string
+        */
        public $backPath;
 
-       // "Pseudo" Description -table name
+       /**
+        * "Pseudo" Description -table name
+        *
+        * @var string
+        */
        public $descrTable;
 
-       // List of column-integers to edit. Is set from TSconfig, default is "1,0,2,3"
+       /**
+        * List of column-integers to edit. Is set from TSconfig, default is "1,0,2,3"
+        *
+        * @var string
+        */
        public $colPosList;
 
-       // Flag: If content can be edited or not.
+       /**
+        * Flag: If content can be edited or not.
+        *
+        * @var bool
+        */
        public $EDIT_CONTENT;
 
-       // Users permissions integer for this page.
+       /**
+        * Users permissions integer for this page.
+        *
+        * @var int
+        */
        public $CALC_PERMS;
 
-       // Currently selected language for editing content elements
+       /**
+        * Currently selected language for editing content elements
+        *
+        * @var int
+        */
        public $current_sys_language;
 
-       // 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();
 
-       // Array, where files to include is accumulated in the init() function
+       /**
+        * Array, where files to include is accumulated in the init() function
+        *
+        * @var array
+        */
        public $include_once = array();
 
-       // Array of tables to be listed by the Web > Page module in addition to the default tables
+       /**
+        * Array of tables to be listed by the Web > Page module in addition to the default tables
+        *
+        * @var array
+        */
        public $externalTables = array();
 
-       // Internal, dynamic:
-       // Module output accumulation
+       /**
+        * Module output accumulation
+        *
+        * @var string
+        */
        public $content;
 
-       // Function menu temporary storage
+       /**
+        * Function menu temporary storage
+        *
+        * @var string
+        */
        public $topFuncMenu;
 
-       // Temporary storage for page edit icon
-       public $editIcon;
-
        /**
         * List of column-integers accessible to the current BE user.
         * Is set from TSconfig, default is $colPosList
@@ -138,7 +242,9 @@ class PageLayoutController {
        public $activeColPosList;
 
        /**
-        * @var array markers array
+        * Markers array
+        *
+        * @var array
         */
        protected $markers = array();
 
index 7e44907..a5e646c 100644 (file)
@@ -25,7 +25,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class PageTreeNavigationController {
 
-       // Internal:
        /**
         * @var string
         */
@@ -55,7 +54,6 @@ class PageTreeNavigationController {
         */
        public $backPath;
 
-       // Internal, static: GPvar:
        /**
         * @var string
         */
index 2f74896..39971e9 100644 (file)
@@ -28,76 +28,87 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class SimpleDataHandlerController {
 
-       // Internal, static: GPvar
-       // Array. Accepts options to be set in TCE object. Currently it supports "reverseOrder" (boolean).
        /**
+        * Array. Accepts options to be set in TCE object. Currently it supports "reverseOrder" (boolean).
+        *
         * @var array
         */
        public $flags;
 
-       // Data array on the form [tablename][uid][fieldname] = value
        /**
+        * Data array on the form [tablename][uid][fieldname] = value
+        *
         * @var array
         */
        public $data;
 
-       // Command array on the form [tablename][uid][command] = value. This array may get additional data set internally based on clipboard commands send in CB var!
        /**
+        * Command array on the form [tablename][uid][command] = value.
+        * This array may get additional data set internally based on clipboard commands send in CB var!
+        *
         * @var array
         */
        public $cmd;
 
-       // Array passed to ->setMirror.
        /**
+        * Array passed to ->setMirror.
+        *
         * @var array
         */
        public $mirror;
 
-       // Cache command sent to ->clear_cacheCmd
        /**
+        * Cache command sent to ->clear_cacheCmd
+        *
         * @var string
         */
        public $cacheCmd;
 
-       // Redirect URL. Script will redirect to this location after performing operations (unless errors has occurred)
        /**
+        * Redirect URL. Script will redirect to this location after performing operations (unless errors has occurred)
+        *
         * @var string
         */
        public $redirect;
 
-       // Boolean. If set, errors will be printed on screen instead of redirection. Should always be used, otherwise you will see no errors if they happen.
        /**
+        * Boolean. If set, errors will be printed on screen instead of redirection. Should always be used, otherwise you will see no errors if they happen.
+        *
         * @var int
         */
        public $prErr;
 
-       // Clipboard command array. May trigger changes in "cmd"
        /**
+        * Clipboard command array. May trigger changes in "cmd"
+        *
         * @var array
         */
        public $CB;
 
-       // Verification code
        /**
+        * Verification code
+        *
         * @var string
         */
        public $vC;
 
-       // Boolean. Update Page Tree Trigger. If set and the manipulated records are pages then the update page tree signal will be set.
        /**
+        * Boolean. Update Page Tree Trigger. If set and the manipulated records are pages then the update page tree signal will be set.
+        *
         * @var int
         */
        public $uPT;
 
-       // String, general comment (for raising stages of workspace versions)
        /**
+        * String, general comment (for raising stages of workspace versions)
+        *
         * @var string
         */
        public $generalComment;
 
-       // Internal, dynamic:
-       // Files to include after init() function is called:
        /**
+        * Files to include after init() function is called:
+        *
         * @var array
         */
        public $include_once = array();
index 18cd932..1034b3e 100644 (file)
@@ -25,47 +25,51 @@ use TYPO3\CMS\Core\Utility\HttpUtility;
  */
 class AddController {
 
-       // Internal, dynamic:
-       // Content accumulation for the module.
        /**
+        * Content accumulation for the module.
+        *
         * @var string
         */
        public $content;
 
-       // If set, the TCEmain class is loaded and used to add the returning ID to the parent record.
        /**
+        * If set, the TCEmain class is loaded and used to add the returning ID to the parent record.
+        *
         * @var int
         */
        public $processDataFlag = 0;
 
-       // Internal, static:
-       // Create new record -pid (pos/neg). If blank, return immediately
        /**
+        * Create new record -pid (pos/neg). If blank, return immediately
+        *
         * @var int
         */
        public $pid;
 
-       // The parent table we are working on.
        /**
+        * The parent table we are working on.
+        *
         * @var string
         */
        public $table;
 
-       // Loaded with the created id of a record when TCEforms (alt_doc.php) returns ...
        /**
+        * Loaded with the created id of a record when TCEforms (alt_doc.php) returns ...
+        *
         * @var int
         */
        public $id;
 
-       // Internal, static: GPvars
-       // Wizard parameters, coming from TCEforms linking to the wizard.
        /**
+        * Wizard parameters, coming from TCEforms linking to the wizard.
+        *
         * @var array
         */
        public $P;
 
-       // Information coming back from alt_doc.php script, telling what the table/id was of the newly created record.
        /**
+        * Information coming back from alt_doc.php script, telling what the table/id was of the newly created record.
+        *
         * @var array
         */
        public $returnEditConf;
index f0f925c..ab456d2 100644 (file)
@@ -26,65 +26,75 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class ColorpickerController {
 
-       // GET vars:
-       // Wizard parameters, coming from TCEforms linking to the wizard.
        /**
+        * Wizard parameters, coming from TCEforms linking to the wizard.
+        *
         * @var array
         */
        public $P;
 
-       // Value of the current color picked.
        /**
+        * Value of the current color picked.
+        *
         * @var string
         */
        public $colorValue;
 
-       // Serialized functions for changing the field... Necessary to call when the value is transferred to the TCEform since the form might need to do internal processing. Otherwise the value is simply not be saved.
        /**
+        * Serialized functions for changing the field...
+        * Necessary to call when the value is transferred to the TCEform since the form might
+        * need to do internal processing. Otherwise the value is simply not be saved.
+        *
         * @var string
         */
        public $fieldChangeFunc;
 
+       /**
+        * @var string
+        */
        protected $fieldChangeFuncHash;
 
-       // Form name (from opener script)
        /**
+        * Form name (from opener script)
+        *
         * @var string
         */
        public $fieldName;
 
-       // Field name (from opener script)
        /**
+        * Field name (from opener script)
+        *
         * @var string
         */
        public $formName;
 
-       // ID of element in opener script for which to set color.
        /**
+        * ID of element in opener script for which to set color.
+        *
         * @var string
         */
        public $md5ID;
 
-       // Internal: If FALSE, a frameset is rendered, if TRUE the content of the picker script.
        /**
+        * Internal: If FALSE, a frameset is rendered, if TRUE the content of the picker script.
+        *
         * @var int
         */
        public $showPicker;
 
-       // Static:
        /**
         * @var string
         */
        public $HTMLcolorList = 'aqua,black,blue,fuchsia,gray,green,lime,maroon,navy,olive,purple,red,silver,teal,yellow,white';
 
-       // Internal:
        /**
         * @var string
         */
        public $pickerImage = '';
 
-       // Error message if image not found.
        /**
+        * Error message if image not found.
+        *
         * @var string
         */
        public $imageError = '';
@@ -96,7 +106,6 @@ class ColorpickerController {
         */
        public $doc;
 
-       // Accumulated content.
        /**
         * @var string
         */
index c076f72..eb3a597 100644 (file)
@@ -25,15 +25,16 @@ use TYPO3\CMS\Core\Utility\HttpUtility;
  */
 class EditController {
 
-       // Internal, static: GPvars
-       // Wizard parameters, coming from TCEforms linking to the wizard.
        /**
+        * Wizard parameters, coming from TCEforms linking to the wizard.
+        *
         * @var array
         */
        public $P;
 
-       // Boolean; if set, the window will be closed by JavaScript
        /**
+        * Boolean; if set, the window will be closed by JavaScript
+        *
         * @var int
         */
        public $doClose;
index d2ef3b5..343f377 100644 (file)
@@ -109,7 +109,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class FormsController {
 
-       // Internal, dynamic:
        /**
         * document template object
         *
@@ -117,42 +116,46 @@ class FormsController {
         */
        public $doc;
 
-       // Content accumulation for the module.
        /**
+        * Content accumulation for the module.
+        *
         * @var string
         */
        public $content;
 
-       // Used to numerate attachments automatically.
        /**
+        * Used to numerate attachments automatically.
+        *
         * @var int
         */
        public $attachmentCounter = 0;
 
-       // Internal, static:
-       // If set, the string version of the content is interpreted/written as XML instead of
-       // the original linebased kind. This variable still needs binding to the wizard parameters
-       // - but support is ready!
        /**
+        * If set, the string version of the content is interpreted/written as XML instead of
+        * the original linebased kind. This variable still needs binding to the wizard parameters
+        * - but support is ready!
+        *
         * @var int
         */
        public $xmlStorage = 0;
 
-       // Internal, static: GPvars
-       // Wizard parameters, coming from TCEforms linking to the wizard.
        /**
+        * Wizard parameters, coming from TCEforms linking to the wizard.
+        *
         * @var array
         */
        public $P;
 
-       // The array which is constantly submitted by the multidimensional form of this wizard.
        /**
+        * The array which is constantly submitted by the multidimensional form of this wizard.
+        *
         * @var array
         */
        public $FORMCFG;
 
-       // Indicates if the form is of a dedicated type, like "formtype_mail" (for tt_content element "Form")
        /**
+        * Indicates if the form is of a dedicated type, like "formtype_mail" (for tt_content element "Form")
+        *
         * @var string
         */
        public $special;
index 167eeea..d82be5c 100644 (file)
@@ -24,28 +24,28 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class ListController {
 
-       // Internal, static:
-       // PID
        /**
         * @var int
         */
        public $pid;
 
-       // Internal, static: GPvars
-       // Wizard parameters, coming from TCEforms linking to the wizard.
        /**
+        * Wizard parameters, coming from TCEforms linking to the wizard.
+        *
         * @var array
         */
        public $P;
 
-       // Table to show, if none, then all tables are listed in list module.
        /**
+        * Table to show, if none, then all tables are listed in list module.
+        *
         * @var string
         */
        public $table;
 
-       // Page id to list.
        /**
+        * Page id to list.
+        *
         * @var string
         */
        public $id;
index 8239824..593631f 100644 (file)
@@ -25,7 +25,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class RteController {
 
-       // Internal, dynamic:
        /**
         * document template object
         *
@@ -33,27 +32,30 @@ class RteController {
         */
        public $doc;
 
-       // Content accumulation for the module.
        /**
+        * Content accumulation for the module.
+        *
         * @var string
         */
        public $content;
 
-       // Internal, static: GPvars
-       // Wizard parameters, coming from TCEforms linking to the wizard.
        /**
+        * Wizard parameters, coming from TCEforms linking to the wizard.
+        *
         * @var array
         */
        public $P;
 
-       // If set, launch a new window with the current records pid.
        /**
+        * If set, launch a new window with the current records pid.
+        *
         * @var string
         */
        public $popView;
 
-       // Set to the URL of this script including variables which is needed to re-display the form. See main()
        /**
+        * Set to the URL of this script including variables which is needed to re-display the form. See main()
+        *
         * @var string
         */
        public $R_URI;
index 60b44e6..68fea2e 100644 (file)
@@ -26,7 +26,6 @@ use TYPO3\CMS\Core\Utility\MathUtility;
  */
 class TableController {
 
-       // Internal, dynamic:
        /**
         * document template object
         *
@@ -34,62 +33,69 @@ class TableController {
         */
        public $doc;
 
-       // Content accumulation for the module.
        /**
+        * Content accumulation for the module.
+        *
         * @var string
         */
        public $content;
 
-       // TRUE, then <input> fields are shown, not textareas.
        /**
+        * TRUE, then <input> fields are shown, not textareas.
+        *
         * @var int
         */
        public $inputStyle = 0;
 
-       // Internal, static:
-       // If set, the string version of the content is interpreted/written as XML
-       // instead of the original linebased kind. This variable still needs binding
-       // to the wizard parameters - but support is ready!
        /**
+        * If set, the string version of the content is interpreted/written as XML
+        * instead of the original linebased kind. This variable still needs binding
+        * to the wizard parameters - but support is ready!
+        *
         * @var int
         */
        public $xmlStorage = 0;
 
-       // Number of new rows to add in bottom of wizard
        /**
+        * Number of new rows to add in bottom of wizard
+        *
         * @var int
         */
        public $numNewRows = 1;
 
-       // Name of field in parent record which MAY contain the number of columns for the table
-       // - here hardcoded to the value of tt_content. Should be set by TCEform parameters (from P)
        /**
+        * Name of field in parent record which MAY contain the number of columns for the table
+        * here hardcoded to the value of tt_content. Should be set by TCEform parameters (from P)
+        *
         * @var string
         */
        public $colsFieldName = 'cols';
 
-       // Internal, static: GPvars
-       // Wizard parameters, coming from TCEforms linking to the wizard.
        /**
+        * Wizard parameters, coming from TCEforms linking to the wizard.
+        *
         * @var array
         */
        public $P;
 
-       // The array which is constantly submitted by the multidimensional form of this wizard.
        /**
+        * The array which is constantly submitted by the multidimensional form of this wizard.
+        *
         * @var array
         */
        public $TABLECFG;
 
-       // Table parsing
-       // quoting of table cells
        /**
+        * Table parsing
+        * quoting of table cells
+        *
         * @var string
         */
        public $tableParsing_quote;
 
-       // delimiter between table cells
        /**
+        * delimiter between table cells
+        *
         * @var string
         */
        public $tableParsing_delimiter;