GenericMetaTagManager implements MetaTagManagerInterface
FinalYes
Handles typical meta tags (non-grouped). Use AbstractMetaTagManager to create your own MetaTags, this class is final by design
Table of Contents
Interfaces
Properties
- $properties : array<string|int, mixed>
- Array of properties that are set by the manager
- $subPropertySeparator : string
- The separator to define subproperties like og:image:width
Methods
- addProperty() : mixed
- Add a property (including subProperties)
- canHandleProperty() : bool
- Check if this manager can handle the given property
- getAllHandledProperties() : array<string|int, mixed>
- Returns an array with all properties that can be handled by this manager
- getProperty() : array<string|int, mixed>
- Get the data of a specific property
- getState() : array<string|int, mixed>
- removeAllProperties() : mixed
- Unset all properties
- removeProperty() : mixed
- Remove one property from the MetaTagManager If there are multiple occurrences of a property, they all will be removed
- renderAllProperties() : string
- Render all registered properties of this manager
- renderProperty() : string
- Render a specific property including subproperties of that property
- updateState() : void
Properties
$properties
Array of properties that are set by the manager
protected
array<string|int, mixed>
$properties
= []
$subPropertySeparator
The separator to define subproperties like og:image:width
protected
string
$subPropertySeparator
= ':'
Methods
addProperty()
Add a property (including subProperties)
public
addProperty(string $property, string $content[, array<string|int, mixed> $subProperties = [] ][, bool $replace = false ][, string $type = 'name' ]) : mixed
Parameters
- $property : string
- $content : string
- $subProperties : array<string|int, mixed> = []
- $replace : bool = false
- $type : string = 'name'
canHandleProperty()
Check if this manager can handle the given property
public
canHandleProperty(string $property) : bool
Parameters
- $property : string
Return values
boolgetAllHandledProperties()
Returns an array with all properties that can be handled by this manager
public
getAllHandledProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>getProperty()
Get the data of a specific property
public
getProperty(string $property[, string $type = 'name' ]) : array<string|int, mixed>
Parameters
- $property : string
- $type : string = 'name'
Return values
array<string|int, mixed>getState()
public
getState() : array<string|int, mixed>
Return values
array<string|int, mixed>removeAllProperties()
Unset all properties
public
removeAllProperties() : mixed
removeProperty()
Remove one property from the MetaTagManager If there are multiple occurrences of a property, they all will be removed
public
removeProperty(string $property[, string $type = '' ]) : mixed
Parameters
- $property : string
- $type : string = ''
renderAllProperties()
Render all registered properties of this manager
public
renderAllProperties() : string
Return values
stringrenderProperty()
Render a specific property including subproperties of that property
public
renderProperty(string $property) : string
Parameters
- $property : string
Return values
stringupdateState()
public
updateState(array<string|int, mixed> $state) : void
Parameters
- $state : array<string|int, mixed>