PHP Класс AppserverIo\Appserver\Core\Api\AppService

См. ссылку: https://github.com/appserver-io/appserver
См. ссылку: http://www.appserver.io
Автор: Tim Wagner ([email protected])
Наследование: extends AppserverIo\Appserver\Core\Api\AbstractFileOperationService
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$extractor AppserverIo\Appserver\Core\Interfaces\ExtractorInterface The extractor instance to handle archive operations with

Открытые методы

Метод Описание
cleanUpFolders ( AppserverIo\Psr\Application\ApplicationInterface $application ) : void Clean up the the directories for the webapp, e. g. to delete cached stuff that has to be recreated after a restart.
createTmpFolders ( AppserverIo\Psr\Application\ApplicationInterface $application ) : void Creates the temporary directory for the webapp.
deploy ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, AppserverIo\Configuration\Interfaces\NodeInterface $appNode ) : void Adds the .dodeploy flag file in the deploy folder, therefore the app will be deployed with the next restart.
findAll ( ) : array Returns all deployed applications.
findAllByName ( string $name ) : array Returns the applications with the passed name.
getExtractor ( ) : AppserverIo\Appserver\Core\Interfaces\ExtractorInterface | null Getter for this service's extractor
injectExtractor ( AppserverIo\Appserver\Core\Interfaces\ExtractorInterface $extractor ) : null Will inject a certain extractor to be used
load ( string $uuid ) : AppNode | null Returns the application with the passed UUID.
loadByWebappPath ( string $webappPath ) : AppNode | null Returns the application with the passed webapp path.
newFromApplication ( AppserverIo\Psr\Application\ApplicationInterface $application ) : void Creates a new app node for the passed application and attaches it to the system configuration.
persist ( AppserverIo\Configuration\Interfaces\NodeInterface $appNode ) : void Persists the system configuration.
soak ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, SplFileInfo $archive ) : void Soaks the passed archive into from a location in the filesystem to the deploy directory.
undeploy ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $uuid ) : void Removes the .deployed flag file from the deploy folder, therefore the app will be undeployed with the next restart.

Описание методов

cleanUpFolders() публичный метод

Clean up the the directories for the webapp, e. g. to delete cached stuff that has to be recreated after a restart.
public cleanUpFolders ( AppserverIo\Psr\Application\ApplicationInterface $application ) : void
$application AppserverIo\Psr\Application\ApplicationInterface The application to clean up the directories for
Результат void

createTmpFolders() публичный метод

Creates the temporary directory for the webapp.
public createTmpFolders ( AppserverIo\Psr\Application\ApplicationInterface $application ) : void
$application AppserverIo\Psr\Application\ApplicationInterface The application to create the temporary directories for
Результат void

deploy() публичный метод

Adds the .dodeploy flag file in the deploy folder, therefore the app will be deployed with the next restart.
public deploy ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, AppserverIo\Configuration\Interfaces\NodeInterface $appNode ) : void
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container the app is bound to
$appNode AppserverIo\Configuration\Interfaces\NodeInterface The application node object
Результат void

findAll() публичный метод

Returns all deployed applications.
См. также: ServiceInterface::findAll()
public findAll ( ) : array
Результат array All deployed applications

findAllByName() публичный метод

Returns the applications with the passed name.
public findAllByName ( string $name ) : array
$name string Name of the application to return
Результат array The applications with the name passed as parameter

getExtractor() публичный метод

Getter for this service's extractor
public getExtractor ( ) : AppserverIo\Appserver\Core\Interfaces\ExtractorInterface | null
Результат AppserverIo\Appserver\Core\Interfaces\ExtractorInterface | null

injectExtractor() публичный метод

Will inject a certain extractor to be used
public injectExtractor ( AppserverIo\Appserver\Core\Interfaces\ExtractorInterface $extractor ) : null
$extractor AppserverIo\Appserver\Core\Interfaces\ExtractorInterface The extractor instance to inject
Результат null

load() публичный метод

Returns the application with the passed UUID.
См. также: ServiceInterface::load()
public load ( string $uuid ) : AppNode | null
$uuid string UUID of the application to return
Результат AppserverIo\Appserver\Core\Api\Node\AppNode | null The application with the UUID passed as parameter

loadByWebappPath() публичный метод

Returns the application with the passed webapp path.
public loadByWebappPath ( string $webappPath ) : AppNode | null
$webappPath string webapp path of the application to return
Результат AppserverIo\Appserver\Core\Api\Node\AppNode | null The application with the webapp path passed as parameter

newFromApplication() публичный метод

Creates a new app node for the passed application and attaches it to the system configuration.
public newFromApplication ( AppserverIo\Psr\Application\ApplicationInterface $application ) : void
$application AppserverIo\Psr\Application\ApplicationInterface The application to create a new AppNode for
Результат void

persist() публичный метод

Persists the system configuration.
public persist ( AppserverIo\Configuration\Interfaces\NodeInterface $appNode ) : void
$appNode AppserverIo\Configuration\Interfaces\NodeInterface The application node object
Результат void

soak() публичный метод

Soaks the passed archive into from a location in the filesystem to the deploy directory.
public soak ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, SplFileInfo $archive ) : void
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container the archive is bound to
$archive SplFileInfo The archive to soak
Результат void

undeploy() публичный метод

Removes the .deployed flag file from the deploy folder, therefore the app will be undeployed with the next restart.
public undeploy ( AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface $containerNode, string $uuid ) : void
$containerNode AppserverIo\Appserver\Core\Api\Node\ContainerNodeInterface The container the app is bound to
$uuid string UUID of the application to delete
Результат void

Описание свойств

$extractor защищенное свойство

The extractor instance to handle archive operations with
protected ExtractorInterface,AppserverIo\Appserver\Core\Interfaces $extractor
Результат AppserverIo\Appserver\Core\Interfaces\ExtractorInterface