Definitions
in package
File definitions helper.
Contains file extensions for common use cases.
Tags
Table of Contents
- get() : array<string|int, mixed>
- Entry point to request a definition set.
- getDefinitions() : array<string|int, mixed>
- Returns a definition set from config or from the default sets.
- isPathIgnored() : bool
- Determines if a path should be ignored, sourced from the ignoreFiles and ignorePatterns definitions.
- assetExtensions() : mixed
- Extensions seen as public assets.
- audioExtensions() : mixed
- Extensions typically used as audio files.
- defaultExtensions() : mixed
- Extensions that are particularly benign.
- ignoreFiles() : mixed
- Files that can be safely ignored.
- ignorePatterns() : mixed
- File patterns that can be safely ignored.
- imageExtensions() : mixed
- Extensions typically used as images.
- videoExtensions() : mixed
- Extensions typically used as video files.
Methods
get()
Entry point to request a definition set.
public
static get( $type) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —getDefinitions()
Returns a definition set from config or from the default sets.
public
getDefinitions( $type) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —isPathIgnored()
Determines if a path should be ignored, sourced from the ignoreFiles and ignorePatterns definitions.
public
static isPathIgnored(string $path) : bool
Parameters
- $path : string
-
Specifies a path to check.
Tags
Return values
bool —Returns TRUE if the path is visible.
assetExtensions()
Extensions seen as public assets.
protected
assetExtensions() : mixed
This list can be customized with config:
- cms.fileDefinitions.assetExtensions
Return values
mixed —audioExtensions()
Extensions typically used as audio files.
protected
audioExtensions() : mixed
This list can be customized with config:
- cms.fileDefinitions.audioExtensions
Return values
mixed —defaultExtensions()
Extensions that are particularly benign.
protected
defaultExtensions() : mixed
This list can be customized with config:
- cms.fileDefinitions.defaultExtensions
Return values
mixed —ignoreFiles()
Files that can be safely ignored.
protected
ignoreFiles() : mixed
This list can be customized with config:
- cms.fileDefinitions.ignoreFiles
Return values
mixed —ignorePatterns()
File patterns that can be safely ignored.
protected
ignorePatterns() : mixed
This list can be customized with config:
- cms.fileDefinitions.ignorePatterns
Return values
mixed —imageExtensions()
Extensions typically used as images.
protected
imageExtensions() : mixed
This list can be customized with config:
- cms.fileDefinitions.imageExtensions
Return values
mixed —videoExtensions()
Extensions typically used as video files.
protected
videoExtensions() : mixed
This list can be customized with config:
- cms.fileDefinitions.videoExtensions