Docs For Class xPDOTransportVehicle

Description

Represents an xPDOTransport embedded within an xPDOTransport package.

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

xPDOVehicle
   |
   --xPDOTransportVehicle

Variable Summary

mixed $class

Method Summary

void install ( &$transport, $options)

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

void uninstall ( &$transport, $options)

void _compilePayload ( &$transport)

void _installTransport ( &$transport, array $options, xPDOTransport $transport)

Variables

mixed $class = 'xPDOTransportVehicle' (line 34)

access: public

Redefinition of:

xPDOVehicle::$class

Inherited Variables

Inherited from xPDOVehicle

xPDOVehicle::$payload

Methods

install (line 78)

Install the xPDOTransport represented by this 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 149)

Put an xPDOTransport representation into a transport package.

access: public

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

&$transport
&$object
$attributes

Redefinition of:

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

uninstall (line 119)

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.

_compilePayload (line 39)

Copies the transport into the vehicle and transforms the payload for storage.

access: protected

void _compilePayload ( &$transport)

&$transport

Redefinition of:

xPDOVehicle::_compilePayload(): Compile necessary resources in preparation for storing the vehicle.

_installTransport (line 89)

Install the xPDOTransport from the vehicle payload.

access: protected

void _installTransport ( &$transport, array $options, xPDOTransport $transport)

xPDOTransport $transport: The host xPDOTransport instance.
array $options: Any optional attributes to apply to the installation.
&$transport

Inherited Methods

Inherited From xPDOVehicle

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