Docs For Class xPDOFileVehicle

Description

Represents an individual file set within an xPDOTransport package.

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

xPDOVehicle
   |
   --xPDOFileVehicle

Variable Summary

mixed $class

Method Summary

void install ( &$transport, $options)

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

void uninstall ( &$transport, $options)

void _compilePayload ( &$transport)

boolean _installFiles (xPDOTransport &$transport, array $options)

boolean _uninstallFiles (xPDOTransport &$transport, array $options)

Variables

mixed $class = 'xPDOFileVehicle' (line 34)

access: public

Redefinition of:

xPDOVehicle::$class

Inherited Variables

Inherited from xPDOVehicle

xPDOVehicle::$payload

Methods

install (line 39)

Install a file set represented by and stored in this vehicle.

access: public

void install ( &$transport, $options)

&$transport
$options

Redefinition of:

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

put (line 183)

Adds the file definition object to the payload.

access: public

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

&$transport
&$object
$attributes

Redefinition of:

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

uninstall (line 47)

Uninstall a file set represented by and stored in this vehicle.

access: public

void uninstall ( &$transport, $options)

&$transport
$options

Redefinition of:

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

_compilePayload (line 197)

Copies the files 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.

_installFiles (line 60)

Install files or folders represented by and stored in this vehicle.

return: True if the files are installed successfully.
access: protected

boolean _installFiles (xPDOTransport &$transport, array $options)

xPDOTransport &$transport: A reference the transport this vehicle is stored in.
array $options: Optional attributes that can be applied to vehicle install process.

_uninstallFiles (line 125)

Uninstall files or folders represented by and stored in this vehicle.

return: True if the files are uninstalled successfully.
access: protected

boolean _uninstallFiles (xPDOTransport &$transport, array $options)

xPDOTransport &$transport: A reference the transport this vehicle is stored in.
array $options: Optional attributes that can be applied to vehicle uninstall process.

Inherited Methods

Inherited From xPDOVehicle

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