HelperTrait
Helper trait for auto-completion of code in modern IDEs.
The trait provides convenience methods for view helpers, defined in the application module. It is designed to be used for type-hinting $this variable inside laminas-view templates via doc blocks.
Other traits from laminas are already chained into this trait. This includes support for the FlashMessenger, Form, and i18n view helpers.
phpcs:disable Generic.Files.LineLength.TooLong
Table of Contents
Methods
- acl() : Acl
- addBreadcrumb() : Breadcrumbs
- bootstrapElementError() : string
- breadcrumbs() : Breadcrumbs
- companyIdentity() : CompanyUser|null
- diff() : string
- featuredCompanyPackage() : CompanyFeaturedPackage|null
- fileUrl() : string
- glideUrl() : GlideUrl
- hashUrl() : HashUrl
- highlightSearch() : string
- hrefLang() : HrefLang
- jobCategories() : array<string|int, JobCategory>
- localisedTextElement() : string
- localiseText() : string
- markdown() : string
- moduleIsActive() : bool
- scriptUrl() : ScriptUrl
- timeDiff() : string
- truncate() : string
Methods
acl()
public
acl(string $factory) : Acl
Parameters
- $factory : string
Return values
AcladdBreadcrumb()
public
addBreadcrumb([string $breadcrumb = = '\'\\\'\\\'\'' ][, bool $active = = 'true' ][, string $url = = '\'\\\'\\\'\'' ][, string|null $setType = = 'null' ]) : Breadcrumbs
Parameters
- $breadcrumb : string = = '\'\\\'\\\'\''
- $active : bool = = 'true'
- $url : string = = '\'\\\'\\\'\''
- $setType : string|null = = 'null'
Return values
BreadcrumbsbootstrapElementError()
public
bootstrapElementError(ElementInterface $element) : string
Parameters
- $element : ElementInterface
Return values
stringbreadcrumbs()
public
breadcrumbs() : Breadcrumbs
Return values
BreadcrumbscompanyIdentity()
public
companyIdentity() : CompanyUser|null
Return values
CompanyUser|nulldiff()
public
diff(string|null $old, string|null $new[, string $renderer = = 'Diff::DIFF_RENDER_COMBINED' ][, array<string|int, mixed> $rendererOverwrites = = '[]' ][, array<string|int, mixed> $differOverwrites = = '[]' ]) : string
Parameters
- $old : string|null
- $new : string|null
- $renderer : string = = 'Diff::DIFF_RENDER_COMBINED'
- $rendererOverwrites : array<string|int, mixed> = = '[]'
- $differOverwrites : array<string|int, mixed> = = '[]'
Return values
stringfeaturedCompanyPackage()
public
featuredCompanyPackage() : CompanyFeaturedPackage|null
Return values
CompanyFeaturedPackage|nullfileUrl()
public
fileUrl(string $path) : string
Parameters
- $path : string
Return values
stringglideUrl()
public
glideUrl() : GlideUrl
Return values
GlideUrlhashUrl()
public
hashUrl() : HashUrl
Return values
HashUrlhighlightSearch()
public
highlightSearch(string $query, string $content) : string
Parameters
- $query : string
- $content : string
Return values
stringhrefLang()
public
hrefLang() : HrefLang
Return values
HrefLangjobCategories()
public
jobCategories() : array<string|int, JobCategory>
Return values
array<string|int, JobCategory>localisedTextElement()
public
localisedTextElement(ElementInterface $element) : string
Parameters
- $element : ElementInterface
Return values
stringlocaliseText()
public
localiseText(LocalisedText $localisedText) : string
Parameters
- $localisedText : LocalisedText
Return values
stringmarkdown()
public
markdown(string $text[, bool $company = = 'false' ]) : string
Parameters
- $text : string
- $company : bool = = 'false'
Return values
stringmoduleIsActive()
public
moduleIsActive(array<string|int, mixed> $conditions) : bool
Parameters
- $conditions : array<string|int, mixed>
Return values
boolscriptUrl()
public
scriptUrl() : ScriptUrl
Return values
ScriptUrltimeDiff()
public
timeDiff(DateTime $start, DateTime $end) : string
Parameters
- $start : DateTime
- $end : DateTime
Return values
stringtruncate()
public
truncate(string $text[, int $length = = '100' ][, array<string|int, mixed> $options = = '[]' ]) : string
Parameters
- $text : string
- $length : int = = '100'
- $options : array<string|int, mixed> = = '[]'