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.

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 exception (fallback mode) Displays a single exception.

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 search listing.

Elgg search listing: gallery view.

Elgg gallery view.

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.

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.

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

Elgg calendar input Displays a calendar 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 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 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 v1.5 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 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 settings system index.

Open Document Definition Handler.

Rest endpoint.

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

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.

Activity 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.

Elgg version library.

Elgg user settings functions.

ElggUser.

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

Elgg testing framework.

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 search helper functions.

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.

This module pings us on the first install.

Elgg PAM library Contains functions for managing authentication using various arbitrary methods.

Elgg page owner library Contains functions for managing page ownership.

Elgg page handler functions.

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 wrapper functions for multibyte string 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 TODO: Move this into start.php?

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 activity stream.

Elgg actions Allows system modules to specify actions.

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

Elgg XML-RPC 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.

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

Author:
Curverider Ltd

This is an update version of the sitesettings/install action which is used by the admin panel to modify basic settings. Core Curverider Ltd http://elgg.org/ Curverider <curverider.co.uk> http://elgg.org/ This action accepts data to import (in OpenDD format) and performs and import. It accepts data as $data. Core Curverider Ltd http://elgg.org/ Creates a nwe site and sets it as the default Core Curverider Ltd http://elgg.org/ Core http://elgg.org/ Functions for listening for and generating the rich activity stream from the system log. Core Curverider Ltd http://elgg.org/ Functions for adding and manipulating options on the admin panel. Core Curverider Ltd http://elgg.org/ Core Curverider Ltd <info@elgg.com> http://elgg.org/ ElggAnnotation An annotation is similar to metadata each entity can contain more than one of each annotation. Core Curverider Ltd <info@elgg.com> Curverider Ltd <info@elgg.com> Core Curverider Ltd <info@elgg.com> API API Curverider Ltd <info@elgg.com> http://elgg.org/ This defines the interface for a cache (wherever that cache is stored). Curverider Ltd <info@elgg.com> API Using this makes future replacements to other caching back ends (eg memcache) much easier. Curverider Ltd <info@elgg.com> API Functions to manage all elgg entities (sites, collections, objects and users). Core Curverider Ltd <info@elgg.com> http://elgg.org/ ElggEntity The elgg entity superclass This class holds methods for accessing the main entities table. Curverider Ltd <info@elgg.com> Core Define some globally useful exception classes. Exceptions Curverider Ltd <info@elgg.com> http://elgg.org/ Subclass for specific IO Exceptions. Curverider Ltd <info@elgg.com> Exceptions Curverider Ltd <info@elgg.com> Exceptions Subclass for specific Security Execeptions (access problems etc) Curverider Ltd <info@elgg.com> Exceptions .. you should not see these! Curverider Ltd <info@elgg.com> Exceptions Core Curverider Ltd Exceptions This file contains ways of extending an Elgg entity in custom ways. Core Curverider Ltd http://elgg.org/ Curverider Ltd Core This file contains classes, interfaces and functions for saving and retrieving data to various file stores. API Curverider Ltd http://elgg.org/ Groups contain other entities, or rather act as a placeholder for other entities to mark any given container as their container. Core Curverider Ltd http://elgg.org/ This file contains functions for getting input from get/post variables. Core Curverider Ltd <info@elgg.com> http://elgg.org/ Requires php5-memcache to work. API Curverider Ltd <info@elgg.com> http://elgg.org/ 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 Curverider Ltd http://elgg.org/ Core Core Curverider Ltd 0.4 http://elgg.org/ Core Curverider Ltdsend_api_get_call http://elgg.org/ A plugin Exception, thrown when an Exception occurs relating to the plugin mechanism. Subclass for specific plugin Exceptions. Exceptions todo 1. Stub containing relationship functions, making import and export easier. Core Curverider Ltd <info@elgg.com> http://elgg.org/ Functions for listening for and generating the river separately from the system log. Core Curverider Ltd http://elgg.org/ Core Curverider http://elgg.org/ /** Filters a string into an array of significant words string $string 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 Curverider Ltd http://elgg.org/ Listens to events and writes crud events into the system log database. Core Curverider Ltd http://elgg.org/ This library contains an Elgg unit test framework which can be used and extended by plugins to provide functional unit tests to aid diagnostics of problems. Core Curverider Ltd <info@elgg.com> http://elgg.org/ Representation of a "user" in the system. Core Functions for adding and manipulating options on the user settings panel. Core Curverider Ltd http://elgg.org/ Contains code for handling versioning and upgrades. Core http://elgg.org/ Contains code for handling widgets. Core http://elgg.org/ Contains functions and classes to handle XML-RPC services, currently only server only. Core Curverider Ltd http://elgg.org/ Contains functions for generating and parsing XML. Core Curverider Ltd http://elgg.org/ The API REST endpoint. API Curverider Ltd <info@elgg.com> http://elgg.org/ This file acts as the endpoint for ODD UUID url requests, exporting the requested data as an OpenDD XML file. Core Curverider Ltd http://elgg.org/ This script triggers any upgrades necessary, ensuring that upgrades are triggered deliberately by a single user. Core Curverider Ltd http://elgg.org/ 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 http://elgg.org/ This file renders a plugin for the admin screen, including active/deactive, manifest details & display plugin settings. Core Curverider Ltd http://elgg.org/ Form to add a new user. Core Curverider Ltd http://elgg.org/ Curverider Ltd <info@elgg.com> http://elgg.com/ $vars['entity'] Updated 10 March 09 Core http://elgg.org/ $vars['wwwroot'] The site URL Displays an entity using the current view. Core Curverider Ltd http://elgg.org/ Displays a metadata item using the current view. Core Curverider Ltd http://elgg.org/ Displays a relationship using the current view. Core Curverider Ltd http://elgg.org/ Core Curverider Ltd http://elgg.org/ collections.php $vars['collection'] The individual friends collection Core Curverider Ltd http://elgg.org/ $vars['collections'] The array of friends collections Core Curverider Ltd http://elgg.org/ $vars['object'] Optionally, the collection edit Core Curverider Ltd http://elgg.org/ $vars['friends'] The array of ElggUser objects Core Curverider Ltd http://elgg.org/ $vars['entities'] The array of ElggUser objects Core Curverider Ltd http://elgg.org/ $vars['count'] The count $vars['friendspicker'] The friendspicker counter number Core Curverider Ltd http://elgg.org/ $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 Curverider Ltd http://elgg.org/ $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 Curverider Ltd http://elgg.org/ $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 label => options for the checkbox field Core Curverider Ltd http://elgg.org/ $vars['js'] Any Javascript to enter into the input tag $vars['internalname'] The name of the input 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 Curverider Ltd http://elgg.org/ $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 Curverider Ltd http://elgg.org/ $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 Curverider Ltd http://elgg.org/ $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 Curverider Ltd http://elgg.org/ $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 Curverider Ltd http://elgg.org/ Core Curverider Ltd http://elgg.org/ $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['value'] An array of tags $vars['class'] Class override Core Curverider Ltd http://elgg.org/ $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 Curverider Ltd http://elgg.org/ $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 Core Curverider Ltd http://elgg.org/ $vars['object'] An error message (string) Core Curverider Ltd http://elgg.org/ $vars['object'] An array of error messages Core Curverider Ltd http://elgg.org/ $vars['object'] An exception Core Curverider Ltd http://elgg.org/ $vars['object'] The array of message registers Core Curverider Ltd http://elgg.org/ $vars['object'] An array of system messages Core Curverider Ltd http://elgg.org/ $vars['object'] A system message (string) This is a placeholder. Core Curverider Ltd http://elgg.org/ Core Curverider Ltd http://elgg.org/ $vars['value'] The current value, if any Core Curverider Ltd http://elgg.org/ $vars['text'] The text to display Core Curverider Ltd http://elgg.org/ $vars['text'] The text of the link $vars['href'] The address $vars['confirm'] The dialog text Core Curverider Ltd http://elgg.org/ $vars['value'] A UNIX epoch timestamp Core Curverider Ltd http://elgg.org/ $vars['value'] The email address to display Core Curverider Ltd http://elgg.org/ $vars['value'] Source of the page Core Curverider Ltd http://elgg.org/ $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) Tags can be a single string (for one tag) or an array of strings Core Curverider Ltd http://elgg.org/ $vars['tags'] The tags to display $vars['tagtype'] The tagtype, optionally Core Curverider Ltd http://elgg.org/ $vars['value'] The URL to display Core Curverider Ltd http://elgg.org/ $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() Core Curverider Ltd http://elgg.org/ $vars['title'] The page title Curverider Ltd http://elgg.com/ Wraps all river items. Curverider http://elgg.com/ Display something in the river when a relationship is created. Curverider Ltd http://elgg.com/ Core Curverider Ltd http://elgg.org/ $vars['action'] If set, the place to forward the form to (usually action/systemsettings/save) Core Curverider Ltd http://elgg.org/ $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 Displays an entity as JSON Core Curverider Ltd http://elgg.org/ Displays a metadata item using json Core Curverider Ltd http://elgg.org/ Displays a relationship using JSON. Core Curverider Ltd http://elgg.org/ Displays an entity as ODD Core Curverider Ltd http://elgg.org/ Displays a relationship using ODD. Core Curverider Ltd http://elgg.org/ Displays an entity as PHP serialised data Core Curverider Ltd http://elgg.org/ Displays a metadata item using PHP serialised data Core Curverider Ltd http://elgg.org/ Displays a relationship using PHP serialised data Core Curverider Ltd http://elgg.org/

 All Classes Namespaces Files Functions Variables Enumerations
Generated on Thu May 23 00:01:34 2013 for Elgg by  doxygen 1.6.3