FilePickerInterface View code

Extends

Define an interface for modules that provide filepicker functionality.

package

CMS
license

GPL
author

Robert Campbell calguy1000@cmsmadesimple.org
since 2.2

Methods

get_profile_or_default(string $profile_name, string $dir = null, integer $uid = null) : \CMSMS\FilePickerProfile

Given a profile name, and other data return a suitable profile by name, or return a default profile

Arguments

string $profile_name

the desired profile name to load

string $dir

A suitable top location

integer $uid

An optional admin user id.

Response

\CMSMS\FilePickerProfile 

get_default_profile(string $dir = null, integer $uid = null) : \CMSMS\FilePickerProfile

Get the default profile for the specified data.

Arguments

string $dir

A suitable top location

integer $uid

An optional admin user id.

Response

\CMSMS\FilePickerProfile 

get_browser_url() : string

Get the URL required to render the filepicker

Response

string 

get_html(string $name, string $value, \CMSMS\FilePickerProfile $profile)

Generate HTML to display an input field that is initialized with the filepicker plugin.

Arguments

string $name

The name for the input field.

string $value

the current value for the input filed

\CMSMS\FilePickerProfile $profile

The profile to use when building the filepicker interface.

Back to top