[bigace-api] element index

Package indexes

• bigace-classes
• bigace-command
• bigace-libs

authenticate

Authenticator::authenticate() in Authenticator.php

This performs an Authentication check.

AUTHENTICATE_UNKNOWN

AUTHENTICATE_UNKNOWN in Authenticator.php

This Flag marks the given Name as unknown (no Principal with this name).

Authenticator

Authenticator::Authenticator() in Authenticator.php

Authenticator

Authenticator in Authenticator.php

The Authenticator Interface defines methods that must be implemented to check Principals and perform the Login comand.

Authenticator.php

Authenticator.php in Authenticator.php

createPrincipal

PrincipalService::createPrincipal() in PrincipalService.php

Creates a Principal.

close

DatabaseConnection::close() in DatabaseConnection.php

Closes the currently used Connection.

count

Result::count() in Result.php

Returns the Number of Results

displayPortlet

Portlet::displayPortlet() in Portlet.php

OPTIONAL TO BE OVERWRITEN!
Return if this Portlet should be displayed or not.

deleteAttributes

PrincipalService::deleteAttributes() in PrincipalService.php

Deletes the attributes for the given Principal.

deletePrincipal

PrincipalService::deletePrincipal() in PrincipalService.php

Deletes a Principal.

DatabaseConnection.php

DatabaseConnection.php in DatabaseConnection.php

DatabaseConnection

DatabaseConnection in DatabaseConnection.php

Interface for Database Connections.

freeResult

DatabaseConnection::freeResult() in DatabaseConnection.php

Free the given SQL resource.

getAllParameter

Portlet::getAllParameter() in Portlet.php

Gets all configured Portlet Parameter.

getHtml

Portlet::getHtml() in Portlet.php

REQIURED TO BE OVERWRITEN!
Return the HTML snippet that this Portlet represents.

getIdentifier

Portlet::getIdentifier() in Portlet.php

Get the Identifier for this Portlet.

getJavascript

Portlet::getJavascript() in Portlet.php

OPTIONAL TO BE OVERWRITEN!
Overwrite if your Portlet needs a Javascript snippet to work.

getParameter

Portlet::getParameter() in Portlet.php

Gets a Portlet Parameter.

getParameterName

Portlet::getParameterName() in Portlet.php

Returns the Name of the given Parameter.

getParameterType

Portlet::getParameterType() in Portlet.php

REQIURED TO BE OVERWRITEN!
Returns the PortletType for the given Key.

getPortlets

PortletService::getPortlets() in PortletService.php

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

Portlet::getTitle() in Portlet.php

REQIURED TO BE OVERWRITEN!
Return the Title for this Portlet.

getAllPrincipals

PrincipalService::getAllPrincipals() in PrincipalService.php

Get an Array with all available Principals.

getAttributes

PrincipalService::getAttributes() in PrincipalService.php

Returns the Principal Attributes as a key-value mapped Array.

getID

Principal::getID() in Principal.php

Returns the Principal ID.

getLanguageID

Principal::getLanguageID() in Principal.php

Gets the Language ID for this Principal.

getName

Principal::getName() in Principal.php

Gets the Principal name.

getParameter

PrincipalService::getParameter() in PrincipalService.php

Gets the given Parameter for the Principal.

isActive

Principal::isActive() in Principal.php

Gets the Users status.

isAnonymous

Principal::isAnonymous() in Principal.php

Returns whether the User is anonymous or not.

isSuperUser

Principal::isSuperUser() in Principal.php

Returns whether the User is Super User or not.

insert

DatabaseConnection::insert() in DatabaseConnection.php

Inserts one or more rows and returns the result.

isConnected

DatabaseConnection::isConnected() in DatabaseConnection.php

Returns whether we are connected to the Database or not.

isError

Result::isError() in Result.php

Returns whether the Statement was successful or not.

lookup

PrincipalService::lookup() in PrincipalService.php

Tries to find a Principal with the given Name.

lookupByID

PrincipalService::lookupByID() in PrincipalService.php

Tries to find a Principal with the given ID.

needsJavascript

Portlet::needsJavascript() in Portlet.php

OPTIONAL TO BE OVERWRITEN!
This method defines if the Portlet needs a Javascript block to work.

next

Result::next() in Result.php

Gets the next result or null if none is available.

Portlet.php

Portlet.php in Portlet.php

PortletService.php

PortletService.php in PortletService.php

Portlet

Portlet::Portlet() in Portlet.php

Portlet

Portlet in Portlet.php

A Portlet is a small piece of Logic, normally displayed by a HTML snippet.

PortletService

PortletService in PortletService.php

This class provides methods for reading and saving of Portlets.

PORTLET_DEFAULT_COLUMN

PORTLET_DEFAULT_COLUMN in PortletService.php

The default Project Field that is used for writing and reading Portlets.

PORTLET_TYPE_BOOLEAN

PORTLET_TYPE_BOOLEAN in Portlet.php

Boolean is a MUST value that will can choosen by a SelectBox.

PORTLET_TYPE_HTML

PORTLET_TYPE_HTML in Portlet.php

HTML behaves like

PORTLET_TYPE_TEXT

, but keeps all TAGs.

PORTLET_TYPE_INT

PORTLET_TYPE_INT in Portlet.php

An int value is always numeric.

PORTLET_TYPE_INT_OPTIONAL

PORTLET_TYPE_INT_OPTIONAL in Portlet.php

Behaves like

PORTLET_TYPE_INT

, but might also be empty.

PORTLET_TYPE_INT_POSITIVE

PORTLET_TYPE_INT_POSITIVE in Portlet.php

An int value that must be greater or equal 0.

PORTLET_TYPE_LANGUAGE

PORTLET_TYPE_LANGUAGE in Portlet.php

Defines a Language ID.

PORTLET_TYPE_LANGUAGE_OPTIONAL

PORTLET_TYPE_LANGUAGE_OPTIONAL in Portlet.php

Defines an optional Language ID. Must not be filled with a value.

PORTLET_TYPE_MENUID

PORTLET_TYPE_MENUID in Portlet.php

Menu ID must be a Number that might be negative.

PORTLET_TYPE_MENUID_OPTIONAL

PORTLET_TYPE_MENUID_OPTIONAL in Portlet.php

This can be an empty Value. Otherwise it behaves like:

PORTLET_TYPE_MENUID

PORTLET_TYPE_STRING

PORTLET_TYPE_STRING in Portlet.php

The default type of a Portlet Parameter. A String.

PORTLET_TYPE_TEXT

PORTLET_TYPE_TEXT in Portlet.php

Defines the value as a Text.

Principal.php

Principal.php in Principal.php

PrincipalService.php

PrincipalService.php in PrincipalService.php

Principal

Principal::Principal() in Principal.php

Principal

Principal in Principal.php

This Interface represents a Principal.

PrincipalService

PrincipalService::PrincipalService() in PrincipalService.php

PrincipalService

PrincipalService in PrincipalService.php

This Service Interface holds methods for loading and manipulating Prinicpals.

PRINCIPAL_PARAMETER_ACTIVE

PRINCIPAL_PARAMETER_ACTIVE in PrincipalService.php

The Parameter to mark a Principal as active.

PRINCIPAL_PARAMETER_LANGUAGE

PRINCIPAL_PARAMETER_LANGUAGE in PrincipalService.php

The Parameter to mark a Principals Language.

PRINCIPAL_PARAMETER_PASSWORD

PRINCIPAL_PARAMETER_PASSWORD in PrincipalService.php

The Parameter to mark a Principals Password.

Result.php

Result.php in Result.php

Result

Result in Result.php

This represents a Result for any Database query made with DatabaseConnection.

savePortlets

PortletService::savePortlets() in PortletService.php

Saves the given Portlets for the Item.

setIgnoreDisplaySetting

PortletService::setIgnoreDisplaySetting() in PortletService.php

If this function is called with

true

also the Portlets are rendered, that return

false

for

Portlet->displayPortlet()

.

setParameter

Portlet::setParameter() in Portlet.php

Sets a Portlet Parameter.

setAttribute

PrincipalService::setAttribute() in PrincipalService.php

Sets the attribute-value mapping for the given Principal.

setParameter

PrincipalService::setParameter() in PrincipalService.php

Sets the given Parameter for the Principal.

sql

DatabaseConnection::sql() in DatabaseConnection.php

Returns the Result of this SQL Query.