!!!IMPORTANT!!! This package is no longer maintained, as Zendframework was renamed to laminas. Please use eth85055/laminas-mvc-themer instead.
The Eth8585\ZendMvcThemer moduole adds theming support to Zend\Mvc apps.
Install eth8505/zend-mvc-themer package via composer.
$ composer require eth8505/zend-mvc-themerLoad the module in your application.config.php file like so:
<?php
return [
'modules' => [
'Eth8585\ZendMvcThemer\\',
// ...
],
];As described above, themes need to be registered with the theme plugin manager. A theme must implement the
ThemeInterface. All methods exept for getName may return an empty array. Check the DefaultTheme class
for an empty implementation of a theme specifying only a name.
Implement the getStylesheet method in your theme, and return an array. Note that all paths will be pushed through
the BasePath view helper and hence must be relative to your public/ directory.
<?php
use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
class MyTheme implements ThemeInterface {
// ...
public function getStylesheets() : array {
return [
'css/theme/my/custom/file.css'
];
}
// ...
}All stylesheets are injected using the appendStylesheet method of the HeadLink viewhelper.
Implement the getScripts method in your theme, and return an array. Note that all paths will be pushed through
the BasePath view helper and hence must be relative to your public/ directory.
<?php
use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
class MyTheme implements ThemeInterface {
// ...
public function getScripts() : array {
return [
'css/theme/my/custom/file.js'
];
}
// ...
}All scripts are injected using the prependFile method of the HeadScript viewhelper.
Implement the getVariables method in your theme, and return an array. Note that all paths will be pushed through
the BasePath view helper and hence must be relative to your public/ directory.
<?php
use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
class MyTheme implements ThemeInterface {
// ...
public function getVariables() : array {
return [
'heading1' => 'one',
'heading2' => [
'key1' => 'test'
]
];
}
// ...
}Theme variables are not automatically injected into your view models, as this could interfere with whatever you
set in your view models. However, the module provides a theme() view helper allowing access to the theme variables.
<html>
<body>
<h1><?= $this->theme()->var('heading1') ?></h1>
<h2><?= $this->theme()->var('heading2/key1') ?></h2>
</body>
</html>Meta tags are a little more complicated than scripts, styles or variables, as there are two basic types, name and
http-equiv. With this module, we use the same basic-syntax for both of them, specifying the type as a key in the
definition array.
To implement custom meta tags, implement get getMetaTags method in your theme.
<?php
use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
class MyTheme implements ThemeInterface {
// ...
public function getMetaTags() : array {
return [
[
'type' => 'name',
'name' => 'robots',
'content' => 'noindex,nofollow'
],
[
'type' => 'http-equiv',
'name' => 'refresh',
'content' => '30'
]
];
}
// ...
}You can either register your themes with the service manager via the config in your module.config.php:
<?php
return [
'zend-mvc-themes' => [
'invokables' => [
MyTheme::class
]
]
];or register it in your module class using the ThemeProviderInterface:
<?php
namespace MyModule;
use Eth8505\ZendMvcThemer\Theme\ThemeProviderInterface;
class Module implements ThemeProviderInterface {
/**
* @inheritdoc
*/
public function getThemeConfig() {
return [
'invokables' => [
MyTheme::class
]
];
}
}Per default, theme resolving is done using the ConfigResolver class, that simply checks the config
zend-mvc-themer/resolver config, and injects the theme as the theme service.
In addition to the default config-based theme resolver, you can also specify a custom resolver class. This can be any
implementation of ThemeResolverInterface of your choosing, reading the theme from the session (if you want to provide
a selection of themes to your users).
Example implementation of a simple hostname-based theme resolver:
<?php
namespace MyModule;
use Eth8505\ZendMvcThemer\Resolver\ThemeResolverInterface;
use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
use Eth8505\ZendMvcThemer\Theme\ThemePluginManager;
use Zend\Http\Request;
class Module implements ThemeResolverInterface {
private $request;
private $pluginManager;
public function __construct(Request $request, ThemePluginManager $pluginManager) {
$this->request = $request;
$this->pluginManager = $pluginManager;
}
public function resolve() : ThemeInterface {
if ($this->request->getUri()->getHost() === 'my.awesome.host') {
$theme = ThemeOne::class;
} else {
$theme = ThemeTwo::class;
}
return $this->pluginManager->get($theme);
}
}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent