FileLinktype extends AbstractLinktype
This class provides Check File Links plugin implementation
Table of Contents
Properties
- $errorParams : array<string|int, mixed>
- Contains parameters needed for the rendering of the error message
- $identifier : string
Methods
- checkLink() : bool
- Checks a given URL + /path/filename.ext for validity
- fetchType() : string
- Type fetching method, based on the type that softRefParserObj returns
- getBrokenUrl() : string
- Construct a valid Url for browser output
- getErrorMessage() : string
- Generate the localized error message from the error params saved from the parsing
- getErrorParams() : array<string|int, mixed>
- Get the value of the private property errorParams
- getIdentifier() : string
- Returns the unique identifier of the linktype
- 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
= 'file'
Methods
checkLink()
Checks a given URL + /path/filename.ext for validity
public
checkLink(string $url, array<string|int, mixed> $softRefEntry, LinkAnalyzer $reference) : bool
Parameters
- $url : string
-
Url to check
- $softRefEntry : array<string|int, mixed>
-
The soft reference entry which builds the context of the url
- $reference : LinkAnalyzer
-
Parent instance
Return values
bool —TRUE on success or FALSE on error
fetchType()
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
getErrorMessage()
Generate the localized error message from the error params saved from the parsing
public
getErrorMessage(array<string|int, mixed> $errorParams) : string
Parameters
- $errorParams : array<string|int, mixed>
-
All parameters needed for the rendering of the error message
Return values
string —Validation error message
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
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