Elgg Namespace Reference

Save menu items. More...

Namespaces

namespace  Core
 

Activate a plugin or plugins.



Detailed Description

Save menu items.

Elgg XML output for XML-RPC.

Elgg XML output pageshell.

Elgg XML output This outputs the api as XML.

RSS user view.

RSS object view.

RSS group view.

Elgg RSS view for a generic_comment annotation.

PHP user view.

PHP site view.

PHP output pageshell.

PHP object view.

PHP group view.

Elgg PHP output This outputs the api results as serialized PHP.

Elgg XML output pageshell for ODD.

Elgg default object view.

JSON user view.

JSON site view.

Elgg JSON output pageshell.

JSON object view.

Elgg exception Displays a single exception.

JSON group view.

Elgg JSON output This outputs the api results as JSON.

Elgg install pageshell.

Elgg ICAL output pageshell.

Elgg ICAL output of default object.

Elgg default user view.

FOAF pageshell.

Elgg failsafe pageshell Special viewtype for rendering exceptions.

Elgg exception (failsafe mode) Displays a single exception.

ElggSite default view.

Elgg 2 sidebar layout.

Layout for main column with one sidebar.

Elgg one-column layout.

Elgg default layout.

Elgg Admin Area Canvas.

Elgg owner block Displays page ownership information.

Elgg global system message list Lists all system messages.

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

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

View a list of items.

Elgg pageshell for the admin area.

Elgg URL display Displays a URL as a link.

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.

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

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.

ElggObject default view.

Elgg list view switcher.

Empty view for backward compatibility.

Elgg pagination.

Displays breadcrumbs.

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.

Create a submit input button.

CSRF security token view for use with secure forms.

Create a reset input button.

Elgg radio input Displays a radio 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 that can use WYSIWYG editor.

Create a hidden data field.

Create a form for data submission.

Elgg file input Displays a file input field.

Elgg email input Displays an email input field.

Elgg dropdown input Displays a dropdown (select) input field.

Elgg checkbox input Displays a checkbox input field.

Elgg checkbox input Displays a checkbox input tag.

This view provides a hook for third parties to provide a CAPTCHA.

Create a input button.

Displays an autocomplete text input.

Generic icon view.

ElggGroup default view.

Elgg AJAX loader.

Elgg add user form.

Elgg forgotten password.

Elgg register form.

Elgg login form.

Form body for editing or adding a friend collection.

Elgg comments add form.

Elgg relationship export.

Elgg metadata export.

Elgg Entity export.

Statistics about this user.

Account settings form wrapper.

Provide a way of setting your password.

User settings for notifications.

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 friends picker count updater Updates the friends count on a collection.

Elgg friends picker Lists the friends picker.

Elgg friends collections Lists a user's friends collections.

View a friends collection.

Elgg login box.

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

Elgg statistics screen.

Elgg administration site basic settings.

Elgg administration site advanced settings.

Elgg administration menu items.

Elgg version number.

Elgg user tools settings.

Elgg user statistics.

Elgg user account settings.

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

Elgg install script.

Elgg index page for web-based applications.

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

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

Elgg cron library.

Elgg annotations Functions to manage object annotations.

ODD Relationship class.

Cron exception.

Configuration exception.

Elgg add action.

Action to reset a password and send success email.

River item delete action.

Elgg notifications user preference save acion.

Elgg logout action.

Elgg OpenDD import action.

Default entity delete action.

Elgg delete comment action.

Core

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

Core

A generic parent class for Configuration exceptions

Exceptions.Stub

A generic parent class for cron exceptions

Exceptions.Stub

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

Core

$vars['module'] The module name. Default: aside

Core

$vars['collection'] The individual friends collection

Core

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

Core

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

Core

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

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

ElggEntity $vars['entity'] The entity to comment on bool $vars['inline'] Show a single line version of the form?

Core

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

Core

$vars['id'] CSS id $vars['class'] Optional additional CSS class $vars['hidden'] Begin hidden? (true)

Core

$vars['entity'] The entity the icon represents - uses getIconURL() method $vars['size'] topbar, tiny, small, medium (default), large, master $vars['href'] Optional override for link $vars['img_class'] Optional CSS class added to img $vars['link_class'] Optional CSS class for the link

Core

$vars['value'] Current value for the text input $vars['match_on'] Array | str What to match on. all|array(groups|users|friends) $vars['match_owner'] Bool. Match only entities that are owned by logged in user. $vars['class'] Additional CSS class

Core

$vars['src'] Src of an image $vars['class'] Additional CSS class

Core

Pass input tag attributes as key value pairs. For a list of allowable attributes, see http://www.w3schools.com/tags/tag_input.asp

$vars['default'] The default value to submit if not checked. Optional, defaults to 0. Set to false for no default. $vars['class'] Additional CSS class

Note:
This also includes a hidden input with the same name as the checkboxes to make sure something is sent to the server. The default value is 0. If using JS, be specific to avoid selecting the hidden default value: $('input[type=checkbox][name=name]')
Warning:
Passing integers as labels does not currently work due to a deprecated hack that will be removed in Elgg 1.9. To use integer labels, the labels must be character codes: 1 would be 1

Core

string $vars['name'] 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['default'] The default value to send if nothing is checked. Optional, defaults to 0. Set to FALSE for no default. bool $vars['disabled'] Make all input elements disabled. Optional. string $vars['value'] The current value. Single value or array. Optional. string $vars['class'] Additional class of the list. Optional. string $vars['align'] 'horizontal' or 'vertical' Default: 'vertical'

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

Core

$vars['value'] The current value, if any $vars['options'] An array of strings representing the options for the dropdown field $vars['options_values'] An associative array of "value" => "option" where "value" is the name and "option" is the value displayed on the button. Replaces $vars['options'] when defined. $vars['class'] Additional CSS class

Core

$vars['class'] Additional CSS class

Core

$vars['value'] The current value if any $vars['class'] Additional CSS class

Use this view for forms as it provides protection against CSRF attacks.

Core

$vars['body'] The body of the form (made up of other input/xxx views and html $vars['action'] The action URL of the form $vars['method'] The submit method: post (default) or get $vars['enctype'] Set to 'multipart/form-data' if uploading a file $vars['disable_security'] turn off CSRF security by setting to true $vars['class'] Additional class for the form

Warning:
Below is the ugliest code in Elgg. It needs to be rewritten or removed

Core

$vars['entities'] The array of ElggUser objects $vars['name'] $vars['value'] $vars['highlight'] $vars['callback']

Core

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

Core

$vars['value'] The current value, if any - will be html encoded $vars['disabled'] Is the input field disabled? $vars['class'] Additional CSS class

Core

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

Core

$vars['value'] The current value, if any $vars['name'] The name of the input field $vars['class'] Additional CSS class $vars['disabled']

Warning:
Passing integers as labels does not currently work due to a deprecated hack that will be removed in Elgg 1.9. To use integer labels, the labels must be character codes: 1 would be 1

Core

$vars['value'] The current value, if any $vars['name'] The name of the input field $vars['options'] An array of strings representing the options for the radio field as "label" => option $vars['class'] Additional class of the list. Optional. $vars['align'] 'horizontal' or 'vertical' Default: 'vertical'

Core

$vars['class'] CSS class that replaces elgg-button-cancel

It is still recommended that you use input/form.

Core

Core

$vars['class'] CSS class that replaces elgg-button-submit

Sends an array of user guids.

Core

$vars['value'] Array of user guids for already selected users or null

The name of the hidden fields is members[]

Warning:
Only a single input/userpicker is supported per web page.

Defaults to lazy load user lists in alphabetical order. User needs to type two characters before seeing the user popup list.

As users are selected they move down to a "users" box. When this happens, a hidden input is created with the name of members[] and a value of the GUID.

Core

$vars['breadcrumbs'] (Optional) Array of arrays with keys 'title' and 'link' $vars['class']

See also:
elgg_push_breadcrumb

Core

int $vars['offset'] The offset in the list int $vars['limit'] Number of items per page int $vars['count'] Number of items in list string $vars['base_url'] Base URL to use in links string $vars['offset_key'] The string to use for offet in the URL

Core

Core

Warning:
This view may be used for other ElggEntity objects

Core

Core

$vars['text'] The text to display

Core

$vars['text'] The text of the link $vars['href'] The address $vars['title'] The title text (defaults to confirm text) $vars['confirm'] The dialog text $vars['encode_text'] Run $vars['text'] through htmlspecialchars() (false)

Core

$vars['value'] Date as text or a Unix timestamp in seconds

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. $vars['class']

Core

$vars['text'] The text to display

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

Core

$vars['value'] The text to display

Core

string $vars['text'] The string between the tags. string $vars['href'] The unencoded url string bool $vars['encode_text'] Run $vars['text'] through htmlspecialchars() (false) bool $vars['is_action'] Is this a link to an action (false) bool $vars['is_trusted'] Is this link trusted (false)

Core

$vars['title'] The page title $vars['body'] The main content of the page $vars['sysmessages'] A 2d array of various message registers, passed from system_messages()

$vars['items'] Array of ElggEntity or ElggAnnotation objects $vars['offset'] Index of the first list item in complete list $vars['limit'] Number of items per page. Only used as input to pagination. $vars['count'] Number of items in the complete list $vars['base_url'] Base URL of list (optional) $vars['pagination'] Show pagination? (default: true) $vars['position'] Position of the pagination: before, after, or both $vars['full_view'] Show the full view of the items (default: false) $vars['list_class'] Additional CSS class for the

$vars['item_class'] Additional CSS class for the elements

Core

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

Core

$vars['content'] Content string $vars['sidebar'] Optional sidebar content $vars['title'] Title string

Core

$vars['content'] Content string

Core

$vars['content'] Content string $vars['class'] Additional class to apply to layout

Core

$vars['content'] Content HTML for the main column $vars['sidebar'] Optional content that is displayed in the sidebar $vars['title'] Optional title for main content area $vars['class'] Additional class to apply to layout $vars['nav'] HTML of the page nav (override) (default: breadcrumbs)

Core

$vars['content'] The content string for the main column $vars['sidebar'] Optional content that is displayed in the sidebar $vars['sidebar_alt'] Optional content that is displayed in the alternate sidebar $vars['class'] Additional class to apply to layout

Core

$vars['object'] An exception

Includes minimal code so as not to create a "Exception thrown without a stack frame in Unknown on line 0" error

Core

$vars['title'] The page title $vars['body'] The main content of the page

Core

//

Core

$vars['title'] The page title $vars['body'] The main content of the page $vars['sysmessages'] Array of system status messages

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 Mon May 20 00:01:25 2013 for Elgg by  doxygen 1.6.3