PHP 클래스 Teleport\Action\Extract

상속: extends Teleport\Action\Action
파일 보기 프로젝트 열기: modxcms/teleport

공개 프로퍼티들

프로퍼티 타입 설명
$package The transport package Extracted from the \modX instance.

보호된 프로퍼티들

프로퍼티 타입 설명
$required Defines the arguments required for the Push action.

공개 메소드들

메소드 설명
process ( ) Process the Extract action.

보호된 메소드들

메소드 설명
createPackage ( string $name, string $version, string $release = '' ) : Teleport\Transport\Transport Create a Transport package to store extracted data into.
createVehicles ( object $vehicle ) : integer Create \xPDOVehicle instances from MODX assets and data to go into the Snapshot.
getName ( ) : string Get a package name for this snapshot.
getSequence ( ) : string Get a package sequence for this snapshot.
getVersion ( ) : string Get a package version for this snapshot.
loadTpl ( string $tpl ) : array Load the JSON extract tpl data into a PHP array.
prepareTpl ( string &$content ) Parse the tpl replacing placeholders from the profile and request arguments.

메소드 상세

createPackage() 보호된 메소드

Create a Transport package to store extracted data into.
protected createPackage ( string $name, string $version, string $release = '' ) : Teleport\Transport\Transport
$name string The name of the package to create.
$version string The version of the package to create.
$release string The release of the package to create.
리턴 Teleport\Transport\Transport A new Transport instance with a signature compiled from name, version, and release.

createVehicles() 보호된 메소드

Create \xPDOVehicle instances from MODX assets and data to go into the Snapshot.
protected createVehicles ( object $vehicle ) : integer
$vehicle object A vehicle definition from the Extract tpl being applied.
리턴 integer The number of vehicles created from the definition.

getName() 보호된 메소드

Get a package name for this snapshot.
protected getName ( ) : string
리턴 string The package name.

getSequence() 보호된 메소드

Get a package sequence for this snapshot.
protected getSequence ( ) : string
리턴 string The package sequence string.

getVersion() 보호된 메소드

Get a package version for this snapshot.
protected getVersion ( ) : string
리턴 string The package version string.

loadTpl() 보호된 메소드

Load the JSON extract tpl data into a PHP array.
protected loadTpl ( string $tpl ) : array
$tpl string A valid stream or file location for the tpl.
리턴 array An array of the tpl data.

prepareTpl() 보호된 메소드

Parse the tpl replacing placeholders from the profile and request arguments.
protected prepareTpl ( string &$content )
$content string The content of the tpl.

process() 공개 메소드

Process the Extract action.
public process ( )

프로퍼티 상세

$package 공개적으로 프로퍼티

The transport package Extracted from the \modX instance.
public $package

$required 보호되어 있는 프로퍼티

Defines the arguments required for the Push action.
protected $required