Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_preload_LibrariesHandler
  • Overview
  • Package
  • Class

Class icms_preload_LibrariesHandler

icms_preload_LibrariesHandler

Class handling third party libraries within ImpressCMS

Package: Preload\Libraries
Category: ICMS
Copyright: The ImpressCMS Project http://www.impresscms.org/
License: GNU General Public License (GPL)
Author: marcan marcan@impresscms.org
Since: 1.1
Located at preload/LibrariesHandler.php
Methods summary
public
# __construct( )

Constructor

Constructor

public static object &
# getInstance( )

Access the only instance of this class

Access the only instance of this class

Returns

object
public true
# triggerEvent( $event, $array = false )

Triggers a specific event on all the libraries

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

Parameters

$event
name of the event to trigger
$array
container to pass any arguments to be used by the library

Returns

true
if successful, FALSE if not
public string
# getLibraryBootFilePath( $library )

Construct the path of the boot file a specified library

Construct the path of the boot file a specified library

Parameters

$library
name of the library

Returns

string
path of the boot file of the specified library
public string
# getFunctionName( $event, $library )

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

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

Parameters

$event
name of the event
$library
name of the library

Returns

string
name of the function
Properties summary
public array $_librariesArray

Public

array $_librariesArray array containing a list of all available third party libraries
# array()
API documentation generated by ApiGen