[TASK] EM: cleanup phpDoc and fix type hints
authorXavier Perseguers <xavier@typo3.org>
Tue, 20 Sep 2011 07:45:08 +0000 (09:45 +0200)
committerXavier Perseguers <xavier@typo3.org>
Tue, 20 Sep 2011 08:10:46 +0000 (10:10 +0200)
Add type hints and fix obviously wrong references (missing "tx_"
and wrong case in class name).

Change-Id: I702ccf454d9a547a075537e36a250169442ba1e1
Resolves: #30074
Releases: 4.6
Reviewed-on: http://review.typo3.org/5098
Reviewed-by: Xavier Perseguers
Tested-by: Xavier Perseguers
15 files changed:
typo3/sysext/em/classes/connection/class.tx_em_connection_extdirectserver.php
typo3/sysext/em/classes/import/class.tx_em_import_mirrorlistimporter.php
typo3/sysext/em/classes/index.php
typo3/sysext/em/classes/install/class.tx_em_install.php
typo3/sysext/em/classes/parser/class.tx_em_parser_extensionxmlpullparser.php
typo3/sysext/em/classes/parser/class.tx_em_parser_extensionxmlpushparser.php
typo3/sysext/em/classes/parser/class.tx_em_parser_mirrorxmlpullparser.php
typo3/sysext/em/classes/parser/class.tx_em_parser_mirrorxmlpushparser.php
typo3/sysext/em/classes/parser/class.tx_em_parser_xmlparserfactory.php
typo3/sysext/em/classes/reports/class.tx_em_reports_extensionstatus.php
typo3/sysext/em/classes/repository/class.tx_em_repository.php
typo3/sysext/em/classes/repository/class.tx_em_repository_mirrors.php
typo3/sysext/em/classes/repository/class.tx_em_repository_utility.php
typo3/sysext/em/classes/settings/class.tx_em_settings.php
typo3/sysext/em/classes/tools/class.tx_em_tools_xmlhandler.php

index 2c3a8d2..a62ed0e 100644 (file)
@@ -60,6 +60,9 @@ class tx_em_Connection_ExtDirectServer {
         */
        static protected $objSettings;
 
+       /**
+        * @var array
+        */
        protected $globalSettings;
 
        /*********************************************************************/
@@ -84,7 +87,7 @@ class tx_em_Connection_ExtDirectServer {
         * Method returns instance of settings class.
         *
         * @access  protected
-        * @return  em_settings  instance of settings class
+        * @return  tx_em_Settings  instance of settings class
         */
        protected function getSettingsObject() {
                if (!is_object(self::$objSettings) && !(self::$objSettings instanceof tx_em_Settings)) {
@@ -165,7 +168,7 @@ class tx_em_Connection_ExtDirectServer {
        }
 
        /**
-        * Render extensionlist for languages
+        * Render extension list for languages
         *
         * @param object $parameters
         * @return array
@@ -316,7 +319,6 @@ class tx_em_Connection_ExtDirectServer {
                $tsStyleConfig->ext_procesInput($parameter, array(), $theConstants, array());
                $arr = $tsStyleConfig->ext_mergeIncomingWithExisting($arr);
 
-
                /** @var $install tx_em_Install */
                $install = t3lib_div::makeInstance('tx_em_Install');
                $install->setSilentMode(TRUE);
@@ -374,7 +376,7 @@ class tx_em_Connection_ExtDirectServer {
                $type = $list[$extKey]['type'];
                $absPath = tx_em_Tools::getExtPath($extKey, $type);
 
-               /** @var $extensionDetails tx_em_Install */
+               /** @var $install tx_em_Install */
                $install = t3lib_div::makeInstance('tx_em_Install');
                $install->setSilentMode(TRUE);
 
@@ -396,7 +398,7 @@ class tx_em_Connection_ExtDirectServer {
        }
 
        /**
-        * genereates a file tree
+        * generates a file tree
         *
         * @param object $parameter
         * @return array
@@ -411,8 +413,6 @@ class tx_em_Connection_ExtDirectServer {
                $dirs = t3lib_div::get_dirs($path);
                $files = t3lib_div::getFilesInDir($path, '', FALSE, '', '');
 
-
-
                if (!is_array($dirs) && !is_array($files)) {
                        return array();
                }
@@ -428,7 +428,6 @@ class tx_em_Connection_ExtDirectServer {
                        }
                }
 
-
                foreach ($files as $key => $file) {
                        $fileInfo = $this->getFileInfo($file);
 
@@ -613,9 +612,10 @@ class tx_em_Connection_ExtDirectServer {
         * @return array
         */
        public function makeDiff($original, $content) {
+               /** @var $diff t3lib_diff */
                $diff = t3lib_div::makeInstance('t3lib_diff');
                $result = $diff->makeDiffDisplay($original, $content);
-               //debug(array($original, $content, $result));
+
                return array(
                        'success' => TRUE,
                        'diff' => '<pre>' . $result . '</pre>'
@@ -662,7 +662,7 @@ class tx_em_Connection_ExtDirectServer {
                /** @var $extensionDetails tx_em_Extensions_Details */
                $this->extensionDetails = t3lib_div::makeInstance('tx_em_Extensions_Details', $this);
 
-               /** @var $terConnection  tx_em_Connection_Ter*/
+               /** @var $terConnection tx_em_Connection_Ter */
                $terConnection = t3lib_div::makeInstance('tx_em_Connection_Ter', $this);
                $terConnection->wsdlURL = $wsdlURL;
 
@@ -699,7 +699,7 @@ class tx_em_Connection_ExtDirectServer {
         * @return string
         */
        public function getExtensionDevelopInfo($extKey) {
-               /** @var $extensionList  tx_em_Extensions_List*/
+               /** @var $extensionList tx_em_Extensions_List */
                $extensionList = t3lib_div::makeInstance('tx_em_Extensions_List', $this);
                list($list,) = $extensionList->getInstalledExtensions();
                /** @var $extensionDetails tx_em_Extensions_Details */
@@ -708,16 +708,15 @@ class tx_em_Connection_ExtDirectServer {
                return $extensionDetails->extInformationarray($extKey, $list[$extKey]);
        }
 
-
        /**
-        * Prints backupdelete
+        * Prints backup delete
         *
         * @param string $parameter
         * @return string
         */
        public function getExtensionBackupDelete($extKey) {
-               $content='';
-          /** @var $extensionList  tx_em_Extensions_List*/
+               $content = '';
+               /** @var $extensionList tx_em_Extensions_List */
                $extensionList = t3lib_div::makeInstance('tx_em_Extensions_List', $this);
                /** @var $extensionDetails tx_em_Extensions_Details */
                $extensionDetails = t3lib_div::makeInstance('tx_em_Extensions_Details');
@@ -728,7 +727,6 @@ class tx_em_Connection_ExtDirectServer {
                /** @var $api tx_em_API */
                $api = t3lib_div::makeInstance('tx_em_API');
 
-
                list($list,) = $extensionList->getInstalledExtensions();
                $uploadArray = $extensionDetails->makeUploadarray($extKey, $list[$extKey]);
 
@@ -883,7 +881,7 @@ class tx_em_Connection_ExtDirectServer {
                                'data' => array(),
                        );
                } elseif ($search === '*') {
-
+                       // Nothing to do
                } else {
                        $quotedSearch = $GLOBALS['TYPO3_DB']->escapeStrForLike(
                                $GLOBALS['TYPO3_DB']->quoteStr($search, 'cache_extensions'),
@@ -1015,10 +1013,10 @@ class tx_em_Connection_ExtDirectServer {
                $objRepository = t3lib_div::makeInstance('tx_em_Repository', $parameter->repository);
 
                if ($objRepository->getMirrorListUrl()) {
+                       /** @var $objRepositoryUtility tx_em_Repository_Utility */
                        $objRepositoryUtility = t3lib_div::makeInstance('tx_em_Repository_Utility', $objRepository);
                        $mirrors = $objRepositoryUtility->getMirrors(TRUE)->getMirrors();
 
-
                        if (count($mirrors)) {
                                $data = array(
                                        array(
@@ -1095,7 +1093,6 @@ class tx_em_Connection_ExtDirectServer {
                }
        }
 
-
        /**
         * Delete repository
         *
@@ -1116,14 +1113,14 @@ class tx_em_Connection_ExtDirectServer {
                                'uid' => intval($uid)
                        );
        }
+
        /**
         * Update repository
         *
-        * @param array $parameter
+        * @param integer $repositoryId
         * @return array
         */
        public function repositoryUpdate($repositoryId) {
-
                if (!intval($repositoryId)) {
                        return array(
                                'success' => FALSE,
@@ -1268,7 +1265,6 @@ class tx_em_Connection_ExtDirectServer {
                        $terConnection = t3lib_div::makeInstance('tx_em_Connection_Ter', $this);
                        /** @var $xmlHandler tx_em_Tools_XmlHandler */
                        $this->xmlHandler = t3lib_div::makeInstance('tx_em_Tools_XmlHandler');
-                       $this->xmlHandler->emObj = $this;
                        $mirrorURL = $this->getSettingsObject()->getMirrorURL();
 
                        $infoIcon = '<span class="t3-icon t3-icon-actions t3-icon-actions-document t3-icon-document-info">&nbsp;</span>';
index 360fbd9..4f66517 100644 (file)
@@ -79,17 +79,18 @@ class tx_em_Import_MirrorListImporter implements SplObserver {
        }
 
        /**
-        * Method collects mirrors' details and returns instance of em_repository_mirrors
+        * Method collects mirrors' details and returns instance of tx_em_Repository_Mirrors
         * with retrieved details.
         *
         * @access  public
-        * @param   string  $localMirrorListFile  bsolute path to (gzipped) local mirror list xml file
-        * @return  em_repository_mirrors
+        * @param   string  $localMirrorListFile  absolute path to (gzipped) local mirror list xml file
+        * @return  tx_em_Repository_Mirrors
         */
        public function getMirrors($localMirrorListFile) {
                $zlibStream = 'compress.zlib://';
 
                $this->parser->parseXML($zlibStream . $localMirrorListFile);
+               /** @var $objRepositoryMirrors tx_em_Repository_Mirrors */
                $objRepositoryMirrors = t3lib_div::makeInstance('tx_em_Repository_Mirrors');
                $objRepositoryMirrors->setMirrors($this->arrTmpMirrors);
                $this->arrTmpMirrors = array();
index f102942..edbc4f1 100644 (file)
@@ -74,6 +74,8 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
 
        var $states = array(); // Extension States; see init()
 
+       var $typeDescr = array();
+
        var $detailCols = array(
                0 => 2,
                1 => 5,
@@ -123,7 +125,6 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
         */
        public $terConnection;
 
-
        /**
         * XML handling class for the TYPO3 Extension Manager
         *
@@ -131,7 +132,6 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
         */
        public $xmlHandler;
 
-
        /**
         * Class for printing extension lists
         *
@@ -174,8 +174,22 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
         */
        public $settings;
 
+       /**
+        * @var string
+        */
+       protected $excludeForPackaging;
 
-       var $JScode; // JavaScript code to be forwared to $this->doc->JScode
+       /**
+        * @var string
+        */
+       protected $listRemote_search;
+
+       /**
+        * @var string
+        */
+       protected $descrTable;
+
+       var $JScode; // JavaScript code to be forwarded to $this->doc->JScode
 
        // GPvars:
        var $CMD = array(); // CMD array
@@ -225,6 +239,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                                '<br /><br />' . sprintf($GLOBALS['LANG']->getLL('security_descr'),
                        '<a href="http://typo3.org/teams/security/" target="_blank">', '</a>'
                );
+               /** @var $flashMessage t3lib_FlashMessage */
                $flashMessage = t3lib_div::makeInstance(
                        't3lib_FlashMessage',
                        $securityMessage,
@@ -276,7 +291,6 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
 
 
                $this->xmlHandler = t3lib_div::makeInstance('tx_em_Tools_XmlHandler');
-               $this->xmlHandler->emObj = $this;
                $this->xmlHandler->useObsolete = $this->MOD_SETTINGS['display_obsolete'];
 
 
@@ -414,7 +428,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
         *
         * @return      void
         */
-       function main() {
+       public function main() {
 
                $menu = '';
 
@@ -856,7 +870,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
        /**
         * Generates a link to the next page of extensions
         *
-        * @return      void
+        * @return string
         */
        function browseLinks() {
                $content = '';
@@ -897,7 +911,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
        /**
         * Allows changing of settings
         *
-        * @return      void
+        * @return string
         */
        function alterSettings() {
                $content = '';
@@ -989,13 +1003,6 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                return $content;
        }
 
-       /**
-        * Allows to set the translation preferences and check the status
-        *
-        * @return      void
-        */
-
-
        /*********************************
         *
         * Command Applications (triggered by GET var)
@@ -1095,7 +1102,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
         *
         * @param       string          Type of data to fetch: (mirrors)
         * @param       boolean         If TRUE the method doesn't produce any output
-        * @return      void
+        * @return      string
         */
        function fetchMetaData($metaType) {
                $content = '';
@@ -1135,6 +1142,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                                $mirror = $this->getMirrorURL();
                                $extfile = $mirror . 'extensions.xml.gz';
                                $extmd5 = t3lib_div::getUrl($mirror . 'extensions.md5', 0, array(TYPO3_user_agent));
+                               $localmd5 = '';
                                if (is_file(PATH_site . 'typo3temp/extensions.xml.gz')) {
                                        $localmd5 = md5_file(PATH_site . 'typo3temp/extensions.xml.gz');
                                }
@@ -1149,6 +1157,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                                                        ) .
                                                        $GLOBALS['LANG']->getLL('translation_problems') . '</p>';
                                } elseif ($extmd5 == $localmd5 && $cacheCount) {
+                                       /** @var $flashMessage t3lib_FlashMessage */
                                        $flashMessage = t3lib_div::makeInstance(
                                                't3lib_FlashMessage',
                                                $GLOBALS['LANG']->getLL('ext_import_list_unchanged'),
@@ -1368,6 +1377,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                                        if (!is_uploaded_file($_FILES['upload_ext_file']['tmp_name'])) {
                                                t3lib_div::sysLog('Possible file upload attack: ' . $_FILES['upload_ext_file']['tmp_name'], 'Extension Manager', 3);
 
+                                               /** @var $flashMessage t3lib_FlashMessage */
                                                $flashMessage = t3lib_div::makeInstance(
                                                        't3lib_FlashMessage',
                                                        $GLOBALS['LANG']->getLL('ext_import_file_not_uploaded'),
@@ -1468,6 +1478,8 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
         * @return      void            Writes content to $this->content
         */
        function showExtDetails($extKey) {
+               $theOutput = '';
+               $dependencyUpdates = '';
                list($list,) = $this->extensionList->getInstalledExtensions();
                $absPath = tx_em_Tools::getExtPath($extKey, $list[$extKey]['type']);
 
@@ -1771,6 +1783,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                                                                        $this->kbMax
                                                                )
                                                        );
+                                                       $this->content .= $theOutput;
                                                }
                                        }
                                } else {
@@ -1844,6 +1857,8 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                                                break;
                                        case 'upload':
                                                $em = t3lib_div::_POST('em');
+                                               $headline = '';
+                                               $eC = 0;
                                                if ($em['action'] == 'doUpload') {
                                                        $em['extKey'] = $extKey;
                                                        $em['extInfo'] = $list[$extKey];
@@ -1865,6 +1880,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                                                                $eC = 2;
                                                        }
                                                        if (!$this->fe_user['username']) {
+                                                               /** @var $flashMessage t3lib_FlashMessage */
                                                                $flashMessage = t3lib_div::makeInstance(
                                                                        't3lib_FlashMessage',
                                                                        sprintf($GLOBALS['LANG']->getLL('ext_details_no_username'),
@@ -2470,7 +2486,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                $content = '<div class="em-repupdate"><strong>Repository:</strong>';
 
                // print registered repositories
-               /* @var $settings em_settings */
+               /** @var $settings tx_em_Settings */
                $settings = t3lib_div::makeInstance('tx_em_Settings');
                $registeredRepos = $settings->getRegisteredRepositories();
                $content .= '<select>';
@@ -2480,7 +2496,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
                $content .= '</select>';
 
                $selectedRepo = $settings->getSelectedRepository();
-               /* @var $repoUtility em_repository_utility */
+               /** @var $repoUtility tx_em_Repository_Utility */
                $repoUtility = t3lib_div::makeInstance('tx_em_Repository_Utility');
                $repoUtility->setRepository($selectedRepo);
 
@@ -2556,7 +2572,7 @@ class SC_mod_tools_em_index extends t3lib_SCbase {
        /* Compatibility wrappers */
 
 
-/**
+       /**
         * Returns the absolute path where the extension $extKey is installed (based on 'type' (SGL))
         *
         * @param       string          Extension key
@@ -2579,6 +2595,7 @@ if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLA
 
 
 // Make instance:
+/** @var $SOBE SC_mod_tools_em_index */
 $SOBE = t3lib_div::makeInstance('SC_mod_tools_em_index');
 $SOBE->init();
 foreach ($SOBE->include_once as $INC_FILE) {
index 5bc5775..0ce4be6 100644 (file)
@@ -853,7 +853,7 @@ class tx_em_Install {
                                                        $hookObject = t3lib_div::getUserObj($classData);
 
                                                        if (!($hookObject instanceof tx_em_Index_CheckDatabaseUpdatesHook)) {
-                                                               throw new UnexpectedValueException('$hookObject must implement interface em_index_checkDatabaseUpdatesHook', 1288418476);
+                                                               throw new UnexpectedValueException('$hookObject must implement interface tx_em_Index_CheckDatabaseUpdatesHook', 1288418476);
                                                        }
 
                                                        /* @var $hookObject tx_em_Index_CheckDatabaseUpdatesHook */
index c2e4862..a4e556c 100644 (file)
@@ -45,7 +45,7 @@ class tx_em_Parser_ExtensionXmlPullParser extends tx_em_Parser_ExtensionXmlAbstr
        /**
         * Keeps list of attached observers.
         *
-        * @var  array
+        * @var  SplObserver[]
         */
        protected $observers = array();
 
@@ -67,7 +67,7 @@ class tx_em_Parser_ExtensionXmlPullParser extends tx_em_Parser_ExtensionXmlAbstr
         *
         * @param   string  $file: GZIP stream resource
         * @return  void
-        * @throws  em_extensionxml_Exception  in case of XML parser errors
+        * @throws  tx_em_ExtensionXmlException  in case of XML parser errors
         */
        public function parseXML($file) {
                if (!(is_object($this->objXML) && (get_class($this->objXML) == 'XMLReader'))) {
index 9ae7d81..f26d503 100644 (file)
@@ -55,6 +55,13 @@ class tx_em_Parser_ExtensionXmlPushParser extends tx_em_Parser_ExtensionXmlAbstr
        protected $element = NULL;
 
        /**
+        * Keeps list of attached observers.
+        *
+        * @var  SplObserver[]
+        */
+       protected $observers = array();
+
+       /**
         * Class constructor.
         *
         * @return void
index 3238566..6fd32ea 100644 (file)
@@ -51,7 +51,7 @@ class tx_em_Parser_MirrorXmlPullParser extends tx_em_Parser_MirrorXmlAbstractPar
        /**
         * Keeps list of attached observers.
         *
-        * @var  array
+        * @var  SplObserver[]
         */
        protected $observers = array();
 
@@ -76,7 +76,7 @@ class tx_em_Parser_MirrorXmlPullParser extends tx_em_Parser_MirrorXmlAbstractPar
         * @access  public
         * @param   string  $file  file resource, typically a stream
         * @return  void
-        * @throws  em_mirrorxml_Exception  in case of XML parser errors
+        * @throws  tx_em_MirrorXmlException  in case of XML parser errors
         */
        public function parseXML($file) {
                if (!(is_object($this->objXML) && (get_class($this->objXML) == 'XMLReader'))) {
index 41882f2..fd9c7f9 100644 (file)
@@ -55,7 +55,7 @@ class tx_em_Parser_MirrorXmlPushParser extends tx_em_Parser_MirrorXmlAbstractPar
        /**
         * Keeps list of attached observers.
         *
-        * @var  array
+        * @var  SplObserver[]
         */
        protected $observers = array();
 
@@ -79,7 +79,7 @@ class tx_em_Parser_MirrorXmlPushParser extends tx_em_Parser_MirrorXmlAbstractPar
         *
         * @param   string  $file: GZIP stream resource
         * @return  void
-        * @throws  em_mirrorxml_Exception  in case of XML parser errors
+        * @throws  tx_em_MirrorXmlException  in case of XML parser errors
         */
        public function parseXML($file) {
 
index 5c99a8d..ac17319 100644 (file)
@@ -77,14 +77,14 @@ class tx_em_Parser_XmlParserFactory {
         * Obtains a xml parser instance.
         *
         * This function will return an instance of a class that implements
-        * em_extensionxml_abstract_parser.
+        * tx_em_ExtensionXml_Abstract_Parser.
         *
         * TODO use autoload if possible (might require EM to be moved in a sysext)
         *
         * @access  public
         * @param   string        $parserType: type of parser, one of extension and mirror
         * @param       string          $excludeClassNames: (optional) comma-separated list of class names
-        * @return      em_extensionxml_abstract_parser an instance of an extension.xml parser
+        * @return      tx_em_ExtensionXml_Abstract_Parser      an instance of an extension.xml parser
         */
        static public function getParserInstance($parserType, $excludeClassNames = '') {
                if (!isset(self::$instance[$parserType]) || !is_object(self::$instance[$parserType]) || !empty($excludeClassNames)) {
@@ -92,7 +92,6 @@ class tx_em_Parser_XmlParserFactory {
                        self::$instance[$parserType] = $objParser = NULL;
                        foreach (self::$parsers[$parserType] as $className => $file) {
                                if (!t3lib_div::inList($excludeClassNames, $className)) {
-                                       //require_once(dirname(__FILE__) . '/' . $file);
                                        $objParser = t3lib_div::makeInstance($className);
                                        if ($objParser->isAvailable()) {
                                                self::$instance[$parserType] = &$objParser;
index d8c2cd3..edf6b27 100644 (file)
@@ -46,7 +46,7 @@ class tx_em_reports_ExtensionStatus  implements tx_reports_StatusProvider {
         * Determines the status of extension manager
         *
         * @return      array   List of statuses
-        * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()
+        * @see tx_reports_StatusProvider::getStatus()
         */
        public function getStatus() {
                $this->ok = $GLOBALS['LANG']->sL('LLL:EXT:em/language/locallang.xml:msg_ok');
index 5eb8cb9..0edd2a4 100644 (file)
@@ -82,7 +82,7 @@ class tx_em_Repository {
        /**
         * Keeps repository mirrors object.
         *
-        * @var  em_repository_mirrors
+        * @var  tx_em_Repository_Mirrors
         */
        protected $mirrors;
 
@@ -249,12 +249,12 @@ class tx_em_Repository {
        }
 
        /**
-        * Method sets URL of a ressource that contains repository mirrors.
+        * Method sets URL of a resource that contains repository mirrors.
         *
         * Parameter is typically a remote gzipped xml file.
         *
         * @access  public
-        * @param   string  $url  URL of file that contains repository mirros
+        * @param   string  $url  URL of file that contains repository mirrors
         * @return  void
         * @see  $mirrorListUrl, getMirrorListUrl()
         */
@@ -314,7 +314,7 @@ class tx_em_Repository {
         * Method returns extension count
         *
         * @access  public
-        * @return  int count of readed extensions
+        * @return  int count of read extensions
         */
        public function getExtensionCount() {
                return $this->extensionCount;
@@ -324,7 +324,7 @@ class tx_em_Repository {
         * Method sets extension count
         *
         * @access  public
-        * @param   string  $count count of readed extensions
+        * @param   string  $count count of read extensions
         * @return  void
         */
        public function setExtensionCount($count) {
@@ -337,7 +337,7 @@ class tx_em_Repository {
         * Repository mirrors object is passed by reference.
         *
         * @access  public
-        * @param   em_repository_mirrors  &$mirrors  instance of {@link em_repository_mirrors repository mirrors} class
+        * @param   tx_em_Repository_Mirrors  &$mirrors  instance of {@link tx_em_Repository_Mirrors repository mirrors} class
         * @return  void
         * @see  $mirrors, getMirrors(), hasMirrors(), removeMirrors()
         */
@@ -365,7 +365,7 @@ class tx_em_Repository {
         * Method returns a repository mirrors object.
         *
         * @access  public
-        * @return  em_repository_mirrors  registered instance of {@link em_repository_mirrors repository mirrors} class or NULL
+        * @return  tx_em_Repository_Mirrors  registered instance of {@link tx_em_Repository_Mirrors repository mirrors} class or NULL
         * @see  $mirrors, addMirrors(), hasMirrors(), removeMirrors()
         */
        public function getMirrors() {
index 34b25a9..543ce89 100644 (file)
@@ -68,16 +68,6 @@ class tx_em_Repository_Mirrors {
        protected $isRandomSelection = TRUE;
 
        /**
-        * Class constructor.
-        *
-        * @access  public
-        * @return  void
-        */
-       function __construct() {
-               // empty constructor
-       }
-
-       /**
         * Method selects one specific mirror to be used.
         *
         * @access  public
index 34d7ec0..9e23684 100644 (file)
@@ -75,7 +75,7 @@ class tx_em_Repository_Utility implements t3lib_Singleton {
        /**
         * Keeps instance of repository class.
         *
-        * @var em_repository
+        * @var tx_em_Repository
         */
        protected $repository = NULL;
 
@@ -84,7 +84,7 @@ class tx_em_Repository_Utility implements t3lib_Singleton {
         * Class constructor.
         *
         * @access  public
-        * @param   object  &$repository  (optional) instance of {@link em_repository repository} class
+        * @param   object  &$repository  (optional) instance of {@link tx_em_Repository repository} class
         * @return  void
         */
        function __construct(&$repository = NULL) {
@@ -113,7 +113,7 @@ class tx_em_Repository_Utility implements t3lib_Singleton {
         * Repository instance is passed by reference.
         *
         * @access  public
-        * @param   em_repository  &$repository  instance of {@link em_repository repository} class
+        * @param   tx_em_Repository  &$repository  instance of {@link tx_em_Repository repository} class
         * @return  void
         * @see  $repository
         */
@@ -247,7 +247,7 @@ class tx_em_Repository_Utility implements t3lib_Singleton {
         *
         * @access  public
         * @param   boolean  $forcedUpdateFromRemote  if boolean TRUE, mirror configuration will always retrieved from remote server
-        * @return  em_repository_mirrors  instance of repository mirrors class
+        * @return  tx_em_Repository_Mirrors  instance of repository mirrors class
         */
        public function getMirrors($forcedUpdateFromRemote = TRUE) {
                $assignedMirror = $this->repository->getMirrors();
@@ -255,6 +255,7 @@ class tx_em_Repository_Utility implements t3lib_Singleton {
                        if ($forcedUpdateFromRemote || !is_file($this->getLocalMirrorListFile())) {
                                $this->fetchMirrorListFile();
                        }
+                       /** @var $objMirrorListImporter tx_em_Import_MirrorListImporter */
                        $objMirrorListImporter = t3lib_div::makeInstance('tx_em_Import_MirrorListImporter');
                        $this->repository->addMirrors($objMirrorListImporter->getMirrors($this->getLocalMirrorListFile()));
                }
@@ -266,9 +267,9 @@ class tx_em_Repository_Utility implements t3lib_Singleton {
         * extension list might be outdated.
         *
         * @access  public
-        * @see  em_repository_utility::PROBLEM_NO_VERSIONS_IN_DATABASE,
-        *                em_repository_utility::PROBLEM_EXTENSION_FILE_NOT_EXISTING,
-        *                em_repository_utility::PROBLEM_EXTENSION_HASH_CHANGED
+        * @see  tx_em_Repository_Utility::PROBLEM_NO_VERSIONS_IN_DATABASE,
+        *                tx_em_Repository_Utility::PROBLEM_EXTENSION_FILE_NOT_EXISTING,
+        *                tx_em_Repository_Utility::PROBLEM_EXTENSION_HASH_CHANGED
         * @return  integer  integer "0" if everything is perfect, otherwise bitmask with occured problems
         * @see  updateExtList()
         */
index 808166d..60fad1e 100644 (file)
@@ -221,10 +221,11 @@ class tx_em_Settings implements t3lib_Singleton {
         * Registered repositories are global (per installation) settings.
         *
         * @access  public
-        * @return  array of {@link em_repository em_repository} instances
+        * @return  array of {@link tx_em_Repository tx_em_Repository} instances
         * @see  registerDefaultRepository(), setRegisteredRepositories()
         */
        public function getRegisteredRepositories() {
+               /** @var $registry t3lib_Registry */
                $registry = t3lib_div::makeInstance('t3lib_Registry');
                $regRepos = $registry->get('core', 'em.repositories.registered');
 
@@ -256,20 +257,22 @@ class tx_em_Settings implements t3lib_Singleton {
         * Registered repositories are global (per installation) settings.
         *
         * @access  public
-        * @param   array  $repositories  array of {@link em_repository em_repository} instances
+        * @param   array  $repositories  array of {@link tx_em_Repository tx_em_Repository} instances
         * @see  registerDefaultRepository(), setRegisteredRepositories()
-        * @throws  InvalidArgumentException in case argument contains no instances of {@link em_repository em_repository}
+        * @throws  InvalidArgumentException in case argument contains no instances of {@link tx_em_Repository tx_em_Repository}
         */
        public function setRegisteredRepositories(array $repositories) {
                // removing mirror instances
                foreach ($repositories as $repository) {
-                       if ($repository instanceof em_repository) {
+                       if ($repository instanceof tx_em_Repository) {
+                               /** @var $repository tx_em_Repository */
                                $repository->removeMirrors();
                        } else {
-                               throw new InvalidArgumentException(get_class($this) . ': ' . 'No valid instances of em_repository given.');
+                               throw new InvalidArgumentException(get_class($this) . ': ' . 'No valid instances of tx_em_Repository given.', 1316504665);
                        }
                }
                if (count($repositories)) {
+                       /** @var $registry t3lib_Registry */
                        $registry = t3lib_div::makeInstance('t3lib_Registry');
                        $registry->set('core', 'em.repositories.registered', $repositories);
                }
@@ -281,7 +284,7 @@ class tx_em_Settings implements t3lib_Singleton {
         * Selected repository is local (per user) settings.
         *
         * @access  public
-        * @return  em_repository  repository instance that is currently selected by a BE user
+        * @return  tx_em_Repository  repository instance that is currently selected by a BE user
         * @see  setSelectedRepository()
         */
        public function getSelectedRepository() {
@@ -295,10 +298,10 @@ class tx_em_Settings implements t3lib_Singleton {
         *
         * @todo        STUB, implementation missing
         * @access  public
-        * @param   em_repository  $repository  repository instance that is currently selected by a BE user
+        * @param   tx_em_Repository  $repository  repository instance that is currently selected by a BE user
         * @see  getSelectedRepository()
         */
-       public function setSelectedRepository(em_repository $repository) {
+       public function setSelectedRepository(tx_em_Repository $repository) {
                // this method would set sth. like "REPOSITORY_TITLE:INT" in a setting field
                // REPOSITORY_TITLE = example: main
                // INT = 0 means randomly selected mirror, >0 selects specific mirror
index ac82161..08368e0 100644 (file)
@@ -37,7 +37,6 @@
  */
 class tx_em_Tools_XmlHandler {
 
-
        /**
         * Holds the parsed XML from extensions.xml.gz
         * @see parseExtensionsXML()