LinkParameterProviderInterface Interface Reference

Inheritance diagram for LinkParameterProviderInterface:

Public Member Functions
	getScriptUrl ()
	getUrlParameters (array $values)
	isCurrentlySelectedItem (array $values)

Detailed Description

Definition at line 17 of file LinkParameterProviderInterface.php.

Member Function Documentation

getScriptUrl

(

)

Returns the URL of the current script

Returns

string

Implemented in FileBrowser, FileLinkHandler, DatabaseBrowser, PageLinkHandler, FolderBrowser, and DummyLinkParameterProvider.

Referenced by ElementBrowserFolderTreeView\setLinkParameterProvider(), and ElementBrowserPageTreeView\setLinkParameterProvider().

getUrlParameters

(

array

$values

)

Provides an array or GET parameters for URL generation

Parameters

array

$values

Array of values to include into the parameters or which might influence the parameters

Returns

string[] Array of parameters which have to be added to URLs

Implemented in FileBrowser, FileLinkHandler, DatabaseBrowser, PageLinkHandler, FolderBrowser, and DummyLinkParameterProvider.

isCurrentlySelectedItem

(

array

$values

)

Check if given value is currently the selected item

This method is only used in the page tree.

Parameters

array

$values

Values to be checked

Returns

bool Returns TRUE if the given values match the currently selected item

Implemented in FileBrowser, FileLinkHandler, DatabaseBrowser, PageLinkHandler, FolderBrowser, and DummyLinkParameterProvider.