Media
extends MediaLibrary
in package
Media Manager
Tags
Table of Contents
Properties
- $_arrSettings : mixed
- $_objTpl : mixed
- $archive : mixed
- $arrPaths : mixed
- $arrWebPaths : mixed
- $docRoot : mixed
- $getAct : mixed
- $getCmd : mixed
- $getFile : mixed
- $getPath : mixed
- $highlightColor : mixed
- $highlightName : mixed
- $path : mixed
- $webPath : mixed
- $allowDirRemoval : bool
- Will be set to `true` by {@see static::getWebPath()} if the requested path is a subdirectory of the requested archive.
- $cx : Cx
- $pageContent : mixed
- $sortBy : mixed
- $sortDesc : mixed
Methods
- __construct() : mixed
- constructor
- _getIcon() : string
- Gets the icon for the file
- _getIconPath() : string
- Returns icon's absolute path
- _getIconWebPath() : string
- Returns icon's web path
- createSettingsArray() : array<string|int, mixed>
- Create an array containing all settings of the media-module.
- editImage() : bool
- Edits and saves an image.
- getDirectoryTree() : array<string|int, mixed>
- Get files by search term
- getFileTypeIconWebPath() : string
- Get the web path to the icon used for displaying the file type of a file
- getImage() : image
- This method is used for the image preview.
- getImageSettings() : array<string|int, mixed>
- Returns the image settings array.
- getMediaPage() : string
- Gets the requested page
- handleRedirect() : void
- Redirect to the page by requested redirect url
- isFileValidToShow() : bool
- Return whether file is valid to show or not
- isIllegalFileName() : bool
- Check the the file name is illegal or not.
- isSearchActivated() : bool
- Check whether the search setting activated
- renMedia() : void
- Renames a media file
- uploadFinished() : string
- this is called as soon as uploads have finished.
- _copyMedia() : void
- copies the media -> paste inserts the media
- _createDirectory() : void
- Create directory
- _createNewDir() : void
- act: newDir creates a new directory through php or ftp
- _cutMedia() : void
- cuts the media -> paste insterts the media
- _deleteFiles() : void
- Delete files
- _deleteMedia() : void
- _deleteMedia2() : string
- _downloadMedia() : void
- Send a file for downloading
- _formatDate() : string
- _formatPerm() : string
- _formatSize() : string
- _formatType() : string
- _getDate() : string
- _getJavaScriptCodePreview() : string
- _getMDate() : string
- _getPerm() : string
- _getSize() : string
- _getType() : string
- _overviewMedia() : string
- Overview Media Data
- _pasteMedia() : void
- Inserts the file
- _pathCheck() : string
- _renameFiles() : void
- Rename files
- _sortDirTree() : array<string|int, mixed>
- _sortingIcons() : array<string|int, mixed>
- _uploadFiles() : void
- Upload files
- deleteDirectory() : bool
- Delete Selected Folder and its contents recursively upload form
- getFormatedFileSize() : string
- Format file size
- getWebPath() : string
- checks and cleans the web path
- isFileLocatedInCurrentArchive() : bool
- Verify that $path is located within the current archive ({@see static::$path}).
- manageAccessGranted() : bool
- Check Rename/Delete permission from settings.
- prettyFormatFilename() : string
- Format a filename according to configuration option 'Pretty format' of currently loaded media archive.
- processFormUpload() : bool
- Process upload form
- uploadAccessGranted() : bool
- Check access from settings.
Properties
$_arrSettings
public
mixed
$_arrSettings
= array()
$_objTpl
public
mixed
$_objTpl
$archive
public
mixed
$archive
$arrPaths
public
mixed
$arrPaths
$arrWebPaths
public
mixed
$arrWebPaths
$docRoot
public
mixed
$docRoot
$getAct
public
mixed
$getAct
$getCmd
public
mixed
$getCmd
$getFile
public
mixed
$getFile
$getPath
public
mixed
$getPath
$highlightColor
public
mixed
$highlightColor
= '#d8ffca'
$highlightName
public
mixed
$highlightName
= array()
$path
public
mixed
$path
$webPath
public
mixed
$webPath
$allowDirRemoval
Will be set to `true` by {@see static::getWebPath()} if the requested path is a subdirectory of the requested archive.
protected
bool
$allowDirRemoval
= false
This will enable folder removal by static::deleteDirectory().
$cx
protected
Cx
$cx
Current Cx instance
$pageContent
protected
mixed
$pageContent
$sortBy
protected
mixed
$sortBy
= 'name'
$sortDesc
protected
mixed
$sortDesc
= false
Methods
__construct()
constructor
public
__construct(mixed $pageContent, mixed $archive) : mixed
Parameters
- $pageContent : mixed
- $archive : mixed
Tags
_getIcon()
Gets the icon for the file
public
static _getIcon(string $file[, string $fileType = null ]) : string
Parameters
- $file : string
-
The File Path
- $fileType : string = null
-
(optional) The File type
Return values
string —The Icon name
_getIconPath()
Returns icon's absolute path
public
static _getIconPath() : string
Return values
string_getIconWebPath()
Returns icon's web path
public
static _getIconWebPath() : string
Return values
stringcreateSettingsArray()
Create an array containing all settings of the media-module.
public
createSettingsArray() : array<string|int, mixed>
Example: $arrSettings[$strSettingName] for the content of $strSettingsName
Tags
Return values
array<string|int, mixed> —$arrReturn
editImage()
Edits and saves an image.
public
editImage(array<string|int, mixed> $arrData) : bool
Parameters
- $arrData : array<string|int, mixed>
-
Contains $_POST array.
Return values
bool —True on success, false otherwise.
getDirectoryTree()
Get files by search term
public
getDirectoryTree([string $path = '' ][, string $searchTerm = '' ][, array<string|int, mixed> &$result = array() ][, bool $recursive = false ]) : array<string|int, mixed>
Parameters
- $path : string = ''
-
Path to search files
- $searchTerm : string = ''
-
Search term
- $result : array<string|int, mixed> = array()
-
Result files and directory array
- $recursive : bool = false
-
True to search recursive
Return values
array<string|int, mixed> —Files array by given search term
getFileTypeIconWebPath()
Get the web path to the icon used for displaying the file type of a file
public
static getFileTypeIconWebPath(string $file[, string $fileType = null ]) : string
Parameters
- $file : string
-
File of which the related file type icon path shall be returned. File must be an absolute file system path or an URL.
- $fileType : string = null
-
(optional) The file type of $file (as file extension). When supplied, the method will skip the file type detection and will run quite faster.
Return values
string —Web path to the icon.
getImage()
This method is used for the image preview.
public
getImage(array<string|int, mixed> $arrData) : image
Parameters
- $arrData : array<string|int, mixed>
-
Contains $_GET array.
Return values
image —On error,
getImageSettings()
Returns the image settings array.
public
getImageSettings() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —$arrImageSettings
getMediaPage()
Gets the requested page
public
getMediaPage() : string
Tags
Return values
string —parsed content
handleRedirect()
Redirect to the page by requested redirect url
public
handleRedirect() : void
isFileValidToShow()
Return whether file is valid to show or not
public
isFileValidToShow(string $filePath, string $fileName) : bool
Parameters
- $filePath : string
-
Folder path to the file
- $fileName : string
-
File name
Return values
bool —True when file is valid to show, False otherwise
isIllegalFileName()
Check the the file name is illegal or not.
public
static isIllegalFileName(type $file) : bool
Parameters
- $file : type
Return values
boolisSearchActivated()
Check whether the search setting activated
public
isSearchActivated() : bool
Return values
bool —True when frontend search setting active, false otherwise
renMedia()
Renames a media file
public
renMedia() : void
uploadFinished()
this is called as soon as uploads have finished.
public
static uploadFinished(mixed $tempPath, mixed $tempWebPath, mixed $data, mixed $uploadId, mixed $fileInfos, mixed $response) : string
takes care of moving them to the right folder
Parameters
- $tempPath : mixed
- $tempWebPath : mixed
- $data : mixed
- $uploadId : mixed
- $fileInfos : mixed
- $response : mixed
Return values
string —the directory to move to
_copyMedia()
copies the media -> paste inserts the media
protected
_copyMedia() : void
act: copy
_createDirectory()
Create directory
protected
_createDirectory(string $dir_name) : void
Parameters
- $dir_name : string
Tags
_createNewDir()
act: newDir creates a new directory through php or ftp
protected
_createNewDir(string $dirName) : void
Parameters
- $dirName : string
_cutMedia()
cuts the media -> paste insterts the media
protected
_cutMedia() : void
act: cut
_deleteFiles()
Delete files
protected
_deleteFiles() : void
Tags
_deleteMedia()
protected
_deleteMedia() : void
_deleteMedia2()
protected
_deleteMedia2(mixed $file) : string
Parameters
- $file : mixed
Return values
string_downloadMedia()
Send a file for downloading
protected
_downloadMedia() : void
_formatDate()
protected
_formatDate(mixed $date) : string
Parameters
- $date : mixed
Return values
string_formatPerm()
protected
_formatPerm(mixed $perm, mixed $key) : string
Parameters
- $perm : mixed
- $key : mixed
Return values
string_formatSize()
protected
_formatSize(mixed $size) : string
Parameters
- $size : mixed
Return values
string_formatType()
protected
_formatType(mixed $type) : string
Parameters
- $type : mixed
Return values
string_getDate()
protected
_getDate(mixed $file) : string
Parameters
- $file : mixed
Return values
string_getJavaScriptCodePreview()
protected
_getJavaScriptCodePreview() : string
Return values
string_getMDate()
protected
_getMDate(mixed $file) : string
Parameters
- $file : mixed
Return values
string_getPerm()
protected
_getPerm(mixed $file) : string
Parameters
- $file : mixed
Return values
string_getSize()
protected
_getSize(mixed $file) : string
Parameters
- $file : mixed
Return values
string_getType()
protected
_getType(mixed $file) : string
Parameters
- $file : mixed
Return values
string_overviewMedia()
Overview Media Data
protected
_overviewMedia() : string
Tags
Return values
string —parsed content
_pasteMedia()
Inserts the file
protected
_pasteMedia() : void
act: paste
_pathCheck()
protected
_pathCheck(mixed $path) : string
Parameters
- $path : mixed
Return values
string_renameFiles()
Rename files
protected
_renameFiles() : void
Tags
_sortDirTree()
protected
_sortDirTree(mixed $tree) : array<string|int, mixed>
Parameters
- $tree : mixed
Return values
array<string|int, mixed>_sortingIcons()
protected
_sortingIcons() : array<string|int, mixed>
Return values
array<string|int, mixed>_uploadFiles()
Upload files
protected
_uploadFiles() : void
deleteDirectory()
Delete Selected Folder and its contents recursively upload form
protected
deleteDirectory(string $dirName) : bool
Parameters
- $dirName : string
Tags
Return values
bool —true if directory and its contents deleted successfully and false if it failed
getFormatedFileSize()
Format file size
protected
getFormatedFileSize(int $bytes) : string
Parameters
- $bytes : int
Tags
Return values
string —formated size
getWebPath()
checks and cleans the web path
protected
getWebPath(mixed $defaultWebPath) : string
Parameters
- $defaultWebPath : mixed
Return values
string —cleaned web path
isFileLocatedInCurrentArchive()
Verify that $path is located within the current archive ({@see static::$path}).
protected
isFileLocatedInCurrentArchive(string $path) : bool
Parameters
- $path : string
-
Filesystem path to verify.
Return values
bool —True if $path is located within the current archive
manageAccessGranted()
Check Rename/Delete permission from settings.
protected
manageAccessGranted() : bool
If setting value is number then check access using Permission If setting value is 'on' then return true Else return false
Return values
bool —true if access gented and false if access denied
prettyFormatFilename()
Format a filename according to configuration option 'Pretty format' of currently loaded media archive.
protected
prettyFormatFilename(string $filename) : string
Parameters
- $filename : string
-
The filename to pretty format
Return values
string —The pretty formatted filename. In case of any error or if the function to pretty format is disabled, then the original $filename is being returned.
processFormUpload()
Process upload form
protected
processFormUpload() : bool
Tags
Return values
bool —true if file uplod successfully and false if it failed
uploadAccessGranted()
Check access from settings.
protected
uploadAccessGranted() : bool
If setting value is number then check access using Permission If setting value is 'on' then return true Else return false
Return values
bool —true if access gented and false if access denied