1. class
  2. Main
  3. \
  4. Classes
  5. \
  6. MediaLibrary

MediaLibrary

class MediaLibrary

MediaLibrary Class

Traits

Singleton

Singleton trait.

Properties

static protected $instance from  Singleton
static protected $cacheKey
protected $storageDisk
protected $storagePath
protected $storageFolder
protected $ignoreNames
protected $ignorePatterns
protected $storageFolderNameLength
protected $allowedExtensions
protected $config

Methods

static 
instance()

Create a new instance of this singleton.

from  Singleton
static 
forgetInstance()

Forget this singleton's instance if it exists

from  Singleton
__construct()

Constructor.

from  Singleton
initialize()

No description

__clone()

No description

from  Singleton
__wakeup()

No description

from  Singleton
listFolderContents($fullPath, $methodName, $recursive = FALSE)

No description

listAllFolders($path = null, array $exclude = [])

No description

listFolders($path = null, array $exclude = [], $recursive = FALSE)

No description

fetchFiles($path, $sortBy = [], $search = null)

No description

get($path, $stream = FALSE)

No description

put($path, $contents)

No description

makeFolder($name)

No description

copyFile($srcPath, $destPath)

No description

moveFile($path, $newPath)

No description

rename($path, $newPath)

No description

deleteFiles($paths)

No description

deleteFolder($path)

No description

exists($path)

No description

validatePath($path, $stripTrailingSlash = FALSE)

No description

getMediaUrl($path)

No description

getMediaPath($path)

No description

getMediaThumb($path, $options)

No description

getDefaultThumbPath($thumbPath, $default = null)

No description

getMediaRelativePath($path)

No description

getConfig($key = null, $default = null)

No description

getAllowedExtensions()

No description

isAllowedExtension($filename)

No description

resetCache()

No description

folderSize($path)

No description

scanFolderContents($fullPath, $methodName, $recursive = FALSE)

No description

isVisible($path)

No description

sortFiles($files, $sortBy)

No description

searchFiles($files, $filter)

No description

getThumbDirectory()

No description

getStorageDisk()

No description

initMediaItem($path, $itemType)

No description

pathMatchesSearch($path, $words)

No description

getMediaThumbFile($filePath, $options)

No description

ensureDirectoryExists($path)

No description

Details

in Singleton at line 18
final static instance()

Create a new instance of this singleton.

in Singleton at line 28
final static forgetInstance()

Forget this singleton's instance if it exists

in Singleton at line 36
final protected __construct()

Constructor.

at line 39
initialize()

No description

in Singleton at line 48
__clone()

No description

in Singleton at line 53
__wakeup()

No description

at line 56
listFolderContents($fullPath, $methodName, $recursive = FALSE)

No description

Parameters

$fullPath
$methodName
$recursive

at line 85
listAllFolders($path = null, array $exclude = [])

No description

Parameters

$path
array $exclude

at line 90
listFolders($path = null, array $exclude = [], $recursive = FALSE)

No description

Parameters

$path
array $exclude
$recursive

at line 120
fetchFiles($path, $sortBy = [], $search = null)

No description

Parameters

$path
$sortBy
$search

at line 135
get($path, $stream = FALSE)

No description

Parameters

$path
$stream

at line 147
put($path, $contents)

No description

Parameters

$path
$contents

at line 155
makeFolder($name)

No description

Parameters

$name

at line 164
copyFile($srcPath, $destPath)

No description

Parameters

$srcPath
$destPath

at line 175
moveFile($path, $newPath)

No description

Parameters

$path
$newPath

at line 186
rename($path, $newPath)

No description

Parameters

$path
$newPath

at line 197
deleteFiles($paths)

No description

Parameters

$paths

at line 208
deleteFolder($path)

No description

Parameters

$path

at line 217
exists($path)

No description

Parameters

$path

at line 225
validatePath($path, $stripTrailingSlash = FALSE)

No description

Parameters

$path
$stripTrailingSlash

at line 233
getMediaUrl($path)

No description

Parameters

$path

at line 240
getMediaPath($path)

No description

Parameters

$path

at line 248
getMediaThumb($path, $options)

No description

Parameters

$path
$options

at line 290
getDefaultThumbPath($thumbPath, $default = null)

No description

Parameters

$thumbPath
$default

at line 300
getMediaRelativePath($path)

No description

Parameters

$path

at line 310
getConfig($key = null, $default = null)

No description

Parameters

$key
$default

at line 318
getAllowedExtensions()

No description

at line 323
isAllowedExtension($filename)

No description

Parameters

$filename

at line 334
resetCache()

No description

at line 339
folderSize($path)

No description

Parameters

$path

at line 354
protected scanFolderContents($fullPath, $methodName, $recursive = FALSE)

No description

Parameters

$fullPath
$methodName
$recursive

at line 373
protected isVisible($path)

No description

Parameters

$path

at line 388
protected sortFiles($files, $sortBy)

No description

Parameters

$files
$sortBy

at line 414
protected searchFiles($files, $filter)

No description

Parameters

$files
$filter

at line 428
protected getThumbDirectory()

No description

at line 433
protected getStorageDisk()

No description

at line 443
protected initMediaItem($path, $itemType)

No description

Parameters

$path
$itemType

at line 463
protected pathMatchesSearch($path, $words)

No description

Parameters

$path
$words

at line 479
protected getMediaThumbFile($filePath, $options)

No description

Parameters

$filePath
$options

at line 494
protected ensureDirectoryExists($path)

No description

Parameters

$path