Inheritance diagram for dcMedia:

Public Member Functions
	__construct (string $type='')

	chdir (?string $dir)

	addFileHandler (string $type, string $event, $function)

	breadCrumb (string $href, string $last='')

	setFileSort (string $type='name')

	getFSDir ()

	getDir ($type=null)

	getFile (int $id)

	searchMedia (string $query)

	getPostMedia (int $post_id, $media_id=null, $link_type=null)

	rebuild (string $pwd='')

	makeDir (?string $directory)

	removeDir (?string $directory)

	createFile (string $name, ?string $title=null, bool $private=false, $dt=null, bool $force=true)

	updateFile (fileItem $file, fileItem $newFile)

	uploadFile (string $tmp, string $name, bool $overwrite=false, ?string $title=null, bool $private=false)

	uploadBits (string $name, string $bits)

	removeFile (?string $name)

	getDBDirs ()

	inflateZipFile (fileItem $f, bool $create_dir=true)

	getZipContent (fileItem $f)

	mediaFireRecreateEvent (fileItem $f)

	imageThumbCreate (?cursor $cur, string $f, bool $force=true)

	imageThumbRemove (string $f)

Public Member Functions inherited from filemanager
	__construct (?string $root, ?string $root_url='')

	chdir (?string $dir)

	getPwd ()

	writable ()

	addExclusion ($list)

	inFiles (string $file)

	getDir ()

	getRootDirs ()

	uploadFile (string $tmp, string $dest, bool $overwrite=false)

	uploadBits (string $name, string $bits)

	makeDir (?string $name)

	moveFile (?string $src_path, ?string $dst_path)

	removeItem (?string $name)

	removeFile (?string $file)

	removeDir (?string $directory)

Static Public Member Functions
static	audioPlayer (string $type, string $url, ?string $player=null, $args=null, bool $fallback=false, bool $preload=true)

static	videoPlayer (string $type, string $url, ?string $player=null, $args=null, bool $fallback=false, bool $preload=true)

static	mp3player (string $url, ?string $player=null, $args=null, bool $fallback=false, bool $preload=true)

static	flvplayer (string $url, ?string $player=null, $args=null)

Data Fields
const	MEDIA_TABLE_NAME = 'media'

	$thumb_tp = '%s/.%s_%s.jpg'

	$thumb_tp_alpha = '%s/.%s_%s.png'

	$thumb_tp_webp = '%s/.%s_%s.webp'

	$thumb_sizes

	$icon_img = 'images/media/%s.svg'

Data Fields inherited from filemanager
	$root

	$root_url

	$dir

Protected Member Functions
	callFileHandler (string $type, string $event,... $args)

	fileRecord (dcRecord $rs)

	sortFileHandler (?fileItem $a, ?fileItem $b)

	rebuildDB (?string $pwd)

	imageThumbUpdate (fileItem $file, fileItem $newFile)

	imageMetaCreate (cursor $cur, string $f, int $id)

Protected Member Functions inherited from filemanager
	isExclude (string $path)

	isFileExclude (string $file)

	inJail (string $path)

	sortHandler (fileItem $a, fileItem $b)

Protected Attributes
	$con

	$table

	$type

	$file_sort = 'name-asc'

	$path

	$relpwd

	$file_handler = []

	$postmedia

Protected Attributes inherited from filemanager
	$pwd

	$exclude_list = []

	$exclude_pattern = ''

Constructor & Destructor Documentation

◆ __construct()

__construct ( string $type = '' )

Constructs a new instance.

Parameters

string $type The media type filter

Exceptions

Exception

References filemanager\$root, filemanager\$root_url, $type, filemanager\addExclusion(), addFileHandler(), dcCore\app(), chdir(), path\clean(), and MEDIA_TABLE_NAME.

Member Function Documentation

◆ chdir()

chdir ( ?string $dir )

Changes working directory.

Parameters

string $dir The directory name

Reimplemented from filemanager.

References filemanager\$dir.

Referenced by __construct(), and rebuild().

◆ addFileHandler()

addFileHandler	(	string	$type,
		string	$event,
			$function
	)

Adds a new file handler for a given media type and event.

Available events are:

create: file creation
update: file update
remove: file deletion

Parameters

string	$type	The media type
string	$event	The event
callable \| array	$function	The callback

References $type.

Referenced by __construct().

◆ callFileHandler()

callFileHandler	(	string	$type,
		string	$event,
			$args
	)

protected

Call filehandler depending on media type and event

Parameters

string	$type	The type
string	$event	The event
	mixed	...$args The arguments

References $type.

Referenced by createFile(), getDir(), mediaFireRecreateEvent(), removeFile(), and updateFile().

◆ breadCrumb()

breadCrumb	(	string	$href,
		string	$last = `''`
	)

Returns HTML breadCrumb for media manager navigation.

Parameters

string	$href	The URL pattern
string	$last	The last item pattern

Returns: string HTML code

References filemanager\$pwd.

◆ fileRecord()

fileRecord ( dcRecord $rs )

protected

Get media file information from recordset

Parameters

dcRecord $rs The recordset

Returns: fileItem The file item.

References dcCore\app(), path\info(), dcRecord\isEmpty(), filemanager\isFileExclude(), dcAuth\PERMISSION_MEDIA_ADMIN, and dt\str().

Referenced by getDir(), getFile(), getPostMedia(), and searchMedia().

◆ setFileSort()

setFileSort ( string $type = 'name' )

Sets the file sort.

Parameters

string $type The type

References $type.

◆ sortFileHandler()

sortFileHandler	(	?fileItem	$a,
		?fileItem	$b
	)

protected

Sort calllback

Parameters

fileItem	$a	1st media
fileItem	$b	2nd media

Returns: int

◆ getFSDir()

getFSDir ( )

Gets current working directory content (using filesystem).

◆ getDir()

getDir ( $type = null )

Gets current working directory content.

Parameters

mixed $type The media type filter

Exceptions

Exception

References filemanager\$dir, $type, dcCore\app(), callFileHandler(), createFile(), fileRecord(), getFile(), files\getMimeType(), filemanager\inFiles(), dcAuth\PERMISSION_MEDIA, and dcAuth\PERMISSION_MEDIA_ADMIN.

◆ getFile()

getFile ( int $id )

Gets file by its id. Returns a filteItem object.

Parameters

int $id The file identifier

Returns: fileItem The file.

References dcCore\app(), fileRecord(), and dcAuth\PERMISSION_MEDIA_ADMIN.

Referenced by getDir().

◆ searchMedia()

searchMedia ( string $query )

Search into media db (only).

Parameters

string $query The search query

Returns: bool true or false if nothing found

References dcCore\app(), fileRecord(), and dcAuth\PERMISSION_MEDIA_ADMIN.

◆ getPostMedia()

getPostMedia	(	int	$post_id,
			$media_id = `null`,
			$link_type = `null`
	)

Returns media items attached to a blog post. Result is an array containing fileItems objects.

Parameters

int	$post_id	The post identifier
mixed	$media_id	The media identifier(s)
mixed	$link_type	The link type(s)

Returns: array Array of fileItems.

References $path, and fileRecord().

◆ rebuild()

rebuild ( string $pwd = '' )

Rebuilds database items collection. Optional $pwd parameter is the path where to start rebuild.

Parameters

string $pwd The directory to rebuild

Exceptions

Exception

References filemanager\$dir, filemanager\$pwd, dcCore\app(), chdir(), createFile(), rebuild(), and rebuildDB().

Referenced by rebuild().

◆ rebuildDB()

rebuildDB ( ?string $pwd )

protected

Rebuilds database items collection. Optional $pwd parameter is the path where to start rebuild else its the current directory

Parameters

string $pwd The directory to rebuild

Exceptions

Exception

References filemanager\$pwd.

Referenced by rebuild().

◆ makeDir()

makeDir ( ?string $directory )

Makes a dir.

Parameters

string $directory the directory to create

Reimplemented from filemanager.

References dcCore\app(), and files\tidyFileName().

◆ removeDir()

removeDir ( ?string $directory )

Remove a dir.

Removes a directory which is relative to working directory.

Parameters

string $directory Directory to remove

Reimplemented from filemanager.

References dcCore\app().

◆ createFile()

createFile	(	string	$name,
		?string	$title = `null`,
		bool	$private = `false`,
			$dt = `null`,
		bool	$force = `true`
	)

Creates or updates a file in database. Returns new media ID or false if file does not exist.

Parameters

string	$name	The file name (relative to working directory)
string	$title	The file title
bool	$private	File is private
mixed	$dt	File date
bool	$force	The force flag

Exceptions

Exception

Returns: integer|bool New media ID or false

References dcCore\app(), callFileHandler(), path\clean(), files\getMimeType(), dcAuth\PERMISSION_MEDIA, dcAuth\PERMISSION_MEDIA_ADMIN, and dt\strftime().

Referenced by getDir(), rebuild(), uploadBits(), and uploadFile().

◆ updateFile()

updateFile	(	fileItem	$file,
		fileItem	$newFile
	)

Updates a file in database.

Parameters

fileItem	$file	The file
fileItem	$newFile	The new file

Exceptions

Exception

References dcCore\app(), callFileHandler(), if, filemanager\isFileExclude(), filemanager\moveFile(), dcAuth\PERMISSION_MEDIA, dcAuth\PERMISSION_MEDIA_ADMIN, and files\tidyFileName().

◆ uploadFile()

uploadFile	(	string	$tmp,
		string	$name,
		bool	$overwrite = `false`,
		?string	$title = `null`,
		bool	$private = `false`
	)

Uploads a file.

Parameters

string	$tmp	The full path of temporary uploaded file
string	$name	The file name (relative to working directory)me
bool	$overwrite	File should be overwrite
string	$title	The file title (should be string\|null)
bool	$private	File is private

Exceptions

Exception

Returns: mixed New media ID or false (should be int|false)

References dcCore\app(), createFile(), dcAuth\PERMISSION_MEDIA, dcAuth\PERMISSION_MEDIA_ADMIN, and files\tidyFileName().

◆ uploadBits()

uploadBits	(	string	$name,
		string	$bits
	)

Creates a file from binary content.

Parameters

string	$name	The file name (relative to working directory)
string	$bits	The binary file contentits

Exceptions

Exception

Returns: string New media ID or false

Reimplemented from filemanager.

References dcCore\app(), createFile(), dcAuth\PERMISSION_MEDIA, dcAuth\PERMISSION_MEDIA_ADMIN, and files\tidyFileName().

◆ removeFile()

removeFile ( ?string $name )

Removes a file.

Parameters

string $name filename

Exceptions

Exception

Reimplemented from filemanager.

References dcCore\app(), callFileHandler(), path\clean(), files\getMimeType(), dcAuth\PERMISSION_MEDIA, and dcAuth\PERMISSION_MEDIA_ADMIN.

◆ getDBDirs()

getDBDirs ( )

Root directories

Returns an array of directory under $root directory.

@uses fileItem

Returns: array

References filemanager\$dir.

◆ inflateZipFile()

inflateZipFile	(	fileItem	$f,
		bool	$create_dir = `true`
	)

Extract zip file in current location.

Parameters

fileItem	$f	fileItem object
bool	$create_dir	Create dir

Exceptions

Exception

Returns: string destination

References text\deaccent().

◆ getZipContent()

getZipContent ( fileItem $f )

Gets the zip content.

Parameters

fileItem $f fileItem object

Returns: array The zip content.

◆ mediaFireRecreateEvent()

mediaFireRecreateEvent ( fileItem $f )

Calls file handlers registered for recreate event.

Parameters

fileItem $f fileItem object

References callFileHandler(), and files\getMimeType().

◆ imageThumbCreate()

imageThumbCreate	(	?cursor	$cur,
		string	$f,
		bool	$force = `true`
	)

Create image thumbnails

Parameters

cursor	$cur	The cursor
string	$f	Image filename
bool	$force	Force creation

Returns: bool

References imageThumbRemove(), and path\info().

◆ imageThumbUpdate()

imageThumbUpdate	(	fileItem	$file,
		fileItem	$newFile
	)

protected

Update image thumbnails

Parameters

fileItem	$file	The file
fileItem	$newFile	The new file

Returns: bool

References path\info().

◆ imageThumbRemove()

imageThumbRemove ( string $f )

Remove image thumbnails

Parameters

string $f Image filename

Returns: bool

References path\info().

Referenced by imageThumbCreate().

◆ imageMetaCreate()

imageMetaCreate	(	cursor	$cur,
		string	$f,
		int	$id
	)

protected

Create image meta

Parameters

cursor	$cur	The cursor
string	$f	Image filename
int	$id	The media identifier

Returns: bool

References dcCore\app(), dt\getTimeOffset(), imageMeta\readMeta(), and dt\str().

◆ audioPlayer()

static audioPlayer	(	string	$type,
		string	$url,
		?string	$player = `null`,
			$args = `null`,
		bool	$fallback = `false`,
		bool	$preload = `true`
	)

static

Returns HTML code for audio player (HTML5)

Parameters

string	$type	The audio mime type
string	$url	The audio URL to play
string	$player	The player URL
mixed	$args	The player arguments
bool	$fallback	The fallback
bool	$preload	Add preload="auto" attribute if true, else preload="none"

Returns: string

Referenced by adminMediaList\mediaLine(), and mp3player().

◆ videoPlayer()

static videoPlayer	(	string	$type,
		string	$url,
		?string	$player = `null`,
			$args = `null`,
		bool	$fallback = `false`,
		bool	$preload = `true`
	)

static

Returns HTML code for video player (HTML5)

Parameters

string	$type	The video mime type
string	$url	The video URL to play
string	$player	The player URL
mixed	$args	The player arguments
bool	$fallback	The fallback (not more used)
bool	$preload	Add preload="auto" attribute if true, else preload="none"

Returns: string

References $type.

◆ mp3player()

static mp3player	(	string	$url,
		?string	$player = `null`,
			$args = `null`,
		bool	$fallback = `false`,
		bool	$preload = `true`
	)

static

Returns HTML code for MP3 player (HTML5)

Parameters

string	$url	The audio URL to play
string	$player	The player URL
mixed	$args	The player arguments
bool	$fallback	The fallback (not more used)
bool	$preload	Add preload="auto" attribute if true, else preload="none"

Returns: string

References audioPlayer().

◆ flvplayer()

static flvplayer	(	string	$url,
		?string	$player = `null`,
			$args = `null`
	)

static

Returns HTML code for FLV player

Parameters

string	$url	The url
string	$player	The player
mixed	$args	The arguments

Returns: string

Deprecated:: since 2.15

Field Documentation

◆ MEDIA_TABLE_NAME

const MEDIA_TABLE_NAME = 'media'

Referenced by __construct(), and dcPostMedia\getPostMedia().

◆ $con

$con

protected

◆ $table

$table

protected

◆ $type

$type

protected

Referenced by __construct(), addFileHandler(), callFileHandler(), getDir(), setFileSort(), and videoPlayer().

◆ $file_sort

$file_sort = 'name-asc'

protected

◆ $path

$path

protected

Referenced by getPostMedia().

◆ $relpwd

$relpwd

protected

◆ $file_handler

$file_handler = []

protected

◆ $postmedia

$postmedia

protected

◆ $thumb_tp

$thumb_tp = '%s/.%s_%s.jpg'

◆ $thumb_tp_alpha

$thumb_tp_alpha = '%s/.%s_%s.png'

◆ $thumb_tp_webp

$thumb_tp_webp = '%s/.%s_%s.webp'

◆ $thumb_sizes

$thumb_sizes

Initial value:

= [
        'm'  => [448, 'ratio', 'medium'],
        's'  => [240, 'ratio', 'small'],
        't'  => [100, 'ratio', 'thumbnail'],
        'sq' => [48, 'crop', 'square'],
    ]

◆ $icon_img

$icon_img = 'images/media/%s.svg'

The documentation for this class was generated from the following file:

inc/core/class.dc.media.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ chdir()

◆ addFileHandler()

◆ callFileHandler()

◆ breadCrumb()

◆ fileRecord()

◆ setFileSort()

◆ sortFileHandler()

◆ getFSDir()

◆ getDir()

◆ getFile()

◆ searchMedia()

◆ getPostMedia()

◆ rebuild()

◆ rebuildDB()

◆ makeDir()

◆ removeDir()

◆ createFile()

◆ updateFile()

◆ uploadFile()

◆ uploadBits()

◆ removeFile()

◆ getDBDirs()

◆ inflateZipFile()

◆ getZipContent()

◆ mediaFireRecreateEvent()

◆ imageThumbCreate()

◆ imageThumbUpdate()

◆ imageThumbRemove()

◆ imageMetaCreate()

◆ audioPlayer()

◆ videoPlayer()

◆ mp3player()

◆ flvplayer()

Field Documentation

◆ MEDIA_TABLE_NAME

◆ $con

◆ $table

◆ $type

◆ $file_sort

◆ $path

◆ $relpwd

◆ $file_handler

◆ $postmedia

◆ $thumb_tp

◆ $thumb_tp_alpha

◆ $thumb_tp_webp

◆ $thumb_sizes

◆ $icon_img