kappa/themes-manager

Package for easier work with themes

dev-master 2016-06-13 19:30 UTC

Requires

• nette/application: ~2.2@dev
• nette/di: ~2.2

Requires (Dev)

• mikey179/vfsstream: ~1.4@dev
• mockery/mockery: ~0.9@dev
• nette/nette: @dev
• nette/tester: ~1.0

BSD-3-Clause

• Ondřej Záruba

• themes
• manager
• Kappa
• packages

README

Package for easier work with themes

Requirements:

• PHP 5.4 or higher
• nette\di 2.2 or higher
• nette\application 2.2 or higher

Installation:

The best way to install Kappa\ThemesManager is using Composer

$ composer require kappa/themes-manager:@dev

Usages

First you must register extension

extensions:
	themes: Kappa\ThemesManager\DI\ThemesManagerExtension

Now you can configure templates for your application in config file

themes:
	themeName:
		themeDir: %wwwDir%/../../ # required
		assetsDir: :themeDir:/assets # required
		params:
			# params
		helpers:
			# helpers in format helperName: @service::method
		macros:
			# macros
		pathMasks:
			templates:
				# path masks for formatTemplateFiles
			layouts:
				# path masks for formatLayoutTemplateFiles

All settings will be used only in own section.

In masks you can use next placeholders:

• :themeDir: - contains theme dir path
• :assetsDir: - contains assets dir path for create temp copy into public directory. In templates now you can use {$assetsDir} variable as base path for scripts, styles and etc... files
• :presenter: - contains presenter name (without modules)
• :modules: - contains module name (module name My:Module will be replaced to My/Module)
• :module_(number): - contains module name (My:Module => module_1 = My, module_2 => Module)
• :action: - contains presenter acion name
• :view: - contains presenter view name
• :themeName: - will be replaced for theme name

In your presenter you can get template factory and file formats

Usages kdyby/autowired, it is recommended

class BasePresenter extends Presenter
{
	use AutowireProperties;

	/**
	 * @var \Kappa\ThemesManager\Theme
	 * @autowire(admin, factory=\Kappa\ThemesManager\ThemeRegistry)
	 */
	public $theme;

or classic

class BasePresenter extends Presenter
{
	/** @var \Kappa\ThemesManager\ThemesRegistry @inject */
	public $themesRegistry;

Update template:

public function getTemplateFactory()
{
	$templateFactory = parent::createTemplate();
	// For kdyby/autowired
	$templateFactory->setTheme($this->theme);
	// Else
	$theme = $this->themesRegistry->getTheme('admin');
	$templateFactory->setTheme($theme);

    return $templateFactory;
}

now your presenter have macros, helpers and params from section 'themeName' defined in config file

Next you can use custom path masks. Example:

public function formatLayoutTemplateFiles()
{
    $list = $this->theme->getPathMapper()->getFormatLayoutTemplateFiles();

    return $list;
}

public function formatTemplateFiles()
{
    $list = $this->theme->getPathMapper()->getFormatTemplateFiles();

    return $list;
}