Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Namespaces | Functions | Variables
elgglib.php File Reference

Go to the source code of this file.

Namespaces

 Elgg\Core
 Activate a plugin or plugins.
 

Functions

 elgg ()
 Get a reference to the global Application object. More...
 
 elgg_register_library ($name, $location)
 Register a PHP file as a library. More...
 
 elgg_load_library ($name)
 Load a PHP library. More...
 
 forward ($location="", $reason= 'system')
 Forward to $location. More...
 
 elgg_register_js ($name, $url, $location= 'head', $priority=null)
 Register a JavaScript file for inclusion. More...
 
 elgg_define_js ($name, $config)
 Defines a JS lib as an AMD module. More...
 
 elgg_unregister_js ($name)
 Unregister a JavaScript file. More...
 
 elgg_load_js ($name)
 Load a JavaScript resource on this page. More...
 
 elgg_require_js ($name)
 Request that Elgg load an AMD module onto the page. More...
 
 elgg_unrequire_js ($name)
 Cancel a request to load an AMD module onto the page. More...
 
 elgg_get_loaded_js ($location= 'head')
 Get the JavaScript URLs that are loaded. More...
 
 elgg_register_css ($name, $url, $priority=null)
 Register a CSS file for inclusion in the HTML head. More...
 
 elgg_unregister_css ($name)
 Unregister a CSS file. More...
 
 elgg_load_css ($name)
 Load a CSS file for this page. More...
 
 elgg_get_loaded_css ()
 Get the loaded CSS URLs. More...
 
 elgg_register_external_file ($type, $name, $url, $location, $priority=500)
 Core registration function for external files. More...
 
 elgg_unregister_external_file ($type, $name)
 Unregister an external file. More...
 
 elgg_load_external_file ($type, $name)
 Load an external resource for use on this page. More...
 
 elgg_get_loaded_external_files ($type, $location)
 Get external resource descriptors. More...
 
 elgg_get_file_list ($directory, $exceptions=array(), $list=array(), $extensions=null)
 Returns a list of files in $directory. More...
 
 sanitise_filepath ($path, $append_slash=true)
 Sanitise file paths ensuring that they begin and end with slashes etc. More...
 
 count_messages ($register="")
 Counts the number of messages, either globally or in a particular register. More...
 
 system_message ($message)
 Display a system message on next page load. More...
 
 register_error ($error)
 Display an error on next page load. More...
 
 elgg_get_system_messages ()
 Get a copy of the current system messages. More...
 
 elgg_set_system_messages (\Elgg\SystemMessages\RegisterSet $set)
 Set the system messages. More...
 
 elgg_register_event_handler ($event, $object_type, $callback, $priority=500)
 
 elgg_unregister_event_handler ($event, $object_type, $callback)
 Unregisters a callback for an event. More...
 
 elgg_trigger_event ($event, $object_type, $object=null)
 
 elgg_trigger_before_event ($event, $object_type, $object=null)
 Trigger a "Before event" indicating a process is about to begin. More...
 
 elgg_trigger_after_event ($event, $object_type, $object=null)
 Trigger an "After event" indicating a process has finished. More...
 
 elgg_trigger_deprecated_event ($event, $object_type, $object=null, $message, $version)
 Trigger an event normally, but send a notice about deprecated use if any handlers are registered. More...
 
 elgg_register_plugin_hook_handler ($hook, $type, $callback, $priority=500)
 
 elgg_unregister_plugin_hook_handler ($hook, $entity_type, $callback)
 Unregister a callback as a plugin hook. More...
 
 elgg_clear_plugin_hook_handlers ($hook, $type)
 Clears all callback registrations for a plugin hook. More...
 
 elgg_trigger_plugin_hook ($hook, $type, $params=null, $returnvalue=null)
 
 elgg_get_ordered_hook_handlers ($hook, $type)
 Returns an ordered array of hook handlers registered for $hook and $type. More...
 
 elgg_get_ordered_event_handlers ($event, $type)
 Returns an ordered array of event handlers registered for $event and $type. More...
 
 _elgg_php_exception_handler ($exception)
 Intercepts, logs, and displays uncaught exceptions. More...
 
 _elgg_php_error_handler ($errno, $errmsg, $filename, $linenum, $vars)
 Intercepts catchable PHP errors. More...
 
 elgg_log ($message, $level= 'NOTICE')
 Display or log a message. More...
 
 elgg_dump ($value, $to_screen=true)
 Logs or displays $value. More...
 
 elgg_get_version ($human_readable=false)
 Get the current Elgg version information. More...
 
 elgg_deprecated_notice ($msg, $dep_version, $backtrace_level=1)
 Log a notice about deprecated use of a function, view, etc. More...
 
 elgg_http_build_url (array $parts, $html_encode=true)
 Builds a URL from the a parts array like one returned by parse_url(). More...
 
 elgg_add_action_tokens_to_url ($url, $html_encode=false)
 Adds action tokens to URL. More...
 
 elgg_http_remove_url_query_element ($url, $element)
 Removes an element from a URL's query string. More...
 
 elgg_http_add_url_query_elements ($url, array $elements)
 Sets elements in a URL's query string. More...
 
 elgg_http_url_is_identical ($url1, $url2, $ignore_params=array('offset', 'limit'))
 Test if two URLs are functionally identical. More...
 
 elgg_extract ($key, $array, $default=null, $strict=true)
 Checks for $array[$key] and returns its value if it exists, else returns $default. More...
 
 elgg_sort_3d_array_by_value (&$array, $element, $sort_order=SORT_ASC, $sort_type=SORT_LOCALE_STRING)
 Sorts a 3d array by specific element. More...
 
 ini_get_bool ($ini_get_arg)
 Return the state of a php.ini setting as a bool. More...
 
 elgg_get_ini_setting_in_bytes ($setting)
 Returns a PHP INI setting in bytes. More...
 
 is_not_null ($string)
 Returns true is string is not empty, false, or null. More...
 
 _elgg_normalize_plural_options_array ($options, $singulars)
 Normalise the singular keys in an options array to plural keys. More...
 
 _elgg_shutdown_hook ()
 Emits a shutdown:system event upon PHP shutdown, but before database connections are dropped. More...
 
 _elgg_js_page_handler ($page)
 Serve javascript pages. More...
 
 _elgg_ajax_page_handler ($segments)
 Serve individual views for Ajax. More...
 
 _elgg_css_page_handler ($page)
 Serve CSS. More...
 
 _elgg_favicon_page_handler ($segments)
 Handle requests for /favicon.ico. More...
 
 _elgg_cacheable_view_page_handler ($page, $type)
 Serves a JS or CSS view with headers for caching. More...
 
 _elgg_sql_reverse_order_by_clause ($order_by)
 Reverses the ordering in an ORDER BY clause. More...
 
 elgg_batch_enable_callback ($object)
 Enable objects with an enable() method. More...
 
 elgg_batch_disable_callback ($object)
 Disable objects with a disable() method. More...
 
 elgg_batch_delete_callback ($object)
 Delete objects with a delete() method. More...
 
 _elgg_is_valid_options_for_batch_operation ($options, $type)
 Checks if there are some constraints on the options array for potentially dangerous operations. More...
 
 _elgg_walled_garden_index ()
 Intercepts the index page when Walled Garden mode is enabled. More...
 
 _elgg_walled_garden_ajax_handler ($page)
 Serve walled garden sections. More...
 
 _elgg_walled_garden_init ()
 Checks the status of the Walled Garden and forwards to a login page if required. More...
 
 _elgg_walled_garden_remove_public_access ($hook, $type, $accesses)
 Remove public access for walled gardens. More...
 
 _elgg_init ()
 Elgg's main init. More...
 
 _elgg_api_test ($hook, $type, $value, $params)
 Adds unit tests for the general API. More...
 

Variables

const ACCESS_DEFAULT -1
 
const ACCESS_PRIVATE 0
 
const ACCESS_LOGGED_IN 1
 
const ACCESS_PUBLIC 2
 
const ACCESS_FRIENDS -2
 
const ELGG_ENTITIES_ANY_VALUE null
 
const ELGG_ENTITIES_NO_VALUE 0
 
const REFERRER -1
 
const REFERER -1
 
return function (\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks)
 

Function Documentation

_elgg_ajax_page_handler (   $segments)

Serve individual views for Ajax.

/ajax/view/<view_name>?<key/value params> /ajax/form/<action_name>?<key/value params>

Parameters
string[]$segments URL segments (not including "ajax")
Returns
bool
See Also
elgg_register_ajax_view() ajax private

Definition at line 1529 of file elgglib.php.

_elgg_api_test (   $hook,
  $type,
  $value,
  $params 
)

Adds unit tests for the general API.

Parameters
string$hookunit_test
string$typesystem
array$valuearray of test files
array$paramsempty

unit_tests system

Returns
array private

Definition at line 1970 of file elgglib.php.

_elgg_cacheable_view_page_handler (   $page,
  $type 
)

Serves a JS or CSS view with headers for caching.

/<css||js>/name/of/view.<last_cache>.<css||js>

Parameters
array$pageThe page array
string$typeThe type: js or css
Returns
bool private

Definition at line 1660 of file elgglib.php.

_elgg_css_page_handler (   $page)

Serve CSS.

Serves CSS from the css views directory with headers for caching control

Parameters
array$pageThe page array
Returns
bool css private

Definition at line 1617 of file elgglib.php.

_elgg_favicon_page_handler (   $segments)

Handle requests for /favicon.ico.

Parameters
string[]$segments The URL segments
Returns
bool private
Since
1.10

Definition at line 1634 of file elgglib.php.

_elgg_init ( )

Elgg's main init.

Handles core actions for comments, the JS pagehandler, and the shutdown function.

init system

Returns
void private
See Also
::handlePageOutput

Definition at line 1923 of file elgglib.php.

_elgg_is_valid_options_for_batch_operation (   $options,
  $type 
)

Checks if there are some constraints on the options array for potentially dangerous operations.

Parameters
array$optionsOptions array
string$typeOptions type: metadata or annotation
Returns
bool private

Definition at line 1791 of file elgglib.php.

_elgg_js_page_handler (   $page)

Serve javascript pages.

Searches for views under js/ and outputs them with special headers for caching control.

Parameters
array$pageThe page array
Returns
bool js private

Definition at line 1512 of file elgglib.php.

_elgg_normalize_plural_options_array (   $options,
  $singulars 
)

Normalise the singular keys in an options array to plural keys.

Used in elgg_get_entities*() functions to support shortcutting plural names by singular names.

Parameters
array$optionsThe options array. $options['keys'] = 'values';
array$singularsA list of singular words to pluralize by adding 's'.
Returns
array
Since
1.7.0 private

Definition at line 1440 of file elgglib.php.

_elgg_php_error_handler (   $errno,
  $errmsg,
  $filename,
  $linenum,
  $vars 
)

Intercepts catchable PHP errors.

Warning
This function should never be called directly.

Definition at line 936 of file elgglib.php.

_elgg_php_exception_handler (   $exception)

Intercepts, logs, and displays uncaught exceptions.

To use a viewtype other than failsafe, create the views: <viewtype>/messages/exceptions/admin_exception <viewtype>/messages/exceptions/exception See the json viewtype for an example.

Warning
This function should never be called directly.
See Also
http://www.php.net/set-exception-handler
Parameters
Exception$exceptionThe exception being handled
Returns
void private

Definition at line 850 of file elgglib.php.

_elgg_shutdown_hook ( )

Emits a shutdown:system event upon PHP shutdown, but before database connections are dropped.

Register for the shutdown:system event to perform functions at the end of page loads.

Warning
Using this event to perform long-running functions is not very useful. Servers will hold pages until processing is done before sending them out to the browser.
See Also
http://www.php.net/register-shutdown-function

Definition at line 1480 of file elgglib.php.

_elgg_sql_reverse_order_by_clause (   $order_by)

Reverses the ordering in an ORDER BY clause.

This is achived by replacing asc with desc, or appending desc to the end of the clause.

This is used mostly for elgg_get_entities() and other similar functions.

Parameters
string$order_byAn order by clause private
Returns
string private

Definition at line 1723 of file elgglib.php.

_elgg_walled_garden_ajax_handler (   $page)

Serve walled garden sections.

Parameters
array$pageArray of URL segments
Returns
string private

Definition at line 1857 of file elgglib.php.

_elgg_walled_garden_index ( )

Intercepts the index page when Walled Garden mode is enabled.

Returns
bool private

Definition at line 1844 of file elgglib.php.

_elgg_walled_garden_init ( )

Checks the status of the Walled Garden and forwards to a login page if required.

If the site is in Walled Garden mode, all page except those registered as plugin pages by { public_pages walled_garden} will redirect to a login page.

Since
1.8.0 init system
Returns
void private

Definition at line 1884 of file elgglib.php.

_elgg_walled_garden_remove_public_access (   $hook,
  $type,
  $accesses 
)

Remove public access for walled gardens.

Parameters
string$hook
string$type
array$accesses
Returns
array private

Definition at line 1907 of file elgglib.php.

count_messages (   $register = "")

Counts the number of messages, either globally or in a particular register.

Parameters
string$registerOptionally, the register
Returns
integer The number of messages

Definition at line 425 of file elgglib.php.

elgg ( )

Get a reference to the global Application object.

Returns
Elgg
Since
2.0.0

Definition at line 19 of file elgglib.php.

elgg_add_action_tokens_to_url (   $url,
  $html_encode = false 
)

Adds action tokens to URL.

As of 1.7.0 action tokens are required on all actions. Use this function to append action tokens to a URL's GET parameters. This will preserve any existing GET parameters.

Note
If you are using { input/form} you don't need to add tokens to the action. The form view automatically handles tokens.
Parameters
string$urlFull action URL
bool$html_encodeHTML encode the url? (default: false)
Returns
string URL with action tokens
Since
1.7.0

Definition at line 1123 of file elgglib.php.

elgg_batch_delete_callback (   $object)

Delete objects with a delete() method.

Used as a callback for .

Parameters
object$objectThe object to disable
Returns
bool private

Definition at line 1777 of file elgglib.php.

elgg_batch_disable_callback (   $object)

Disable objects with a disable() method.

Used as a callback for .

Parameters
object$objectThe object to disable
Returns
bool private

Definition at line 1763 of file elgglib.php.

elgg_batch_enable_callback (   $object)

Enable objects with an enable() method.

Used as a callback for .

Parameters
object$objectThe object to enable
Returns
bool private

Definition at line 1749 of file elgglib.php.

elgg_clear_plugin_hook_handlers (   $hook,
  $type 
)

Clears all callback registrations for a plugin hook.

Parameters
string$hookThe name of the hook
string$typeThe type of the hook
Returns
void
Since
2.0

Definition at line 743 of file elgglib.php.

elgg_define_js (   $name,
  $config 
)

Defines a JS lib as an AMD module.

This is useful for shimming traditional JS or for setting the paths of AMD modules.

Calling multiple times for the same name will:

  • set the preferred path to the last call setting a path
  • overwrite the shimmed AMD modules with the last call setting a shimmed module

Use elgg_require_js($name) to load on the current page.

Calling this function is not needed if your JS are in views named like module/name.js Instead, simply call elgg_require_js("module/name").

Note
The configuration is cached in simplecache, so logic should not depend on user- specific values like get_language().
Parameters
string$nameThe module name
array$configAn array like the following: array 'deps' An array of AMD module dependencies string 'exports' The name of the exported module string 'src' The URL to the JS. Can be relative.
Returns
void

Definition at line 171 of file elgglib.php.

elgg_deprecated_notice (   $msg,
  $dep_version,
  $backtrace_level = 1 
)

Log a notice about deprecated use of a function, view, etc.

Parameters
string$msgMessage to log
string$dep_versionHuman-readable release version: 1.7, 1.8, ...
int$backtrace_levelHow many levels back to display the backtrace. Useful if calling from functions that are called from other places (like elgg_view()). Set to -1 for a full backtrace.
Returns
bool
Since
1.7.0

Definition at line 1070 of file elgglib.php.

elgg_dump (   $value,
  $to_screen = true 
)

Logs or displays $value.

If $to_screen is true, $value is displayed to screen. Else, it is handled by PHP's error_log() function.

A { debug log} is called. If a handler returns false, it will stop the default logging method.

Parameters
mixed$valueThe value
bool$to_screenDisplay to screen?
Returns
void
Since
1.7.0

Definition at line 1031 of file elgglib.php.

elgg_extract (   $key,
  $array,
  $default = null,
  $strict = true 
)

Checks for $array[$key] and returns its value if it exists, else returns $default.

Shorthand for $value = (isset($array['key'])) ? $array['key'] : 'default';

Parameters
string$keyThe key to check.
array$arrayThe array to check against.
mixed$defaultDefault value to return if nothing is found.
bool$strictReturn array key if it's set, even if empty. If false, return $default if the array key is unset or empty.
Returns
mixed
Since
1.8.0

Definition at line 1310 of file elgglib.php.

elgg_get_file_list (   $directory,
  $exceptions = array(),
  $list = array(),
  $extensions = null 
)

Returns a list of files in $directory.

Only returns files. Does not recurse into subdirs.

Parameters
string$directoryDirectory to look in
array$exceptionsArray of filenames to ignore
array$listArray of files to append to
mixed$extensionsArray of extensions to allow, null for all. Use a dot: array('.php').
Returns
array Filenames in $directory, in the form $directory/filename.

Definition at line 367 of file elgglib.php.

elgg_get_ini_setting_in_bytes (   $setting)

Returns a PHP INI setting in bytes.

Use this for arithmetic when determining if a file can be uploaded.

Parameters
string$settingThe php.ini setting
Returns
int
Since
1.7.0 http://www.php.net/manual/en/function.ini-get.php

Definition at line 1388 of file elgglib.php.

elgg_get_loaded_css ( )

Get the loaded CSS URLs.

Returns
array
Since
1.8.0

Definition at line 296 of file elgglib.php.

elgg_get_loaded_external_files (   $type,
  $location 
)

Get external resource descriptors.

Parameters
string$typeType of file: js or css
string$locationPage location
Returns
array
Since
1.8.0

Definition at line 351 of file elgglib.php.

elgg_get_loaded_js (   $location = 'head')

Get the JavaScript URLs that are loaded.

Parameters
string$location'head' or 'footer'
Returns
array
Since
1.8.0

Definition at line 245 of file elgglib.php.

elgg_get_ordered_event_handlers (   $event,
  $type 
)

Returns an ordered array of event handlers registered for $event and $type.

Parameters
string$eventEvent name
string$typeObject type
Returns
array
Since
2.0.0

Definition at line 829 of file elgglib.php.

elgg_get_ordered_hook_handlers (   $hook,
  $type 
)

Returns an ordered array of hook handlers registered for $hook and $type.

Parameters
string$hookHook name
string$typeHook type
Returns
array
Since
2.0.0

Definition at line 815 of file elgglib.php.

elgg_get_system_messages ( )

Get a copy of the current system messages.

Returns
Since
2.1

Definition at line 463 of file elgglib.php.

elgg_get_version (   $human_readable = false)

Get the current Elgg version information.

Parameters
bool$human_readableWhether to return a human readable version (default: false)
Returns
string|false Depending on success
Since
1.9

Definition at line 1043 of file elgglib.php.

elgg_http_add_url_query_elements (   $url,
array  $elements 
)

Sets elements in a URL's query string.

Parameters
string$urlThe URL
array$elementsKey/value pairs to set in the URL. If the value is null, the element is removed from the URL.
Returns
string The new URL with the query strings added
Since
1.7.0

Definition at line 1171 of file elgglib.php.

elgg_http_build_url ( array  $parts,
  $html_encode = true 
)

Builds a URL from the a parts array like one returned by parse_url().

Note
If only partial information is passed, a partial URL will be returned.
Parameters
array$partsAssociative array of URL components like parse_url() returns 'user' and 'pass' parts are ignored because of security reasons
bool$html_encodeHTML Encode the url?
See Also
https://github.com/Elgg/Elgg/pull/8146#issuecomment-91544585
Returns
string Full URL
Since
1.7.0

Definition at line 1088 of file elgglib.php.

elgg_http_remove_url_query_element (   $url,
  $element 
)

Removes an element from a URL's query string.

Note
You can send a partial URL string.
Parameters
string$urlFull URL
string$elementThe element to remove
Returns
string The new URL with the query element removed.
Since
1.7.0

Definition at line 1157 of file elgglib.php.

elgg_http_url_is_identical (   $url1,
  $url2,
  $ignore_params = array('offset', 'limit') 
)

Test if two URLs are functionally identical.

If $ignore_params is used, neither the name nor its value will be considered when comparing.

The order of GET params doesn't matter.

Parameters
string$url1First URL
string$url2Second URL
array$ignore_paramsGET params to ignore in the comparison
Returns
bool
Since
1.8.0

Definition at line 1215 of file elgglib.php.

elgg_load_css (   $name)

Load a CSS file for this page.

This must be called before elgg_view_page(). It can be called before the CSS file is registered. If you do not want a CSS file loaded, unregister it.

Parameters
string$nameIdentifier of the CSS file
Returns
void
Since
1.8.0

Definition at line 286 of file elgglib.php.

elgg_load_external_file (   $type,
  $name 
)

Load an external resource for use on this page.

Parameters
string$typeType of file: js or css
string$nameThe identifier for the file
Returns
void
Since
1.8.0

Definition at line 338 of file elgglib.php.

elgg_load_js (   $name)

Load a JavaScript resource on this page.

This must be called before elgg_view_page(). It can be called before the script is registered. If you do not want a script loaded, unregister it.

Parameters
string$nameIdentifier of the JavaScript resource
Returns
void
Since
1.8.0

Definition at line 208 of file elgglib.php.

elgg_load_library (   $name)

Load a PHP library.

See Also
elgg_register_library
Parameters
string$nameThe name of the library
Returns
void
Exceptions
InvalidParameterException
Since
1.8.0

Definition at line 56 of file elgglib.php.

elgg_log (   $message,
  $level = 'NOTICE' 
)

Display or log a message.

If $level is >= to the debug setting in ->debug, the message will be sent to elgg_dump(). Messages with lower priority than ->debug are ignored.

Outputs all levels but NOTICE to screen by default.

Note
No messages will be displayed unless debugging has been enabled.
Parameters
string$messageUser message
string$levelNOTICE | WARNING | ERROR
Returns
bool
Since
1.7.0

Definition at line 1000 of file elgglib.php.

elgg_register_css (   $name,
  $url,
  $priority = null 
)

Register a CSS file for inclusion in the HTML head.

Parameters
string$nameAn identifier for the CSS file
string$urlURL of the CSS file
int$priorityPriority of the CSS file (lower numbers load earlier)
Returns
bool
Since
1.8.0

Definition at line 259 of file elgglib.php.

elgg_register_event_handler (   $event,
  $object_type,
  $callback,
  $priority = 500 
)

Definition at line 538 of file elgglib.php.

elgg_register_external_file (   $type,
  $name,
  $url,
  $location,
  $priority = 500 
)

Core registration function for external files.

Parameters
string$typeType of external resource (js or css)
string$nameIdentifier used as key
string$urlURL
string$locationLocation in the page to include the file
int$priorityLoading priority of the file
Returns
bool
Since
1.8.0

Definition at line 312 of file elgglib.php.

elgg_register_js (   $name,
  $url,
  $location = 'head',
  $priority = null 
)

Register a JavaScript file for inclusion.

This function handles adding JavaScript to a web page. If multiple calls are made to register the same JavaScript file based on the $id variable, only the last file is included. This allows a plugin to add JavaScript from a view that may be called more than once. It also handles more than one plugin adding the same JavaScript.

jQuery plugins often have filenames such as jquery.rating.js. A best practice is to base $name on the filename: "jquery.rating". It is recommended to not use version numbers in the name.

The JavaScript files can be local to the server or remote (such as Google's CDN).

Note
Since 2.0, scripts with location "head" will also be output in the footer, but before those with location "footer".
Parameters
string$nameAn identifier for the JavaScript library
string$urlURL of the JavaScript file
string$locationPage location: head or footer. (default: head)
int$priorityPriority of the JS file (lower numbers load earlier)
Returns
bool
Since
1.8.0

Definition at line 143 of file elgglib.php.

elgg_register_library (   $name,
  $location 
)

Register a PHP file as a library.

See Also
elgg_load_library
Parameters
string$nameThe name of the library
string$locationThe location of the file
Returns
void
Since
1.8.0

Definition at line 34 of file elgglib.php.

elgg_register_plugin_hook_handler (   $hook,
  $type,
  $callback,
  $priority = 500 
)

Definition at line 715 of file elgglib.php.

elgg_require_js (   $name)

Request that Elgg load an AMD module onto the page.

Parameters
string$nameThe AMD module name.
Returns
void
Since
1.9.0

Definition at line 220 of file elgglib.php.

elgg_set_system_messages ( \Elgg\SystemMessages\RegisterSet  $set)

Set the system messages.

This will overwrite the state of all messages and errors!

Parameters
\Elgg\SystemMessages\RegisterSet$setSet of messages
Returns
void
Since
2.1

Definition at line 474 of file elgglib.php.

elgg_sort_3d_array_by_value ( $array,
  $element,
  $sort_order = SORT_ASC,
  $sort_type = SORT_LOCALE_STRING 
)

Sorts a 3d array by specific element.

Warning
Will re-index numeric indexes.
Note
This operates the same as the built-in sort functions. It sorts the array and returns a bool for success.

Do this: elgg_sort_3d_array_by_value($my_array); Not this: $my_array = elgg_sort_3d_array_by_value($my_array);

Parameters
array&$arrayArray to sort
string$elementElement to sort by
int$sort_orderPHP sort order http://us2.php.net/array_multisort
int$sort_typePHP sort type http://us2.php.net/sort
Returns
bool

Definition at line 1342 of file elgglib.php.

elgg_trigger_after_event (   $event,
  $object_type,
  $object = null 
)

Trigger an "After event" indicating a process has finished.

Unlike regular events, all the handlers will be called, their return values ignored.

To register for an after event, append ":after" to the event name when registering.

Parameters
string$eventThe event type. The fired event type will be appended with ":after".
string$object_typeThe object type
string$objectThe object involved in the event
Returns
true
See Also
elgg_trigger_before_event

Definition at line 629 of file elgglib.php.

elgg_trigger_before_event (   $event,
  $object_type,
  $object = null 
)

Trigger a "Before event" indicating a process is about to begin.

Like regular events, a handler returning false will cancel the process and false will be returned.

To register for a before event, append ":before" to the event name when registering.

Parameters
string$eventThe event type. The fired event type will be appended with ":before".
string$object_typeThe object type
string$objectThe object involved in the event
Returns
bool False if any handler returned false, otherwise true
See Also
elgg_trigger_event
elgg_trigger_after_event

Definition at line 610 of file elgglib.php.

elgg_trigger_deprecated_event (   $event,
  $object_type,
  $object = null,
  $message,
  $version 
)

Trigger an event normally, but send a notice about deprecated use if any handlers are registered.

Parameters
string$eventThe event type
string$object_typeThe object type
string$objectThe object involved in the event
string$messageThe deprecation message
string$versionHuman-readable release version: 1.9, 1.10, ...
Returns
bool
See Also
elgg_trigger_event

Definition at line 646 of file elgglib.php.

elgg_trigger_event (   $event,
  $object_type,
  $object = null 
)

Definition at line 589 of file elgglib.php.

elgg_trigger_plugin_hook (   $hook,
  $type,
  $params = null,
  $returnvalue = null 
)

Definition at line 801 of file elgglib.php.

elgg_unregister_css (   $name)

Unregister a CSS file.

Parameters
string$nameThe identifier for the CSS file
Returns
bool
Since
1.8.0

Definition at line 271 of file elgglib.php.

elgg_unregister_event_handler (   $event,
  $object_type,
  $callback 
)

Unregisters a callback for an event.

Parameters
string$eventThe event type
string$object_typeThe object type
string$callbackThe callback. Since 1.11, static method callbacks will match dynamic methods
Returns
bool true if a handler was found and removed
Since
1.7

Definition at line 552 of file elgglib.php.

elgg_unregister_external_file (   $type,
  $name 
)

Unregister an external file.

Parameters
string$typeType of file: js or css
string$nameThe identifier of the file
Returns
bool
Since
1.8.0

Definition at line 325 of file elgglib.php.

elgg_unregister_js (   $name)

Unregister a JavaScript file.

Parameters
string$nameThe identifier for the JavaScript library
Returns
bool
Since
1.8.0

Definition at line 193 of file elgglib.php.

elgg_unregister_plugin_hook_handler (   $hook,
  $entity_type,
  $callback 
)

Unregister a callback as a plugin hook.

Parameters
string$hookThe name of the hook
string$entity_typeThe name of the type of entity (eg "user", "object" etc)
callable$callbackThe PHP callback to be removed. Since 1.11, static method callbacks will match dynamic methods
Returns
void
Since
1.8.0

Definition at line 730 of file elgglib.php.

elgg_unrequire_js (   $name)

Cancel a request to load an AMD module onto the page.

Note
The elgg, jquery, and jquery-ui modules cannot be cancelled.
Parameters
string$nameThe AMD module name.
Returns
void
Since
2.1.0

Definition at line 233 of file elgglib.php.

forward (   $location = "",
  $reason = 'system' 
)

Forward to $location.

Sends a 'Location: $location' header and exists. If headers have already been sent, throws an exception.

Parameters
string$locationURL to forward to browser to. This can be a path relative to the network's URL.
string$reasonShort explanation for why we're forwarding. Set to '404' to forward to error page. Default message is 'system'.
Returns
void
Exceptions
SecurityException

Definition at line 93 of file elgglib.php.

ini_get_bool (   $ini_get_arg)

Return the state of a php.ini setting as a bool.

Warning
Using this on ini settings that are not boolean will be inaccurate!
Parameters
string$ini_get_argThe INI setting
Returns
bool Depending on whether it's on or off

Definition at line 1368 of file elgglib.php.

is_not_null (   $string)

Returns true is string is not empty, false, or null.

Function to be used in array_filter which returns true if $string is not null.

Parameters
string$stringThe string to test
Returns
bool

Definition at line 1419 of file elgglib.php.

register_error (   $error)

Display an error on next page load.

See Also
system_messages()
Parameters
string | array$errorError or errors to add
Returns
bool

Definition at line 452 of file elgglib.php.

sanitise_filepath (   $path,
  $append_slash = true 
)

Sanitise file paths ensuring that they begin and end with slashes etc.

Parameters
string$pathThe path
bool$append_slashAdd tailing slash
Returns
string

Definition at line 399 of file elgglib.php.

system_message (   $message)

Display a system message on next page load.

See Also
system_messages()
Parameters
string | array$messageMessage or messages to add
Returns
bool

Definition at line 438 of file elgglib.php.

Variable Documentation

const ACCESS_DEFAULT -1

Definition at line 1987 of file elgglib.php.

const ACCESS_FRIENDS -2

Definition at line 1991 of file elgglib.php.

const ACCESS_LOGGED_IN 1

Definition at line 1989 of file elgglib.php.

const ACCESS_PRIVATE 0

Definition at line 1988 of file elgglib.php.

const ACCESS_PUBLIC 2

Definition at line 1990 of file elgglib.php.

const ELGG_ENTITIES_ANY_VALUE null

Definition at line 2001 of file elgglib.php.

const ELGG_ENTITIES_NO_VALUE 0

Definition at line 2010 of file elgglib.php.

Definition at line 2031 of file elgglib.php.

const REFERER -1

Definition at line 2029 of file elgglib.php.

const REFERRER -1

Definition at line 2019 of file elgglib.php.