PHP Класс AppserverIo\Appserver\Meta\Composer\Script\Setup

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

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

Свойство Тип Описание
$defaultProperties array The available properties we used for parsing the template.
$logo string appserver.io written in ASCI art.
$mergedProperties array The array with the merged and os specific template variables.
$osProperties array The OS specific configuration properties.

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

Метод Описание
changeFilePermissions ( string $filename, integer $mode = 420 ) : void Sets the passed mode for the file if NOT on Windows.
copyOsSpecificResource ( string $os, string $resource, boolean $override = false, integer $mode = 420 ) : void Copies the passed OS specific resource file to the target directory.
getLinuxDistro ( ) : string Returns the Linux distribution we're running on.
getValue ( string $key ) : mixed | null Returns the configuration value with the passed key.
postInstall ( Composer\Script\Event $event ) : void This method will be invoked by composer after a successful installation and creates the application server configuration file under etc/appserver/appserver.xml.
postUpdate ( Composer\Script\Event $event ) : void This method will be invoked by composer after a successful update and creates the application server configuration file under etc/appserver/appserver.xml.
prepareContext ( null | string $installDir = null, null | Composer\Script\Event $event = null ) : void Prepares the context by given event or without event for other usage
prepareDirectory ( string $directory, integer $mode = 509 ) : void Prepares the passed directory if necessary.
prepareOsSpecificPath ( string $path ) : string Prepares the passed path to work on the actual OS.
prepareProperties ( string $os, array $contextProperties ) : void Merge the properties based on the passed OS.
processOsSpecificTemplate ( string $os, string $template, boolean $override = false, integer $mode = 420 ) : void Processes the OS specific template and replace the properties with the OS specific values.
processTemplate ( string $template, boolean $override = false, integer $mode = 420 ) : void Processes the template and replace the properties with the OS specific values.

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

changeFilePermissions() публичный статический Метод

Sets the passed mode for the file if NOT on Windows.
public static changeFilePermissions ( string $filename, integer $mode = 420 ) : void
$filename string The filename to set the mode for
$mode integer The mode to set
Результат void

copyOsSpecificResource() публичный статический Метод

Copies the passed OS specific resource file to the target directory.
public static copyOsSpecificResource ( string $os, string $resource, boolean $override = false, integer $mode = 420 ) : void
$os string The OS we want to copy the files for
$resource string The resource file we want to copy
$override boolean TRUE if the file should be overwritten if exists, else FALSE
$mode integer The mode of the target file
Результат void

getLinuxDistro() публичный статический Метод

Returns the Linux distribution we're running on.
public static getLinuxDistro ( ) : string
Результат string The Linux distribution we're running on

getValue() публичный статический Метод

Returns the configuration value with the passed key.
public static getValue ( string $key ) : mixed | null
$key string The key to get value for
Результат mixed | null The configuration value

postInstall() публичный статический Метод

This method will be invoked by composer after a successful installation and creates the application server configuration file under etc/appserver/appserver.xml.
public static postInstall ( Composer\Script\Event $event ) : void
$event Composer\Script\Event The event that invokes this method
Результат void

postUpdate() публичный статический Метод

This method will be invoked by composer after a successful update and creates the application server configuration file under etc/appserver/appserver.xml.
public static postUpdate ( Composer\Script\Event $event ) : void
$event Composer\Script\Event The event that invokes this method
Результат void

prepareContext() публичный статический Метод

Prepares the context by given event or without event for other usage
public static prepareContext ( null | string $installDir = null, null | Composer\Script\Event $event = null ) : void
$installDir null | string The install dir to check for info files
$event null | Composer\Script\Event The event instance or null
Результат void

prepareDirectory() публичный статический Метод

Prepares the passed directory if necessary.
public static prepareDirectory ( string $directory, integer $mode = 509 ) : void
$directory string The directory to prepare
$mode integer The mode of the directory
Результат void

prepareOsSpecificPath() публичный статический Метод

Prepares the passed path to work on the actual OS.
public static prepareOsSpecificPath ( string $path ) : string
$path string The path we want to perpare
Результат string The prepared path

prepareProperties() публичный статический Метод

Merge the properties based on the passed OS.
public static prepareProperties ( string $os, array $contextProperties ) : void
$os string The OS we want to merge the properties for
$contextProperties array The properties to merge
Результат void

processOsSpecificTemplate() публичный статический Метод

Processes the OS specific template and replace the properties with the OS specific values.
public static processOsSpecificTemplate ( string $os, string $template, boolean $override = false, integer $mode = 420 ) : void
$os string The OS we want to process the template for
$template string The path to the template
$override boolean TRUE if the file should be overwritten if exists, else FALSE
$mode integer The mode of the target file
Результат void

processTemplate() публичный статический Метод

Processes the template and replace the properties with the OS specific values.
public static processTemplate ( string $template, boolean $override = false, integer $mode = 420 ) : void
$template string The path to the template
$override boolean TRUE if the file should be overwritten if exists, else FALSE
$mode integer The mode of the target file
Результат void

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

$defaultProperties защищенное статическое свойство

The available properties we used for parsing the template.
protected static array $defaultProperties
Результат array

$mergedProperties защищенное статическое свойство

The array with the merged and os specific template variables.
protected static array $mergedProperties
Результат array

$osProperties защищенное статическое свойство

The OS specific configuration properties.
protected static array $osProperties
Результат array