/**
* Constructor.
*
* @param Zikula_ServiceManager $serviceManager ServiceManager.
*
* @throws InvalidArgumentException If getMeta() is not implemented correctly.
*/
public function __construct(Zikula_ServiceManager $serviceManager)
{
$this->serviceManager = $serviceManager;
$this->eventManager = $this->serviceManager->getService('zikula.eventmanager');
$this->_setup();
$meta = $this->getMeta();
if (!isset($meta['displayname']) && !isset($meta['description']) && !isset($meta['version'])) {
throw new InvalidArgumentException(sprintf('%s->getMeta() must be implemented according to the abstract. See docblock in Zikula_AbstractPlugin for details', get_class($this)));
}
// Load any handlers if they exist
if ($this->getReflection()->hasMethod('setupHandlerDefinitions')) {
$this->setupHandlerDefinitions();
}
}
/**
* Invoke handler.
*
* @param callable $handler Callable by PHP.
* @param Zikula_EventInterface $event Event object.
*
* @return void
*/
private function invoke($handler, Zikula_EventInterface $event)
{
if ($handler instanceof Zikula_ServiceHandler) {
$service = $this->serviceManager->getService($handler->getId());
$method = $handler->getMethodName();
// invoke service method
$service->$method($event);
} else {
if (is_array($handler)) {
// PHP callable format
if (is_object($handler[0])) {
// invoke instanciated object method.
$handler[0]->$handler[1]($event);
} else {
// invoke static class method.
$handler[0]::$handler[1]($event);
}
} else {
// invoke function including anonymous functions
$handler($event);
}
}
}
/**
* Convenience to get a service.
*
* @param string $id Service Name.
*
* @return mixed Service or null.
*/
protected function getService($id)
{
return $this->serviceManager->getService($id);
}
/**
* Constructor.
*
* @param Zikula_ServiceManager $serviceManager ServiceManager.
* @param string $moduleName Module name ("zikula" for system plugins).
* @param integer|null $caching Whether or not to cache (Zikula_View::CACHE_*) or use config variable (null).
*/
public function __construct(Zikula_ServiceManager $serviceManager, $moduleName = '', $caching = null)
{
$this->serviceManager = $serviceManager;
$this->eventManager = $this->serviceManager->getService('zikula.eventmanager');
$this->request = $this->serviceManager->getService('request');
// set the error reporting level
$this->error_reporting = isset($GLOBALS['ZConfig']['Debug']['error_reporting']) ? $GLOBALS['ZConfig']['Debug']['error_reporting'] : E_ALL;
$this->allow_php_tag = true;
// get variables from input
$module = FormUtil::getPassedValue('module', null, 'GETPOST', FILTER_SANITIZE_STRING);
$type = FormUtil::getPassedValue('type', 'user', 'GETPOST', FILTER_SANITIZE_STRING);
$func = FormUtil::getPassedValue('func', 'main', 'GETPOST', FILTER_SANITIZE_STRING);
// set vars based on the module structures
$this->homepage = empty($module) ? true : false;
$this->type = strtolower(!$this->homepage ? $type : System::getVar('starttype'));
$this->func = strtolower(!$this->homepage ? $func : System::getVar('startfunc'));
// Initialize the module property with the name of
// the topmost module. For Hooks, Blocks, API Functions and others
// you need to set this property to the name of the respective module!
$this->toplevelmodule = ModUtil::getName();
if (!$moduleName) {
$moduleName = $this->toplevelmodule;
}
$this->modinfo = ModUtil::getInfoFromName($moduleName);
$this->module = array($moduleName => $this->modinfo);
// initialise environment vars
$this->language = ZLanguage::getLanguageCode();
$this->baseurl = System::getBaseUrl();
$this->baseuri = System::getBaseUri();
// system info
$this->themeinfo = ThemeUtil::getInfo(ThemeUtil::getIDFromName(UserUtil::getTheme()));
$this->theme = $theme = $this->themeinfo['directory'];
//---- Plugins handling -----------------------------------------------
// add plugin paths
switch ($this->modinfo['type'])
{
case ModUtil::TYPE_MODULE :
$mpluginPath = "modules/" . $this->modinfo['directory'] . "/templates/plugins";
$mpluginPathOld = "modules/" . $this->modinfo['directory'] . "/pntemplates/plugins";
break;
case ModUtil::TYPE_SYSTEM :
$mpluginPath = "system/" . $this->modinfo['directory'] . "/templates/plugins";
$mpluginPathOld = "system/" . $this->modinfo['directory'] . "/pntemplates/plugins";
break;
default:
$mpluginPath = "system/" . $this->modinfo['directory'] . "/templates/plugins";
$mpluginPathOld = "system/" . $this->modinfo['directory'] . "/pntemplates/plugins";
}
// add standard plugin search path
$this->plugins_dir = array();
$this->addPluginDir('config/plugins'); // Official override
$this->addPluginDir('lib/viewplugins'); // Core plugins
$this->addPluginDir("themes/$theme/plugins"); // Theme plugins
$this->addPluginDir('plugins'); // Smarty core plugins
$this->addPluginDir($mpluginPath); // Plugins for current module
// check if the 'type' parameter in the URL is admin and if yes,
// include system/Admin/templates/plugins to the plugins_dir array
if ($type === 'admin') {
if (!$this instanceof Zikula_View_Theme) {
$this->addPluginDir('system/Admin/templates/plugins');
} else {
$this->load_filter('output', 'admintitle');
}
}
// adds legacy plugin paths if needed
if (System::isLegacyMode()) {
$this->addPluginDir('lib/legacy/plugins'); // Core legacy plugins
$this->addPluginDir($mpluginPathOld); // Module plugins (legacy paths)
$this->addPluginDir("themes/$theme/templates/modules/$moduleName/plugins"); // Module override in themes
}
//---- Cache handling -------------------------------------------------
if ($caching && in_array((int)$caching, array(0, 1, 2))) {
$this->caching = (int)$caching;
} else {
$this->caching = (int)ModUtil::getVar('Theme', 'render_cache');
}
// write actions should not be cached or weird things happen
if (isset($_POST) && count($_POST) != 0) {
$this->caching = Zikula_View::CACHE_DISABLED;
}
$this->compile_id = '';
$this->cache_id = '';
// template compilation
$this->compile_dir = CacheUtil::getLocalDir('view_compiled');
$this->compile_check = ModUtil::getVar('Theme', 'render_compile_check');
$this->force_compile = ModUtil::getVar('Theme', 'render_force_compile');
// template caching
$this->cache_dir = CacheUtil::getLocalDir('view_cache');
$this->cache_lifetime = ModUtil::getVar('Theme', 'render_lifetime');
$this->expose_template = (ModUtil::getVar('Theme', 'render_expose_template') == true) ? true : false;
// register resource type 'z' this defines the way templates are searched
// during {include file='my_template.tpl'} this enables us to store selected module
// templates in the theme while others can be kept in the module itself.
$this->register_resource('z', array('Zikula_View_Resource',
'z_get_template',
'z_get_timestamp',
'z_get_secure',
'z_get_trusted'));
// set 'z' as default resource type
$this->default_resource_type = 'z';
// process some plugins specially when Render cache is enabled
if (!$this instanceof Zikula_View_Theme && $this->caching) {
$this->register_nocache_plugins();
}
// register the 'nocache' block to allow dynamic zones caching templates
$this->register_block('nocache', array('Zikula_View_Resource', 'block_nocache'), false);
// For ajax requests we use the short urls filter to 'fix' relative paths
if (($this->serviceManager->getService('zikula')->getStage() & Zikula_Core::STAGE_AJAX) && System::getVar('shorturls')) {
$this->load_filter('output', 'shorturls');
}
// register prefilters
$this->register_prefilter('z_prefilter_add_literal');
if ($GLOBALS['ZConfig']['System']['legacy_prefilters']) {
$this->register_prefilter('z_prefilter_legacy');
}
$this->register_prefilter('z_prefilter_gettext_params');
//$this->register_prefilter('z_prefilter_notifyfilters');
// assign some useful settings
$this->assign('homepage', $this->homepage)
->assign('modinfo', $this->modinfo)
->assign('module', $moduleName)
->assign('toplevelmodule', $this->toplevelmodule)
->assign('type', $this->type)
->assign('func', $this->func)
->assign('lang', $this->language)
->assign('themeinfo', $this->themeinfo)
->assign('themepath', $this->baseurl . 'themes/' . $theme)
->assign('baseurl', $this->baseurl)
->assign('baseuri', $this->baseuri);
if (System::isLegacyMode()) {
$this->assign('stylepath', $this->baseurl . 'themes/' . $theme . '/style')
->assign('scriptpath', $this->baseurl . 'themes/' . $theme . '/javascript')
->assign('imagepath', $this->baseurl . 'themes/' . $theme . '/images')
->assign('imagelangpath', $this->baseurl . 'themes/' . $theme . '/images/' . $this->language);
}
// for {gt} template plugin to detect gettext domain
if ($this->modinfo['type'] == ModUtil::TYPE_MODULE) {
$this->domain = ZLanguage::getModuleDomain($this->modinfo['name']);
}
// make render object available to modifiers
parent::assign('zikula_view', $this);
// add ServiceManager, EventManager and others to all templates
parent::assign('serviceManager', $this->serviceManager);
parent::assign('eventManager', $this->eventManager);
parent::assign('zikula_core', $this->serviceManager->getService('zikula'));
parent::assign('request', $this->request);
parent::assign('modvars', ModUtil::getModvars()); // Get all modvars from any modules that have accessed their modvars at least once.
$this->add_core_data();
// metadata for SEO
if (!isset($this->serviceManager['zikula_view.metatags'])) {
$this->serviceManager['zikula_view.metatags'] = new ArrayObject(array());
}
parent::assign('metatags', $this->serviceManager['zikula_view.metatags']);
$event = new Zikula_Event('view.init', $this);
$this->eventManager->notify($event);
}
/**
* Constructor.
*
* @param Zikula_ServiceManager $serviceManager Servicemanager.
*/
public function __construct(Zikula_ServiceManager $serviceManager)
{
$this->serviceManager = $serviceManager;
$this->eventManager = $this->serviceManager->getService('zikula.eventmanager');
$this->event = new Zikula_Event('log', $this);
}
/**
* Constructor.
*
* @param Zikula_ServiceManager $serviceManager ServiceManager.
*/
public function __construct(Zikula_ServiceManager $serviceManager)
{
$this->serviceManager = $serviceManager;
$this->mailer = $serviceManager->getService('mailer');
}