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

Go to the source code of this file.

Namespaces

 Elgg\Core
 Activate a plugin or plugins.
 

Functions

 elgg_get_entities_from_private_settings (array $options=array())
 Returns entities based upon private settings. More...
 
 get_private_setting ($entity_guid, $name)
 Gets a private setting for an entity. More...
 
 get_all_private_settings ($entity_guid)
 Return an array of all private settings. More...
 
 set_private_setting ($entity_guid, $name, $value)
 Sets a private setting for an entity. More...
 
 remove_private_setting ($entity_guid, $name)
 Deletes a private setting for an entity. More...
 
 remove_all_private_settings ($entity_guid)
 Deletes all private settings for an entity. More...
 

Function Documentation

elgg_get_entities_from_private_settings ( array  $options = array())

Returns entities based upon private settings.

Also accepts all options available to elgg_get_entities(). Supports the singular option shortcut.

See Also
elgg_get_entities
Parameters
array$optionsArray in format:
private_setting_names => null|ARR private setting names

private_setting_values => null|ARR metadata values

private_setting_name_value_pairs => null|ARR (
                                    name => 'name',
                                    value => 'value',
                                    'operand' => '=',
                                   )
                             Currently if multiple values are sent via
                          an array (value => array('value1', 'value2')
                          the pair's operand will be forced to "IN".

private_setting_name_value_pairs_operator => null|STR The operator to use for combining
                                   (name = value) OPERATOR (name = value); default AND

private_setting_name_prefix => STR A prefix to apply to all private settings. Used to namespace plugin user settings or by plugins to namespace their own settings.

Returns
mixed int If count, int. If not count, array. false on errors.
Since
1.8.0

Definition at line 44 of file private_settings.php.

get_all_private_settings (   $entity_guid)

Return an array of all private settings.

Parameters
int$entity_guidThe entity GUID
Returns
string[] empty array if no settings
See Also
set_private_setting()
get_private_settings()
remove_private_setting()
remove_all_private_settings()

Definition at line 81 of file private_settings.php.

get_private_setting (   $entity_guid,
  $name 
)

Gets a private setting for an entity.

Plugin authors can set private data on entities. By default private data will not be searched or exported.

Note
Internal: Private data is used to store settings for plugins and user settings.
Parameters
int$entity_guidThe entity GUID
string$nameThe name of the setting
Returns
mixed The setting value, or null if does not exist
See Also
set_private_setting()
get_all_private_settings()
remove_private_setting()
remove_all_private_settings()

Definition at line 66 of file private_settings.php.

remove_all_private_settings (   $entity_guid)

Deletes all private settings for an entity.

Parameters
int$entity_guidThe Entity GUID
Returns
bool
See Also
get_private_setting()
get_all_private_settings()
set_private_setting()
remove_private_settings()

Definition at line 129 of file private_settings.php.

remove_private_setting (   $entity_guid,
  $name 
)

Deletes a private setting for an entity.

Parameters
int$entity_guidThe Entity GUID
string$nameThe name of the setting
Returns
bool
See Also
get_private_setting()
get_all_private_settings()
set_private_setting()
remove_all_private_settings()

Definition at line 114 of file private_settings.php.

set_private_setting (   $entity_guid,
  $name,
  $value 
)

Sets a private setting for an entity.

Parameters
int$entity_guidThe entity GUID
string$nameThe name of the setting
string$valueThe value of the setting
Returns
bool
See Also
get_private_setting()
get_all_private_settings()
remove_private_setting()
remove_all_private_settings()

Definition at line 98 of file private_settings.php.