deprecated-1.7.php File Reference

Go to the source code of this file.

Functions
	get_entities_from_access_id ($collection_id, $entity_type="", $entity_subtype="", $owner_guid=0, $limit=10, $offset=0, $order_by="", $site_guid=0, $count=false)
	Get entities with the specified access collection id. More...
	get_entities_from_access_collection ($collection_id, $entity_type="", $entity_subtype="", $owner_guid=0, $limit=10, $offset=0, $order_by="", $site_guid=0, $count=false)
	get_entities_from_annotations ($entity_type="", $entity_subtype="", $name="", $value="", $owner_guid=0, $group_guid=0, $limit=10, $offset=0, $order_by="asc", $count=false, $timelower=0, $timeupper=0)
	Get entities from annotations. More...
	list_entities_from_annotations ($entity_type="", $entity_subtype="", $name="", $value="", $limit=10, $owner_guid=0, $group_guid=0, $asc=false, $fullview=true, $listtypetoggle=false)
	Lists entities. More...
	get_library_files ($directory, $exceptions=array(), $list=array())
	Returns all php files in a directory. More...
	elgg_validate_action_url ($url)
	Add action tokens to URL. More...
	test_ip ()
	Does nothing. More...
	is_ip_in_array ()
	Does nothing. More...
	get_entities ($type="", $subtype="", $owner_guid=0, $order_by="", $limit=10, $offset=0, $count=false, $site_guid=0, $container_guid=null, $timelower=0, $timeupper=0)
	Returns entities. More...
	delete_entities ($type="", $subtype="", $owner_guid=0)
	Delete multiple entities that match a given query. More...
	list_registered_entities ($owner_guid=0, $limit=10, $fullview=true, $listtypetoggle=false, $allowedtypes=true)
	Lists entities. More...
	list_entities ($type="", $subtype="", $owner_guid=0, $limit=10, $fullview=true, $listtypetoggle=false, $pagination=true)
	Lists entities. More...
	search_for_group ($criteria, $limit=10, $offset=0, $order_by="", $count=false)
	Searches for a group based on a complete or partial name or description. More...
	search_list_groups_by_name ($hook, $user, $returnvalue, $tag)
	Returns a formatted list of groups suitable for injecting into search. More...
	list_group_search ($tag, $limit=10)
	Displays a list of group objects that have been searched for. More...
	get_entities_from_metadata ($meta_name, $meta_value="", $entity_type="", $entity_subtype="", $owner_guid=0, $limit=10, $offset=0, $order_by="", $site_guid=0, $count=FALSE, $case_sensitive=TRUE)
	Return a list of entities based on the given search criteria. More...
	get_entities_from_metadata_multi ($meta_array, $entity_type="", $entity_subtype="", $owner_guid=0, $limit=10, $offset=0, $order_by="", $site_guid=0, $count=false, $meta_array_operator='and')
	Return entities from metadata. More...
	menu_item ($menu_name, $menu_url)
	Returns a menu item for use in the children section of add_menu() This is not currently used in the Elgg core. More...
	search_for_object ($criteria, $limit=10, $offset=0, $order_by="", $count=false)
	Searches for an object based on a complete or partial title or description using full text searching. More...
	search_list_objects_by_name ($hook, $user, $returnvalue, $tag)
	Returns a formatted list of objects suitable for injecting into search. More...
	get_entities_from_relationship ($relationship, $relationship_guid, $inverse_relationship=false, $type="", $subtype="", $owner_guid=0, $order_by="", $limit=10, $offset=0, $count=false, $site_guid=0)
	Return entities from relationships. More...
	search_for_site ($criteria, $limit=10, $offset=0, $order_by="", $count=false)
	Searches for a site based on a complete or partial name or description or url using full text searching. More...
	search_for_user ($criteria, $limit=10, $offset=0, $order_by="", $count=false)
	Searches for a user based on a complete or partial name or username. More...
	list_user_search ($tag, $limit=10)
	Displays a list of user objects that have been searched for. More...
	search_list_users_by_name ($hook, $user, $returnvalue, $tag)
	Returns a formatted list of users suitable for injecting into search. More...
	extend_view ($view, $view_name, $priority=501, $viewtype='')
	Extend a view. More...
	get_views ($dir, $base)
	Get views in a dir. More...
	make_register_object ($register_name, $register_value, $children_array=array())
	Constructs and returns a register object. More...
	delete_object_entity ($guid)
	THIS FUNCTION IS DEPRECATED. More...
	delete_user_entity ($guid)
	THIS FUNCTION IS DEPRECATED. More...

Function Documentation

delete_entities()

delete_entities	(		$type = "",
			$subtype = "",
			$owner_guid = 0
	)

Delete multiple entities that match a given query.

This function iterates through and calls delete_entity on each one, this is somewhat inefficient but lets the 'delete' event be called for each entity.

Parameters

string	$type	The type of entity (eg "user", "object" etc)
string	$subtype	The arbitrary subtype of the entity
int	$owner_guid	The GUID of the owning user

Returns

false

Definition at line 396 of file deprecated-1.7.php.

delete_object_entity()

delete_object_entity

(

$guid

)

THIS FUNCTION IS DEPRECATED.

Delete a object's extra data.

Parameters

int

$guid

GUID

Returns

1

Definition at line 1141 of file deprecated-1.7.php.

delete_user_entity()

delete_user_entity

(

$guid

)

THIS FUNCTION IS DEPRECATED.

Delete a user's extra data.

Parameters

int

$guid

User GUID

Returns

1

Definition at line 1159 of file deprecated-1.7.php.

elgg_validate_action_url()

elgg_validate_action_url

(

$url

)

Add action tokens to URL.

Parameters

string

$url

URL

Returns

string

Definition at line 258 of file deprecated-1.7.php.

extend_view()

extend_view	(		$view,
			$view_name,
			$priority = 501,
			$viewtype = ''
	)

Extend a view.

Parameters

string	$view	The view to extend.
string	$view_name	This view is added to $view
int	$priority	The priority, from 0 to 1000, to add at (lowest numbers displayed first)
string	$viewtype	Not used

Returns

void

Definition at line 1085 of file deprecated-1.7.php.

get_entities()

get_entities	(		$type = "",
			$subtype = "",
			$owner_guid = 0,
			$order_by = "",
			$limit = 10,
			$offset = 0,
			$count = false,
			$site_guid = 0,
			$container_guid = null,
			$timelower = 0,
			$timeupper = 0
	)

Returns entities.

Parameters

string	$type	Entity type
string	$subtype	Entity subtype
int	$owner_guid	Owner GUID
string	$order_by	Order by clause
int	$limit	Limit
int	$offset	Offset
bool	$count	Return a count or an array of entities
int	$site_guid	Site GUID
int	$container_guid	Container GUID
int	$timelower	Lower time limit
int	$timeupper	Upper time limit

Returns

array

Definition at line 308 of file deprecated-1.7.php.

get_entities_from_access_collection()

get_entities_from_access_collection	(		$collection_id,
			$entity_type = "",
			$entity_subtype = "",
			$owner_guid = 0,
			$limit = 10,
			$offset = 0,
			$order_by = "",
			$site_guid = 0,
			$count = false
	)

Definition at line 70 of file deprecated-1.7.php.

get_entities_from_access_id()

get_entities_from_access_id	(		$collection_id,
			$entity_type = "",
			$entity_subtype = "",
			$owner_guid = 0,
			$limit = 10,
			$offset = 0,
			$order_by = "",
			$site_guid = 0,
			$count = false
	)

Get entities with the specified access collection id.

Parameters

int	$collection_id	ID of collection
string	$entity_type	Type of entities
string	$entity_subtype	Subtype of entities
int	$owner_guid	Guid of owner
int	$limit	Limit of number of entities to return
int	$offset	Skip this many entities
string	$order_by	Column to order by
int	$site_guid	The site guid
bool	$count	Return a count or entities

Returns

array

Definition at line 19 of file deprecated-1.7.php.

get_entities_from_annotations()

get_entities_from_annotations	(		$entity_type = "",
			$entity_subtype = "",
			$name = "",
			$value = "",
			$owner_guid = 0,
			$group_guid = 0,
			$limit = 10,
			$offset = 0,
			$order_by = "asc",
			$count = false,
			$timelower = 0,
			$timeupper = 0
	)

Get entities from annotations.

No longer used.

Parameters

mixed	$entity_type	Type of entity
mixed	$entity_subtype	Subtype of entity
string	$name	Name of annotation
string	$value	Value of annotation
int	$owner_guid	Guid of owner of annotation
int	$group_guid	Guid of group
int	$limit	Limit
int	$offset	Offset
string	$order_by	SQL order by string
bool	$count	Count or return entities
int	$timelower	Lower time limit
int	$timeupper	Upper time limit

Returns

ElggEntity[]|int

Definition at line 101 of file deprecated-1.7.php.

get_entities_from_metadata()

get_entities_from_metadata	(		$meta_name,
			$meta_value = "",
			$entity_type = "",
			$entity_subtype = "",
			$owner_guid = 0,
			$limit = 10,
			$offset = 0,
			$order_by = "",
			$site_guid = 0,
			$count = FALSE,
			$case_sensitive = TRUE
	)

Return a list of entities based on the given search criteria.

Parameters

mixed	$meta_name	Metadat name
mixed	$meta_value	Metadata value
string	$entity_type	The type of entity to look for, eg 'site' or 'object'
string	$entity_subtype	The subtype of the entity.
int	$owner_guid	Owner GUID
int	$limit	Limit
int	$offset	Offset
string	$order_by	Optional ordering.
int	$site_guid	Site GUID. 0 for current, -1 for any.
bool	$count	Return a count instead of entities
bool	$case_sensitive	Metadata names case sensitivity

Returns

int|array A list of entities, or a count if $count is set to true

Definition at line 616 of file deprecated-1.7.php.

get_entities_from_metadata_multi()

get_entities_from_metadata_multi	(		$meta_array,
			$entity_type = "",
			$entity_subtype = "",
			$owner_guid = 0,
			$limit = 10,
			$offset = 0,
			$order_by = "",
			$site_guid = 0,
			$count = false,
			$meta_array_operator = 'and'
	)

Return entities from metadata.

Parameters

mixed	$meta_array	Metadata name
string	$entity_type	The type of entity to look for, eg 'site' or 'object'
string	$entity_subtype	The subtype of the entity.
int	$owner_guid	Owner GUID
int	$limit	Limit
int	$offset	Offset
string	$order_by	Optional ordering.
int	$site_guid	Site GUID. 0 for current, -1 for any.
bool	$count	Return a count instead of entities
bool	$meta_array_operator	Operator for metadata values

Returns

int|array A list of entities, or a count if $count is set to true

Definition at line 690 of file deprecated-1.7.php.

get_entities_from_relationship()

get_entities_from_relationship	(		$relationship,
			$relationship_guid,
			$inverse_relationship = false,
			$type = "",
			$subtype = "",
			$owner_guid = 0,
			$order_by = "",
			$limit = 10,
			$offset = 0,
			$count = false,
			$site_guid = 0
	)

Return entities from relationships.

Parameters

string	$relationship	The relationship type
int	$relationship_guid	The GUID of the relationship owner
bool	$inverse_relationship	Invert relationship?
string	$type	Entity type
string	$subtype	Entity subtype
int	$owner_guid	Entity owner GUID
string	$order_by	Order by clause
int	$limit	Limit
int	$offset	Offset
bool	$count	Return a count instead of entities?
int	$site_guid	Site GUID

Returns

mixed

Definition at line 868 of file deprecated-1.7.php.

get_library_files()

get_library_files	(		$directory,
			$exceptions = array(),
			$list = array()
	)

Returns all php files in a directory.

Parameters

string	$directory	Directory to look in
array	$exceptions	Array of extensions (with .!) to ignore
array	$list	A list files to include in the return

Returns

array

Definition at line 244 of file deprecated-1.7.php.

get_views()

get_views	(		$dir,
			$base
	)

Get views in a dir.

Parameters

string	$dir	Dir
string	$base	Base view

Returns

array

Definition at line 1100 of file deprecated-1.7.php.

is_ip_in_array()

is_ip_in_array

(

)

Does nothing.

Returns

bool

Definition at line 283 of file deprecated-1.7.php.

list_entities()

list_entities	(		$type = "",
			$subtype = "",
			$owner_guid = 0,
			$limit = 10,
			$fullview = true,
			$listtypetoggle = false,
			$pagination = true
	)

Lists entities.

Parameters

string	$type	Entity type
string	$subtype	Entity subtype
int	$owner_guid	Owner GUID
int	$limit	Limit
bool	$fullview	Display entity full views?
bool	$listtypetoggle	Allow switching to gallery mode?
bool	$pagination	Show pagination?

Returns

string

Definition at line 457 of file deprecated-1.7.php.

list_entities_from_annotations()

list_entities_from_annotations	(		$entity_type = "",
			$entity_subtype = "",
			$name = "",
			$value = "",
			$limit = 10,
			$owner_guid = 0,
			$group_guid = 0,
			$asc = false,
			$fullview = true,
			$listtypetoggle = false
	)

Lists entities.

See also

elgg_view_entity_list

Parameters

string	$entity_type	Type of entity.
string	$entity_subtype	Subtype of entity.
string	$name	Name of annotation.
string	$value	Value of annotation.
int	$limit	Maximum number of results to return.
int	$owner_guid	Owner.
int	$group_guid	Group container. Currently only supported if entity_type is object
boolean	$asc	Whether to list in ascending or descending order (default: desc)
boolean	$fullview	Whether to display the entities in full
boolean	$listtypetoggle	Can 'gallery' view can be displayed (default: no)

Returns

string Formatted entity list

Definition at line 181 of file deprecated-1.7.php.

list_group_search()

list_group_search	(		$tag,
			$limit = 10
	)

Displays a list of group objects that have been searched for.

See also

elgg_view_entity_list

Parameters

string	$tag	Search criteria
int	$limit	The number of entities to display on a page

Returns

string The list in a form suitable to display

Definition at line 586 of file deprecated-1.7.php.

list_registered_entities()

list_registered_entities	(		$owner_guid = 0,
			$limit = 10,
			$fullview = true,
			$listtypetoggle = false,
			$allowedtypes = true
	)

Lists entities.

Parameters

int	$owner_guid	Owner GUID
int	$limit	Limit
bool	$fullview	Show entity full views
bool	$listtypetoggle	Show list type toggle
bool	$allowedtypes	A string of the allowed types

Returns

string

Definition at line 413 of file deprecated-1.7.php.

list_user_search()

list_user_search	(		$tag,
			$limit = 10
	)

Displays a list of user objects that have been searched for.

See also

elgg_view_entity_list

Parameters

string	$tag	Search criteria
int	$limit	The number of entities to display on a page

Returns

string The list in a form suitable to display

Definition at line 1026 of file deprecated-1.7.php.

make_register_object()

make_register_object	(		$register_name,
			$register_value,
			$children_array = array()
	)

Constructs and returns a register object.

Parameters

string	$register_name	The name of the register
mixed	$register_value	The value of the register
array	$children_array	Optionally, an array of children

Returns

false|\stdClass Depending on success

Definition at line 1115 of file deprecated-1.7.php.

menu_item()

menu_item	(		$menu_name,
			$menu_url
	)

Returns a menu item for use in the children section of add_menu() This is not currently used in the Elgg core.

Parameters

string	$menu_name	The name of the menu item
string	$menu_url	Its URL

Returns

\stdClass|false Depending on success

Definition at line 755 of file deprecated-1.7.php.

search_for_group()

search_for_group	(		$criteria,
			$limit = 10,
			$offset = 0,
			$order_by = "",
			$count = false
	)

Searches for a group based on a complete or partial name or description.

Parameters

string	$criteria	The partial or full name or description
int	$limit	Limit of the search.
int	$offset	Offset.
string	$order_by	The order.
boolean	$count	Whether to return the count of results or just the results.

Returns

mixed

Definition at line 504 of file deprecated-1.7.php.

search_for_object()

search_for_object	(		$criteria,
			$limit = 10,
			$offset = 0,
			$order_by = "",
			$count = false
	)

Searches for an object based on a complete or partial title or description using full text searching.

IMPORTANT NOTE: With MySQL's default setup: 1) $criteria must be 4 or more characters long 2) If $criteria matches greater than 50% of results NO RESULTS ARE RETURNED!

Parameters

string	$criteria	The partial or full name or username.
int	$limit	Limit of the search.
int	$offset	Offset.
string	$order_by	The order.
boolean	$count	Whether to return the count of results or just the results.

Returns

int|false

Definition at line 777 of file deprecated-1.7.php.

search_for_site()

search_for_site	(		$criteria,
			$limit = 10,
			$offset = 0,
			$order_by = "",
			$count = false
	)

Searches for a site based on a complete or partial name or description or url using full text searching.

IMPORTANT NOTE: With MySQL's default setup: 1) $criteria must be 4 or more characters long 2) If $criteria matches greater than 50% of results NO RESULTS ARE RETURNED!

Parameters

string	$criteria	The partial or full name or username.
int	$limit	Limit of the search.
int	$offset	Offset.
string	$order_by	The order.
boolean	$count	Whether to return the count of results or just the results.

Returns

mixed

Definition at line 930 of file deprecated-1.7.php.

search_for_user()

search_for_user	(		$criteria,
			$limit = 10,
			$offset = 0,
			$order_by = "",
			$count = false
	)

Searches for a user based on a complete or partial name or username.

Parameters

string	$criteria	The partial or full name or username.
int	$limit	Limit of the search.
int	$offset	Offset.
string	$order_by	The order.
boolean	$count	Whether to return the count of results or just the results.

Returns

mixed

Definition at line 977 of file deprecated-1.7.php.

search_list_groups_by_name()

search_list_groups_by_name	(		$hook,
			$user,
			$returnvalue,
			$tag
	)

Returns a formatted list of groups suitable for injecting into search.

Parameters

string	$hook	Hook name
string	$user	User
mixed	$returnvalue	Previous hook's return value
string	$tag	Tag to search on

Returns

string

Definition at line 553 of file deprecated-1.7.php.

search_list_objects_by_name()

search_list_objects_by_name	(		$hook,
			$user,
			$returnvalue,
			$tag
	)

Returns a formatted list of objects suitable for injecting into search.

Parameters

sting	$hook	Hook
string	$user	user
mixed	$returnvalue	Previous return value
mixed	$tag	Search term

Returns

array

Definition at line 824 of file deprecated-1.7.php.

search_list_users_by_name()

search_list_users_by_name	(		$hook,
			$user,
			$returnvalue,
			$tag
	)

Returns a formatted list of users suitable for injecting into search.

Parameters

string	$hook	Hook name
string	$user	User?
mixed	$returnvalue	Previous hook's return value
mixed	$tag	Tag to search against

Returns

void

Definition at line 1048 of file deprecated-1.7.php.

test_ip()

test_ip

(

)

Does nothing.

Returns

0

Definition at line 271 of file deprecated-1.7.php.