class Library extends ConcreteObject (View source)

Properties

$error from ConcreteObject
string $sclHandle The library handle.
string $sclName The library name.
bool $sclIsActive Is this the active library?
$pkgHandle
protected int $pkgID The package ID (or 0 if it's a core library).

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

string
getSystemCaptchaLibraryHandle()

Get the library handle.

string
getSystemCaptchaLibraryName()

Get the library name.

bool
isSystemCaptchaLibraryActive()

Is this the active library?

int
getPackageID()

Get the package ID (or 0 if it's a core library).

string|false
getPackageHandle()

Get the package handle (or false if it's a core library).

Package|null
getPackageObject()

Get the package instance (or null if it's a core library).

static Library|null
getActive()

Get the active library.

static Library|null
getByHandle(string $sclHandle)

Get a library given its handle.

static Library
add(string $sclHandle, string $sclName, Package|int|false $pkg = false)

Add a new library.

delete()

Delete this library (if it's the default one we'll activate the default core library).

activate()

Make this library the active one.

static Library[]
getList()

Retrieve all the installed libraries.

static Library[]
getListByPackage(Package|int $pkg)

Retrieve the libraries installed by a package.

export(SimpleXMLElement $xml)

Export the data of this library.

static 
exportList(SimpleXMLElement $xml)

Export the data of all the libraries.

bool
hasOptionsForm()

Does this library has an option form?

getController()

Returns the controller class for the currently selected captcha library.

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

string getSystemCaptchaLibraryHandle()

Get the library handle.

Return Value

string

string getSystemCaptchaLibraryName()

Get the library name.

Return Value

string

bool isSystemCaptchaLibraryActive()

Is this the active library?

Return Value

bool

int getPackageID()

Get the package ID (or 0 if it's a core library).

Return Value

int

string|false getPackageHandle()

Get the package handle (or false if it's a core library).

Return Value

string|false

Package|null getPackageObject()

Get the package instance (or null if it's a core library).

Return Value

Package|null

static Library|null getActive()

Get the active library.

Return Value

Library|null

static Library|null getByHandle(string $sclHandle)

Get a library given its handle.

Parameters

string $sclHandle the library handle

Return Value

Library|null

static Library add(string $sclHandle, string $sclName, Package|int|false $pkg = false)

Add a new library.

Parameters

string $sclHandle the library handle
string $sclName the library name
Package|int|false $pkg the package that installs this library

Return Value

Library

delete()

Delete this library (if it's the default one we'll activate the default core library).

activate()

Make this library the active one.

static Library[] getList()

Retrieve all the installed libraries.

Return Value

Library[]

static Library[] getListByPackage(Package|int $pkg)

Retrieve the libraries installed by a package.

Parameters

Package|int $pkg the package instance (or its ID)

Return Value

Library[]

export(SimpleXMLElement $xml)

Export the data of this library.

Parameters

SimpleXMLElement $xml the parent XML element

static exportList(SimpleXMLElement $xml)

Export the data of all the libraries.

Parameters

SimpleXMLElement $xml the parent XML element

bool hasOptionsForm()

Does this library has an option form?

Return Value

bool

Controller getController()

Returns the controller class for the currently selected captcha library.

Return Value

Controller