deprecation.php File Reference

Go to the source code of this file.

Functions
	elgg_trigger_deprecated_event ($event, $object_type, $object=null, $message=null, $version=null)
	Deprecation Bundles helper functions for deprecation. More...
	elgg_trigger_deprecated_plugin_hook ($hook, $type, $params=null, $returnvalue=null, $message=null, $version=null)
	Trigger an plugin hook normally, but send a notice about deprecated use if any handlers are registered. More...
	elgg_deprecated_notice (string $msg, string $dep_version)
	Log a notice about deprecated use of a function, view, etc. More...
	elgg_view_deprecated ($view, array $vars, $suggestion, $version)
	Display a view with a deprecation notice. More...

Function Documentation

elgg_deprecated_notice	(	string	$msg,
		string	$dep_version
	)

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

Parameters

string	$msg	Message to log
string	$dep_version	Human-readable release version: 1.7, 1.8, ...

Returns

true

Since

1.7.0

Definition at line 52 of file deprecation.php.

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

Deprecation Bundles helper functions for deprecation.

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

Parameters

string	$event	The event type
string	$object_type	The object type
string	$object	The object involved in the event
string	$message	The deprecation message
string	$version	Human-readable release version: 1.9, 1.10, ...

Returns

bool

See also

elgg_trigger_event()

Definition at line 20 of file deprecation.php.

elgg_trigger_deprecated_plugin_hook	(		$hook,
			$type,
			$params = null,
			$returnvalue = null,
			$message = null,
			$version = null
	)

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

Parameters

string	$hook	The name of the plugin hook
string	$type	The type of the plugin hook
mixed	$params	Supplied params for the hook
mixed	$returnvalue	The value of the hook, this can be altered by registered callbacks
string	$message	The deprecation message
string	$version	Human-readable release version: 1.9, 1.10, ...

Returns

mixed

See also

elgg_trigger_plugin_hook()

Since

3.0

Definition at line 39 of file deprecation.php.

elgg_view_deprecated	(		$view,
		array	$vars,
			$suggestion,
			$version
	)

Display a view with a deprecation notice.

No missing view NOTICE is logged

Parameters

string	$view	The name and location of the view to use
array	$vars	Variables to pass to the view
string	$suggestion	Suggestion with the deprecation message
string	$version	Human-readable release version: 1.7, 1.8, ...

Returns

string The parsed view

See also

elgg_view()

Definition at line 70 of file deprecation.php.