Docs For Class xPDOObjectVehicle

Description

Represents an xPDOObject within an xPDOTransport package.

Located in /xpdo/transport/xpdoobjectvehicle.class.php (line 33)

xPDOVehicle
   |
   --xPDOObjectVehicle

Variable Summary

mixed $class

Method Summary

void get ( &$transport, [ $options = array ()], [ $element = null])

void install ( &$transport, $options)

void put ( &$transport, &$object, [ $attributes = array ()])

void uninstall ( &$transport, $options)

void _installObject ( &$transport, array $options, array $element, xPDOObject &$parentObject, array $fkMeta, xPDOTransport $transport)

void _installRelated ( &$transport, &$parent, $element, $options)

void _putRelated ( &$transport, string $alias, xPDOObject &$object, &$payloadElement, xPDOTransport $transport, array $payloadElement)

void _uninstallObject ( &$transport, $options, $element, &$parentObject, $fkMeta)

void _uninstallRelated ( &$transport, &$parent, $element, $options)

Variables

mixed $class = 'xPDOObjectVehicle' (line 34)

access: public

Redefinition of:

xPDOVehicle::$class

Inherited Variables

Inherited from xPDOVehicle

xPDOVehicle::$payload

Methods

get (line 42)

Retrieve an xPDOObject instance represented in this vehicle.

This method returns the main object contained in the payload, but you can optionally specify a related_objects node within the payload to retrieve a specific dependent object.

access: public

void get ( &$transport, [ $options = array ()], [ $element = null])

&$transport
$options
$element

Redefinition of:

xPDOVehicle::get(): Retrieve an artifact represented in this vehicle.

install (line 85)

Install the xPDOObjects represented by vehicle into the transport host.

access: public

void install ( &$transport, $options)

&$transport
$options

Redefinition of:

xPDOVehicle::install(): Install the vehicle artifact into a transport host.

put (line 343)

Put an xPDOObject representation into a transport package.

This implementation supports the inclusion of related objects. Simply instantiate the related objects that you want to include in the vehicle on the main object, and set xPDOTransport::RELATED_OBJECTS => true in your attributes.

access: public

void put ( &$transport, &$object, [ $attributes = array ()])

&$transport
&$object
$attributes

Redefinition of:

xPDOVehicle::put(): Put an artifact representation into this vehicle.

uninstall (line 227)

Uninstalls vehicle artifacts from the transport host.

access: public

void uninstall ( &$transport, $options)

&$transport
$options

Redefinition of:

xPDOVehicle::uninstall(): Uninstalls the vehicle artifact from a transport host.

_installObject (line 103)

Install a single xPDOObject from the vehicle payload.

access: protected

void _installObject ( &$transport, array $options, array $element, xPDOObject &$parentObject, array $fkMeta, xPDOTransport $transport)

xPDOTransport $transport: The host xPDOTransport instance.
array $options: Any optional attributes to apply to the installation.
array $element: A node of the payload representing the object to install.
xPDOObject &$parentObject: A reference to the object serving as a parent to the one being installed.
array $fkMeta: The foreign key relationship data that defines the relationship with the parentObject.
&$transport

_installRelated (line 207)

Installs a related object from the vehicle.

access: public

void _installRelated ( &$transport, &$parent, $element, $options)

&$transport
&$parent
$element
$options

_putRelated (line 400)

Recursively put related objects into the vehicle.

access: protected

void _putRelated ( &$transport, string $alias, xPDOObject &$object, &$payloadElement, xPDOTransport $transport, array $payloadElement)

xPDOTransport $transport: The host xPDOTransport instance.
string $alias: The alias representing the relation to the parent object.
xPDOObject &$object: A reference to the dependent object being added into the vehicle.
array $payloadElement: An element of the payload to place the dependent object in.
&$transport
&$payloadElement

_uninstallObject (line 236)

Uninstall the xPDOObjects represented by a vehicle element from the transport host.

access: public

void _uninstallObject ( &$transport, $options, $element, &$parentObject, $fkMeta)

&$transport
$options
$element
&$parentObject
$fkMeta

_uninstallRelated (line 317)

Uninstalls related objects from the vehicle.

access: public

void _uninstallRelated ( &$transport, &$parent, $element, $options)

&$transport
&$parent
$element
$options

Inherited Methods

Inherited From xPDOVehicle

xPDOVehicle::get()
xPDOVehicle::install()
xPDOVehicle::put()
xPDOVehicle::register()
xPDOVehicle::resolve()
xPDOVehicle::store()
xPDOVehicle::uninstall()
xPDOVehicle::validate()
xPDOVehicle::_compilePayload()