adminMediaPage Class Reference

class for admin media page More...

Inheritance diagram for adminMediaPage:

Public Member Functions
	__construct ()
	hasQuery ()
	mediaWritable ()
	mediaArchivable ()
	getDirs (string $type='')
	getDirsRecord ()
	mediaLine (string $file_id)
	showUploader ()
	showLast ()
	getLast ()
	updateLast (string $dir, bool $remove=false)
	getFav ()
	updateFav (string $dir, bool $remove=false)
	openPage (string $breadcrumb, string $header='')
	closePage ()
	breadcrumb (array $element=[])
Public Member Functions inherited from adminMediaFilter
	__construct (string $type='media')
	getPostTitle ()
	getPostType ()
Public Member Functions inherited from adminGenericFilterV2
	__construct (string $type)
	userOptions (?string $option=null)
	values (bool $escape=false, bool $ui_only=false)
	value (string $id, ?string $undefined=null)
	__get (string $id)
	add ($filter=null, $value=null)
	remove (string $id)
	params ()
	show (bool $set=false)
	js (string $reset_url='')
	display ($adminurl, string $extra='')

Protected Attributes
	$media_has_query = false
	$media_writable = false
	$media_archivable = null
	$media_dir = null
	$media_last = null
	$media_fav = null
	$media_uploader = null
Protected Attributes inherited from adminMediaFilter
	$post_type = ''
	$post_title = ''
Protected Attributes inherited from adminGenericFilterV2
	$type
	$filters = []
	$show = false
	$has_user_pref = false

Additional Inherited Members
Protected Member Functions inherited from adminMediaFilter
	legacyBehavior ()
	getPostIdFilter ()
	getDirFilter ()
	getFileModeFilter ()
	getPluginIdFilter ()
	getLinkTypeFilter ()
	getPopupFilter ()
	getSelectFilter ()
Protected Member Functions inherited from adminGenericFilterV2
	parseOptions ()

Detailed Description

class for admin media page

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructs a new instance.

References dcCore\app().

Member Function Documentation

hasQuery()

hasQuery

(

)

Check if page has a valid query

Returns

boolean Has query

References $media_has_query.

mediaWritable()

mediaWritable

(

)

Check if media dir is writable

Returns

boolean Is writable

References $media_writable.

mediaArchivable()

mediaArchivable

(

)

Check if media dir is archivable

Returns

boolean Is archivable

References $media_archivable, dcCore\app(), getDirsRecord(), and dcAuth\PERMISSION_MEDIA_ADMIN.

getDirs()

getDirs

(

string

$type = ''

)

Return list of fileItem objects of current dir

Parameters

string

$type

dir, file, all type

Returns

array Dirs and/or files fileItem objects

References $media_dir, and adminGenericFilterV2\$type.

Referenced by breadcrumb().

getDirsRecord()

getDirsRecord

(

)

Return dcRecord instance of fileItem objects

Returns

dcRecord Dirs and/or files fileItem objects

References $media_dir, DC_SHOW_HIDDEN_DIRS, and dcRecord\newFromArray().

Referenced by mediaArchivable().

mediaLine()

mediaLine

(

string

$file_id

)

Return HTML code of an element of list or grid items list

Parameters

string

$file_id

The file id

Returns

string The element

References dcCore\app(), and adminMediaList\mediaLine().

showUploader()

showUploader

(

)

Show enhance uploader

Returns

boolean Show enhance uploader

References $media_uploader.

showLast()

showLast

(

)

Number of recent/fav dirs to show

Returns

integer Nb of dirs

References dcCore\app().

Referenced by updateFav(), and updateLast().

getLast()

getLast

(

)

Return list of last dirs

Returns

array Last dirs

References $media_last, and dcCore\app().

Referenced by updateLast().

updateLast()

updateLast	(	string	$dir,
		bool	$remove = false
	)

Update user last dirs

Parameters

string	$dir	The directory
boolean	$remove	Remove

Returns

boolean The change

References dcCore\app(), getLast(), and showLast().

getFav()

getFav

(

)

Return list of fav dirs

Returns

array Fav dirs

References $media_fav, and dcCore\app().

Referenced by updateFav().

updateFav()

updateFav	(	string	$dir,
		bool	$remove = false
	)

Update user fav dirs

Parameters

string	$dir	The directory
boolean	$remove	Remove

Returns

boolean The change

References dcCore\app(), getFav(), and showLast().

openPage()

openPage	(	string	$breadcrumb,
		string	$header = ''
	)

The top of media page or popup

Parameters

string	$breadcrumb	The breadcrumb
string	$header	The headers

References dcPage\open(), and dcPage\openPopup().

closePage()

closePage

(

)

The end of media page or popup

References dcPage\close(), dcPage\closePopup(), and dcPage\helpBlock().

breadcrumb()

breadcrumb

(

array

$element = []

)

The breadcrumb of media page or popup

Parameters

array

$element

The additionnal element

Returns

string The HTML code of breadcrumb

References dcCore\app(), dcPage\breadcrumb(), html\escapeHTML(), getDirs(), and adminGenericFilterV2\values().

Field Documentation

$media_has_query

$media_has_query = false

protected

Referenced by hasQuery().

$media_writable

$media_writable = false

protected

Referenced by mediaWritable().

$media_archivable

$media_archivable = null

protected

Referenced by mediaArchivable().

$media_dir

$media_dir = null

protected

Referenced by getDirs(), and getDirsRecord().

$media_last

$media_last = null

protected

Referenced by getLast().

$media_fav

$media_fav = null

protected

Referenced by getFav().

$media_uploader

$media_uploader = null

protected

Referenced by showUploader().

---

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

• admin/media.php