xPDOVehicle
Represents an individual artifact within an xPDOTransport package.
Extend this abstract class to provide custom xPDOVehicle behavior for various kinds of artifacts (e.g. objects, xPDOObjects, files, database schemas, etc.).
Located in /xpdo/transport/xpdovehicle.class.php (line 38)
| Class | Description |
|---|---|
xPDOFileVehicle
|
Represents an individual file set within an xPDOTransport package. |
|
xPDOObjectVehicle
|
Represents an xPDOObject within an xPDOTransport package. |
|
xPDOTransportVehicle
|
Represents an xPDOTransport embedded within an xPDOTransport package. |
void
get
( &$transport, [array $options = array ()], [array $element = null], xPDOTransport $transport)
get (line 89)
Retrieve an artifact represented in this vehicle.
By default, this method simply returns the raw payload merged with the provided options, but you can optionally provide a payload element specifically on which to operate as well as override the method in derivatives to further transform the returned artifact.
- xPDOTransport $transport: The transport package containing this vehicle.
- array $options: Options that apply to the artifact or retrieval process.
- array $element: An optional payload element representing a specific part of the artifact to operate on. If not specified, the root element of the payload is used.
- &$transport
- xPDOObjectVehicle::get() : Retrieve an xPDOObject instance represented in this vehicle.
install (line 106)
Install the vehicle artifact into a transport host.
- xPDOTransport &$transport: A reference to the transport.
- array $options: An array of options for altering the installation of the artifact.
- xPDOFileVehicle::install() : Install a file set represented by and stored in this vehicle.
- xPDOObjectVehicle::install() : Install the xPDOObjects represented by vehicle into the transport host.
- xPDOTransportVehicle::install() : Install the xPDOTransport represented by this vehicle into the transport host.
put (line 292)
Put an artifact representation into this vehicle.
- xPDOTransport $transport: The transport package hosting the vehicle.
- mixed &$object: A reference to the artifact this vehicle will represent.
- array $attributes: Additional attributes represented in the vehicle.
- &$transport
- xPDOFileVehicle::put() : Adds the file definition object to the payload.
- xPDOObjectVehicle::put() : Put an xPDOObject representation into a transport package.
- xPDOTransportVehicle::put() : Put an xPDOTransport representation into a transport package.
register (line 55)
Build a manifest entry to be registered in a transport for this vehicle.
- xPDOTransport &$transport: The xPDOTransport instance to register the vehicle into.
resolve (line 130)
Resolve any dependencies of the artifact represented in this vehicle.
- xPDOTransport &$transport: A reference to the xPDOTransport in which this vehicle is stored.
- mixed &$object: An object reference to resolve dependencies for. Use this to make the artifact or other important data available to the resolver scripts.
- array $options: Additional options for the resolution process.
store (line 356)
Store this xPDOVehicle instance into an xPDOTransport.
- xPDOTransport &$transport: The transport to store the vehicle in.
uninstall (line 117)
Uninstalls the vehicle artifact from a transport host.
- xPDOTransport &$transport: A reference to the transport.
- array $options: An array of options for altering the uninstallation of the artifact.
- xPDOFileVehicle::uninstall() : Uninstall a file set represented by and stored in this vehicle.
- xPDOObjectVehicle::uninstall() : Uninstalls vehicle artifacts from the transport host.
- xPDOTransportVehicle::uninstall() : Uninstalls vehicle artifacts from the transport host.
validate (line 252)
Validate any dependencies for the object represented in this vehicle.
- xPDOTransport &$transport: A reference to the xPDOTransport in which this vehicle is stored.
- xPDOObject &$object: An object reference to access during validation.
- array $options: Additional options for the validation process.
_compilePayload (line 380)
Compile necessary resources in preparation for storing the vehicle.
- xPDOTransport &$transport: A reference to the transport the vehicle is being stored in.
- xPDOFileVehicle::_compilePayload() : Copies the files into the vehicle and transforms the payload for storage.
- xPDOTransportVehicle::_compilePayload() : Copies the transport into the vehicle and transforms the payload for storage.
Documentation generated on Fri, 17 Jun 2011 10:04:15 -0600 by phpDocumentor 1.4.3