API Documentation
\
App
Base
Abstracts
Blocks
Commands
Controllers
Migrations
Models
Queues
Controllers
Dummy
Exceptions
Overrides
Migrations
Tools
Assets
Cache
DataCollector
Plates
Utils
Traits
Site
Blocks
Commands
App
Cache
Config
Cron
Db
Generate
Info
Queue
Roles
Users
Website
Controllers
Admin
Crud
Json
Frontend
Users
Cron
Tasks
Migrations
Models
Queues
ContactFormMail
InternalMail
LinkFormMail
Routing

\App\Base\Tools\PlatesSiteBase

Plates template helper

Summary

Methods
Properties
Constants
__construct()
register()
getObject()
getCurrentWebsite()
getCurrentLocale()
renderBlocks()
translate()
getDebugbar()
assetUrl()
getUrl()
getGravatar()
drawIcon()
env()
version()
renderFlashMessages()
summarize()
getPageRegions()
No public properties found
No constants found
getAssets()
getHtmlRenderer()
getApp()
$engine
$container
N/A
No private methods found
No private properties found
N/A

Properties

$engine

$engine :\League\Plates\Engine

Type

\League\Plates\Engine—templates engine

$container

$container :\Psr\Container\ContainerInterface

Type

\Psr\Container\ContainerInterface—container

Methods

__construct()

__construct(\Psr\Container\ContainerInterface  $container)

constructor

Parameters

\Psr\Container\ContainerInterface $container

register()

register(\League\Plates\Engine  $engine): void

{@inheritdocs}

Parameters

\League\Plates\Engine $engine

[description]

getObject()

getObject(): self

gets helper object

Returns

self

getCurrentWebsite()

getCurrentWebsite(): \App\Site\Models\Website

gets current website

Returns

\App\Site\Models\Website

getCurrentLocale()

getCurrentLocale(): string

gets current locale

Returns

string

renderBlocks()

renderBlocks(  $region,\App\Base\Abstracts\Controllers\BasePage  $controller): string

render block for region

Parameters

$region
\App\Base\Abstracts\Controllers\BasePage $controller

Throws

\Degami\Basics\Exceptions\BasicException
\Phpfastcache\Exceptions\PhpfastcacheSimpleCacheException

Returns

string

translate()

translate(string  $string): string

gets string translations

Parameters

string $string

Returns

string

getDebugbar()

getDebugbar(): \DebugBar\StandardDebugBar

return debugger object

Returns

\DebugBar\StandardDebugBar

assetUrl()

assetUrl(  $asset_path): string

gets asset url

Parameters

$asset_path

Throws

\Degami\Basics\Exceptions\BasicException
\Phpfastcache\Exceptions\PhpfastcacheSimpleCacheException

Returns

string

getUrl()

getUrl(string  $route_name,array  $route_params = array()): string

gets route url by name and params

Parameters

string $route_name
array $route_params

Returns

string

getGravatar()

getGravatar(string  $email,integer  $s = 80,string  $d = 'mp',string  $r = 'g',string  $class = 'rounded-circle'): string

gets gravatar html

Parameters

string $email
integer $s
string $d
string $r
string $class

Returns

string

drawIcon()

drawIcon(string  $icon_name): void

draws icon

Parameters

string $icon_name

env()

env(string  $variable,null  $default = null): mixed

gets env variable

Parameters

string $variable
null $default

Returns

mixed

version()

version(): string

gets app version

Returns

string

summarize()

summarize(string  $text,integer  $max_words = 10): string

summarize text

Parameters

string $text
integer $max_words

Returns

string

getPageRegions()

getPageRegions(): array

returns page regions

Returns

array

getApp()

getApp(): \App\App

gets app object

Returns

\App\App