Definitions
File definitions helper.
class Winter\Storm\Filesystem\DefinitionsContains file extensions for common use cases.
Methods
public final __construct ()
Lock down the constructor for this class.
public static get (string $type) : array
Entry point to request a definition set.
| Property | Type | Description |
|---|---|---|
| $type | string |
string
|
public getDefinitions (string $type) : array
Returns a definition set from config or from the default sets.
| Property | Type | Description |
|---|---|---|
| $type | string |
string
|
public static isPathIgnored (string $path) : bool
Determines if a path should be ignored based on the ignoreFiles and ignorePatterns definitions.
Returns true if the path is ignored, false otherwise.
| Property | Type | Description |
|---|---|---|
| $path | string |
string
|
protected assetExtensions () : array
Extensions seen as public assets.
This list can be customized with config:
cms.fileDefinitions.assetExtensions
protected audioExtensions () : array
Extensions typically used as audio files.
This list can be customized with config:
cms.fileDefinitions.audioExtensions
protected defaultExtensions () : array
Extensions that are particularly benign.
This list can be customized with config:
cms.fileDefinitions.defaultExtensions
protected ignoreFiles () : array
Files that can be safely ignored.
This list can be customized with the config:
cms.fileDefinitions.ignoreFiles
protected ignorePatterns () : array
File patterns that can be safely ignored.
This list can be customized with the config:
cms.fileDefinitions.ignorePatterns
protected imageExtensions () : array
Extensions typically used as images.
This list can be customized with config:
cms.fileDefinitions.imageExtensions
protected videoExtensions () : array
Extensions typically used as video files.
This list can be customized with config:
cms.fileDefinitions.videoExtensions