Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Elgg\DeprecationWrapper Class Reference
Inheritance diagram for Elgg\DeprecationWrapper:

Public Member Functions

 __construct ($object, $message, $version, $reporter= 'elgg_deprecated_notice')
 Create the wrapper. More...
 
 __get ($name)
 Get a property on the object. More...
 
 __set ($name, $value)
 Set a property on the object. More...
 
 __call ($name, $arguments)
 Call a method on the object. More...
 
 __toString ()
 Get the object as string. More...
 
 offsetSet ($key, $value)
 Array access interface. More...
 
 offsetGet ($key)
 Array access interface. More...
 
 offsetUnset ($key)
 Array access interface. More...
 
 offsetExists ($offset)
 Array access interface. More...
 

Protected Member Functions

 displayWarning ()
 Display a warning. More...
 

Protected Attributes

 $object
 
 $string
 
 $message
 
 $version
 
 $reporter
 

Detailed Description

Definition at line 25 of file DeprecationWrapper.php.

Constructor & Destructor Documentation

Elgg\DeprecationWrapper::__construct (   $object,
  $message,
  $version,
  $reporter = 'elgg_deprecated_notice' 
)

Create the wrapper.

Parameters
mixed$objectThe object or string to wrap
string$messageThe deprecation message to display when used
string$versionThe Elgg version this was deprecated
callable$reporterfunction called to report deprecation

Definition at line 49 of file DeprecationWrapper.php.

Member Function Documentation

Elgg\DeprecationWrapper::__call (   $name,
  $arguments 
)

Call a method on the object.

Parameters
string$nameMethod name
array$argumentsMethod arguments
Returns
mixed

Definition at line 90 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::__get (   $name)

Get a property on the object.

Parameters
string$nameProperty name
Returns
mixed

Definition at line 66 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::__set (   $name,
  $value 
)

Set a property on the object.

Parameters
string$nameProperty name
mixed$valueProperty value
Returns
void

Definition at line 78 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::__toString ( )

Get the object as string.

Returns
string

Definition at line 100 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::displayWarning ( )
protected

Display a warning.

Returns
void

Definition at line 114 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::offsetExists (   $offset)

Array access interface.

See Also
::offsetExists()
Parameters
mixed$offsetOffset
Returns
bool

Definition at line 191 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::offsetGet (   $key)

Array access interface.

See Also
::offsetGet()
Parameters
mixed$keyName
Returns
mixed

Definition at line 155 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::offsetSet (   $key,
  $value 
)

Array access interface.

See Also
::offsetSet()
Parameters
mixed$keyName
mixed$valueValue
Returns
void

Definition at line 132 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::offsetUnset (   $key)

Array access interface.

See Also
::offsetUnset()
Parameters
mixed$keyName
Returns
void

Definition at line 173 of file DeprecationWrapper.php.

Member Data Documentation

Elgg\DeprecationWrapper::$message
protected

Definition at line 33 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::$object
protected

Definition at line 27 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::$reporter
protected

Definition at line 39 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::$string
protected

Definition at line 30 of file DeprecationWrapper.php.

Elgg\DeprecationWrapper::$version
protected

Definition at line 36 of file DeprecationWrapper.php.


The documentation for this class was generated from the following file: