PHP Interface AppserverIo\Appserver\Core\Interfaces\ExtractorInterface

See link: https://github.com/appserver-io/appserver

Author: Johann Zelger ([email protected])

Show file Open project: appserver-io/appserver

Public Methods

Method	Description
deployArchive ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, SplFileInfo $archive ) : void	Extracts the passed archive to a folder with the basename of the archive file.
deployWebapps ( ) : void	Gathers all available archived webapps and extract them for usage.
flagArchive ( SplFileInfo $archive, string $flag ) : void	Flags the archive in specific states of extraction
getExtensionSuffix ( ) : string	Returns the archive extension suffix e.g. .phar
getExtractorNode ( ) : AppserverIo\Appserver\Core\Api\Node\ExtractorNodeInterface	Returns the extractor node configuration data.
isDeployable ( SplFileInfo $archive ) : boolean	Checks if archive is deployable.
isUndeployable ( SplFileInfo $archive ) : boolean	Check if archive is undeployable.
soakArchive ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, SplFileInfo $archive ) : void	Soaks the passed archive from a location in the filesystem into the deploy directory and prepares it for the next restart by setting the appropriate flag.
undeployArchive ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, SplFileInfo $archive ) : void	Un-deploys the passed archive after backing up files that are NOT part of the archive.
unflagArchive ( SplFileInfo $archive ) : void	Deletes all old flags, so the app will be un-deployed with the next appserver restart.

Method Details

deployArchive() public method

Extracts the passed archive to a folder with the basename of the archive file.

public deployArchive ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, SplFileInfo $archive ) : void
$containerNode	AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface	The container the archive belongs to
$archive	SplFileInfo	The archive file to be deployed
return	void

deployWebapps() public method

Gathers all available archived webapps and extract them for usage.

public deployWebapps ( ) : void
return	void

flagArchive() public method

Flags the archive in specific states of extraction

public flagArchive ( SplFileInfo $archive, string $flag ) : void
$archive	SplFileInfo	The archive file
$flag	string	The flag to set
return	void

getExtensionSuffix() public method

Returns the archive extension suffix e.g. .phar

public getExtensionSuffix ( ) : string
return	string	the archive extension suffix

getExtractorNode() public method

Returns the extractor node configuration data.

public getExtractorNode ( ) : AppserverIo\Appserver\Core\Api\Node\ExtractorNodeInterface
return	AppserverIo\Appserver\Core\Api\Node\ExtractorNodeInterface	The extractor node configuration data

isDeployable() public method

Checks if archive is deployable.

public isDeployable ( SplFileInfo $archive ) : boolean
$archive	SplFileInfo	The archive object
return	boolean

isUndeployable() public method

Check if archive is undeployable.

public isUndeployable ( SplFileInfo $archive ) : boolean
$archive	SplFileInfo	The archive object
return	boolean

soakArchive() public method

Soaks the passed archive from a location in the filesystem into the deploy directory and prepares it for the next restart by setting the appropriate flag.

public soakArchive ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, SplFileInfo $archive ) : void
$containerNode	AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface	The container the archive belongs to
$archive	SplFileInfo	The archive to be soaked
return	void

undeployArchive() public method

Un-deploys the passed archive after backing up files that are NOT part of the archive.

public undeployArchive ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, SplFileInfo $archive ) : void
$containerNode	AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface	The container the archive belongs to
$archive	SplFileInfo	The archive file to be un-deployed
return	void

unflagArchive() public method

Deletes all old flags, so the app will be un-deployed with the next appserver restart.

public unflagArchive ( SplFileInfo $archive ) : void
$archive	SplFileInfo	The archive to un-flag
return	void