Library
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
Get the library handle.
Get the library name.
Is this the active library?
Get the package ID (or 0 if it's a core library).
Get the package handle (or false if it's a core library).
Get the package instance (or null if it's a core library).
Get a library given its handle.
Delete this library (if it's the default one we'll activate the default core library).
Make this library the active one.
Does this library has an option form?
Returns the controller class for the currently selected captcha library.
Details
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.
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?
Controller
getController()
Returns the controller class for the currently selected captcha library.