Elgg Namespace Reference

Elgg CSS file. More...


Detailed Description

Elgg CSS file.

Elgg XML output for XML-RPC.

Elgg XML output This outputs the api as XML.

Elgg RSS output pageshell.

Elgg default group view.

Elgg PHP output pageshell.

Elgg PHP output This outputs the api as PHP.

Elgg XML output pageshell for ODD.

JSON river view.

Elgg JSON output pageshell.

Elgg JSON output This outputs the api as JSON.

Elgg JS pageshell.

Elgg JS default view.

Elgg ICAL output pageshell.

Elgg ICAL output of default object.

Elgg ICAL output.

Elgg default user view.

Elgg XML output pageshell.

Elgg fallback pageshell Render a few things (like the installation process) in a fallback mode, text only with minimal use of functions.

Elgg settings not found message Is saved to the errors register when settings.php cannot be found.

Elgg .htaccess not found message Is saved to the errors register when the main .htaccess cannot be found.

Elgg bad database settings.

Elgg exception (fallback mode) Displays a single exception.

Elgg checkbox input Displays a checkbox input field.

Create a input button Use this view for forms rather than creating a submit/reset button tag in the wild as it provides extra security which help prevent CSRF attacks.

Elgg widget wrapper.

Elgg edit widget layout.

Elgg sample welcome page (logged out).

Elgg sample welcome page (logged in).

Elgg statistics screen showing online users.

Elgg settings specific user settings.

Elgg plugin specific user settings.

Elgg user main settings page.

Provide a way of setting your password.

Provide a way of setting your full name.

Provide a way of setting your language prefs.

Provide a way of setting your email.

Provide a way of setting your default access.

Elgg user display.

Elgg basic tos page.

Elgg basic privacy page.

Elgg basic about page The standard HTML about page.

Elgg default spotlight The spotlight area that displays across the site.

ElggSite default view.

Elgg system settings form The form to change system settings.

Elgg system settings on initial installation.

Elgg relationship create event.

Elgg river item wrapper.

Elgg river for dashboard.

Elgg pageshell The standard HTML page shell that everything else fits into.

Elgg title element.

Elgg spotlight The spotlight area that displays across the site.

Elgg owner block Displays page ownership information.

Elgg header contents This file holds the header output that a user will see.

Elgg pageshell The standard HTML header that displays across the site.

Elgg footer The standard HTML footer that displays across the site.

Elgg top toolbar The standard elgg top toolbar.

Elgg URL display Displays a URL as a link.

Elgg tags Displays a list of tags, separated by commas.

Elgg tagcloud Displays a tagcloud.

Elgg pulldown display Displays a value that was entered into the system via a pulldown.

Elgg display long text Displays a large amount of text, with new lines converted to line breaks.

Display a page in an embedded window.

Elgg email output Displays an email address that was entered using an email input field.

Date Displays a properly formatted date.

Elgg confirmation link A link that displays a confirmation dialog before it executes.

Elgg text output Displays some text that was input using a standard text field.

Elgg calendar output Displays a calendar output field.

Elgg default widget view.

Elgg plugin.

Elgg default object view.

ElggEntity default view.

User settings for notifications.

Elgg list view switcher.

Elgg standard tools drop down This will be populated depending on the plugins active - only plugin navigation will appear here.

Elgg pagination.

Elgg standard message Displays a single Elgg system message.

Elgg list system messages Lists system messages.

Elgg global system message list Lists all system messages.

Elgg exception Displays a single exception.

Elgg list errors Lists error messages.

Elgg error message Displays a single error message.

User Picker.

This view provides a hook for third parties to provide a URL shortener.

Elgg URL input Displays a URL input field.

Elgg text input Displays a text input field.

Elgg tag input Displays a tag input field.

Create a submit input button Use this view for forms rather than creating a submit/reset button tag in the wild as it provides extra security which help prevent CSRF attacks.

CSRF security token view for use with secure forms.

Create a reset input button Use this view for forms rather than creating a submit/reset button tag in the wild as it provides extra security which help prevent CSRF attacks.

Elgg radio input Displays a radio input field.

Elgg pulldown input Displays a pulldown input field.

Elgg long text input (plaintext) Displays a long text input field that should not be overridden by wysiwyg editors.

Elgg password input Displays a password input field.

Elgg long text input Displays a long text input field.

Create a hidden data field Use this view for forms rather than creating a hidden tag in the wild as it provides extra security which help prevent CSRF attacks.

Create a form for data submission.

Elgg file input Displays a file input field.

Elgg email input Displays an email input field.

Elgg checkbox input Displays a checkbox input field NB: This also includes a hidden input with the same name as the checkboxes to make sure something is sent to the server.

This view provides a hook for third parties to provide captcha behaviour.

Elgg calendar input Displays a calendar input field.

Create a input button.

Displays an autocomplete text input.

Elgg access level input Displays a pulldown input field.

ElggGroup default view.

Generic icon view.

Elgg friends picker count updater Updates the friends count on a collection.

Elgg create new friend river item.

Elgg friends picker Lists the friends picker.

Elgg friends list Lists a user's friends.

Elgg friend collections add/edit.

Elgg friend collections required hidden fields for js friends picker form.

Elgg friends collections Lists a user's friends collections.

Elgg friends collection Lists one of a user's friends collections.

Elgg relationship export.

Elgg metadata export.

Elgg Entity export.

Elgg entity listing: gallery view.

Elgg gallery view.

Elgg entity listing.

View a list of entities.

Elgg Default Theme core CSS file.

Elgg comments add form.

Elgg widget layout.

Elgg 2 column left sidebar canvas layout.

Elgg 2 column left sidebar with boxes.

Elgg one-column layout.

Elgg 2 column right sidebar canvas layout.

Elgg default layout.

Elgg sample welcome page.

Elgg API default output This outputs the api in a human readable way.

Elgg generic comment.

Elgg default annotation view.

Elgg comment river view.

Elgg AJAX loader.

Elgg user search box.

Add a user.

Elgg administration user main screen.

Elgg statistics screen.

Elgg administration site main screen.

Elgg plugin manifest class.

Elgg administration plugin main screen.

Elgg user sub-component on the main menu.

Elgg satistics sub-component on the main menu.

Elgg site sub-component on the main menu.

Elgg plugin sub-component on the main menu.

Elgg administration main screen.

Elgg add user form.

Elgg register form.

Elgg login form.

Elgg forgotten password.

Elgg version number.

Elgg upgrade script.

Simple cache viewer Bypasses the engine to view simple cached CSS views.

Elgg user account settings.

Elgg user statistics.

Elgg user plugin settings.

Elgg user settings system index.

Open Document Definition Handler.

Rest endpoint.

Core language file.

Elgg install script.

Elgg index page for web-based applications.

Elgg friends picker callback.

Elgg friends of page.

Elgg friends page.

Elgg collections of friends.

Elgg add a collection of friends.

Entity viewer.

Generic entity viewer Given a GUID, this page will try and display any entity.

Elgg engine bootstrapper Loads the various elements of the Elgg engine.

Elgg XML library.

Elgg XML-RPC library.

Elgg widgets library.

Provides interfaces for Elgg's views system.

Elgg version library.

Elgg user settings functions.

ElggUser.

Elgg users Functions to manage multiple or single users in an Elgg install.

Elgg tags Functions for managing tags and tag clouds.

Elgg system log.

Elgg statistics library.

Elgg Social Functions and objects which provide powerful social aspects within Elgg.

ElggSite Representation of a "site" in the system.

Elgg sites Functions to manage multiple or single sites in an Elgg install.

Elgg session management Functions to manage logins.

Elgg river 2.0.

Relationship class.

Elgg relationships.

Elgg database query Contains a wrapper for performing database queries in a structured way.

For now, loads plugins directly.

PluginException.

Elgg plugins library Contains functions for managing plugins.

Elgg Simple PAM library Contains functions for managing authentication.

Elgg page owner library Contains functions for managing page ownership.

Elgg page handler functions.

Output functions Processing text for output such as pulling out URLs and extracting excerpts.

ODD Relationship class.

ODD Metadata class.

ODD Entity class.

Open Data Definition (ODD) superclass.

OpenDD PHP Library.

ElggObject Representation of an "object" in the system.

Elgg objects Functions to manage multiple or single objects in an Elgg install.

Notifications This file contains classes and functions which allow plugins to register and send notifications.

Elgg metastrngs Functions to manage object metastrings.

ElggMetadata This class describes metadata that can be attached to ElggEntities.

Elgg metadata Functions to manage object metadata.

Elgg memcache support.

Elgg geo-location tagging library.

Elgg language module Functions to manage language and translations.

Elgg installation Various functions to assist with installing and upgrading the system.

Parameter input functions.

Elgg Groups.

Elgg filestore.

ElggExtender.

Elgg Entity Extender.

Import exception.

Export exception.

Define an interface for all ODD exportable objects.

Elgg Data import export functionality.

RegistrationException Could not register a new user for whatever reason.

InvalidParameterException A parameter is invalid.

NotImplementedException Thrown when a method or function has not been implemented, primarily used in development.

InstallationException Thrown when there is a major problem with the installation.

ClassNotFoundException An Class not found Exception, throw when an class can not be found occurs.

InvalidClassException An invalid class Exception, throw when a class is invalid.

Data format exception An exception thrown when there is a problem in the format of some data.

CallException An exception thrown when there is a problem calling something.

APIException The API Exception class, thrown by the API layer when an API call has an issue.

ClassNotFoundException An database exception, throw when a database exception happens, subclass if more detail is needed.

SecurityException An Security Exception, throw when a Security Exception occurs.

ConfigurationException There is a configuration error.

ClassException A class Exception, throw when there is a class error.

IOException An IO Exception, throw when an IO Exception occurs.

Exceptions.

Require the locatable interface.

Elgg entities.

Elgg library Contains important functionality core to Elgg.

Elgg database Contains database connection and transfer functionality.

Elgg cron library.

Elgg configuration library Contains functions for managing system configuration.

Elgg calendar / entity / event functions.

ElggFileCache Store cached data in a file store.

ElggStaticVariableCache Dummy cache which stores values in a static array.

ElggCache The elgg cache superclass.

Elgg cache Cache file interface for caching data.

ElggHMACCache Store cached data in a temporary database, only used by the HMAC stuff.

ErrorResult The error result class.

SuccessResult Generic success result class, extend if you want to do something special.

GenericResult Result superclass.

Elgg API Functions and objects which make up the API engine.

Include the ElggExtender superclass.

Elgg annotations Functions to manage object annotations.

Elgg admin functions.

Elgg actions Allows system modules to specify actions.

Elgg access permissions For users, objects, collections and all metadata.

Elgg XML-RPC handler.

Elgg web services handler.

Elgg page handler.

Elgg Cron handler.

Elgg action handler.

Elgg latest content page.

Elgg dashboard.

Elgg administration user system index.

Elgg administration statistics index This is a special page that displays a number of statistics.

Elgg administration site system index.

Elgg administration plugin system index This is a special page that permits the configuration of plugins in a standard way.

Elgg administration system index.

Elgg widget save action.

Elgg widget reorder action.

Elgg widget add action.

Aggregate action for saving settings.

Elgg add action.

Close or open spotlight.

Action to request a new password.

Action to reset a password and send success email.

Action for changing a user's password.

Action for changing a user's name.

Action for changing a user's personal language settings.

Action for changing a user's default access level.

Elgg install site action.

Elgg registration action.

Elgg plugin user settings save action.

Elgg plugin settings save action.

Elgg notifications user preference save acion.

Elgg logout action.

Elgg login action.

Elgg OpenDD import action.

Elgg remove friend action.

Elgg friends: delete collection action.

Elgg collection add page.

Elgg add friend action.

Default entity delete action.

Action for saving a new email address for a user and triggering a confirmation.

Elgg delete comment action.

Elgg add comment action.

Admin password reset.

Make another user an admin.

Elgg delete user.

Elgg ban user.

Elgg update site action.

Reorder plugin action.

Enable plugin action.

Disable plugin action.

Elgg registration page.

Forgotten password function.

Core

This is an update version of the sitesettings/install action which is used by the admin panel to modify basic settings.

Core

This action accepts data to import (in OpenDD format) and performs and import. It accepts data as $data.

Core

Creates a nwe site and sets it as the default

Core

If page_handler() fails, send to front page.

Core

Functions for adding and manipulating options on the admin panel.

Core

ElggAnnotation An annotation is similar to metadata. Each entity can have more than one of each type of annotation.

Core

API

This defines the interface for a cache (wherever that cache is stored).

API

Using this makes future replacements to other caching back ends (eg memcache) much easier.

API

Functions to manage all elgg entities (sites, groups, objects and users).

Core

ElggEntity The elgg entity superclass This class holds methods for accessing the main entities table.

Core

Define some globally useful exception classes.

Exceptions

Subclass for specific IO Exceptions.

Exceptions

Exceptions

Subclass for specific Security Execeptions (access problems etc)

Exceptions

.. you should not see these!

Exceptions

This file contains ways of extending an Elgg entity in custom ways.

Core

This file contains classes, interfaces and functions for saving and retrieving data to various file stores.

API

Groups contain other entities, or rather act as a placeholder for other entities to mark any given container as their container.

Core

This file contains functions for getting input from get/post variables.

Core

Requires php5-memcache to work.

API

There are notification methods which are provided out of the box (see notification_init() ). Each method is identified by a string, e.g. "email".

To register an event use register_notification_handler() and pass the method name and a handler function.

To send a notification call notify() passing it the method you wish to use combined with a number of method specific addressing parameters.

Catch NotificationException to trap errors.

API

Core

Version:
0.4

This is not a full implementation of PAM. It supports a single facility (authentication) and allows multiple policies (user authentication is the default). There are two control flags possible for each module: sufficient or required. The entire chain for a policy is processed (or until a required module fails). A module fails by returning false or throwing an exception. The order that modules are processed is determined by the order they are registered. For an example of a PAM, see pam_auth_userpass() in sessions.php.

For more information on PAMs see: http://www.freebsd.org/doc/en/articles/pam/index.html

Core

A plugin Exception, thrown when an Exception occurs relating to the plugin mechanism. Subclass for specific plugin Exceptions.

Exceptions

Stub containing relationship functions, making import and export easier.

Core

Functions for listening for and generating the river separately from the system log.

Core

Core

/** Filters a string into an array of significant words

Parameters:
string $string
Returns:
array

This file contains a number of functions for obtaining statistics about the running system. These statistics are mainly used by the administration pages, and is also where the basic views for statistics are added.

Core

Listens to events and writes crud events into the system log database.

Core

Representation of a "user" in the system.

Core

Functions for adding and manipulating options on the user settings panel.

Core

Contains code for handling versioning and upgrades.

Core

Contains code for handling widgets.

Core

Contains functions and classes to handle XML-RPC services, currently only server only.

Core

Contains functions for generating and parsing XML.

Core

The API REST endpoint.

API

This file acts as the endpoint for ODD UUID url requests, exporting the requested data as an OpenDD XML file.

Core

This script triggers any upgrades necessary, ensuring that upgrades are triggered deliberately by a single user.

Core

This file defines the current version of the core Elgg code being used. This is compared against the values stored in the database to determine whether upgrades should be performed.

Core

This file renders a plugin for the admin screen, including active/deactive, manifest details & display plugin settings.

Core

Form to add a new user.

Core

$vars['entity']

Updated 30 Sept 09

Core

$vars['wwwroot'] The site URL

Displays an entity using the current view.

Core

Displays a metadata item using the current view.

Core

Displays a relationship using the current view.

Core

Core

See also:
collections.php

$vars['collection'] The individual friends collection

Core

$vars['collections'] The array of friends collections

Core

$vars['object'] Optionally, the collection edit

Core

$vars['friends'] The array of ElggUser objects

Core

$vars['entities'] The array of ElggUser objects

Core

$vars['count'] The count $vars['friendspicker'] The friendspicker counter number

Core

$vars['entity'] The entity the icon represents - uses getIcon() method $vars['js'] Any JavaScript to add to img tag $vars['size'] topbar, tiny, small, medium (default), large, master $vars['link'] Optional link for the image $vars['align'] Align attribute of the img tag

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['match_on'] Array | str What to match on. all|array(group|user|friend|subtype) $vars['match_owner'] Bool. Match only entities that are owned by logged in user.

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['internalid'] The id of the input field $vars['type'] Submit, button, or reset, defaults to submit. $vars['src'] Src of an image

The default value is 0. If using JS, be specific to avoid selecting the hidden default value: $('input[type=checkbox][name=internalname])

Core

string $vars['internalname'] The name of the input fields (Forced to an array by appending []) array $vars['options'] An array of strings representing the label => option for the each checkbox field string $vars['internalid'] The id for each input field. Optional (Only use this with a single value.) string $vars['default'] The default value to send if nothing is checked. Optional, defaults to 0. bool $vars['disabled'] Make all input elements disabled. Optional. string $vars['value'] The current value. Optional. string $vars['class'] The class of each input element. Optional. string $vars['js'] Any Javascript to enter into the input tag. Optional.

Core

$vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['internalid'] The id of the input field $vars['class'] CSS class $vars['disabled'] Is the input field disabled? $vars['value'] The current value if any

Use this view for forms rather than creating a form tag in the wild as it provides extra security which help prevent CSRF attacks.

Core

$vars['body'] The body of the form (made up of other input/xxx views and html $vars['method'] Method (default POST) $vars['enctype'] How the form is encoded, default blank $vars['action'] URL of the action being called $vars['js'] Any Javascript to enter into the form $vars['internalid'] id for the form for CSS/Javascript $vars['internalname'] name for the form for Javascript $vars['disable_security'] turn off CSRF security by setting to true

Core

$vars['value'] The current value, if any - will be html encoded $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['internalid'] The id of the input field $vars['class'] CSS class $vars['disabled'] Is the input field disabled?

NB: Default values of FALSE or NULL will match '' (empty string) and not 0.

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['options'] An array of strings representing the options for the pulldown field $vars['options_values'] An associative array of "value" => "option" where "value" is an internal name and "option" is the value displayed on the button. Replaces $vars['options'] when defined.

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['options'] An array of strings representing the options for the radio field as "label" => option

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['type'] Submit or reset, defaults to submit.

It is still recommended that you use input/form.

Core

Core

$vars['value'] The current value, if any - string or array - tags will be encoded $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['internalid'] The id of the input field $vars['class'] CSS class override $vars['disabled'] Is the input field disabled?

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['disabled'] If true then control is read-only $vars['class'] Class override

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['class'] Class override

Sends an array of user guids.

Core

$vars['value'] The current value, if any $vars['internalname'] The name of the input field

pops up defaulted to lazy load friends lists in paginated alphabetical order. upon

As users are checked they move down to a "users" box. When this happens, a hidden input is created also. {$internalnal}[] with the value th GUID.

Core

$vars['object'] An error message (string)

Core

$vars['object'] An array of error messages

Core

$vars['object'] An exception

Core

$vars['object'] The array of message registers

Core

$vars['object'] An array of system messages

Core

$vars['object'] A system message (string)

This is a placeholder.

Core

Core

$vars['value'] The current value, if any

Core

$vars['text'] The text to display

Core

$vars['text'] The text of the link $vars['href'] The address $vars['confirm'] The dialog text

Core

$vars['value'] A UNIX epoch timestamp

Core

$vars['value'] The email address to display

Core

$vars['value'] Source of the page

Core

$vars['value'] The text to display $vars['parse_urls'] Whether to turn urls into links. Default is true.

Core

$vars['tagcloud'] An array of stdClass objects with two elements: 'tag' (the text of the tag) and 'total' (the number of elements with this tag) $vars['value'] Sames as tagcloud $vars['type'] Entity type $vars['subtype'] Entity subtype

Tags can be a single string (for one tag) or an array of strings

Core

$vars['tags'] The tags to display $vars['tagtype'] The tagtype, optionally

Core

string $vars['href'] The string to display in the tags string $vars['text'] The string between the tags. bool $vars['target'] Set the target="" attribute. string $vars['class'] what to add in class="" string $vars['js'] Javascript to insert in tag bool $vars['is_action'] Is this a link to an action?

$vars['body'] The content to display inside content wrapper $vars['subclass'] Additional css class

Core

$vars['config'] The site configuration settings, imported $vars['title'] The page title $vars['body'] The main content of the page

Core

$vars['title'] The page title

Core

$vars['config'] The site configuration settings, imported $vars['title'] The page title $vars['body'] The main content of the page $vars['messages'] A 2d array of various message registers, passed from system_messages()

Wraps all river items.

Display something in the river when a relationship is created.

Core

$vars['action'] If set, the place to forward the form to (usually action/systemsettings/save)

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['type'] Submit or reset, defaults to submit. $vars['src'] Src of an image

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['options'] An array of strings representing the options for the checkbox field

Use this view for forms rather than creating a form tag in the wild as it provides extra security which help prevent CSRF attacks.

Core

$vars['body'] The body of the form (made up of other input/xxx views and html $vars['method'] Method (default POST) $vars['enctype'] How the form is encoded, default blank $vars['action'] URL of the action being called

Core

$vars['value'] The current value, if any $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input field $vars['options'] An array of strings representing the options for the pulldown field $vars['options_values'] An associative array of "value" => "option" where "value" is an internal name and "option" is the value displayed on the button. Replaces $vars['options'] when defined.

Displays an entity as JSON

Core

Displays a metadata item using json

Core

Displays a relationship using JSON.

Core

Displays an entity as ODD

Core

Displays a relationship using ODD.

Core

Displays an entity as PHP serialised data

Core

Displays a metadata item using PHP serialised data

Core

Displays a relationship using PHP serialised data

Core

 All Classes Namespaces Files Functions Variables Enumerations
Generated on Tue Jun 18 00:01:34 2013 for Elgg by  doxygen 1.6.3