X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=framework%2Fmain%2Fclasses%2Fcommands%2Fclass_BaseCommand.php;h=754217da9c796984b6b8a9d919e31875b2609332;hb=HEAD;hp=9787fb0b7bbfe0c80c668434aa0c2e17d0c6ade3;hpb=2882b57ca6f372b822f96034ff2fe6aafd7daeb8;p=core.git diff --git a/framework/main/classes/commands/class_BaseCommand.php b/framework/main/classes/commands/class_BaseCommand.php index 9787fb0b..754217da 100644 --- a/framework/main/classes/commands/class_BaseCommand.php +++ b/framework/main/classes/commands/class_BaseCommand.php @@ -3,18 +3,26 @@ namespace Org\Mxchange\CoreFramework\Command; // Import framework stuff -use Org\Mxchange\CoreFramework\Factory\ObjectFactory; +use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap; +use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory; +use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper; +use Org\Mxchange\CoreFramework\Generic\FrameworkInterface; use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem; -use Org\Mxchange\CoreFramework\Registry\Registry; use Org\Mxchange\CoreFramework\Request\Requestable; use Org\Mxchange\CoreFramework\Response\Responseable; +use Org\Mxchange\CoreFramework\Traits\Resolver\ResolverTrait; +use Org\Mxchange\CoreFramework\Traits\Template\CompileableTemplateTrait; + +// Import SPL stuff +use \BadMethodCallException; +use \InvalidArgumentException; /** * A general (base) command * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.shipsimu.org * @@ -32,17 +40,47 @@ use Org\Mxchange\CoreFramework\Response\Responseable; * along with this program. If not, see . */ abstract class BaseCommand extends BaseFrameworkSystem { + // Load traits + use CompileableTemplateTrait; + use ResolverTrait; + /** * Protected constructor * * @param $className Name of the class * @return void */ - protected function __construct ($className) { + protected function __construct (string $className) { // Call parent constructor parent::__construct($className); } + /** + * Initializes the template engine + * + * @param $templateType Type of template, e.g. 'html', 'image', 'console' ... + * @return void + * @throws InvalidArgumentException If a parameter has an invalid value + */ + public final function initTemplateEngine (string $templateType) { + // Check paramter + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-COMMAND: templateType=%s - CALLED!', $templateType)); + if (empty($templateType)) { + // Throw IAE + throw new InvalidArgumentException('Parameter "templateType" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + + // Prepare a template instance + $templateInstance = ObjectFactory::createObjectByConfiguredName(sprintf('%s_template_class', $templateType)); + + // Set it here + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-COMMAND: templateInstance=%s', $templateInstance->__toString())); + $this->setTemplateInstance($templateInstance); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-COMMAND: EXIT!'); + } + /** * Sends a generic HTTP response with header, menu, content and footer * @@ -50,71 +88,83 @@ abstract class BaseCommand extends BaseFrameworkSystem { * @param $responseInstance An instance of a class with an Responseable interface * @param $suffix Optional template suffix, e.g. '_form' for forms * @return void + * @throws BadMethodCallException If a POST request ended here */ - protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance, $suffix = '') { - // This command doesn't handle any POST requests, so only handle get request - assert(!$requestInstance->isPostRequestMethod()); - - // Get the application instance - $applicationInstance = Registry::getRegistry()->getInstance('app'); - - // Prepare a template instance - $templateInstance = $this->prepareTemplateInstance($applicationInstance); + protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance, string $suffix = '') { + // Check conditions + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-COMMAND: requestInstance=%s,responseInstance=%s,suffix=%s - CALLED!', $requestInstance->__toString(), $responseInstance->__toString(), $suffix)); + if ($requestInstance->isPostRequestMethod()) { + // POST request isn't handled here + throw new BadMethodCallException('This method does only handle GET/HEAD requests', FrameworkInterface::EXCEPTION_BAD_METHOD_CALL); + } // Transfer application data - $templateInstance->assignApplicationData($applicationInstance); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-COMMAND: Invoking this->templateInstance->assignApplicationData() ...'); + $this->getTemplateInstance()->assignApplicationData(); // Assign base URL - $templateInstance->assignConfigVariable('base_url'); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-COMMAND: Invoking this->templateInstance->assignConfigVariable(base_url) ...'); + $this->getTemplateInstance()->assignConfigVariable('base_url'); + + // Get the application instance + $applicationInstance = ApplicationHelper::getSelfInstance(); // Load the master template + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-COMMAND: applicationInstance=%s', $applicationInstance->__toString())); $masterTemplate = $applicationInstance->buildMasterTemplateName(); // Load header template - $templateInstance->loadCodeTemplate('header'); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-COMMAND: masterTemplate=%s', $masterTemplate)); + $this->getTemplateInstance()->loadCodeTemplate('header'); // Compile and assign it with a variable - $templateInstance->compileTemplate(); - $templateInstance->assignTemplateWithVariable('header', 'header'); + $this->getTemplateInstance()->compileTemplate(); + $this->getTemplateInstance()->assignTemplateWithVariable('header', 'header'); // Load footer template - $templateInstance->loadCodeTemplate('footer'); + $this->getTemplateInstance()->loadCodeTemplate('footer'); // Compile and assign it with a variable - $templateInstance->compileTemplate(); - $templateInstance->assignTemplateWithVariable('footer', 'footer'); + $this->getTemplateInstance()->compileTemplate(); + $this->getTemplateInstance()->assignTemplateWithVariable('footer', 'footer'); // Load the content template - $templateInstance->loadCodeTemplate($this->getResolverInstance()->getCommandName() . $suffix); + $this->getTemplateInstance()->loadCodeTemplate($this->getResolverInstance()->getCommandName() . $suffix); // Assign the content template with the master template as a content ... ;) - $templateInstance->assignTemplateWithVariable($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName(), 'main_content'); + $this->getTemplateInstance()->assignTemplateWithVariable($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName(), 'main_content'); // Load the master template - $templateInstance->loadCodeTemplate($masterTemplate); + $this->getTemplateInstance()->loadCodeTemplate($masterTemplate); // Set title - $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_' . $applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_title')); + $this->getTemplateInstance()->assignVariable('title', FrameworkBootstrap::getLanguageInstance()->getMessage('page_' . $applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_title')); - // Construct the menu in every command. We could do this in BaseCommand class. But this means - // *every* command has a navigation system and that is want we don't want. - $menuInstance = ObjectFactory::createObjectByConfiguredName($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_menu_class', array($applicationInstance)); + /* + * Construct the menu in every command. We could do this in BaseCommand + * class. But this means *every* command has a navigation system and + * that is want we don't want. + */ + $menuInstance = ObjectFactory::createObjectByConfiguredName($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_menu_class'); // Render the menu $menuInstance->renderMenu(); // Transfer it to the template engine instance - $menuInstance->transferContentToTemplateEngine($templateInstance); + $menuInstance->transferContentToTemplateEngine($this->getTemplateInstance()); /* * ... and all variables. This should be merged together in a pattern * to make things easier. A cache mechanism should be added between * these two calls to cache compiled templates. */ - $templateInstance->compileVariables(); + $this->getTemplateInstance()->compileVariables(); // Get the content back from the template engine and put it in response class - $templateInstance->transferToResponse($responseInstance); + $this->getTemplateInstance()->transferToResponse($responseInstance); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-COMMAND: EXIT!'); } }