1. Documentation
  2. API
  3. Library
  4. Filesystem
  5. Definitions

October\Rain\Filesystem\Definitions

File definitions helper. Contains file extensions for common use cases.

Public methods

public static void get($type)

getDefinitions is an entry point to request a definition set

Parameters
  • $type

public void getDefinitions($type)

getDefinitions returns a definition set from config or from the default sets.

Parameters
  • $type

public static boolean isPathIgnored(string $path)

Determines if a path should be ignored, sourced from the ignoreFiles and ignorePatterns definitions.

Parameters
  • string $path - Specifies a path to check.

Protected methods

protected void assetExtensions()

Extensions seen as public assets. This list can be customized with config:

  • cms.fileDefinitions.assetExtensions

protected void audioExtensions()

Extensions typically used as audio files. This list can be customized with config:

  • cms.fileDefinitions.audioExtensions

protected void defaultExtensions()

Extensions that are particularly benign. This list can be customized with config:

  • cms.fileDefinitions.defaultExtensions

protected void ignoreFiles()

Files that can be safely ignored. This list can be customized with config:

  • cms.fileDefinitions.ignoreFiles

protected void ignorePatterns()

File patterns that can be safely ignored. This list can be customized with config:

  • cms.fileDefinitions.ignorePatterns

protected void imageExtensions()

Extensions typically used as images. This list can be customized with config:

  • cms.fileDefinitions.imageExtensions

protected void videoExtensions()

Extensions typically used as video files. This list can be customized with config:

  • cms.fileDefinitions.videoExtensions