BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
___PHPSTORM_HELPERS\object Class Reference

Public Member Functions

 __construct ()
 
 __destruct ()
 
 __call ($name, $arguments)
 
 __get ($name)
 
 __set ($name, $value)
 
 __isset ($name)
 
 __unset ($name)
 
 __sleep ()
 
 __wakeup ()
 
 __toString ()
 
 __invoke ()
 
 __debugInfo ()
 
 __clone ()
 

Static Public Member Functions

static __callStatic ($name, $arguments)
 
static __set_state ($an_array)
 

Constructor & Destructor Documentation

___PHPSTORM_HELPERS\object::__construct ( )

PHP 5 allows developers to declare constructor methods for classes. Classes which have a constructor method call this method on each newly-created object, so it is suitable for any initialization that the object may need before it is used.

Note: Parent constructors are not called implicitly if the child class defines a constructor. In order to run a parent constructor, a call to parent::__construct() within the child constructor is required.

param [ mixed $args [, $... ]]

Returns
void http://php.net/manual/en/language.oop5.decon.php
___PHPSTORM_HELPERS\object::__destruct ( )

PHP 5 introduces a destructor concept similar to that of other object-oriented languages, such as C++. The destructor method will be called as soon as all references to a particular object are removed or when the object is explicitly destroyed or in any order in shutdown sequence.

Like constructors, parent destructors will not be called implicitly by the engine. In order to run a parent destructor, one would have to explicitly call parent::__destruct() in the destructor body.

Note: Destructors called during the script shutdown have HTTP headers already sent. The working directory in the script shutdown phase can be different with some SAPIs (e.g. Apache).

Note: Attempting to throw an exception from a destructor (called in the time of script termination) causes a fatal error.

Returns
void http://php.net/manual/en/language.oop5.decon.php

Member Function Documentation

___PHPSTORM_HELPERS\object::__call (   $name,
  $arguments 
)

is triggered when invoking inaccessible methods in an object context.

Parameters
$namestring
$argumentsarray
Returns
mixed http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.methods
static ___PHPSTORM_HELPERS\object::__callStatic (   $name,
  $arguments 
)
static

is triggered when invoking inaccessible methods in a static context.

Parameters
$namestring
$argumentsarray
Returns
mixed http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.methods
___PHPSTORM_HELPERS\object::__clone ( )

When an object is cloned, PHP 5 will perform a shallow copy of all of the object's properties. Any properties that are references to other variables, will remain references. Once the cloning is complete, if a __clone() method is defined, then the newly created object's __clone() method will be called, to allow any necessary properties that need to be changed. NOT CALLABLE DIRECTLY.

Returns
mixed http://php.net/manual/en/language.oop5.cloning.php
___PHPSTORM_HELPERS\object::__debugInfo ( )

This method is called by var_dump() when dumping an object to get the properties that should be shown. If the method isn't defined on an object, then all public, protected and private properties will be shown.

Since
PHP 5.6.0
Returns
array http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.debuginfo
___PHPSTORM_HELPERS\object::__get (   $name)

is utilized for reading data from inaccessible members.

Parameters
$namestring
Returns
mixed http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members
___PHPSTORM_HELPERS\object::__invoke ( )

The __invoke method is called when a script tries to call an object as a function.

Returns
mixed http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.invoke
___PHPSTORM_HELPERS\object::__isset (   $name)

is triggered by calling isset() or empty() on inaccessible members.

Parameters
$namestring
Returns
bool http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members
___PHPSTORM_HELPERS\object::__set (   $name,
  $value 
)

run when writing data to inaccessible members.

Parameters
$namestring
$valuemixed
Returns
void http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members
static ___PHPSTORM_HELPERS\object::__set_state (   $an_array)
static

This static method is called for classes exported by var_export() since PHP 5.1.0. The only parameter of this method is an array containing exported properties in the form array('property' => value, ...).

Since
5.1.0
Parameters
$an_arrayarray
Returns
mixed http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.set-state
___PHPSTORM_HELPERS\object::__sleep ( )

serialize() checks if your class has a function with the magic name __sleep. If so, that function is executed prior to any serialization. It can clean up the object and is supposed to return an array with the names of all variables of that object that should be serialized. If the method doesn't return anything then NULL is serialized and E_NOTICE is issued. The intended use of __sleep is to commit pending data or perform similar cleanup tasks. Also, the function is useful if you have very large objects which do not need to be saved completely.

Returns
array|NULL http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.sleep
___PHPSTORM_HELPERS\object::__toString ( )

The __toString method allows a class to decide how it will react when it is converted to a string.

Returns
string http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.tostring
___PHPSTORM_HELPERS\object::__unset (   $name)

is invoked when unset() is used on inaccessible members.

Parameters
$namestring
Returns
void http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members
___PHPSTORM_HELPERS\object::__wakeup ( )

unserialize() checks for the presence of a function with the magic name __wakeup. If present, this function can reconstruct any resources that the object may have. The intended use of __wakeup is to reestablish any database connections that may have been lost during serialization and perform other reinitialization tasks.

Returns
void http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.sleep

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