AbstractLinktype implements LinktypeInterface, LabelledLinktypeInterface
This class provides Check Base plugin implementation
Table of Contents
Interfaces
- LinktypeInterface
- This class provides interface implementation.
- LabelledLinktypeInterface
- This class is used for composition in addition to LinktypeInterface, and provides the ability to expand implementing classes with the possibility to provide a custom Linktype label. It is utilized in the abstract class `AbstractLinktype`.
Properties
- $errorParams : array<string|int, mixed>
- Contains parameters needed for the rendering of the error message
- $identifier : string
Methods
- fetchType() : string
- Base type fetching method, based on the type that softRefParserObj returns
- getBrokenUrl() : string
- Construct a valid Url for browser output
- getErrorParams() : array<string|int, mixed>
- Get the value of the private property errorParams
- getIdentifier() : string
- Returns the unique identifier of the linktype
- getReadableName() : string
- Get localized label for this linktype to be displayed in Backend user interface.
- setAdditionalConfig() : void
- Function to override config of Linktype. Should be used only if necessary. Add additional configuration to TSconfig.
- getLanguageService() : LanguageService
- setErrorParams() : mixed
- Set the value of the protected property errorParams
Properties
$errorParams
Contains parameters needed for the rendering of the error message
protected
array<string|int, mixed>
$errorParams
= []
$identifier
protected
string
$identifier
= ''
Methods
fetchType()
Base type fetching method, based on the type that softRefParserObj returns
public
fetchType(array<string|int, mixed> $value, string $type, string $key) : string
Parameters
- $value : array<string|int, mixed>
-
Reference properties
- $type : string
-
Current type
- $key : string
-
Validator hook name
Return values
string —Fetched type
getBrokenUrl()
Construct a valid Url for browser output
public
getBrokenUrl(array<string|int, mixed> $row) : string
Parameters
- $row : array<string|int, mixed>
-
Broken link record
Return values
string —Parsed broken url
getErrorParams()
Get the value of the private property errorParams
public
getErrorParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —All parameters needed for the rendering of the error message
getIdentifier()
Returns the unique identifier of the linktype
public
getIdentifier() : string
Return values
stringgetReadableName()
Get localized label for this linktype to be displayed in Backend user interface.
public
getReadableName() : string
Custom Linktypes should override this and provide language labels for their type.
Return values
stringsetAdditionalConfig()
Function to override config of Linktype. Should be used only if necessary. Add additional configuration to TSconfig.
public
setAdditionalConfig(array<string|int, mixed> $config) : void
Parameters
- $config : array<string|int, mixed>
getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicesetErrorParams()
Set the value of the protected property errorParams
protected
setErrorParams(array<string|int, mixed> $value) : mixed
Parameters
- $value : array<string|int, mixed>
-
All parameters needed for the rendering of the error message