LinksExtension
extends BaseExtension
in package
Provides extensions to the Plates engine, adding helper methods for handling of configuration links
Tags
Table of Contents
- $dbTheme : Theme
- __construct() : mixed
- Creates a new LinksExtension class
- blogCategory() : BlogCategory|null
- Returns the blog category with the given name or null
- classicPage() : ClassicPage|null
- Returns the simple page with the given name or null
- file() : File|null
- Returns the file with the given name or null
- form() : Form|null
- Returns the form with the given name or null
- gallery() : Gallery|null
- Returns the gallery with the given name or null
- hasBlogCategory() : bool
- Returns true when a blog category with that name is configured
- hasClassicPage() : bool
- Returns true when a simple page with that name is configured
- hasFile() : bool
- Returns true when a file with that name is configured
- hasForm() : bool
- Returns true when a form with that name is configured
- hasGallery() : bool
- Returns true when a gallery with that name is configured
- hasMenu() : bool
- Returns true when a menu with that name is configured
- hasModernPage() : bool
- Returns true when a segment page with that name is configured
- menu() : Menu|null
- Returns the menu with the given name or null
- modernPage() : ModernPage|null
- Returns the segment page with the given name or null
- register() : void
- Registers the helper method with the plates engine
Properties
$dbTheme
private
Theme
$dbTheme
The theme from the database
Tags
Methods
__construct()
Creates a new LinksExtension class
public
__construct(Theme $dbTheme) : mixed
Parameters
- $dbTheme : Theme
Tags
Return values
mixed —blogCategory()
Returns the blog category with the given name or null
public
blogCategory(string $name) : BlogCategory|null
Parameters
- $name : string
Tags
Return values
BlogCategory|null —classicPage()
Returns the simple page with the given name or null
public
classicPage(string $name) : ClassicPage|null
Parameters
- $name : string
Tags
Return values
ClassicPage|null —file()
Returns the file with the given name or null
public
file(string $name) : File|null
Parameters
- $name : string
Tags
Return values
File|null —form()
Returns the form with the given name or null
public
form(string $name) : Form|null
Parameters
- $name : string
Tags
Return values
Form|null —gallery()
Returns the gallery with the given name or null
public
gallery(string $name) : Gallery|null
Parameters
- $name : string
Tags
Return values
Gallery|null —hasBlogCategory()
Returns true when a blog category with that name is configured
public
hasBlogCategory(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —hasClassicPage()
Returns true when a simple page with that name is configured
public
hasClassicPage(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —hasFile()
Returns true when a file with that name is configured
public
hasFile(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —hasForm()
Returns true when a form with that name is configured
public
hasForm(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —hasGallery()
Returns true when a gallery with that name is configured
public
hasGallery(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —hasMenu()
Returns true when a menu with that name is configured
public
hasMenu(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —hasModernPage()
Returns true when a segment page with that name is configured
public
hasModernPage(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —menu()
Returns the menu with the given name or null
public
menu(string $name) : Menu|null
Parameters
- $name : string
Tags
Return values
Menu|null —modernPage()
Returns the segment page with the given name or null
public
modernPage(string $name) : ModernPage|null
Parameters
- $name : string
Tags
Return values
ModernPage|null —register()
Registers the helper method with the plates engine
public
register(Engine $engine) : void
Parameters
- $engine : Engine