[CLEANUP] Add phpDoc to properties in several extensions 94/33894/2
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 7 Nov 2014 19:31:41 +0000 (20:31 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 8 Nov 2014 14:46:24 +0000 (15:46 +0100)
* recycler
* reports
* rsaauth
* saltedpasswords
* sv
* taskcenter
* tstemplate

Resolves: #62774
Releases: master
Change-Id: I43641c9e10e361be7d1312fe5e549a03144e8c0f
Reviewed-on: http://review.typo3.org/33894
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
39 files changed:
typo3/sysext/recycler/Classes/Controller/RecyclerAjaxController.php
typo3/sysext/recycler/Classes/Controller/RecyclerModuleController.php
typo3/sysext/recycler/Classes/Domain/Model/DeletedRecords.php
typo3/sysext/reports/Classes/Controller/ReportController.php
typo3/sysext/reports/Classes/Report/Status/SystemStatus.php
typo3/sysext/reports/Classes/Report/Status/WarningMessagePostProcessor.php
typo3/sysext/reports/Classes/ReportInterface.php
typo3/sysext/reports/Classes/Status.php
typo3/sysext/reports/Classes/Task/SystemStatusUpdateTaskNotificationEmailField.php
typo3/sysext/reports/Classes/ViewHelpers/ActionMenuItemViewHelper.php
typo3/sysext/reports/Classes/ViewHelpers/IconViewHelper.php
typo3/sysext/rsaauth/Classes/Backend/AbstractBackend.php
typo3/sysext/rsaauth/Classes/Backend/AjaxLoginHandler.php
typo3/sysext/rsaauth/Classes/Backend/BackendFactory.php
typo3/sysext/rsaauth/Classes/Backend/CommandLineBackend.php
typo3/sysext/rsaauth/Classes/Backend/PhpBackend.php
typo3/sysext/rsaauth/Classes/BackendWarnings.php
typo3/sysext/rsaauth/Classes/Hook/FrontendLoginHook.php
typo3/sysext/rsaauth/Classes/Hook/LoginFormHook.php
typo3/sysext/rsaauth/Classes/Hook/UserSetupHook.php
typo3/sysext/rsaauth/Classes/Keypair.php
typo3/sysext/rsaauth/Classes/RsaAuthService.php
typo3/sysext/rsaauth/Classes/Storage/SessionStorage.php
typo3/sysext/rsaauth/Classes/Storage/StorageFactory.php
typo3/sysext/saltedpasswords/Classes/Evaluation/BackendEvaluator.php
typo3/sysext/saltedpasswords/Classes/Evaluation/Evaluator.php
typo3/sysext/saltedpasswords/Classes/Evaluation/FrontendEvaluator.php
typo3/sysext/saltedpasswords/Classes/Salt/BlowfishSalt.php
typo3/sysext/saltedpasswords/Classes/Salt/Md5Salt.php
typo3/sysext/saltedpasswords/Classes/Salt/PhpassSalt.php
typo3/sysext/saltedpasswords/Classes/Salt/SaltInterface.php
typo3/sysext/saltedpasswords/Classes/SaltedPasswordService.php
typo3/sysext/saltedpasswords/Classes/Task/BulkUpdateFieldProvider.php
typo3/sysext/saltedpasswords/Classes/Task/BulkUpdateTask.php
typo3/sysext/saltedpasswords/Classes/Utility/ExtensionManagerConfigurationUtility.php
typo3/sysext/sv/Classes/AbstractAuthenticationService.php
typo3/sysext/sv/Classes/LoginFormHook.php
typo3/sysext/taskcenter/Classes/Controller/TaskModuleController.php
typo3/sysext/tstemplate/Classes/Controller/TypoScriptTemplateModuleController.php

index 0b08fa2..99fa4ad 100644 (file)
@@ -27,14 +27,14 @@ class RecyclerAjaxController {
        /**
         * Stores the content for the ajax output
         *
-        * @var         string
+        * @var string
         */
        protected $content;
 
        /**
         * Command to be processed
         *
-        * @var         string
+        * @var string
         */
        protected $command;
 
@@ -43,7 +43,7 @@ class RecyclerAjaxController {
         * Example: Json format
         * [ ["pages",1],["pages",2],["tt_content",34] ]
         *
-        * @var         string
+        * @var string
         */
        protected $data;
 
index 49b62c0..86e7146 100644 (file)
@@ -16,8 +16,6 @@ namespace TYPO3\CMS\Recycler\Controller;
 
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 
-// This checks permissions and exits if the users has no permission for entry.
-
 /**
  * Module 'Recycler' for the 'recycler' extension.
  *
@@ -30,14 +28,29 @@ class RecyclerModuleController extends \TYPO3\CMS\Backend\Module\BaseScriptClass
         */
        public $doc;
 
+       /**
+        * @var string
+        */
        protected $relativePath;
 
+       /**
+        * @var array
+        */
        protected $pageRecord = array();
 
+       /**
+        * @var bool
+        */
        protected $isAccessibleForCurrentUser = FALSE;
 
+       /**
+        * @var bool
+        */
        protected $allowDelete = FALSE;
 
+       /**
+        * @var int
+        */
        protected $recordsPageLimit = 50;
 
        /**
index f54f317..8061657 100644 (file)
@@ -24,21 +24,21 @@ class DeletedRecords {
        /**
         * Array with all deleted rows
         *
-        * @var         array
+        * @var array
         */
        protected $deletedRows = array();
 
        /**
         * String with the global limit
         *
-        * @var         string
+        * @var string
         */
        protected $limit = '';
 
        /**
         * Array with all available FE tables
         *
-        * @var         array
+        * @var array
         */
        protected $table = array();
 
@@ -52,14 +52,14 @@ class DeletedRecords {
        /**
         * Array with all label fields drom different tables
         *
-        * @var         array
+        * @var array
         */
        public $label;
 
        /**
         * Array with all title fields drom different tables
         *
-        * @var         array
+        * @var array
         */
        public $title;
 
index d844586..1dc1cab 100644 (file)
@@ -13,9 +13,9 @@ namespace TYPO3\CMS\Reports\Controller;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Reports controller
- *
  */
 class ReportController extends \TYPO3\CMS\Extbase\Mvc\Controller\ActionController {
 
index 9e6e4a5..07c66e5 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Reports\Report\Status;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Performs several checks about the system's health
  *
index 3993e16..c3781d3 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Reports\Report\Status;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Post processes the warning messages found in about modules.
  *
index 26ec7c2..7b8c8e4 100644 (file)
@@ -13,12 +13,14 @@ namespace TYPO3\CMS\Reports;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Interface for classes which provide a report.
  *
  * @author Ingo Renner <ingo@typo3.org>
  */
 interface ReportInterface {
+
        /**
         * Returns the content for a report
         *
index 6340e43..a033df8 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Reports;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * A class representing a certain status
  *
@@ -25,6 +26,7 @@ class Status {
        const OK = 0;
        const WARNING = 1;
        const ERROR = 2;
+
        /**
         * @var string
         */
index 810272b..13f9eeb 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Reports\Task;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Additional field to set the notification email address(es) for system health
  * issue notifications.
index 492fbfe..2bbab62 100644 (file)
@@ -13,9 +13,9 @@ namespace TYPO3\CMS\Reports\ViewHelpers;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Render an item of the menu
- *
  */
 class ActionMenuItemViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper {
 
index 5c3d6b0..67a09f2 100644 (file)
@@ -13,9 +13,9 @@ namespace TYPO3\CMS\Reports\ViewHelpers;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Render the icon of a report
- *
  */
 class IconViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper {
 
index 0fb31c7..147be68 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Rsaauth\Backend;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class contains an abstract SSL backend for the TYPO3 RSA authentication
  * service.
index 72a8bd5..2cba73e 100644 (file)
@@ -18,6 +18,7 @@ namespace TYPO3\CMS\Rsaauth\Backend;
  * Class AjaxLoginHandler
  */
 class AjaxLoginHandler {
+
        /**
         * Gets RSA Public Key.
         *
@@ -26,7 +27,7 @@ class AjaxLoginHandler {
         * @return void
         */
        public function getRsaPublicKey(array $parameters, \TYPO3\CMS\Core\Http\AjaxRequestHandler $parent) {
-               $backend = \TYPO3\CMS\Rsaauth\Backend\BackendFactory::getBackend();
+               $backend = BackendFactory::getBackend();
                if ($backend !== NULL) {
                        $keyPair = $backend->createNewKeyPair();
                        $storage = \TYPO3\CMS\Rsaauth\Storage\StorageFactory::getStorage();
index 27f6252..6ac602d 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Rsaauth\Backend;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class contains a factory for the RSA backends.
  *
@@ -62,7 +63,7 @@ class BackendFactory {
                        foreach (self::$availableBackends as $backend) {
                                $backendObject = \TYPO3\CMS\Core\Utility\GeneralUtility::getUserObj($backend);
                                // Check that it is derived from the proper base class
-                               if ($backendObject instanceof \TYPO3\CMS\Rsaauth\Backend\AbstractBackend) {
+                               if ($backendObject instanceof AbstractBackend) {
                                        /** @var $backendObject \TYPO3\CMS\Rsaauth\Backend\AbstractBackend */
                                        if ($backendObject->isAvailable()) {
                                                // The backend is available, save it and stop the loop
index 4bd71cd..c15041e 100644 (file)
@@ -23,7 +23,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  *
  * @author Dmitry Dulepov <dmitry@typo3.org>
  */
-class CommandLineBackend extends \TYPO3\CMS\Rsaauth\Backend\AbstractBackend {
+class CommandLineBackend extends AbstractBackend {
+
        /**
         * @var int
         */
index 9eb7c03..775fa78 100644 (file)
@@ -21,7 +21,7 @@ namespace TYPO3\CMS\Rsaauth\Backend;
  *
  * @author Dmitry Dulepov <dmitry@typo3.org>
  */
-class PhpBackend extends \TYPO3\CMS\Rsaauth\Backend\AbstractBackend {
+class PhpBackend extends AbstractBackend {
        /**
         * Creates a new key pair for the encryption or gets the existing key pair (if one already has been generated).
         *
index 8d0de3b..764cfb5 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Rsaauth;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class contains a hook to the backend warnings collection. It checks
  * RSA configuration and create a warning if the configuration is wrong.
index 9d92089..d61ec5e 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Rsaauth\Hook;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class contains a hook to implement RSA authentication for the TYPO3
  * Frontend. Warning: felogin must be USER_INT for this to work!
index 3e7f577..39ec7bf 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Rsaauth\Hook;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class provides a hook to the login form to add extra javascript code
  * and supply a proper form tag.
index 1bc2949..6ba9821 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Rsaauth\Hook;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class provides a hook to the login form to add extra javascript code
  * and supply a proper form tag.
index efd783a..358bec4 100644 (file)
@@ -21,6 +21,7 @@ namespace TYPO3\CMS\Rsaauth;
  * @author Dmitry Dulepov <dmitry@typo3.org>
  */
 class Keypair implements \TYPO3\CMS\Core\SingletonInterface {
+
        /**
         * RSA public exponent (3 or 0x10001)
         *
index 95bca6b..43cbe9d 100644 (file)
@@ -14,7 +14,6 @@ namespace TYPO3\CMS\Rsaauth;
  * The TYPO3 project - inspiring people to share!
  */
 
-// Include backends
 /**
  * Service "RSA authentication" for the "rsaauth" extension. This service will
  * authenticate a user using hos password encoded with one time public key. It
index 8b3385a..329f731 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Rsaauth\Storage;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class contains a session-based storage for private keys. This storage
  * is not secure enough because its implementation stores keys completely in the
@@ -22,7 +23,7 @@ namespace TYPO3\CMS\Rsaauth\Storage;
  *
  * @author Dmitry Dulepov <dmitry@typo3.org>
  */
-class SessionStorage extends \TYPO3\CMS\Rsaauth\Storage\AbstractStorage {
+class SessionStorage extends AbstractStorage {
 
        /**
         * Creates an instance of this class. It checks and initializes PHP
index d0a35e5..7418171 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Rsaauth\Storage;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class contains a factory for the RSA backends.
  *
index f6dc94b..cb35ae3 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Saltedpasswords\Evaluation;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Class implementing salted evaluation methods for BE users.
  *
@@ -20,7 +21,7 @@ namespace TYPO3\CMS\Saltedpasswords\Evaluation;
  * @author Steffen Ritter <info@rs-websystems.de>
  * @since 2009-06-14
  */
-class BackendEvaluator extends \TYPO3\CMS\Saltedpasswords\Evaluation\Evaluator {
+class BackendEvaluator extends Evaluator {
 
        /**
         * Class constructor.
index b50d989..16b21ac 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Saltedpasswords\Evaluation;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Class implementing salted evaluation methods.
  *
index 044af51..426c0e8 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Saltedpasswords\Evaluation;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Class implementing salted evaluation methods for FE users.
  *
@@ -20,7 +21,7 @@ namespace TYPO3\CMS\Saltedpasswords\Evaluation;
  * @author Steffen Ritter <info@rs-websystems.de>
  * @since 2009-06-14
  */
-class FrontendEvaluator extends \TYPO3\CMS\Saltedpasswords\Evaluation\Evaluator {
+class FrontendEvaluator extends Evaluator {
 
        /**
         * Class constructor.
index 6f5fb15..08347e7 100644 (file)
@@ -23,22 +23,25 @@ namespace TYPO3\CMS\Saltedpasswords\Salt;
  *
  * @author Marcus Krause <marcus#exp2009@t3sec.info>
  */
-class BlowfishSalt extends \TYPO3\CMS\Saltedpasswords\Salt\Md5Salt {
+class BlowfishSalt extends Md5Salt {
 
        /**
         * The default log2 number of iterations for password stretching.
         */
        const HASH_COUNT = 7;
+
        /**
         * The default maximum allowed log2 number of iterations for
         * password stretching.
         */
        const MAX_HASH_COUNT = 17;
+
        /**
         * The default minimum allowed log2 number of iterations for
         * password stretching.
         */
        const MIN_HASH_COUNT = 4;
+
        /**
         * Keeps log2 number
         * of iterations for password stretching.
index bccaf9e..5d1ff85 100644 (file)
@@ -23,13 +23,14 @@ namespace TYPO3\CMS\Saltedpasswords\Salt;
  *
  * @author Marcus Krause <marcus#exp2009@t3sec.info>
  */
-class Md5Salt extends \TYPO3\CMS\Saltedpasswords\Salt\AbstractSalt implements \TYPO3\CMS\Saltedpasswords\Salt\SaltInterface {
+class Md5Salt extends AbstractSalt implements SaltInterface {
 
        /**
         * Keeps a string for mapping an int to the corresponding
         * base 64 character.
         */
        const ITOA64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
+
        /**
         * Keeps length of a MD5 salt in bytes.
         *
index c1d79b5..45c2597 100644 (file)
@@ -27,27 +27,31 @@ namespace TYPO3\CMS\Saltedpasswords\Salt;
  * @see http://drupal.org/node/29706/
  * @see http://www.openwall.com/phpass/
  */
-class PhpassSalt extends \TYPO3\CMS\Saltedpasswords\Salt\AbstractSalt implements \TYPO3\CMS\Saltedpasswords\Salt\SaltInterface {
+class PhpassSalt extends AbstractSalt implements SaltInterface {
 
        /**
         * Keeps a string for mapping an int to the corresponding
         * base 64 character.
         */
        const ITOA64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
+
        /**
         * The default log2 number of iterations for password stretching.
         */
        const HASH_COUNT = 14;
+
        /**
         * The default maximum allowed log2 number of iterations for
         * password stretching.
         */
        const MAX_HASH_COUNT = 24;
+
        /**
         * The default minimum allowed log2 number of iterations for
         * password stretching.
         */
        const MIN_HASH_COUNT = 7;
+
        /**
         * Keeps log2 number
         * of iterations for password stretching.
index 87ac4c4..989b98d 100644 (file)
@@ -22,6 +22,7 @@ namespace TYPO3\CMS\Saltedpasswords\Salt;
  * @author Steffen Ritter <info@rs-websystems.de>
  */
 interface SaltInterface {
+
        /**
         * Method checks if a given plaintext password is correct by comparing it with
         * a given salted hashed password.
index d7d203a..e9b6b91 100644 (file)
@@ -13,11 +13,10 @@ namespace TYPO3\CMS\Saltedpasswords;
  *
  * The TYPO3 project - inspiring people to share!
  */
-/**
- * Contains authentication service class for salted hashed passwords.
- */
+
 /**
  * Class implements salted-password hashes authentication service.
+ * Contains authentication service class for salted hashed passwords.
  *
  * @author Marcus Krause <marcus#exp2009@t3sec.info>
  * @author Steffen Ritter <info@rs-websystems.de>
index 6e4ae91..3c050b3 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Saltedpasswords\Task;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Additional field for salted passwords bulk update task
  *
index 472776d..cf2e075 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Saltedpasswords\Task;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Update plaintext and hashed passwords of existing users to salted passwords.
  *
index 6941035..ef6e185 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Saltedpasswords\Utility;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 use TYPO3\CMS\Core\Messaging\FlashMessage;
 use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
index f419e94..3cd1c35 100644 (file)
@@ -28,44 +28,51 @@ class AbstractAuthenticationService extends \TYPO3\CMS\Core\Service\AbstractServ
         */
        public $pObj;
 
-       // Subtype of the service which is used to call the service.
        /**
+        * Subtype of the service which is used to call the service.
+        *
         * @var string
         */
        public $mode;
 
-       // Submitted login form data
        /**
+        * Submitted login form data
+        *
         * @var array
         */
        public $login = array();
 
-       // Various data
        /**
+        * Various data
+        *
         * @var array
         */
        public $authInfo = array();
 
-       // User db table definition
        /**
+        * User db table definition
+        *
         * @var array
         */
        public $db_user = array();
 
-       // Usergroups db table definition
        /**
+        * Usergroups db table definition
+        *
         * @var array
         */
        public $db_groups = array();
 
-       // If the writelog() functions is called if a login-attempt has be tried without success
        /**
+        * If the writelog() functions is called if a login-attempt has be tried without success
+        *
         * @var bool
         */
        public $writeAttemptLog = FALSE;
 
-       // If the \TYPO3\CMS\Core\Utility\GeneralUtility::devLog() function should be used
        /**
+        * If the \TYPO3\CMS\Core\Utility\GeneralUtility::devLog() function should be used
+        *
         * @var bool
         */
        public $writeDevLog = FALSE;
index aef6784..0d89c39 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Sv;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class contains a BE login form hook. It adds all necessary JavaScript
  * for the superchallenged authentication.
@@ -32,7 +33,6 @@ class LoginFormHook {
                // Get the code according to the login level
                switch ($pObj->loginSecurityLevel) {
                        case 'challenged':
-
                        case 'superchallenged':
                                $_SESSION['login_challenge'] = $this->getChallenge();
                                $content = '<form action="index.php" method="post" name="loginform" ' . 'onsubmit="doChallengeResponse(' . ($pObj->loginSecurityLevel == 'challenged' ? 0 : 1) . ');">' . '<input type="hidden" name="challenge" value="' . htmlspecialchars($_SESSION['login_challenge']) . '" />';
index 366b0f7..fd43d47 100644 (file)
@@ -24,6 +24,9 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class TaskModuleController extends \TYPO3\CMS\Backend\Module\BaseScriptClass {
 
+       /**
+        * @var array
+        */
        protected $pageinfo;
 
        /**
index 7c6fbc9..7647348 100644 (file)
@@ -27,20 +27,44 @@ use TYPO3\CMS\Backend\Utility\IconUtility;
  */
 class TypoScriptTemplateModuleController extends \TYPO3\CMS\Backend\Module\BaseScriptClass {
 
+       /**
+        * @var string
+        */
        public $perms_clause;
 
+       /**
+        * @var string
+        */
        public $e;
 
+       /**
+        * @var string
+        */
        public $sObj;
 
+       /**
+        * @var string
+        */
        public $edit;
 
+       /**
+        * @var string
+        */
        public $textExtensions = 'html,htm,txt,css,tmpl,inc,js';
 
+       /**
+        * @var string
+        */
        public $modMenu_type = '';
 
+       /**
+        * @var string
+        */
        public $modMenu_dontValidateList = '';
 
+       /**
+        * @var string
+        */
        public $modMenu_setDefaultList = '';
 
        /**