));
}
- // Init template engine
- self::getResponseInstance()->initTemplateEngine($applicationInstance);
-
// Now call all methods in one go
foreach (array('setupApplicationData', 'initApplication', 'launchApplication') as $methodName) {
// Debug message
// CFG: MENU-TEMPLATE-CLASS
$cfg->setConfigEntry('menu_template_class', 'Org\Mxchange\CoreFramework\Template\Engine\MenuTemplateEngine');
+// CFG: CONSOLE-TEMPLATE-CLASS
+$cfg->setConfigEntry('console_template_class', 'Org\Mxchange\CoreFramework\Template\Engine\ConsoleTemplateEngine');
+
// CFG: MENU-TEMPLATE-EXTENSION
$cfg->setConfigEntry('menu_template_extension', '.xml');
use Org\Mxchange\CoreFramework\Stream\Input\InputStream;
use Org\Mxchange\CoreFramework\Stream\Output\OutputStreamer;
use Org\Mxchange\CoreFramework\Stream\Output\OutputStream;
-use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
use Org\Mxchange\CoreFramework\User\ManageableAccount;
use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
*/
private $updateInstance = NULL;
- /**
- * Template engine instance
- */
- private $templateInstance = NULL;
-
/**
* Database result instance
*/
return $this->resultInstance;
}
- /**
- * Setter for template engine instances
- *
- * @param $templateInstance An instance of a template engine class
- * @return void
- */
- protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
- $this->templateInstance = $templateInstance;
- }
-
- /**
- * Getter for template engine instances
- *
- * @return $templateInstance An instance of a template engine class
- */
- protected final function getTemplateInstance () {
- return $this->templateInstance;
- }
-
/**
* Setter for search instance
*
return $str;
}
- /**
- * Prepare the template engine (HtmlTemplateEngine by default) for a given
- * application helper instance (ApplicationHelper by default).
- *
- * @param $applicationInstance An application helper instance or
- * null if we shall use the default
- * @return $templateInstance The template engine instance
- * @throws NullPointerException If the discovered application
- * instance is still null
- */
- protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
- // Is the application instance set?
- if (is_null($applicationInstance)) {
- // Get the current instance
- $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
-
- // Still null?
- if (is_null($applicationInstance)) {
- // Thrown an exception
- throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } // END - if
- } // END - if
-
- // Initialize the template engine
- $templateInstance = ObjectFactory::createObjectByConfiguredName('html_template_class');
-
- // Return the prepared instance
- return $templateInstance;
- }
-
/**
* Debugs this instance by putting out it's full content
*
parent::__construct($className);
}
+ /**
+ * Initializes the template engine
+ *
+ * @param $templateType Type of template, e.g. 'html', 'image', 'console' ...
+ * @return void
+ */
+ public final function initTemplateEngine (string $templateType) {
+ // Prepare a template instance
+ $templateInstance = ObjectFactory::createObjectByConfiguredName(sprintf('%s_template_class', $templateType));
+
+ // Set it here
+ $this->setTemplateInstance($templateInstance);
+ }
+
/**
* Setter for resolver instance
*
* @param $suffix Optional template suffix, e.g. '_form' for forms
* @return void
*/
- protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance, $suffix = '') {
+ protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance, string $suffix = '') {
// This command doesn't handle any POST requests, so only handle get request
assert(!$requestInstance->isPostRequestMethod());
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Transfer application data
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Assign base URL
- $templateInstance->assignConfigVariable('base_url');
+ $this->getTemplateInstance()->assignConfigVariable('base_url');
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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', $this->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->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);
}
}
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Assign application data with template engine
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Assign base URL
- $templateInstance->assignConfigVariable('base_url');
+ $this->getTemplateInstance()->assignConfigVariable('base_url');
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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 home template
- $templateInstance->loadCodeTemplate('confirm_link');
+ $this->getTemplateInstance()->loadCodeTemplate('confirm_link');
// Assign the home template with the master template as a content ... ;)
- $templateInstance->assignTemplateWithVariable('confirm_link', 'main_content');
+ $this->getTemplateInstance()->assignTemplateWithVariable('confirm_link', 'main_content');
// Load the master template
- $templateInstance->loadCodeTemplate($masterTemplate);
+ $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
// Set title
- $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_confirm_link_title'));
+ $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage('page_confirm_link_title'));
// Get user instance
try {
}
// Set username
- $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USERNAME));
+ $this->getTemplateInstance()->assignVariable('username', $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USERNAME));
// 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->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);
}
/**
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
// Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Transfer application data
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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 home template
- $templateInstance->loadCodeTemplate('home');
+ $this->getTemplateInstance()->loadCodeTemplate('home');
// Assign the home template with the master template as a content ... ;)
- $templateInstance->assignTemplateWithVariable('home', 'main_content');
+ $this->getTemplateInstance()->assignTemplateWithVariable('home', 'main_content');
// Load the master template
- $templateInstance->loadCodeTemplate($masterTemplate);
+ $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
// Set title
- $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_home_title'));
+ $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage('page_home_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->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);
}
/**
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Assign base URL
- $templateInstance->assignConfigVariable('base_url');
+ $this->getTemplateInstance()->assignConfigVariable('base_url');
// Assign all the application's data with template variables
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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 matching template
- $templateInstance->loadCodeTemplate('action_' . $this->actionName);
+ $this->getTemplateInstance()->loadCodeTemplate('action_' . $this->actionName);
// Assign the template with the master template as a content ... ;)
- $templateInstance->compileTemplate();
- $templateInstance->assignTemplateWithVariable('action_' . $this->actionName, 'login_content');
+ $this->getTemplateInstance()->compileTemplate();
+ $this->getTemplateInstance()->assignTemplateWithVariable('action_' . $this->actionName, 'login_content');
// Load main template
- $templateInstance->loadCodeTemplate('login_main');
+ $this->getTemplateInstance()->loadCodeTemplate('login_main');
// Assign the main template with the master template as a content ... ;)
- $templateInstance->compileTemplate();
- $templateInstance->assignTemplateWithVariable('login_main', 'main_content');
+ $this->getTemplateInstance()->compileTemplate();
+ $this->getTemplateInstance()->assignTemplateWithVariable('login_main', 'main_content');
// Load the master template
- $templateInstance->loadCodeTemplate($masterTemplate);
+ $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
// Set title
- $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage($this->actionName . '_title'));
+ $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage($this->actionName . '_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->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);
}
/**
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Assign application data with template engine
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Assign base URL
- $templateInstance->assignConfigVariable('base_url');
+ $this->getTemplateInstance()->assignConfigVariable('base_url');
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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 home template
- $templateInstance->loadCodeTemplate('login_form');
+ $this->getTemplateInstance()->loadCodeTemplate('login_form');
// Assign the home template with the master template as a content ... ;)
- $templateInstance->assignTemplateWithVariable('login_form', 'main_content');
+ $this->getTemplateInstance()->assignTemplateWithVariable('login_form', 'main_content');
// Load the master template
- $templateInstance->loadCodeTemplate($masterTemplate);
+ $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
// Set title
- $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_title'));
+ $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_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->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);
}
/**
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Assign application data with template engine
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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 login_failed template
- $templateInstance->loadCodeTemplate('login_failed');
+ $this->getTemplateInstance()->loadCodeTemplate('login_failed');
// Assign the login_failed template with the master template as a content ... ;)
- $templateInstance->assignTemplateWithVariable('login_failed', 'main_content');
+ $this->getTemplateInstance()->assignTemplateWithVariable('login_failed', 'main_content');
// Load the master template
- $templateInstance->loadCodeTemplate($masterTemplate);
+ $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
// Set title
- $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('login_failed_title'));
+ $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage('login_failed_title'));
// Assign base URL
- $templateInstance->assignConfigVariable('base_url');
+ $this->getTemplateInstance()->assignConfigVariable('base_url');
// 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->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);
}
/**
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Assign application data
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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 logout_done template
- $templateInstance->loadCodeTemplate('logout_done');
+ $this->getTemplateInstance()->loadCodeTemplate('logout_done');
// Assign the logout_done template with the master template as a content ... ;)
- $templateInstance->assignTemplateWithVariable('logout_done', 'main_content');
+ $this->getTemplateInstance()->assignTemplateWithVariable('logout_done', 'main_content');
// Load the master template
- $templateInstance->loadCodeTemplate($masterTemplate);
+ $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
// Set title
- $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('logout_done_title'));
+ $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage('logout_done_title'));
// Assign base URL
- $templateInstance->assignConfigVariable('base_url');
+ $this->getTemplateInstance()->assignConfigVariable('base_url');
// 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->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);
}
/**
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Assign all the application's data with template variables
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Assign base URL
- $templateInstance->assignConfigVariable('base_url');
+ $this->getTemplateInstance()->assignConfigVariable('base_url');
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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 register template
- $templateInstance->loadCodeTemplate('register_form');
+ $this->getTemplateInstance()->loadCodeTemplate('register_form');
// Assign the register template with the master template as a content ... ;)
- $templateInstance->compileTemplate();
- $templateInstance->assignTemplateWithVariable('register_form', 'main_content');
+ $this->getTemplateInstance()->compileTemplate();
+ $this->getTemplateInstance()->assignTemplateWithVariable('register_form', 'main_content');
// Load the master template
- $templateInstance->loadCodeTemplate($masterTemplate);
+ $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
// Set title
- $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_register_title'));
+ $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage('page_register_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->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);
}
/**
// Re-set config entry to mailer engine
FrameworkBootstrap::getConfigurationInstance()->setConfigEntry('html_template_class', FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('mail_template_class'));
- // Prepare the template engine
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Assign the application data with the template engine
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Get a mailer class
- $mailerInstance = ObjectFactory::createObjectByConfiguredName('mailer_class', array($templateInstance, 'resend_link'));
+ $mailerInstance = ObjectFactory::createObjectByConfiguredName('mailer_class', array($this->getTemplateInstance(), 'resend_link'));
// Set this mailer in our template engine
- $templateInstance->setMailerInstance($mailerInstance);
+ $this->getTemplateInstance()->setMailerInstance($mailerInstance);
// Add template variables we shall get
$mailerInstance->addConfigTemplateVariable('base_url');
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Transfer application data
- $templateInstance->assignApplicationData();
+ $this->getTemplateInstance()->assignApplicationData();
// Load the master template
$masterTemplate = $applicationInstance->buildMasterTemplateName();
// Load header template
- $templateInstance->loadCodeTemplate('header');
+ $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 status template
- $templateInstance->loadCodeTemplate('status');
+ $this->getTemplateInstance()->loadCodeTemplate('status');
// Assign the status template with the master template as a content ... ;)
- $templateInstance->assignTemplateWithVariable('status', 'main_content');
+ $this->getTemplateInstance()->assignTemplateWithVariable('status', 'main_content');
// Load the master template
- $templateInstance->loadCodeTemplate($masterTemplate);
+ $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
// Set title
- $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_status_title'));
+ $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage('page_status_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->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);
}
/**
// Get the application instance
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
- // Prepare a template instance
- $templateInstance = $this->prepareTemplateInstance($applicationInstance);
-
// Assign variable
- $templateInstance->assignVariable('decrypted_code', $decryptedCode);
+ $this->getTemplateInstance()->assignVariable('decrypted_code', $decryptedCode);
// Load the code (pardon, image...) template
- $templateInstance->loadCodeTemplate('code_captcha');
+ $this->getTemplateInstance()->loadCodeTemplate('code_captcha');
// Compile the template
- $templateInstance->compileTemplate();
+ $this->getTemplateInstance()->compileTemplate();
// Compile all variables
- $templateInstance->compileVariables();
+ $this->getTemplateInstance()->compileVariables();
// Transfer it to the response
- $templateInstance->transferToResponse($responseInstance);
+ $this->getTemplateInstance()->transferToResponse($responseInstance);
}
/**
* @return void
*/
public function finishImage () {
- // Get template instance
- $templateInstance = $this->getTemplateInstance();
-
// Compile width and height
- $width = $templateInstance->compileRawCode($this->getWidth());
- $height = $templateInstance->compileRawCode($this->getHeight());
+ $width = $this->getTemplateInstance()->compileRawCode($this->getWidth());
+ $height = $this->getTemplateInstance()->compileRawCode($this->getHeight());
// Set both again
$this->setWidth($width);
$this->imageResource = imagecreatetruecolor($width, $height);
// Compile background colors
- $red = $templateInstance->compileRawCode($this->backgroundColor['red']);
- $green = $templateInstance->compileRawCode($this->backgroundColor['green']);
- $blue = $templateInstance->compileRawCode($this->backgroundColor['blue']);
+ $red = $this->getTemplateInstance()->compileRawCode($this->backgroundColor['red']);
+ $green = $this->getTemplateInstance()->compileRawCode($this->backgroundColor['green']);
+ $blue = $this->getTemplateInstance()->compileRawCode($this->backgroundColor['blue']);
// Set all back
$this->initBackgroundColor();
imagefill($this->getImageResource(), 0, 0, $backColor);
// Compile foreground colors
- $red = $templateInstance->compileRawCode($this->foregroundColor['red']);
- $green = $templateInstance->compileRawCode($this->foregroundColor['green']);
- $blue = $templateInstance->compileRawCode($this->foregroundColor['blue']);
+ $red = $this->getTemplateInstance()->compileRawCode($this->foregroundColor['red']);
+ $green = $this->getTemplateInstance()->compileRawCode($this->foregroundColor['green']);
+ $blue = $this->getTemplateInstance()->compileRawCode($this->foregroundColor['blue']);
// Set all fore
$this->initForegroundColor();
switch ($this->groupable) {
case 'single': // Single image string
// Compile image string
- $imageString = $templateInstance->compileRawCode($this->getString());
+ $imageString = $this->getTemplateInstance()->compileRawCode($this->getString());
// Set it back
$this->setString($imageString);
// Compile X/Y coordinates and font size
- $x = $templateInstance->compileRawCode($this->getX());
- $y = $templateInstance->compileRawCode($this->getY());
- $size = $templateInstance->compileRawCode($this->getFontSize());
+ $x = $this->getTemplateInstance()->compileRawCode($this->getX());
+ $y = $this->getTemplateInstance()->compileRawCode($this->getY());
+ $size = $this->getTemplateInstance()->compileRawCode($this->getFontSize());
// Set the image string
imagestring($this->getImageResource(), $size, $x, $y, $imageString, $foreColor);
case 'groupable': // More than one string allowed
// Walk through all groups
- foreach ($templateInstance->getVariableGroups() as $group => $set) {
+ foreach ($this->getTemplateInstance()->getVariableGroups() as $group => $set) {
// Set the group
- $templateInstance->setVariableGroup($group, false);
+ $this->getTemplateInstance()->setVariableGroup($group, false);
// Compile image string
- $imageString = $templateInstance->compileRawCode($this->getString());
+ $imageString = $this->getTemplateInstance()->compileRawCode($this->getString());
// Compile X/Y coordinates and font size
- $x = $templateInstance->compileRawCode($this->getX());
- $y = $templateInstance->compileRawCode($this->getY());
- $size = $templateInstance->compileRawCode($this->getFontSize());
+ $x = $this->getTemplateInstance()->compileRawCode($this->getX());
+ $y = $this->getTemplateInstance()->compileRawCode($this->getY());
+ $size = $this->getTemplateInstance()->compileRawCode($this->getFontSize());
// Set the image string
//* DEBUG: */ print __METHOD__.": size={$size}, x={$x}, y={$y}, string={$imageString}<br />\n";
if (!class_exists($this->getClassName())) {
// Class not found, so throw an exception
throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
- } // END - if
+ }
// Initiate the command
$commandInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
*/
public function resolveCommandByRequest (Requestable $requestInstance) {
// Init variables
- $commandName = '';
- $commandInstance = NULL;
-
- // This goes fine so let's resolve the command
$commandName = $requestInstance->getRequestElement('command');
+ $commandType = FrameworkBootstrap::getRequestTypeFromSystem();
+ $commandInstance = NULL;
// Is the command empty? Then fall back to default command
if (empty($commandName)) {
- $commandName = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('default_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_command');
- } // END - if
+ // Fall back to default command
+ $commandName = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry(sprintf('default_%s_command', $commandType));
+ }
// Check if command is valid
if ($this->isCommandValid($this->getNamespace(), $commandName) === false) {
// This command is invalid!
throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
- } // END - if
+ }
// Get the command
$commandInstance = $this->loadCommand($commandName);
if ((!is_object($commandInstance)) || (!$commandInstance instanceof Commandable)) {
// This command has an invalid instance!
throw new UnexpectedValueException(sprintf('commandInstance for commandName=%s is not object (%s) or does not implement Commandable.', $commandName, gettype($commandInstance)), self::EXCEPTION_INVALID_COMMAND);
- } // END - if
+ }
// Set last command
$this->setResolvedInstance($commandInstance);
+ // Init template engine
+ $commandInstance->initTemplateEngine($commandType);
+
// Return the resolved command instance
return $commandInstance;
}
* @return $commandInstance An instance of the command class
* @throws InvalidCommandException Thrown if $commandName is invalid
*/
- public function resolveCommand ($namespace, $commandName) {
+ public function resolveCommand (string $namespace, string $commandName) {
// Is a action set?
if (empty($namespace)) {
// Then thrown an exception here
// Initiate the instance variable
$commandInstance = NULL;
+ $commandType = FrameworkBootstrap::getRequestTypeFromSystem();
// Is the command empty? Then fall back to default command
if (empty($commandName)) {
// Init default command
- $commandName = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('default_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_command');
- } // END - if
+ $commandName = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry(sprintf('default_%s_command', $commandType));
+ }
// Check if command is valid
if ($this->isCommandValid($namespace, $commandName) === false) {
// This command is invalid!
throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
- } // END - if
+ }
// Get the command
$commandInstance = $this->loadCommand($commandName);
+ // Init template engine
+ $commandInstance->initTemplateEngine($commandType);
+
// Return the instance
return $commandInstance;
}
if (class_exists($this->getClassName())) {
// This class does exist. :-)
$isValid = true;
- } // END - if
+ }
// Set command name
$this->setCommandName($commandName);
*/
public function resolveController () {
// Init variables
- $controllerName = '';
- $controllerInstance = NULL;
-
- // Get namespace and controller name
$controllerName = $this->getControllerName();
+ $controllerInstance = NULL;
// Get the controller
$controllerInstance = $this->loadController($controllerName);
return $responseInstance;
}
- /**
- * Initializes the template engine instance
- *
- * @param $applicationInstance An instance of a manageable application
- * @return void
- */
- public final function initTemplateEngine (ManageableApplication $applicationInstance) {
- $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
- }
-
/**
* Adds a cookie to the response
*
* @return void
* @throws ResponseHeadersAlreadySentException If headers are already sent
*/
- public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = NULL) {
+ public function addCookie (string $cookieName, $cookieValue, bool $encrypted = FALSE, int $expires = NULL) {
//* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
$this->partialStub('Naturally unimplemented in console response.');
}
return $responseInstance;
}
- /**
- * Initializes the template engine instance
- *
- * @param $applicationInstance An instance of a manageable application
- * @return void
- */
- public final function initTemplateEngine (ManageableApplication $applicationInstance) {
- $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
- }
-
/**
* Adds a cookie to the response
*
* @todo If the return statement is removed and setcookie() commented out,
* @todo this will send only one cookie out, the first one.
*/
- public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = NULL) {
+ public function addCookie (string $cookieName, $cookieValue, bool $encrypted = FALSE, int $expires = NULL) {
//* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
// Are headers already sent?
if (headers_sent()) {
} // END - if
// Shall we encrypt the cookie?
- if ($encrypted === true) {
+ if ($encrypted) {
// Unsupported at the moment
$this->partialStub('Encryption is unsupported at the moment.');
} // END - if
return $this->imageInstance;
}
- /**
- * Initializes the template engine instance
- *
- * @param $applicationInstance An instance of a manageable application
- * @return void
- */
- public final function initTemplateEngine (ManageableApplication $applicationInstance) {
- // Get config instance
- $cfg = FrameworkBootstrap::getConfigurationInstance();
-
- // Set new template engine
- $cfg->setConfigEntry('html_template_class' , $cfg->getConfigEntry('image_template_class'));
- $cfg->setConfigEntry('raw_template_extension' , '.img');
- $cfg->setConfigEntry('code_template_extension', '.xml');
- $cfg->setConfigEntry('tpl_base_path' , 'templates/images/');
- // @TODO Please fix this
- $cfg->setConfigEntry('code_template_type' , 'image');
-
- // Get a prepared instance
- $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
- }
-
/**
* Adds a cookie to the response
*
* @todo If the return statement is removed and setcookie() commented out,
* @todo this will send only one cookie out, the first one.
*/
- public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = NULL) {
+ public function addCookie (string $cookieName, $cookieValue, bool $encrypted = FALSE, int $expires = NULL) {
// Are headers already sent?
if (headers_sent()) {
// Throw an exception here
throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
- } // END - if
+ }
// Shall we encrypt the cookie?
- if ($encrypted === true) {
+ if ($encrypted) {
// Unsupported at the moment
$this->partialStub('Encryption is unsupported at the moment.');
- } // END - if
+ }
// For slow browsers set the cookie array element first
$_COOKIE[$cookieName] = $cookieValue;
protected function __construct () {
// Call parent constructor
parent::__construct(__CLASS__);
+
+ // Set template type
+ $this->setTemplateType('mail');
}
/**
* @return void
*/
private function renderMenuEntry () {
- // Prepare template engine
- $templateInstance = $this->prepareTemplateInstance();
-
// Load menu entry template
- $templateInstance->loadCodeTemplate('menu_entry');
+ $this->getTemplateInstance()->loadCodeTemplate('menu_entry');
// Copy all variables over to it
foreach ($this->menuEntryVariables as $variableName) {
} // END - if
// ... into the instance
- $templateInstance->assignVariable($variableName, $variableValue);
+ $this->getTemplateInstance()->assignVariable($variableName, $variableValue);
} // END - foreach
// Compile template + variables
- $templateInstance->compileTemplate();
- $templateInstance->compileVariables();
+ $this->getTemplateInstance()->compileTemplate();
+ $this->getTemplateInstance()->compileVariables();
// Remember it here
- $this->menuEntries[$this->readVariable('entry_id')] = $templateInstance->getRawTemplateData();
+ $this->menuEntries[$this->readVariable('entry_id')] = $this->getTemplateInstance()->getRawTemplateData();
}
/**
// Init block content
$blockContent = implode('', $this->menuEntries);
- // Prepare template engine
- $templateInstance = $this->prepareTemplateInstance();
-
// Load menu entry template
- $templateInstance->loadCodeTemplate('menu_block');
+ $this->getTemplateInstance()->loadCodeTemplate('menu_block');
// Copy all variables over to it
foreach ($this->menuBlockVariables as $variableName) {
$variableValue = $this->readVariable($variableName);
// ... into the instance
- $templateInstance->assignVariable($variableName, $variableValue);
+ $this->getTemplateInstance()->assignVariable($variableName, $variableValue);
} // END - foreach
// Assign block content
- $templateInstance->assignVariable('block_content', $blockContent);
+ $this->getTemplateInstance()->assignVariable('block_content', $blockContent);
// Compile template + variables
- $templateInstance->compileTemplate();
- $templateInstance->compileVariables();
+ $this->getTemplateInstance()->compileTemplate();
+ $this->getTemplateInstance()->compileVariables();
// Remember it here
- array_push($this->menuBlocks, $templateInstance->getRawTemplateData());
+ array_push($this->menuBlocks, $this->getTemplateInstance()->getRawTemplateData());
// Reset rendered menu entries array
$this->menuEntries = array();
*/
function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance);
+ /**
+ * Initializes the template engine
+ *
+ * @param $templateType Type of template, e.g. 'html', 'image', 'console' ...
+ * @return void
+ */
+ function initTemplateEngine (string $templateType);
+
}
*/
interface CommandResolver extends Resolver {
/**
- * Returns an command instance for a given request class
+ * Getter for command name
+ *
+ * @return $commandName Last validated command name
+ */
+ function getCommandName ();
+
+ /**
+ * Returns an command instance for a given request class or null if
+ * it was not found
*
* @param $requestInstance An instance of a Requestable class
* @return $commandInstance An instance of the resolved command
+ * @throws InvalidCommandException Thrown if $commandName is invalid
+ * @throws UnexpectedValueException Thrown if $commandInstance is an invalid instance
*/
function resolveCommandByRequest (Requestable $requestInstance);
+ /**
+ * Resolves the command by its direct name and returns an instance of its class
+ *
+ * @param $namespace Namespace to look in
+ * @param $commandName The direct command name we shall resolve
+ * @return $commandInstance An instance of the command class
+ * @throws InvalidCommandException Thrown if $commandName is invalid
+ */
+ function resolveCommand (string $namespace, string $commandName);
+
}
// Import framework stuff
use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
-use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
/**
* An interface for responses
* @param $cookieName Cookie's name
* @param $cookieValue Value to store in the cookie
* @param $encrypted Do some extra encryption on the value
+ * @param $expires Timestamp of expiration (default: configured)
* @return void
* @throws ResponseHeadersAlreadySentException If headers are already sent
*/
- function addCookie ($cookieName, $cookieValue, $encrypted = false);
+ function addCookie (string $cookieName, $cookieValue, bool $encrypted = FALSE, int $expires = NULL);
/**
* Redirect to a configured URL. The URL can be absolute or relative. In
*/
function refreshCookie ($cookieName);
- /**
- * Initializes the template engine instance
- *
- * @param $applicationInstance An instance of a manageable application
- * @return void
- */
- function initTemplateEngine (ManageableApplication $applicationInstance);
-
}
return $resolverInstance;
}
- /**
- * Resolves the default controller of the given command
- *
- * @return $controllerInstance A controller instance for the default
- * command
- * @throws InvalidControllerInstanceException Thrown if $controllerInstance
- * is invalid
- */
- public function resolveController () {
- // Init variables
- $controllerName = '';
- $controllerInstance = NULL;
-
- // Get namespace and command name
- $controllerName = $this->getControllerName();
-
- // Get the command
- $controllerInstance = $this->loadController($controllerName);
-
- // And validate it
- if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
- // This command has an invalid instance!
- throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
- } // END - if
-
- // Set last controller
- $this->setResolvedInstance($controllerInstance);
-
- // Return the maybe resolved instance
- return $controllerInstance;
- }
-
}
projects / core.git / commitdiff