[+TASK] Extbase: Replaced "public static" by "static public" in various places to...
authorBastian Waidelich <bastian@typo3.org>
Wed, 10 Nov 2010 19:05:49 +0000 (19:05 +0000)
committerBastian Waidelich <bastian@typo3.org>
Wed, 10 Nov 2010 19:05:49 +0000 (19:05 +0000)
[+TASK] Extbase: Marked Utitlity_Extension camelCase/underscore helper functions deprecated
[+TASK] Extbase: Removed obsolete FIXME comments, whitespace fixes

typo3/sysext/extbase/Classes/Dispatcher.php
typo3/sysext/extbase/Classes/MVC/Request.php
typo3/sysext/extbase/Classes/MVC/Web/FrontendRequestHandler.php
typo3/sysext/extbase/Classes/Persistence/Mapper/DataMapFactory.php
typo3/sysext/extbase/Classes/Persistence/Mapper/DataMapper.php
typo3/sysext/extbase/Classes/Utility/ClassLoader.php
typo3/sysext/extbase/Classes/Utility/Extension.php
typo3/sysext/extbase/Classes/Utility/Localization.php
typo3/sysext/extbase/Classes/Utility/TypoScript.php

index 3eeb864..d888046 100644 (file)
@@ -71,7 +71,7 @@ class Tx_Extbase_Dispatcher {
         * @return Tx_Extbase_Configuration_Manager An instance of the Configuration Manager
         * @deprecated since Extbase 1.3.0; will be removed in Extbase 1.5.0
         */
-       public static function getConfigurationManager() {
+       static public function getConfigurationManager() {
                t3lib_div::logDeprecatedFunction();
                return self::$configurationManager;
        }
@@ -82,7 +82,7 @@ class Tx_Extbase_Dispatcher {
         * @return Tx_Extbase_Persistence_Manager An instance of the Persistence Manager
         * @deprecated since Extbase 1.3.0; will be removed in Extbase 1.5.0
         */
-       public static function getPersistenceManager() {
+       static public function getPersistenceManager() {
                t3lib_div::logDeprecatedFunction();
                return self::$persistenceManager;
        }
@@ -93,7 +93,7 @@ class Tx_Extbase_Dispatcher {
         * @return array The configuration for the Extbase framework
         * @deprecated since Extbase 1.3.0; will be removed in Extbase 1.5.0
         */
-       public static function getExtbaseFrameworkConfiguration() {
+       static public function getExtbaseFrameworkConfiguration() {
                t3lib_div::logDeprecatedFunction();
                return self::$configurationManager->getConfiguration(Tx_Extbase_Configuration_ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
        }
index 3487d91..e4d4484 100644 (file)
@@ -215,7 +215,7 @@ class Tx_Extbase_MVC_Request implements Tx_Extbase_MVC_RequestInterface {
         * @api
         */
        public function getControllerExtensionKey() {
-               return Tx_Extbase_Utility_Extension::convertCamelCaseToLowerCaseUnderscored($this->controllerExtensionName);
+               return t3lib_div::camelCaseToLowerCaseUnderscored($this->controllerExtensionName);
        }
 
        /**
index 161f2dc..9888e32 100644 (file)
@@ -52,7 +52,7 @@ class Tx_Extbase_MVC_Web_FrontendRequestHandler extends Tx_Extbase_MVC_Web_Abstr
                                if ($this->cObj->getUserObjectType() === tslib_cObj::OBJECTTYPE_USER) {
                                        $this->cObj->convertToUserIntObject();
                                        // tslib_cObj::convertToUserIntObject() will recreate the object, so we have to stop the request here
-                                       return; //FIXME
+                                       return;
                                }
                                $request->setIsCached(FALSE);
                        }
index c195a5a..b6629b8 100644 (file)
@@ -113,7 +113,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapFactory implements t3lib_Singleton {
                        if (isset($columnDefinition['mapOnProperty'])) {
                                $propertyName = $columnDefinition['mapOnProperty'];
                        } else {
-                               $propertyName = Tx_Extbase_Utility_Extension::convertUnderscoredToLowerCamelCase($columnName);
+                               $propertyName = t3lib_div::underscoredToLowerCamelCase($columnName);
                        }
                        // if (in_array($propertyName, $classPropertyNames)) { // TODO Enable check for property existance
                                $columnMap = new Tx_Extbase_Persistence_Mapper_ColumnMap($columnName, $propertyName);
index 4f88f96..c9ec6d6 100644 (file)
@@ -69,7 +69,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
         * @var Tx_Extbase_Persistence_Mapper_DataMapFactory
         */
        protected $dataMapFactory;
-       
+
        /**
         * @var Tx_Extbase_Persistence_QueryFactoryInterface
         */
@@ -116,7 +116,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
        public function injectReflectionService(Tx_Extbase_Reflection_Service $reflectionService) {
                $this->reflectionService = $reflectionService;
        }
-       
+
        /**
         * Injects the DataMap Factory
         *
@@ -135,7 +135,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
        public function injectQueryFactory(Tx_Extbase_Persistence_QueryFactoryInterface $queryFactory) {
                $this->queryFactory = $queryFactory;
        }
-       
+
        /**
         * Sets the query object model factory
         *
@@ -168,7 +168,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                }
                return $objects;
        }
-       
+
        /**
         * Returns the target type for the given row.
         *
@@ -190,7 +190,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                }
                return $targetType;
        }
-       
+
        /**
         * Maps a single row on an object of the given class
         *
@@ -248,7 +248,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                        if (!$dataMap->isPersistableProperty($propertyName)) continue;
                        $columnMap = $dataMap->getColumnMap($propertyName);
                        $columnName = $columnMap->getColumnName();
-                       $propertyData = $this->reflectionService->getClassSchema($className)->getProperty($propertyName);                       
+                       $propertyData = $this->reflectionService->getClassSchema($className)->getProperty($propertyName);
                        $propertyValue = NULL;
                        if ($row[$columnName] !== NULL) {
                                switch ($propertyData['type']) {
@@ -287,7 +287,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                        }
                }
        }
-       
+
        /**
         * Creates a DateTime from an unix timestamp. If the input is empty
         * NULL is returned.
@@ -331,7 +331,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                }
                return $result;
        }
-       
+
        /**
         * Fetches the related objects from the storage backend.
         *
@@ -346,13 +346,13 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                $query = $this->getPreparedQuery($parentObject, $propertyName, $fieldValue);
                return $query->execute();
        }
-       
+
        /**
         * Builds and returns the prepared query, ready to be executed.
         *
-        * @param Tx_Extbase_DomainObject_DomainObjectInterface $parentObject 
-        * @param string $propertyName 
-        * @param string $fieldValue 
+        * @param Tx_Extbase_DomainObject_DomainObjectInterface $parentObject
+        * @param string $propertyName
+        * @param string $fieldValue
         * @return void
         */
        protected function getPreparedQuery(Tx_Extbase_DomainObject_DomainObjectInterface $parentObject, $propertyName, $fieldValue = '') {
@@ -374,15 +374,15 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                $query->matching($this->getConstraint($query, $parentObject, $propertyName, $fieldValue, $columnMap->getRelationTableMatchFields()));
                return $query;
        }
-       
+
        /**
         * Builds and returns the constraint for multi value properties.
         *
         * @param Tx_Extbase_Persistence_QueryInterface $query
-        * @param Tx_Extbase_DomainObject_DomainObjectInterface $parentObject 
-        * @param string $propertyName 
-        * @param string $fieldValue 
-        * @param array $relationTableMatchFields 
+        * @param Tx_Extbase_DomainObject_DomainObjectInterface $parentObject
+        * @param string $propertyName
+        * @param string $fieldValue
+        * @param array $relationTableMatchFields
         * @return Tx_Extbase_Persistence_QOM_ConstraintInterface $constraint
         */
        protected function getConstraint(Tx_Extbase_Persistence_QueryInterface $query, Tx_Extbase_DomainObject_DomainObjectInterface $parentObject, $propertyName, $fieldValue = '', $relationTableMatchFields = array()) {
@@ -409,8 +409,8 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
        /**
         * Builds and returns the source to build a join for a m:n relation.
         *
-        * @param Tx_Extbase_DomainObject_DomainObjectInterface $parentObject 
-        * @param string $propertyName 
+        * @param Tx_Extbase_DomainObject_DomainObjectInterface $parentObject
+        * @param string $propertyName
         * @return Tx_Extbase_Persistence_QOM_SourceInterface $source
         */
        protected function getSource(Tx_Extbase_DomainObject_DomainObjectInterface $parentObject, $propertyName) {
@@ -427,13 +427,13 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                        );
                return $source;
        }
-       
+
        /**
         * Returns the given result as property value of the specified property type.
         *
-        * @param mixed $result The result could be an object or an ObjectStorage 
+        * @param mixed $result The result could be an object or an ObjectStorage
         * @param array $propertyMetaData The property meta data
-        * @param array $result The result 
+        * @param array $result The result
         * @return void
         */
        public function mapResultToPropertyValue(Tx_Extbase_DomainObject_DomainObjectInterface $parentObject, $propertyName, $result) {
@@ -462,7 +462,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                                }
                        } elseif (strpos($propertyMetaData['type'], '_') !== FALSE) {
                                if (is_array($result)) {
-                                       
+
                                        if (current($result) !== FALSE) {
                                                $propertyValue = current($result);
                                        } else {
@@ -475,7 +475,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                }
                return $propertyValue;
        }
-       
+
        /**
         * Counts the number of related objects assigned to a property of a parent object
         *
@@ -487,7 +487,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                $query = $this->getPreparedQuery($parentObject, $propertyName, $fieldValue);
                return $query->count();
        }
-       
+
        /**
         * Delegates the call to the Data Map.
         * Returns TRUE if the property is persistable (configured in $TCA)
@@ -503,7 +503,7 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
 
        /**
         * Returns a data map for a given class name
-        * 
+        *
         * @param string $className The class name you want to fetch the Data Map for
         * @return Tx_Extbase_Persistence_Mapper_DataMap The data map
         */
@@ -547,9 +547,9 @@ class Tx_Extbase_Persistence_Mapper_DataMapper implements t3lib_Singleton {
                                }
                        }
                }
-               return Tx_Extbase_Utility_Extension::convertCamelCaseToLowerCaseUnderscored($propertyName);
+               return t3lib_div::camelCaseToLowerCaseUnderscored($propertyName);
        }
-       
+
        /**
         * Returns the type of a child object.
         *
index d783f53..2e030c4 100644 (file)
@@ -33,7 +33,7 @@
  * @version $Id$
  */
 class Tx_Extbase_Utility_ClassLoader {
-       
+
        /**
         * Loads php files containing classes or interfaces found in the classes directory of
         * an extension.
@@ -42,9 +42,9 @@ class Tx_Extbase_Utility_ClassLoader {
         * @uses t3lib_extMgm::extPath()
         * @return void
         */
-       public static function loadClass($className) {
+       static public function loadClass($className) {
                $classNameParts = explode('_', $className, 3);
-               $extensionKey = Tx_Extbase_Utility_Extension::convertCamelCaseToLowerCaseUnderscored($classNameParts[1]);
+               $extensionKey = t3lib_div::camelCaseToLowerCaseUnderscored($classNameParts[1]);
                if (t3lib_extMgm::isLoaded($extensionKey)) {
                        $classFilePathAndName = t3lib_extMgm::extPath($extensionKey) . 'Classes/' . strtr($classNameParts[2], '_', '/') . '.php';
                        if (file_exists($classFilePathAndName)) {
@@ -52,6 +52,6 @@ class Tx_Extbase_Utility_ClassLoader {
                        }
                }
        }
-       
+
 }
 ?>
\ No newline at end of file
index 4f5e0c5..3eafebc 100644 (file)
@@ -51,7 +51,7 @@ class Tx_Extbase_Utility_Extension {
         * @param string $defaultControllerAction is an optional array controller name (as array key) and action name (as array value) that should be called as default
         * @return void
         */
-       public static function configurePlugin($extensionName, $pluginName, array $controllerActions, array $nonCacheableControllerActions = array()) {
+       static public function configurePlugin($extensionName, $pluginName, array $controllerActions, array $nonCacheableControllerActions = array()) {
                if (empty($pluginName)) {
                        throw new InvalidArgumentException('The plugin name must not be empty', 1239891987);
                }
@@ -133,7 +133,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param string $pluginTitle is a speaking title of the plugin that will be displayed in the drop down menu in the backend
         * @return void
         */
-       public static function registerPlugin($extensionName, $pluginName, $pluginTitle) {
+       static public function registerPlugin($extensionName, $pluginName, $pluginTitle) {
                if (empty($pluginName)) {
                        throw new InvalidArgumentException('The plugin name must not be empty', 1239891987);
                }
@@ -241,7 +241,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param array $config The configuration options of the module (icon, locallang.xml file)
         * @return void
         */
-       public static function registerModule($extensionName, $main = '', $sub = '', $position = '', array $controllerActions, $config = array()) {
+       static public function registerModule($extensionName, $main = '', $sub = '', $position = '', array $controllerActions, $config = array()) {
                if (empty($extensionName)) {
                        throw new InvalidArgumentException('The extension name was invalid (must not be empty and must match /[A-Za-z][_A-Za-z0-9]/)', 1239891989);
                }
@@ -284,24 +284,43 @@ tt_content.list.20.' . $pluginSignature . ' {
                t3lib_extMgm::addModule($main, $sub, $position);
        }
 
-       // TODO PHPdoc
-       public static function convertCamelCaseToLowerCaseUnderscored($string) {
-               // FIXME The cache doesn't work IMO as it is static (did I really implemented this? ;-))
-               static $conversionMap = array();
-               if (!isset($conversionMap[$string])) {
-                       $conversionMap[$string] = strtolower(preg_replace('/(?<=\w)([A-Z])/', '_\\1', $string));
-               }
-               return $conversionMap[$string];
+       /**
+        * Returns a given CamelCasedString as an lowercase string with underscores.
+        * Example: Converts BlogExample to blog_example, and minimalValue to minimal_value
+        *
+        * @param string $string
+        * @return mixed
+        * @see t3lib_div::underscoredToLowerCamelCase()
+        * @deprecated since Extbase 1.3.0; will be removed in Extbase 1.5.0
+        */
+       static public function convertCamelCaseToLowerCaseUnderscored($string) {
+               return t3lib_div::camelCaseToLowerCaseUnderscored($string);
        }
 
-       public static function convertUnderscoredToLowerCamelCase($string) {
-               $string = str_replace(' ', '', ucwords(str_replace('_', ' ', strtolower($string))));
-               $string[0] = strtolower($string[0]);
-               return $string;
+       /**
+        * Returns a given string with underscores as lowerCamelCase.
+        * Example: Converts minimal_value to minimalValue
+        *
+        * @param string $string
+        * @return mixed
+        * @see t3lib_div::underscoredToLowerCamelCase()
+        * @deprecated since Extbase 1.3.0; will be removed in Extbase 1.5.0
+        */
+       static public function convertUnderscoredToLowerCamelCase($string) {
+               return t3lib_div::underscoredToLowerCamelCase($string);
        }
 
-       public static function convertLowerUnderscoreToUpperCamelCase($camelCasedString) {
-               return t3lib_div::underscoredToUpperCamelCase($camelCasedString);
+       /**
+        * Returns a given string with underscores as UpperCamelCase.
+        * Example: Converts blog_example to BlogExample
+        *
+        * @param string $string
+        * @return string
+        * @see t3lib_div::underscoredToUpperCamelCase()
+        * @deprecated since Extbase 1.3.0; will be removed in Extbase 1.5.0
+        */
+       static public function convertLowerUnderscoreToUpperCamelCase($string) {
+               return t3lib_div::underscoredToUpperCamelCase($string);
        }
 
        /**
@@ -312,7 +331,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param   array   $additionalAutoloadClasses additional classes to be added to the autoloader. The key must be the classname all-lowercase, the value must be the entry to be inserted
         * @return      string  HTML string which should be outputted
         */
-       public static function createAutoloadRegistryForExtension($extensionKey, $extensionPath, $additionalAutoloadClasses = array()) {
+       static public function createAutoloadRegistryForExtension($extensionKey, $extensionPath, $additionalAutoloadClasses = array()) {
                $classNameToFileMapping = array();
                $extensionName = str_replace(' ', '', ucwords(str_replace('_', ' ', $extensionKey)));
                $errors = self::buildAutoloadRegistryForSinglePath($classNameToFileMapping, $extensionPath . 'Classes/', '.*tslib.*', '$extensionClassesPath . \'|\'');
@@ -369,7 +388,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param       string  $valueWrap      Wrap for the file name
         * @return void
         */
-       protected static function buildAutoloadRegistryForSinglePath(&$classNameToFileMapping, $path, $excludeRegularExpression = '', $valueWrap = '\'|\'') {
+       static protected function buildAutoloadRegistryForSinglePath(&$classNameToFileMapping, $path, $excludeRegularExpression = '', $valueWrap = '\'|\'') {
 //             if (file_exists($path . 'Classes/')) {
 //                     return "<b>This appears to be a new-style extension which has its PHP classes inside the Classes/ subdirectory. It is not needed to generate the autoload registry for these extensions.</b>";
 //             }
@@ -390,7 +409,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param       string  $filePath       File path (absolute)
         * @return      array   Class names
         */
-       protected static function extractClassNames($filePath) {
+       static protected function extractClassNames($filePath) {
                $fileContent = php_strip_whitespace($filePath);
                $classNames = array();
                if (FALSE) {
@@ -437,7 +456,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param       array   $intermediateTokens     optional: list of tokens that are allowed to skip when looking for the wanted token
         * @return      mixed
         */
-       protected static function findToken(array &$tokenList, array $wantedTokens, array $intermediateTokens = array()) {
+       static protected function findToken(array &$tokenList, array $wantedTokens, array $intermediateTokens = array()) {
                $skipAllTokens = count($intermediateTokens) ? false : true;
 
                $returnValue = false;
@@ -471,7 +490,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param string $pluginName name of the plugin to retrieve the namespace for
         * @return string plugin namespace
         */
-       public static function getPluginNamespace($extensionName, $pluginName) {
+       static public function getPluginNamespace($extensionName, $pluginName) {
                $pluginSignature = strtolower($extensionName . '_' . $pluginName);
                $defaultPluginNamespace = 'tx_' . $pluginSignature;
                $objectManager = t3lib_div::makeInstance('Tx_Extbase_Object_ObjectManager');
@@ -497,7 +516,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param string $actionName name of the target action (lowerCamelCase)
         * @return string name of the target plugin (UpperCamelCase) or NULL if no matching plugin configuration was found
         */
-       public static function getPluginNameByAction($extensionName, $controllerName, $actionName) {
+       static public function getPluginNameByAction($extensionName, $controllerName, $actionName) {
                if (!isset($GLOBALS['TSFE']->tmpl->setup['tt_content.']['list.']['20.']) || !is_array($GLOBALS['TSFE']->tmpl->setup['tt_content.']['list.']['20.'])) {
                        return NULL;
                }
@@ -536,7 +555,7 @@ tt_content.list.20.' . $pluginSignature . ' {
         * @param string $pluginName name of the plugin to retrieve the target PID for
         * @return integer uid of the target page or NULL if target page could not be determined
         */
-       public static function getTargetPidByPlugin($extensionName, $pluginName) {
+       static public function getTargetPidByPlugin($extensionName, $pluginName) {
                $pluginSignature = strtolower($extensionName . '_' . $pluginName);
                $objectManager = t3lib_div::makeInstance('Tx_Extbase_Object_ObjectManager');
                $configurationManager = $objectManager->get('Tx_Extbase_Configuration_ConfigurationManagerInterface');
index bb5c9f0..cf9e0d5 100644 (file)
@@ -134,7 +134,7 @@ class Tx_Extbase_Utility_Localization {
         * @author Christopher Hlubek <hlubek@networkteam.com>
         * @author Bastian Waidelich <bastian@typo3.org>
         */
-       protected static function initializeLocalization($extensionName) {
+       static protected function initializeLocalization($extensionName) {
                if (isset(self::$LOCAL_LANG[$extensionName])) {
                        return;
                }
index e319e6f..ad14877 100644 (file)
@@ -42,7 +42,7 @@ class Tx_Extbase_Utility_TypoScript {
         * @return void
         * @api
         */
-       public static function convertTypoScriptArrayToPlainArray(array $settings) {
+       static public function convertTypoScriptArrayToPlainArray(array $settings) {
                foreach ($settings as $key => &$value) {
                        if(substr($key, -1) === '.') {
                                $keyWithoutDot = substr($key, 0, -1);
@@ -74,7 +74,7 @@ class Tx_Extbase_Utility_TypoScript {
         * @return array array with Typoscript as usual (with dot)
         * @api
         */
-       public static function convertPlainArrayToTypoScriptArray($plainArray) {
+       static public function convertPlainArrayToTypoScriptArray($plainArray) {
                $typoScriptArray = array();
                if (is_array($plainArray)) {
                        foreach ($plainArray as $key => $value) {