model/modx/transport/modtransportvehicle.class.php

Classes 
package
modx
subpackage
transport
Classes
modTransportVehicle

Description

\modTransportVehicle

package
modx
subpackage
transport
Properties
$attributes
$obj
$resolvers
$validators
Methods
__construct
compile
fetch
resolve
validate

Description

Abstracts the vehicle construct for package building.

Properties

$attributesThe collection of attributes to attach to the vehicle.

array $attributes = ''

Details

array
The collection of attributes to attach to the vehicle.
visibility
public
default
final
false
static
false
access
public

$objThe actual object or artifact payload that the vehicle represents.

mixed $obj = ''

Details

mixed
The actual object or artifact payload that the vehicle represents.
visibility
public
default
final
false
static
false
access
public

$resolversThe collection of dependencies to resolve post-install/upgrade.

array $resolvers = ''

Details

array
The collection of dependencies to resolve post-install/upgrade.
visibility
public
default
final
false
static
false
access
public

$validatorsThe collection of dependences to validate against pre-install/upgrade.

string $validators = ''

Details

string
The collection of dependences to validate against pre-install/upgrade.
visibility
public
default
final
false
static
false
access
public

Methods

__construct

__construct( mixed $obj, array $attr = array ) :

Creates an instance of the modTransportVehicle class.

Arguments
$obj
mixed
The object that the vehicle represents.
$attr
array
An array of attributes for the object.
Details
visibility
public
final
false
static
false

compile

compile( ) : array

Compiles the attributes array to pass on to the modPackageBuilder instance.

Output
array
An array of added attributes.
Details
visibility
public
final
false
static
false
access
public

fetch

fetch( ) : mixed

Returns the artifact payload associated with the vehicle.

Output
mixed
The payload for this vehicle.
Details
visibility
public
final
false
static
false
access
public

resolve

resolve( string $type, array $options ) : array

Adds a post-save resolver to the vehicle.

Arguments
$type
string
The type of resolver (php,file,etc)
$options
array
An array of options for the resolver.
Output
array
The added resolver.
Details
visibility
public
final
false
static
false
access
public

validate

validate( string $type, array $options ) : array

Adds a pre-creation validator to the vehicle.

Arguments
$type
string
The type of validator (php,file,etc)
$options
array
An array of options for the validator.
Output
array
The added validator.
Details
visibility
public
final
false
static
false
access
public
Documentation was generated by DocBlox 0.11.2.