Docs For Class LibertySystem

constructor LibertySystem [line 90]

LibertySystem LibertySystem(
[
$pExtras = TRUE])

Initiate Class

Tags:

usedby:	TreasurySystem
usedby:	NexusSystem

Parameters:

$pExtras

[ Top ]

method getContentStatus [line 357]

TRUE getContentStatus(
)

getContentStatus

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

[ Top ]

method getContentTypeDescription [line 405]

Content getContentTypeDescription(
$pContentType
$pContentType)

Get the description of a given content type

Tags:

return:	type description
access:	public

Parameters:

$pContentType

$pContentType

Content type GUID you want the description for

[ Top ]

method getMimeThumbnailURL [line 509]

Full getMimeThumbnailURL(
string
$pMimeType, [string
$pExt = NULL])

Get the URL to the icon for the mime type passed in. This should probably check for files of multiple image types instead of just jpg

Tags:

return:	image HTML tag to mime icon
access:	public

Parameters:

string	$pMimeType	Mime type of the file
string	$pExt	Extension of the file - used to get backup mime icon

[ Top ]

method getPluginFunction [line 313]

TRUE getPluginFunction(
array
$pGuid, array
$pFunctionName)

getPluginFunction

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Overridden in child classes as:

TreasurySystem::getPluginFunction(): Get the function of the plugin responsible for dealing with a given upload

Parameters:

array	$pGuid
array	$pFunctionName

[ Top ]

method getPluginInfo [line 295]

TRUE getPluginInfo(
array
$pGuid)

getPluginInfo

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pGuid

[ Top ]

method getService [line 424]

Service getService(
$pPackageName
$pPackageName)

Get the service details of a given package

Tags:

return:	details if the package has them - FALSE if the package is not a service
access:	public

Parameters:

$pPackageName

$pPackageName

Package name of you want the service details for

[ Top ]

method hasService [line 446]

TRUE hasService(

$pServiceName)

Check to see if a package has any service capabilities

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

$pServiceName

[ Top ]

method invokeServiceFunctionR [line 482]

array invokeServiceFunctionR(
$pFunction
$pFunction, $pArgs
$pArgs)

Return an associate array of the non empty return values of all the functions with the given arguments

Tags:

return:

an associate array of the non empty return values

Parameters:

$pFunction	$pFunction	the liberty name of the function to invoke
$pArgs	$pArgs	an array of arguments to the function

[ Top ]

method isPluginActive [line 203]

TRUE isPluginActive(
$pPluginGuid
$pPluginGuid)

Check to see if a given plugin is activ or not

Tags:

return:

if the plugin is active, FALSE if it's not

Parameters:

$pPluginGuid

$pPluginGuid

Plugin GUID of the plugin you want to check

[ Top ]

method loadActivePlugins [line 105]

none loadActivePlugins(
)

Load only active plugins from disk

Tags:

access:

public

[ Top ]

method loadContentTypes [line 366]

none loadContentTypes(
[
$pCacheTime = BIT_QUERY_CACHE_TIME])

Load all available content types into $this->mContentTypes

Parameters:

$pCacheTime

[ Top ]

method registerContentType [line 382]

none registerContentType(

$pGuid, 
$pTypeParams)

Tags:

access:

public

Parameters:

	$pGuid
	$pTypeParams

[ Top ]

method registerDataTag [line 215]

void registerDataTag(
string
$pTag, string
$pPluginGuid)

Allow data plugins to register their tag

Tags:

access:

public

Parameters:

string	$pTag	Tag of plugin, e.g.: TOC
string	$pPluginGuid	GUID of plugin, e.g.: PLUGIN_GUID_TOC

[ Top ]

method registerPlugin [line 227]

none registerPlugin(
$pGuid
$pGuid, $pPluginParams
$pPluginParams)

Allow plugins to register themselves using this function. Data is added directly to the list of existing plugins

Tags:

access:

public

Parameters:

$pGuid	$pGuid	GUID of plugin
$pPluginParams	$pPluginParams	Set of plugin parameters (see treasury/plugins/mime.*.php for example)

[ Top ]

method registerService [line 436]

none registerService(

$pServiceName, 
$pPackageName, 
$pServiceHash)

$pServiceHash Service hash details. see existing service hashes found in <package>/bit_setup_inc.php for examples and details

Tags:

access:

public

Parameters:

	$pServiceName
	$pPackageName
	$pServiceHash

[ Top ]

method resetAllPluginSettings [line 332]

TRUE resetAllPluginSettings(
)

This function will purge all plugin settings set in kernel_config. useful when the path to plugins changes or plugins don't seem to be working

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

[ Top ]

method scanAllPlugins [line 132]

none scanAllPlugins(
[
$pPluginsPath = NULL])

Load all plugins found in specified directory Use loadActivePlugins to load only the active plugins

Parameters:

$pPluginsPath

[ Top ]

method setActivePlugin [line 280]

TRUE setActivePlugin(
array
$pPluginGuid)

set a single plugin as active and store the appropriate information in the database

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pPluginGuid

the plugin guid we want to set active

[ Top ]

method setActivePlugins [line 252]

TRUE setActivePlugins(
array
$pPluginGuids)

setActivePlugins

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pPluginGuids

an array of all the plugin guids that are active. Any left out are *inactive*!

[ Top ]

Class: LibertySystem

Class Overview

Variables

Methods

Child classes:

Inherited Variables

Class: BitBase

Inherited Methods

Class: LibertyBase

Class: BitBase

Class Details

Class Variables

$mContentStatus =

$mContentTypes =

$mDataTags =

$mPluginFileName =

$mPlugins = array()

$mSystem = LIBERTY_PKG_NAME

Class Methods

constructor LibertySystem [line 90]

Tags:

Parameters:

method getContentStatus [line 357]

Tags:

method getContentTypeDescription [line 405]

Tags:

Parameters:

method getMimeThumbnailURL [line 509]

Tags:

Parameters:

method getPluginFunction [line 313]

Tags:

Parameters:

method getPluginInfo [line 295]

Tags:

Parameters:

method getService [line 424]

Tags:

Parameters:

method hasService [line 446]

Tags:

Parameters:

method invokeServiceFunctionR [line 482]

Tags:

Parameters:

method isPluginActive [line 203]

Tags:

Parameters:

method loadActivePlugins [line 105]

Tags:

method loadContentTypes [line 366]

Parameters:

method registerContentType [line 382]

Tags:

Parameters:

method registerDataTag [line 215]

Tags:

Parameters:

method registerPlugin [line 227]

Tags:

Parameters:

method registerService [line 436]

Tags:

Parameters:

method resetAllPluginSettings [line 332]

Tags:

method scanAllPlugins [line 132]

Parameters:

method setActivePlugin [line 280]

Tags:

Parameters:

method setActivePlugins [line 252]

Tags:

Parameters: