CGL + docs

Author: Georg Ringer

Classes/Cli/Dispatcher.php

@@ -27,7 +27,7 @@
  * This script must be included by the "CLI module dispatcher"
  *
  * @author Georg Ringer <[email protected]>
- * @package	TYPO3
+ * @package TYPO3
  * @subpackage tx_coreapi
  */
 class Tx_Coreapi_Cli_Dispatcher {
@@ -51,12 +51,14 @@ class Tx_Coreapi_Cli_Dispatcher {
 	 */
 	public function __construct() {
 		if (!isset($_SERVER['argv'][1])) {
-			die('ERROR: No service defined');
+			$this->error('No service defined');
 		}
 
 		$split = explode(':', $_SERVER['argv'][1]);
-		if (count($split) !== 2) {
-			die('ERROR: Only one : is allowed in first argument');
+		if (count($split) === 1) {
+			$this->error('CLI calls need to be like coreapi cache:clearallcaches');
+		} elseif (count($split) !== 2) {
+			$this->error('Only one : is allowed in first argument');
 		}
 
 		$this->service = strtolower($split[0]);
@@ -80,7 +82,7 @@ public function start() {
 					$this->siteApi();
 					break;
 				default:
-					die(sprintf('ERROR: Service "%s" not supported', $this->service));
+					$this->error(sprintf('Service "%s" not supported', $this->service));
 			}
 		} catch (Exception $e) {
 			$errorMessage = sprintf('ERROR: Error in service "%s" and command "%s"": %s!', $this->service, $this->command, $e->getMessage());
@@ -106,7 +108,7 @@ protected function cacheApi() {
 				$this->outputLine('Page cache cleared');
 				break;
 			default:
-				die(sprintf('ERROR: Command "%s" not supported', $this->command));
+				$this->error(sprintf('Command "%s" not supported', $this->command));
 		}
 	}
 
@@ -123,7 +125,7 @@ protected function databaseApi() {
 				}
 				break;
 			default:
-				die(sprintf('ERROR: Command "%s" not supported', $this->command));
+				$this->error(sprintf('Command "%s" not supported', $this->command));
 		}
 	}
 
@@ -195,7 +197,7 @@ protected function extensionApi() {
 				$this->outputTable($out);
 				break;
 			default:
-				die(sprintf('ERROR: Command "%s" not supported', $this->command));
+				$this->error(sprintf('Command "%s" not supported', $this->command));
 		}
 
 	}
@@ -217,7 +219,7 @@ protected function siteApi() {
 				$siteApiService->createSysNews($_SERVER['argv'][2], $_SERVER['argv'][3]);
 				break;
 			default:
-				die(sprintf('ERROR: Command "%s" not supported', $this->command));
+				$this->error(sprintf('Command "%s" not supported', $this->command));
 		}
 	}
 
@@ -250,8 +252,17 @@ protected function outputTable(array $input) {
 		$this->outputLine(str_repeat('-', self::MAXIMUM_LINE_LENGTH));
 	}
 
-}
+	/**
+	 * End call
+	 *
+	 * @param string $message Error message
+	 * @return void
+	 */
+	protected function error($message) {
+		die('ERROR: ' . $message);
+	}
 
+}
 
 if ((TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI) && basename(PATH_thisScript) == 'cli_dispatch.phpsh') {
 	$dispatcher = t3lib_div::makeInstance('Tx_Coreapi_Cli_Dispatcher');

Classes/Service/DatabaseApiService.php

@@ -54,18 +54,15 @@ public function __construct() {
 	/**
 	 * Database compare
 	 *
-	 * @param string $actions comma seperated list of IDs
+	 * @param string $actions comma separated list of IDs
 	 * @return array
+	 * @throws InvalidArgumentException
 	 */
 	public function databaseCompare($actions) {
 		$errors = array();
 
-
-		/** @var $service Tx_Coreapi_Service_DatabaseApiService */
-		$service = t3lib_div::makeInstance('Tx_Coreapi_Service_DatabaseApiService');
 		$availableActions = array_flip(t3lib_div::makeInstance('Tx_Extbase_Reflection_ClassReflection', 'Tx_Coreapi_Service_DatabaseApiService')->getConstants());
 
-
 		if (empty($actions)) {
 			throw new InvalidArgumentException('No compare modes defined');
 		}
@@ -82,7 +79,7 @@ public function databaseCompare($actions) {
 
 		$tblFileContent = t3lib_div::getUrl(PATH_t3lib . 'stddb/tables.sql');
 
-		foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $extKey => $loadedExtConf) {
+		foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $loadedExtConf) {
 			if (is_array($loadedExtConf) && $loadedExtConf['ext_tables.sql']) {
 				$extensionSqlContent = t3lib_div::getUrl($loadedExtConf['ext_tables.sql']);
 				$tblFileContent .= LF . LF . LF . LF . $extensionSqlContent;

Classes/Service/ExtensionApiService.php

@@ -45,6 +45,7 @@ class Tx_Coreapi_Service_ExtensionApiService {
 	 *
 	 * @param string $key extension key
 	 * @return array
+	 * @throws InvalidArgumentException
 	 */
 	public function getExtensionInformation($key) {
 		if (strlen($key) === 0) {

Classes/Service/SiteApiService.php

@@ -53,6 +53,7 @@ public function getSiteInfo() {
 	 * @param string $header header
 	 * @param string $text text
 	 * @return void
+	 * @throws InvalidArgumentException
 	 */
 	public function createSysNews($header, $text) {
 		if (strlen($header) === 0) {

README.md

@@ -1,6 +1,6 @@
 ## TYPO3 Extension 'coreapi' ##
 
-The EXT:coreapi should provide a simple to use API for common core features. Useable by injectable ServiceClasses or by the CLI dispatcher.
+The EXT:coreapi should provide a simple to use API for common core features.
 
 Checkout the project website at forge.typo3.org:
 	http://forge.typo3.org/projects/show/extension-coreapi
@@ -15,10 +15,13 @@ Checkout the project website at forge.typo3.org:
 	* clearConfigurationCache
 
 ### CLI call: ###
+
+#### TYPO3 4.7+ ####
 If you are using TYPO3 4.7+, you can use the awesome CommandController of Extbase
 
 This will show you all available calls
 	./typo3/cli_dispatch.phpsh extbase help
 
+#### TYPO3 4.6 and below ####
 If you are using 4.5 or 4.6, you can still use the extension with a call like
-	./typo3/cli_dispatch.phpsh coreapi extensionapi info coreapi
+	./typo3/cli_dispatch.phpsh coreapi cache:clearallcaches