Linux/Unix>> zend-mvc-themer>> 返回
项目作者： eth8505

项目描述 ：
Module for Theming Zend\Mvc apps
高级语言： PHP
项目地址: git://github.com/eth8505/zend-mvc-themer.git
创建时间： 2018-03-12T18:53:53Z
项目社区：https://github.com/eth8505/zend-mvc-themer
开源协议：MIT License
下载


Eth8505\ZendMvcThemer - Module for Theming Zend\Mvc apps

!!!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.

How to install

Install eth8505/zend-mvc-themer package via composer.

  1. $ composer require eth8505/zend-mvc-themer

Load the module in your application.config.php file like so:

  1. <?php
  3. return [
  4.     'modules' => [
  5.         'Eth8585\ZendMvcThemer\\',
  6.         // ...
  7.     ],
  8. ];

How to use

1 Creating a theme

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.

1.1 Specifying custom stylesheets

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.

  1. <?php
  3. use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
  5. class MyTheme implements ThemeInterface {
  6.     // ...
  7.     public function getStylesheets() : array {
  8.         return [
  9.             'css/theme/my/custom/file.css'
  10.         ];
  11.     }
  12.     // ...
  13. }

All stylesheets are injected using the appendStylesheet method of the HeadLink viewhelper.

1.2 Specifying custom javascripts

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.

  1. <?php
  3. use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
  5. class MyTheme implements ThemeInterface {
  6.     // ...
  7.     public function getScripts() : array {
  8.         return [
  9.             'css/theme/my/custom/file.js'
  10.         ];
  11.     }
  12.     // ...
  13. }

All scripts are injected using the prependFile method of the HeadScript viewhelper.

1.3 Specifying custom variables

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.

  1. <?php
  3. use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
  5. class MyTheme implements ThemeInterface {
  6.     // ...
  7.     public function getVariables() : array {
  8.         return [
  9.             'heading1' => 'one',
  10.             'heading2' => [
  11.                 'key1' => 'test'
  12.             ]
  13.         ];
  14.     }
  15.     // ...
  16. }

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.

  1. <html>
  2.     <body>
  3.         <h1><?= $this->theme()->var('heading1') ?></h1>
  4.         <h2><?= $this->theme()->var('heading2/key1') ?></h2>
  5.     </body>
  6. </html>

1.4 Specifying custom meta tags

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.

  1. <?php
  3. use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
  5. class MyTheme implements ThemeInterface {
  6.     // ...
  7.     public function getMetaTags() : array {
  8.         return [
  9.             [
  10.                 'type' => 'name',
  11.                 'name' => 'robots',
  12.                 'content' => 'noindex,nofollow'
  13.             ],
  14.             [
  15.                 'type' => 'http-equiv',
  16.                 'name' => 'refresh',
  17.                 'content' => '30'
  18.             ]
  19.         ];
  20.     }
  21.     // ...
  22. }

2. Register with service manager

You can either register your themes with the service manager via the config in your module.config.php:

  1. <?php
  3. return [
  4.     'zend-mvc-themes' => [
  5.         'invokables' => [
  6.             MyTheme::class
  7.         ]
  8.     ]
  9. ];

or register it in your module class using the ThemeProviderInterface:

  1. <?php
  3. namespace MyModule;
  5. use Eth8505\ZendMvcThemer\Theme\ThemeProviderInterface;
  7. class Module implements ThemeProviderInterface {
  9.     /**
  10.      * @inheritdoc 
  11.      */
  12.     public function getThemeConfig() {
  14.         return [
  15.             'invokables' => [
  16.                 MyTheme::class
  17.             ]
  18.         ];
  20.     }
  22. }

3. Resolving themes

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.

3.1 Custom theme resolvers

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:

  1. <?php
  2. namespace MyModule;
  4. use Eth8505\ZendMvcThemer\Resolver\ThemeResolverInterface;
  5. use Eth8505\ZendMvcThemer\Theme\ThemeInterface;
  6. use Eth8505\ZendMvcThemer\Theme\ThemePluginManager;
  7. use Zend\Http\Request;
  9. class Module implements ThemeResolverInterface {
  11.     private $request;
  13.     private $pluginManager;
  15.     public function __construct(Request $request, ThemePluginManager $pluginManager) {
  16.         $this->request = $request;
  17.         $this->pluginManager = $pluginManager;
  18.     }
  20.     public function resolve() : ThemeInterface  {
  22.         if ($this->request->getUri()->getHost() === 'my.awesome.host') {
  23.             $theme = ThemeOne::class;
  24.         } else {
  25.             $theme = ThemeTwo::class;
  26.         }
  28.         return $this->pluginManager->get($theme);
  30.     }
  32. }