PHP Class Doctrine\ODM\MongoDB\Mapping\ClassMetadata

Once populated, ClassMetadata instances are usually cached in a serialized form. IMPORTANT NOTE: The fields of this class are only public for 2 reasons: 1) To allow fast READ access. 2) To drastically reduce the size of a serialized instance (private/protected members get the whole class name, namespace inclusive, prepended to every property in the serialized representation).

See link: www.doctrine-project.com

Since: 1.0

Author: Jonathan H. Wage ([email protected])

Author: Roman Borschel ([email protected])

Show file Open project: doctrine/mongodb-odm Class Usage Examples

Public Properties

Property	Type	Description
$reflFields	ReflectionProperty[]	The ReflectionProperty instances of the mapped class.

Public Methods

Method	Description
__construct ( string $documentName )	Initializes a new ClassMetadata instance that will hold the object-document mapping metadata of the class with the given name.
__sleep ( ) : array	Determines which fields get serialized.
__wakeup ( ) : void	Restores some state that can not be serialized/unserialized.
mapField ( array $mapping ) : void	Map a field.
newInstance ( ) : object	Creates a new instance of the mapped class, without invoking the constructor.

Method Details

__construct() public method

Initializes a new ClassMetadata instance that will hold the object-document mapping metadata of the class with the given name.

public __construct ( string $documentName )
$documentName	string	The name of the document class the new instance is used for.

__sleep() public method

It is only serialized what is necessary for best unserialization performance. That means any metadata properties that are not set or empty or simply have their default value are NOT serialized. Parts that are also NOT serialized because they can not be properly unserialized: - reflClass (ReflectionClass) - reflFields (ReflectionProperty array)

public __sleep ( ) : array
return	array	The names of all the fields that should be serialized.

__wakeup() public method

Restores some state that can not be serialized/unserialized.

public __wakeup ( ) : void
return	void

mapField() public method

Map a field.

public mapField ( array $mapping ) : void
$mapping	array	The mapping information.
return	void

newInstance() public method

Creates a new instance of the mapped class, without invoking the constructor.

public newInstance ( ) : object
return	object

Property Details

$reflFields public property

The ReflectionProperty instances of the mapped class.

public ReflectionProperty[] $reflFields
return	ReflectionProperty[]