icms_preload_LibrariesHandler

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_preload_LibrariesHandler

icms_preload_LibrariesHandler

Class handling third party libraries within ImpressCMS

• Class name: icms_preload_LibrariesHandler
• Namespace:

Properties

$_librariesArray

public mixed $_librariesArray = array()

• Visibility: public

Methods

__construct

void icms_preload_LibrariesHandler::__construct()

Constructor

• Visibility: public

getInstance

object icms_preload_LibrariesHandler::getInstance()

Access the only instance of this class

• Visibility: public
• This method is static.

triggerEvent

bool icms_preload_LibrariesHandler::triggerEvent(event, array)

Triggers a specific event on all the libraries

Here are the currently supported events:

• finishCoreBoot : this event is triggered at the end of the core booting process (end of include/common.php)
• adminHeader : this event is triggered when calling icms_cp_header() and is used to output content in the head section of the admin side
• beforeFooter : this event is triggered when include/footer.php is called, at the begining of the file
• startOutputInit : this event is triggered when starting to output the content, in include/header.php after instantiation of $xoopsTpl

• Visibility: public

Arguments

• event mixed - <p>string name of the event to trigger</p>
• array mixed - <p>mixed container to pass any arguments to be used by the library</p>

getLibraryBootFilePath

string icms_preload_LibrariesHandler::getLibraryBootFilePath(library)

Construct the path of the boot file a specified library

• Visibility: public

Arguments

• library mixed - <p>string name of the library</p>

getFunctionName

string icms_preload_LibrariesHandler::getFunctionName(event, library)

Construct the name of the function which would be call on a specific event for a specific library

• Visibility: public

Arguments

• event mixed - <p>string name of the event</p>
• library mixed - <p>string name of the library</p>