HtmlPartsRenderer
extends ContainerAwareObject
in package
Html Parts Renderer Helper Class
Table of Contents
Properties
- $translators : array<string|int, mixed>
- $container : ContainerInterface
Methods
- __call() : mixed
- {@inheritdoc}
- __construct() : mixed
- constructor
- containerCall() : mixed
- call method through container
- containerMake() : mixed
- create object through container
- getApp() : App
- gets app object
- getApplicationLogger() : Manager
- gets application_logger service
- getAppRouteInfo() : RouteInfo|null
- gets route info
- getAppWebsite() : Website|null
- gets current website
- getAssets() : Manager
- gets assets manager
- getCache() : Manager
- get cache manager
- getContainer() : ContainerInterface
- gets container object
- getCrudRouter() : Crud
- gets crud service
- getDb() : Database
- gets db object
- getDebugbar() : StandardDebugBar
- gets debugbar object
- getEnv() : mixed
- gets env variable
- getEventManager() : SharedEventEmitter
- gets events manager service
- getFAIcon() : string
- gets an Font Awesome icon
- getGoogleAuthenticator() : PHPGangsta_GoogleAuthenticator
- gets google authenticator service
- getGravatar() : string
- Get either a Gravatar image tag for a specified email address.
- getGuzzle() : Client
- gets guzzle service
- getHtmlAdminClasses() : string
- returns body_classes array based on controller
- getHtmlRenderer() : HtmlPartsRenderer
- gets html renderer service
- getIcon() : string
- gets an icon
- getIcons() : Icons
- gets icons service
- getImagine() : Imagine
- gets imagine service
- getLog() : Logger
- gets log object
- getMailer() : Mailer
- gets mailer service
- getPdo() : PDO
- gets PDO object
- getRedis() : Manager
- gets redis service
- getRequest() : Request
- gets current request object
- getRouters() : array<string|int, mixed>
- gets routers
- getSchema() : Schema
- gets schema object
- getSearch() : Manager
- gets search service
- getSesMailer() : SesClient
- gets SES mailer service
- getSiteData() : SiteData
- gets site data service
- getSmtpMailer() : Swift_Mailer
- gets SMTP mailer service
- getTemplates() : Engine
- gets plates engine object
- getTranslator() : Translator
- gets translator
- getUtils() : Globals
- gets global utils service
- getWebhooksRouter() : Webhooks
- gets webhooks service
- getWebRouter() : Web
- gets routing service
- getZip() : Zip
- gets zip service
- renderAdminTable() : string
- renders admin table
- renderApplicationLog() : mixed
- renders application log
- renderArrayOnTable() : mixed
- Renders array as table field name - field value
- renderBlocks() : string|null
- render region blocks
- renderFlag() : string
- renders a flag icon
- renderFlashMessages() : TagList
- returns flash message html
- renderLog() : mixed
- renders log
- renderPaginator() : string
- renders paginator
- renderQueueMessage() : mixed
- renders queue message
- renderSiteMenu() : string|null
- render site menu
- renderUncachableBlockTag() : string
- requestUrl() : string|bool
- executes an http request
- getService() : mixed
- gets registered service
- internalRenderSiteMenu() : TagElement
- internally renders site menu
- renderMenuLink() : TagElement
- internally renders menu link
- getPaginatorLi() : TagElement
- gets paginator li html tag
Properties
$translators
public
static array<string|int, mixed>
$translators
= []
translators
$container
protected
ContainerInterface
$container
Methods
__call()
{@inheritdoc}
public
__call(string $name, mixed $arguments) : mixed
Parameters
- $name : string
- $arguments : mixed
Tags
__construct()
constructor
public
__construct(ContainerInterface $container) : mixed
Parameters
- $container : ContainerInterface
containerCall()
call method through container
public
containerCall(callable $callable[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
- $callable : callable
- $arguments : array<string|int, mixed> = []
containerMake()
create object through container
public
containerMake(string $className[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
- $className : string
- $arguments : array<string|int, mixed> = []
getApp()
gets app object
public
getApp() : App
Tags
Return values
AppgetApplicationLogger()
gets application_logger service
public
getApplicationLogger() : Manager
Tags
Return values
ManagergetAppRouteInfo()
gets route info
public
getAppRouteInfo() : RouteInfo|null
Return values
RouteInfo|nullgetAppWebsite()
gets current website
public
getAppWebsite() : Website|null
Return values
Website|nullgetAssets()
gets assets manager
public
getAssets() : Manager
Tags
Return values
ManagergetCache()
get cache manager
public
getCache() : Manager
Tags
Return values
ManagergetContainer()
gets container object
public
getContainer() : ContainerInterface
Return values
ContainerInterfacegetCrudRouter()
gets crud service
public
getCrudRouter() : Crud
Tags
Return values
CrudgetDb()
gets db object
public
getDb() : Database
Tags
Return values
DatabasegetDebugbar()
gets debugbar object
public
getDebugbar() : StandardDebugBar
Tags
Return values
StandardDebugBargetEnv()
gets env variable
public
getEnv(string $variable[, mixed $default = null ]) : mixed
Parameters
- $variable : string
- $default : mixed = null
Tags
getEventManager()
gets events manager service
public
getEventManager() : SharedEventEmitter
Tags
Return values
SharedEventEmittergetFAIcon()
gets an Font Awesome icon
public
getFAIcon(string $icon_name, string $theme) : string
Parameters
- $icon_name : string
- $theme : string
Tags
Return values
stringgetGoogleAuthenticator()
gets google authenticator service
public
getGoogleAuthenticator() : PHPGangsta_GoogleAuthenticator
Tags
Return values
PHPGangsta_GoogleAuthenticatorgetGravatar()
Get either a Gravatar image tag for a specified email address.
public
getGravatar(string $email[, int $s = 80 ][, string $d = 'mp' ][, string $r = 'g' ][, string $class = 'rounded-circle' ]) : string
Parameters
- $email : string
-
The email address
- $s : int = 80
-
Size in pixels, defaults to 80px [ 1 - 2048 ]
- $d : string = 'mp'
-
Default imageset to use [ 404 | mp | identicon | monsterid | wavatar ]
- $r : string = 'g'
-
Maximum rating (inclusive) [ g | pg | r | x ]
- $class : string = 'rounded-circle'
-
html class
Return values
string —containing a complete image tag
getGuzzle()
gets guzzle service
public
getGuzzle() : Client
Tags
Return values
ClientgetHtmlAdminClasses()
returns body_classes array based on controller
public
getHtmlAdminClasses(AdminPage|Login $controller) : string
Parameters
Return values
stringgetHtmlRenderer()
gets html renderer service
public
getHtmlRenderer() : HtmlPartsRenderer
Tags
Return values
HtmlPartsRenderergetIcon()
gets an icon
public
getIcon(string $icon_name[, array<string|int, mixed> $attributes = [] ]) : string
Parameters
- $icon_name : string
- $attributes : array<string|int, mixed> = []
Tags
Return values
stringgetIcons()
gets icons service
public
getIcons() : Icons
Tags
Return values
IconsgetImagine()
gets imagine service
public
getImagine() : Imagine
Tags
Return values
ImaginegetLog()
gets log object
public
getLog() : Logger
Tags
Return values
LoggergetMailer()
gets mailer service
public
getMailer() : Mailer
Tags
Return values
MailergetPdo()
gets PDO object
public
getPdo() : PDO
Tags
Return values
PDOgetRedis()
gets redis service
public
getRedis() : Manager
Tags
Return values
ManagergetRequest()
gets current request object
public
getRequest() : Request
Tags
Return values
RequestgetRouters()
gets routers
public
getRouters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getSchema()
gets schema object
public
getSchema() : Schema
Tags
Return values
SchemagetSearch()
gets search service
public
getSearch() : Manager
Tags
Return values
ManagergetSesMailer()
gets SES mailer service
public
getSesMailer() : SesClient
Tags
Return values
SesClientgetSiteData()
gets site data service
public
getSiteData() : SiteData
Tags
Return values
SiteDatagetSmtpMailer()
gets SMTP mailer service
public
getSmtpMailer() : Swift_Mailer
Tags
Return values
Swift_MailergetTemplates()
gets plates engine object
public
getTemplates() : Engine
Tags
Return values
EnginegetTranslator()
gets translator
public
getTranslator([string|null $locale_code = null ]) : Translator
Parameters
- $locale_code : string|null = null
Tags
Return values
TranslatorgetUtils()
gets global utils service
public
getUtils() : Globals
Tags
Return values
GlobalsgetWebhooksRouter()
gets webhooks service
public
getWebhooksRouter() : Webhooks
Tags
Return values
WebhooksgetWebRouter()
gets routing service
public
getWebRouter() : Web
Tags
Return values
WebgetZip()
gets zip service
public
getZip() : Zip
Tags
Return values
ZiprenderAdminTable()
renders admin table
public
renderAdminTable(array<string|int, mixed> $elements[, null $header = null ][, BasePage|null $current_page = null ]) : string
Parameters
- $elements : array<string|int, mixed>
- $header : null = null
- $current_page : BasePage|null = null
Tags
Return values
stringrenderApplicationLog()
renders application log
public
renderApplicationLog(ApplicationLog $log) : mixed
Parameters
- $log : ApplicationLog
Tags
renderArrayOnTable()
Renders array as table field name - field value
public
renderArrayOnTable(array<string|int, mixed> $data[, bool $nowrap = true ]) : mixed
Parameters
- $data : array<string|int, mixed>
- $nowrap : bool = true
Tags
renderBlocks()
render region blocks
public
renderBlocks(string $region[, null $locale = null ][, BasePage|null $current_page = null ]) : string|null
Parameters
- $region : string
- $locale : null = null
- $current_page : BasePage|null = null
Tags
Return values
string|nullrenderFlag()
renders a flag icon
public
renderFlag(mixed $country_code[, string $class = 'flag-icon' ][, int $width = 20 ]) : string
Parameters
- $country_code : mixed
- $class : string = 'flag-icon'
- $width : int = 20
Tags
Return values
stringrenderFlashMessages()
returns flash message html
public
renderFlashMessages(BasePage $controller) : TagList
Parameters
- $controller : BasePage
Tags
Return values
TagListrenderLog()
renders log
public
renderLog(RequestLog|CronLog|MailLog|AdminActionLog $log[, bool $nowrap = true ]) : mixed
Parameters
- $log : RequestLog|CronLog|MailLog|AdminActionLog
- $nowrap : bool = true
Tags
renderPaginator()
renders paginator
public
renderPaginator(int $current_page, int $total, BasePage $controller[, int $page_size = BaseCollection::ITEMS_PER_PAGE ][, int $visible_links = 2 ]) : string
Parameters
- $current_page : int
- $total : int
- $controller : BasePage
- $page_size : int = BaseCollection::ITEMS_PER_PAGE
- $visible_links : int = 2
Tags
Return values
stringrenderQueueMessage()
renders queue message
public
renderQueueMessage(QueueMessage $message) : mixed
Parameters
- $message : QueueMessage
Tags
renderSiteMenu()
render site menu
public
renderSiteMenu(string $locale) : string|null
Parameters
- $locale : string
Tags
Return values
string|nullrenderUncachableBlockTag()
public
renderUncachableBlockTag(Block $block, BasePage|null $current_page[, string|null $locale = null ]) : string
Parameters
Return values
stringrequestUrl()
executes an http request
public
requestUrl(string $url[, string $method = 'GET' ][, array<string|int, mixed> $options = [] ]) : string|bool
Parameters
- $url : string
- $method : string = 'GET'
- $options : array<string|int, mixed> = []
Tags
Return values
string|boolgetService()
gets registered service
protected
getService(string $service_key) : mixed
Parameters
- $service_key : string
Tags
internalRenderSiteMenu()
internally renders site menu
protected
internalRenderSiteMenu(array<string|int, mixed> $menu_tree[, array<string|int, mixed>|null $parent = null ]) : TagElement
Parameters
- $menu_tree : array<string|int, mixed>
- $parent : array<string|int, mixed>|null = null
Tags
Return values
TagElementrenderMenuLink()
internally renders menu link
protected
renderMenuLink(array<string|int, mixed> $leaf[, string $link_class = 'nav-link' ]) : TagElement
Parameters
- $leaf : array<string|int, mixed>
- $link_class : string = 'nav-link'
Tags
Return values
TagElementgetPaginatorLi()
gets paginator li html tag
private
getPaginatorLi(string $li_class, string|null $href, string $text) : TagElement
Parameters
- $li_class : string
- $href : string|null
- $text : string