gilbertsoft / typo3-gslib

ext_emconf.php

Indentation +29 added lines, -29 removed lines

@@ -22,33 +22,33 @@
  */
 
 $EM_CONF[$_EXTKEY] = [
-    'title' => 'GS Library',
-    'description' => 'GS Library is a collection of utility functions, base classes and other templates for the usage in other extensions.',
-    'version' => '0.0.9',
-    'category' => 'misc',
-    'constraints' => [
-        'depends' => [
-            'php' => '7.0.0-7.2.99',
-            'typo3' => '8.7.0-9.5.99',
-        ],
-        'conflicts' => [],
-        'suggests' => [],
-    ],
-    'state' => 'beta',
-    'uploadfolder' => 0,
-    'createDirs' => '',
-    'clearCacheOnLoad' => 0,
-    'author' => 'Simon Gilli',
-    'author_email' => 'typo3@gilbertsoft.org',
-    'author_company' => 'Gilbertsoft',
-    'autoload' => [
-        'psr-4' => [
-            'Gilbertsoft\\Lib\\' => 'Classes',
-        ],
-    ],
-    'autoload-dev' => [
-        'psr-4' => [
-            'Gilbertsoft\\Lib\\Tests\\' => 'Tests',
-        ],
-    ],
+	'title' => 'GS Library',
+	'description' => 'GS Library is a collection of utility functions, base classes and other templates for the usage in other extensions.',
+	'version' => '0.0.9',
+	'category' => 'misc',
+	'constraints' => [
+		'depends' => [
+			'php' => '7.0.0-7.2.99',
+			'typo3' => '8.7.0-9.5.99',
+		],
+		'conflicts' => [],
+		'suggests' => [],
+	],
+	'state' => 'beta',
+	'uploadfolder' => 0,
+	'createDirs' => '',
+	'clearCacheOnLoad' => 0,
+	'author' => 'Simon Gilli',
+	'author_email' => 'typo3@gilbertsoft.org',
+	'author_company' => 'Gilbertsoft',
+	'autoload' => [
+		'psr-4' => [
+			'Gilbertsoft\\Lib\\' => 'Classes',
+		],
+	],
+	'autoload-dev' => [
+		'psr-4' => [
+			'Gilbertsoft\\Lib\\Tests\\' => 'Tests',
+		],
+	],
 ];

Classes/Utility/StorageRepositoryUtility.php

Indentation +131 added lines, -131 removed lines

@@ -34,135 +34,135 @@
  */
 class StorageRepositoryUtility
 {
-    /**
-     * @const string Suffix added to storage name
-     */
-    const STORAGE_SUFFIX = '/ (auto-created)';
-
-    /**
-     * Get the storage repository
-     *
-     * @return \TYPO3\CMS\Core\Resource\StorageRepository
-     */
-    public static function getStorageRepository()
-    {
-        return GeneralUtility::makeInstance(\TYPO3\CMS\Core\Resource\StorageRepository::class);
-    }
-
-    /**
-     * Searches for a local storage.
-     *
-     * @param string $name Local storage name
-     * @return NULL|\TYPO3\CMS\Core\Resource\ResourceStorage
-     */
-    public static function findLocalStorage($name)
-    {
-        /** @var $storageObjects \TYPO3\CMS\Core\Resource\ResourceStorage[] */
-        $storageObjects = self::getStorageRepository()->findByStorageType('Local');
-
-        foreach ($storageObjects as $storage) {
-            if (isset($storage->getConfiguration()['basePath']) && ($storage->getConfiguration()['basePath'] == rtrim($name, '/') . '/')) {
-                return $storage;
-            }
-        }
-
-        return null;
-    }
-
-    /**
-     * Creates a directory in the web root if it is not existing.
-     *
-     * @param string $name Relative path to folder from web root, see PHP mkdir() function. Removes trailing slash internally.
-     * @return bool TRUE if mkdir went well!
-     */
-    public static function createDirectoryAtWebRoot($name)
-    {
-        if (!@is_dir(Environment::getPublicPath() . '/' . $name)) {
-            return GeneralUtility::mkdir(Environment::getPublicPath() . '/' . $name);
-        }
-
-        return true;
-    }
-
-    /**
-     * Creates a local storage if not exists.
-     *
-     * @param string $extensionKey
-     * @param string $name Local storage name
-     * @param string $message Optional message
-     * @return NULL|int Uid of the inserted or found record
-     * @throws \InvalidArgumentException
-     */
-    public static function createLocalStorage($extensionKey, $name, $message = '')
-    {
-        if (!is_string($name) || empty($name)) {
-            throw new \InvalidArgumentException('$name must be a non empty string.', 1491681665);
-        }
-
-        if (self::createDirectoryAtWebRoot($name) !== true) {
-            FlashMessageUtility::showFlashMessage(
-                $extensionKey,
-                'Local storage ' . $name . ' could not be created!',
-                'Local storage not created',
-                FlashMessage::WARNING
-            );
-
-            return null;
-        }
-
-        $addMessage = (is_string($message) && !empty($message) ? ' ' . $message : '');
-        /** @var $storage \TYPO3\CMS\Core\Resource\ResourceStorage */
-        $storage = self::findLocalStorage($name);
-
-        if ($storage !== null) {
-            FlashMessageUtility::showFlashMessage(
-                $extensionKey,
-                'Local storage ' . $name . ' was found.' . $addMessage,
-                'Local storage found',
-                FlashMessage::NOTICE
-            );
-
-            return $storage->getUid();
-        }
-
-        $uid = self::getStorageRepository()->createLocalStorage(
-            $name . self::STORAGE_SUFFIX,
-            $name,
-            'relative',
-            'This is the local ' . $name . '/ directory. This storage mount has been created automatically by ' . $extensionKey . '.' . $addMessage,
-            false
-        );
-
-        FlashMessageUtility::showFlashMessage(
-            $extensionKey,
-            'Local storage ' . $name . ' successfully created.' . $addMessage,
-            'Local storage created'
-        );
-
-        return $uid;
-    }
-
-    /**
-     * Removes a local storage.
-     *
-     * @param string $extensionKey
-     * @param string $name Local storage name
-     * @return void
-     * @throws \InvalidArgumentException
-     */
-    public static function removeLocalStorage($extensionKey, $name)
-    {
-        if (!is_string($name) || empty($name)) {
-            throw new \InvalidArgumentException('$name must be a non empty string.', 1491682406);
-        }
-
-        if (self::findLocalStorage($name) !== null) {
-            FlashMessageUtility::showFlashMessage(
-                $extensionKey,
-                'Local storage ' . $name . ' must be removed by an admin from the root line in the backend and web root directory.',
-                'Remove local storage',
-                FlashMessage::NOTICE
-            );
-        }
-    }
+	/**
+	 * @const string Suffix added to storage name
+	 */
+	const STORAGE_SUFFIX = '/ (auto-created)';
+
+	/**
+	 * Get the storage repository
+	 *
+	 * @return \TYPO3\CMS\Core\Resource\StorageRepository
+	 */
+	public static function getStorageRepository()
+	{
+		return GeneralUtility::makeInstance(\TYPO3\CMS\Core\Resource\StorageRepository::class);
+	}
+
+	/**
+	 * Searches for a local storage.
+	 *
+	 * @param string $name Local storage name
+	 * @return NULL|\TYPO3\CMS\Core\Resource\ResourceStorage
+	 */
+	public static function findLocalStorage($name)
+	{
+		/** @var $storageObjects \TYPO3\CMS\Core\Resource\ResourceStorage[] */
+		$storageObjects = self::getStorageRepository()->findByStorageType('Local');
+
+		foreach ($storageObjects as $storage) {
+			if (isset($storage->getConfiguration()['basePath']) && ($storage->getConfiguration()['basePath'] == rtrim($name, '/') . '/')) {
+				return $storage;
+			}
+		}
+
+		return null;
+	}
+
+	/**
+	 * Creates a directory in the web root if it is not existing.
+	 *
+	 * @param string $name Relative path to folder from web root, see PHP mkdir() function. Removes trailing slash internally.
+	 * @return bool TRUE if mkdir went well!
+	 */
+	public static function createDirectoryAtWebRoot($name)
+	{
+		if (!@is_dir(Environment::getPublicPath() . '/' . $name)) {
+			return GeneralUtility::mkdir(Environment::getPublicPath() . '/' . $name);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Creates a local storage if not exists.
+	 *
+	 * @param string $extensionKey
+	 * @param string $name Local storage name
+	 * @param string $message Optional message
+	 * @return NULL|int Uid of the inserted or found record
+	 * @throws \InvalidArgumentException
+	 */
+	public static function createLocalStorage($extensionKey, $name, $message = '')
+	{
+		if (!is_string($name) || empty($name)) {
+			throw new \InvalidArgumentException('$name must be a non empty string.', 1491681665);
+		}
+
+		if (self::createDirectoryAtWebRoot($name) !== true) {
+			FlashMessageUtility::showFlashMessage(
+				$extensionKey,
+				'Local storage ' . $name . ' could not be created!',
+				'Local storage not created',
+				FlashMessage::WARNING
+			);
+
+			return null;
+		}
+
+		$addMessage = (is_string($message) && !empty($message) ? ' ' . $message : '');
+		/** @var $storage \TYPO3\CMS\Core\Resource\ResourceStorage */
+		$storage = self::findLocalStorage($name);
+
+		if ($storage !== null) {
+			FlashMessageUtility::showFlashMessage(
+				$extensionKey,
+				'Local storage ' . $name . ' was found.' . $addMessage,
+				'Local storage found',
+				FlashMessage::NOTICE
+			);
+
+			return $storage->getUid();
+		}
+
+		$uid = self::getStorageRepository()->createLocalStorage(
+			$name . self::STORAGE_SUFFIX,
+			$name,
+			'relative',
+			'This is the local ' . $name . '/ directory. This storage mount has been created automatically by ' . $extensionKey . '.' . $addMessage,
+			false
+		);
+
+		FlashMessageUtility::showFlashMessage(
+			$extensionKey,
+			'Local storage ' . $name . ' successfully created.' . $addMessage,
+			'Local storage created'
+		);
+
+		return $uid;
+	}
+
+	/**
+	 * Removes a local storage.
+	 *
+	 * @param string $extensionKey
+	 * @param string $name Local storage name
+	 * @return void
+	 * @throws \InvalidArgumentException
+	 */
+	public static function removeLocalStorage($extensionKey, $name)
+	{
+		if (!is_string($name) || empty($name)) {
+			throw new \InvalidArgumentException('$name must be a non empty string.', 1491682406);
+		}
+
+		if (self::findLocalStorage($name) !== null) {
+			FlashMessageUtility::showFlashMessage(
+				$extensionKey,
+				'Local storage ' . $name . ' must be removed by an admin from the root line in the backend and web root directory.',
+				'Remove local storage',
+				FlashMessage::NOTICE
+			);
+		}
+	}
 }

Classes/Utility/FlashMessageUtility.php

Indentation +69 added lines, -69 removed lines

@@ -34,76 +34,76 @@
  */
 class FlashMessageUtility
 {
-    /**
-     * @var \TYPO3\CMS\Core\Messaging\FlashMessageService
-     */
-    protected static $flashMessageService = null;
-    /**
-     * Returns the Flash Message Service
-     *
-     * @return \TYPO3\CMS\Core\Messaging\FlashMessageService
-     */
-    public static function getFlashMessageService()
-    {
-        if (self::$flashMessageService === null) {
-            // cache the object for performance-reasons
-            self::$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
-        }
-        return self::$flashMessageService;
-    }
+	/**
+	 * @var \TYPO3\CMS\Core\Messaging\FlashMessageService
+	 */
+	protected static $flashMessageService = null;
+	/**
+	 * Returns the Flash Message Service
+	 *
+	 * @return \TYPO3\CMS\Core\Messaging\FlashMessageService
+	 */
+	public static function getFlashMessageService()
+	{
+		if (self::$flashMessageService === null) {
+			// cache the object for performance-reasons
+			self::$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
+		}
+		return self::$flashMessageService;
+	}
 
-    /**
-     * Returns the Flash Message Queue
-     *
-     * @param string $extensionKey
-     * @return \TYPO3\CMS\Core\Messaging\FlashMessageQueue
-     * @throws \InvalidArgumentException
-     */
-    public static function getFlashMessageQueue($extensionKey)
-    {
-        if (!is_string($extensionKey) || empty($extensionKey)) {
-            throw new \InvalidArgumentException('$extensionKey must be a non empty string.', 1491502264);
-        }
-        return self::getFlashMessageService()->getMessageQueueByIdentifier('gslib.flashmessages.' . $extensionKey);
-    }
+	/**
+	 * Returns the Flash Message Queue
+	 *
+	 * @param string $extensionKey
+	 * @return \TYPO3\CMS\Core\Messaging\FlashMessageQueue
+	 * @throws \InvalidArgumentException
+	 */
+	public static function getFlashMessageQueue($extensionKey)
+	{
+		if (!is_string($extensionKey) || empty($extensionKey)) {
+			throw new \InvalidArgumentException('$extensionKey must be a non empty string.', 1491502264);
+		}
+		return self::getFlashMessageService()->getMessageQueueByIdentifier('gslib.flashmessages.' . $extensionKey);
+	}
 
-    /**
-     * Adds a Flash Message to the Flash Message Queue
-     *
-     * @param \TYPO3\CMS\Core\Messaging\FlashMessage $flashMessage
-     * @param string $extensionKey
-     * @return void
-     */
-    public static function addFlashMessageToQueue(FlashMessage $flashMessage, $extensionKey)
-    {
-        if ($flashMessage) {
-            self::getFlashMessageQueue($extensionKey)->enqueue($flashMessage);
-        }
-    }
+	/**
+	 * Adds a Flash Message to the Flash Message Queue
+	 *
+	 * @param \TYPO3\CMS\Core\Messaging\FlashMessage $flashMessage
+	 * @param string $extensionKey
+	 * @return void
+	 */
+	public static function addFlashMessageToQueue(FlashMessage $flashMessage, $extensionKey)
+	{
+		if ($flashMessage) {
+			self::getFlashMessageQueue($extensionKey)->enqueue($flashMessage);
+		}
+	}
 
-    /**
-     * Create a Flash Message and add it to the Queue
-     *
-     * @param string $extensionKey
-     * @param string $message The message.
-     * @param string $title Optional message title.
-     * @param int $severity Optional severity, must be either of one of \TYPO3\CMS\Core\Messaging\FlashMessage constants
-     * @param bool $storeInSession Optional, defines whether the message should be stored in the session or only for one request (default)
-     * @return void
-     */
-    public static function showFlashMessage($extensionKey, $message, $title = '', $severity = FlashMessage::OK, $storeInSession = true)
-    {
-        if (is_string($message) || !empty($message)) {
-            self::addFlashMessageToQueue(
-                GeneralUtility::makeInstance(
-                    FlashMessage::class,
-                    $message,
-                    $title,
-                    $severity,
-                    $storeInSession
-                ), 
-                $extensionKey
-            );
-        }
-    }
+	/**
+	 * Create a Flash Message and add it to the Queue
+	 *
+	 * @param string $extensionKey
+	 * @param string $message The message.
+	 * @param string $title Optional message title.
+	 * @param int $severity Optional severity, must be either of one of \TYPO3\CMS\Core\Messaging\FlashMessage constants
+	 * @param bool $storeInSession Optional, defines whether the message should be stored in the session or only for one request (default)
+	 * @return void
+	 */
+	public static function showFlashMessage($extensionKey, $message, $title = '', $severity = FlashMessage::OK, $storeInSession = true)
+	{
+		if (is_string($message) || !empty($message)) {
+			self::addFlashMessageToQueue(
+				GeneralUtility::makeInstance(
+					FlashMessage::class,
+					$message,
+					$title,
+					$severity,
+					$storeInSession
+				), 
+				$extensionKey
+			);
+		}
+	}
 }

Classes/Utility/ExtensionUtility.php

Indentation +45 added lines, -45 removed lines

@@ -36,53 +36,53 @@
  */
 class ObjectUtility
 {
-    /**
-     * Get Object Manager instance.
-     *
-     * @return \TYPO3\CMS\Extbase\Object\ObjectManager
-     */
-    public static function getObjectManager()
-    {
-        return GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
-    }
+	/**
+	 * Get Object Manager instance.
+	 *
+	 * @return \TYPO3\CMS\Extbase\Object\ObjectManager
+	 */
+	public static function getObjectManager()
+	{
+		return GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
+	}
 
-    /**
-     * Get Configuration Manager instance.
-     *
-     * @return \TYPO3\CMS\Extbase\Configuration\ConfigurationManager
-     */
-    public static function getConfigurationManager()
-    {
-        return self::getObjectManager()->get(\TYPO3\CMS\Extbase\Configuration\ConfigurationManager::class);
-    }
+	/**
+	 * Get Configuration Manager instance.
+	 *
+	 * @return \TYPO3\CMS\Extbase\Configuration\ConfigurationManager
+	 */
+	public static function getConfigurationManager()
+	{
+		return self::getObjectManager()->get(\TYPO3\CMS\Extbase\Configuration\ConfigurationManager::class);
+	}
 
-    /**
-     * Get Typoscript Service instance.
-     *
-     * @return \TYPO3\CMS\Extbase\Service\TyposcriptService
-     */
-    public static function getTyposcriptService()
-    {
-        return self::getObjectManager()->get(\TYPO3\CMS\Extbase\Service\TyposcriptService::class);
-    }
+	/**
+	 * Get Typoscript Service instance.
+	 *
+	 * @return \TYPO3\CMS\Extbase\Service\TyposcriptService
+	 */
+	public static function getTyposcriptService()
+	{
+		return self::getObjectManager()->get(\TYPO3\CMS\Extbase\Service\TyposcriptService::class);
+	}
 
-    /**
-     * Get Flex Form Service instance.
-     *
-     * @return \TYPO3\CMS\Core\Service\FlexFormService
-     */
-    public static function getFlexFormService()
-    {
-        return self::getObjectManager()->get(\TYPO3\CMS\Core\Service\FlexFormService::class);
-    }
+	/**
+	 * Get Flex Form Service instance.
+	 *
+	 * @return \TYPO3\CMS\Core\Service\FlexFormService
+	 */
+	public static function getFlexFormService()
+	{
+		return self::getObjectManager()->get(\TYPO3\CMS\Core\Service\FlexFormService::class);
+	}
 
-    /**
-     * Get Configuration Utility instance.
-     *
-     * @return \TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility
-     */
-    public static function getConfigurationUtility()
-    {
-        return self::getObjectManager()->get(\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::class);
-    }
+	/**
+	 * Get Configuration Utility instance.
+	 *
+	 * @return \TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility
+	 */
+	public static function getConfigurationUtility()
+	{
+		return self::getObjectManager()->get(\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::class);
+	}
 }

Classes/Service/InstallService.php

Indentation +24 added lines, -24 removed lines

@@ -33,29 +33,29 @@
  */
 class InstallService extends AbstractInstallService
 {
-    /**
-     * Executes the setup tasks if extension is installed.
-     *
-     * @param string $extensionKey Installed extension key
-     */
-    public function afterInstall($extensionKey)
-    {
-        if ($extensionKey == $this->extensionKey)
-        {
-            // insert custom code here
-        }
-    }
+	/**
+	 * Executes the setup tasks if extension is installed.
+	 *
+	 * @param string $extensionKey Installed extension key
+	 */
+	public function afterInstall($extensionKey)
+	{
+		if ($extensionKey == $this->extensionKey)
+		{
+			// insert custom code here
+		}
+	}
 
-    /**
-     * Executes the setup tasks if extension is uninstalled.
-     *
-     * @param string $extensionKey Uninstalled extension key
-     */
-    public function afterUninstall($extensionKey)
-    {
-        if ($extensionKey == $this->extensionKey)
-        {
-            // insert custom code here
-        }
-    }
+	/**
+	 * Executes the setup tasks if extension is uninstalled.
+	 *
+	 * @param string $extensionKey Uninstalled extension key
+	 */
+	public function afterUninstall($extensionKey)
+	{
+		if ($extensionKey == $this->extensionKey)
+		{
+			// insert custom code here
+		}
+	}
 }