Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
LibraryPlugin Interface Reference

Public Member Functions

 getRequestURL (string $library_file_id)
 
 getRequestTitle ()
 
 getRequestIcon ()
 

Member Function Documentation

getRequestIcon ( )

Generates the icon for the plugin action to create a request. That icon may vary depending on the library file that shall be requested. Therefore, the file is passed to this method.

Parameters
LibraryFile$fileThe file to which the request URL icon shall be generated.
Returns
Icon The icon for the request URL action of the plugin.
getRequestTitle ( )

Generates the title for the plugin action to create a request. That title may vary depending on the library file that shall be requested. Therefore, the file is passed to this method.

Parameters
LibraryFile$fileThe file to which the request URL title shall be generated.
Returns
string The title for the request URL action of the plugin.
getRequestURL ( string  $library_file_id)

Generates the URL that leads to the plugin action to create a request. The URL may vary depending on the ID of the library file that shall be requested. Therefore, the library file ID is passed to this method.

Parameters
$library_file_idThe library file ID to which a request URL shall be generated.
Returns
string The URL for the request action of the plugin.

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