[class tree: bigace-api] [index: bigace-api] [all elements]

a

authenticate

in file Authenticator.php, method Authenticator::authenticate()
    This performs an Authentication check.

AUTHENTICATE_UNKNOWN

in file Authenticator.php, constant AUTHENTICATE_UNKNOWN
    This Flag marks the given Name as unknown (no Principal with this name).

Authenticator

in file Authenticator.php, method Authenticator::Authenticator()

Authenticator

in file Authenticator.php, class Authenticator
    The Authenticator Interface defines methods that must be implemented to check Principals and perform the Login comand.

Authenticator.php

procedural page Authenticator.php

AutoJob

in file AutoJob.php, class AutoJob
    This represents an executable AutoJob, which can be runned at Program Startup in a defined time-cycle.

AUTOJOB_CORRUPT

in file AutoJob.php, constant AUTOJOB_CORRUPT

AUTOJOB_FAILURE

in file AutoJob.php, constant AUTOJOB_FAILURE

AUTOJOB_RUNNING

in file AutoJob.php, constant AUTOJOB_RUNNING

AUTOJOB_STOPPED

in file AutoJob.php, constant AUTOJOB_STOPPED

AutoJob.php

procedural page AutoJob.php

c

createHash

in file Authenticator.php, method Authenticator::createHash()
    Creates a hash to be used as password.

createPrincipal

in file PrincipalService.php, method PrincipalService::createPrincipal()
    Creates a Principal.

close

in file DatabaseConnection.php, method DatabaseConnection::close()
    Closes the currently used Connection.

count

in file Result.php, method Result::count()
    Returns the Number of Results

Captcha

in file Captcha.php, class Captcha
    An interface for validating implemented to check Principals and perform the Login comand.

Captcha.php

procedural page Captcha.php

d

displayPortlet

in file Portlet.php, method Portlet::displayPortlet()
    OPTIONAL TO BE OVERWRITEN!
Return if this Portlet should be displayed or not.

deleteAttributes

in file PrincipalService.php, method PrincipalService::deleteAttributes()
    Deletes all attributes for the given Principal.

deletePrincipal

in file PrincipalService.php, method PrincipalService::deletePrincipal()
    Deletes a Principal.

DatabaseConnection.php

procedural page DatabaseConnection.php

DBError.php

procedural page DBError.php

DatabaseConnection

in file DatabaseConnection.php, class DatabaseConnection
    Interface for Database Connections.

DBError

in file DBError.php, class DBError
    A database error.

e

execute

in file AutoJob.php, method AutoJob::execute()

escape

in file DatabaseConnection.php, method DatabaseConnection::escape()
    Escapes a value to be used in any SQL Statement.

f

free

in file Result.php, method Result::free()
    Free the memory for this result.

freeResult

in file DatabaseConnection.php, method DatabaseConnection::freeResult()
    Free the given SQL resource.

g

getConfigPackage

in file AutoJob.php, method AutoJob::getConfigPackage()
    If your AutoJob requires further configuration, you should return the configs package name.

getDescription

in file AutoJob.php, method AutoJob::getDescription()
    Returns the Description of this AutoJob.

getMessage

in file AutoJob.php, method AutoJob::getMessage()
    Return a log message at least if the execution task failed.

getName

in file AutoJob.php, method AutoJob::getName()
    Returns the Name (unique identifier) of this AutoJob.

getNextExecution

in file AutoJob.php, method AutoJob::getNextExecution()
    Calculates and returns the next execution time as Unix Timestamp.

getContentNames

in file MenuTemplate.php, method MenuTemplate::getContentNames()
    Returns an array of Strings, each String representing one Name of an additional Content piece.

getDescription

in file MenuTemplate.php, method MenuTemplate::getDescription()
    Returns the Description of this Template.

getName

in file MenuTemplate.php, method MenuTemplate::getName()
    Returns the Name of this Template.

getPortletColumns

in file MenuTemplate.php, method MenuTemplate::getPortletColumns()
    Returns an array of Strings, each String representing one Portlet column definition.

getAllParameter

in file Portlet.php, method Portlet::getAllParameter()
    Gets all configured Portlet Parameter.

getHtml

in file Portlet.php, method Portlet::getHtml()
    REQIURED TO BE OVERWRITEN!
Return the HTML snippet that this Portlet represents.

getIdentifier

in file Portlet.php, method Portlet::getIdentifier()
    Get the Identifier for this Portlet.

getJavascript

in file Portlet.php, method Portlet::getJavascript()
    OPTIONAL TO BE OVERWRITEN!
Overwrite if your Portlet needs a Javascript snippet to work.

getParameter

in file Portlet.php, method Portlet::getParameter()
    Gets a Portlet Parameter.

getParameterName

in file Portlet.php, method Portlet::getParameterName()
    Returns the Name of the given Parameter.

getParameterType

in file Portlet.php, method Portlet::getParameterType()
    REQIURED TO BE OVERWRITEN!
Returns the PortletType for the given Key.

getPortlets

in file PortletService.php, method PortletService::getPortlets()
    Get an array with ready parsed and configured Portlets for the given Itemtype and ID. Even if Portlets are ment to be used with Menus, it is possible to fetch them for all Itemtypes.

getTitle

in file Portlet.php, method Portlet::getTitle()
    REQIURED TO BE OVERWRITEN!
Return the Title for this Portlet.

getParameterName

in file TranslatedPortlet.php, method TranslatedPortlet::getParameterName()

getTranslation

in file TranslatedPortlet.php, method TranslatedPortlet::getTranslation()
    Gets the Translation fo the given key.

getAllPrincipals

in file PrincipalService.php, method PrincipalService::getAllPrincipals()
    Get an Array with all available Principals.

getAttributes

in file PrincipalService.php, method PrincipalService::getAttributes()
    Returns the Principal Attributes as a key-value mapped Array.

getEmail

in file Principal.php, method Principal::getEmail()
    Returns the Users email.

getID

in file Principal.php, method Principal::getID()
    Returns the Principal ID.

getLanguageID

in file Principal.php, method Principal::getLanguageID()
    Gets the Language ID for this Principal.

getName

in file Principal.php, method Principal::getName()
    Gets the Principal name.

getParameter

in file PrincipalService.php, method PrincipalService::getParameter()
    Gets the given Parameter for the Principal.

getError

in file DatabaseConnection.php, method DatabaseConnection::getError()
    Return a DBError or null.

getMessage

in file DBError.php, method DBError::getMessage()
    Gets the error message

getNumber

in file DBError.php, method DBError::getNumber()
    Returns the error number

get

in file Captcha.php, method Captcha::get()
    Returns the image url.

h

hasPortletSupport

in file MenuTemplate.php, method MenuTemplate::hasPortletSupport()
    Returns whether this Layout supports dynamic Portlets.

i

isActive

in file Principal.php, method Principal::isActive()
    Gets the Users status.

isAnonymous

in file Principal.php, method Principal::isAnonymous()
    Returns whether the User is anonymous or not.

isSuperUser

in file Principal.php, method Principal::isSuperUser()
    Returns whether the User is Super User or not.

insert

in file DatabaseConnection.php, method DatabaseConnection::insert()
    Inserts one or more rows and returns the result.

isConnected

in file DatabaseConnection.php, method DatabaseConnection::isConnected()
    Returns whether we are connected to the Database or not.

isError

in file Result.php, method Result::isError()
    Returns whether the Statement was successful or not.

l

loadBundle

in file TranslatedPortlet.php, method TranslatedPortlet::loadBundle()
    Loads the given ResourceBundle for this Portlet.

lookup

in file PrincipalService.php, method PrincipalService::lookup()
    Tries to find a Principal with the given Name.

lookupByID

in file PrincipalService.php, method PrincipalService::lookupByID()
    Tries to find a Principal with the given ID.

m

MenuTemplate

in file MenuTemplate.php, class MenuTemplate
    This represents a MenuTemplate, that is used to render a requested Menu.

n

needsJavascript

in file Portlet.php, method Portlet::needsJavascript()
    OPTIONAL TO BE OVERWRITEN!
This method defines if the Portlet needs a Javascript block to work.

next

in file Result.php, method Result::next()
    Gets the next result or FALSE if none is available.

p

Portlet.php

procedural page Portlet.php

PortletService.php

procedural page PortletService.php

Portlet

in file Portlet.php, method Portlet::Portlet()

Portlet

in file Portlet.php, class Portlet
    A Portlet is a small piece of Logic, normally displayed by a HTML snippet.

PortletService

in file PortletService.php, class PortletService
    This class provides methods for reading and saving of Portlets.

PORTLET_DEFAULT_COLUMN

in file PortletService.php, constant PORTLET_DEFAULT_COLUMN
    The default Project Field that is used for writing and reading Portlets.

PORTLET_TYPE_BOOLEAN

in file Portlet.php, constant PORTLET_TYPE_BOOLEAN
    Boolean is a MUST value that will can choosen by a SelectBox.

PORTLET_TYPE_HTML

in file Portlet.php, constant PORTLET_TYPE_HTML
    HTML behaves like

1. PORTLET_TYPE_TEXT

, but keeps all TAGs.

PORTLET_TYPE_INT

in file Portlet.php, constant PORTLET_TYPE_INT
    An int value is always numeric.

PORTLET_TYPE_INT_OPTIONAL

in file Portlet.php, constant PORTLET_TYPE_INT_OPTIONAL
    Behaves like

1. PORTLET_TYPE_INT

, but might also be empty.

PORTLET_TYPE_INT_POSITIVE

in file Portlet.php, constant PORTLET_TYPE_INT_POSITIVE
    An int value that must be greater or equal 0.

PORTLET_TYPE_LANGUAGE

in file Portlet.php, constant PORTLET_TYPE_LANGUAGE
    Defines a Language ID.

PORTLET_TYPE_LANGUAGE_OPTIONAL

in file Portlet.php, constant PORTLET_TYPE_LANGUAGE_OPTIONAL
    Defines an optional Language ID. Must not be filled with a value.

PORTLET_TYPE_MENUID

in file Portlet.php, constant PORTLET_TYPE_MENUID
    Menu ID must be a Number that might be negative.

PORTLET_TYPE_MENUID_OPTIONAL

in file Portlet.php, constant PORTLET_TYPE_MENUID_OPTIONAL
    This can be an empty Value. Otherwise it behaves like:

1. PORTLET_TYPE_MENUID

PORTLET_TYPE_STRING

in file Portlet.php, constant PORTLET_TYPE_STRING
    The default type of a Portlet Parameter. A String.

PORTLET_TYPE_TEXT

in file Portlet.php, constant PORTLET_TYPE_TEXT
    Defines the value as a Text.

Principal.php

procedural page Principal.php

PrincipalService.php

procedural page PrincipalService.php

Principal

in file Principal.php, method Principal::Principal()

Principal

in file Principal.php, class Principal
    This Interface represents a Principal.

PrincipalService

in file PrincipalService.php, method PrincipalService::PrincipalService()

PrincipalService

in file PrincipalService.php, class PrincipalService
    This Service Interface holds methods for loading and manipulating Prinicpals.

PRINCIPAL_PARAMETER_ACTIVE

in file PrincipalService.php, constant PRINCIPAL_PARAMETER_ACTIVE
    The Parameter to mark a Principal as active.

PRINCIPAL_PARAMETER_EMAIL

in file PrincipalService.php, constant PRINCIPAL_PARAMETER_EMAIL
    The Parameter to set the Principals email adress.

PRINCIPAL_PARAMETER_LANGUAGE

in file PrincipalService.php, constant PRINCIPAL_PARAMETER_LANGUAGE
    The Parameter to mark a Principals Language.

PRINCIPAL_PARAMETER_PASSWORD

in file PrincipalService.php, constant PRINCIPAL_PARAMETER_PASSWORD
    The Parameter to mark a Principals Password.

r

Result.php

procedural page Result.php

Result

in file Result.php, class Result
    This represents a Result for any Database query made with DatabaseConnection.

s

savePortlets

in file PortletService.php, method PortletService::savePortlets()
    Saves the given Portlets for the Item.

setIgnoreDisplaySetting

in file PortletService.php, method PortletService::setIgnoreDisplaySetting()
    If this function is called with

1. true

also the Portlets are rendered, that return

1. false

for

1. Portlet->displayPortlet()

.

setParameter

in file Portlet.php, method Portlet::setParameter()
    Sets a Portlet Parameter.

setAttribute

in file PrincipalService.php, method PrincipalService::setAttribute()
    Sets the attribute-value mapping for the given Principal.

setParameter

in file PrincipalService.php, method PrincipalService::setParameter()
    Sets the given Parameter for the Principal.

sql

in file DatabaseConnection.php, method DatabaseConnection::sql()
    Returns the Result of this SQL Query.

t

TranslatedPortlet

in file TranslatedPortlet.php, class TranslatedPortlet
    This is a base class for Portlets that use a ResourceBundle.

v

validate

in file Captcha.php, method Captcha::validate()
    This validates the Users Captcha test.