PHP Class AppserverIo\Appserver\Meta\Composer\Script\Setup

Show file Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property Type Description
$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.

Public Methods

Method Description
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.

Method Details

changeFilePermissions() public static method

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
return void

copyOsSpecificResource() public static method

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
return void

getLinuxDistro() public static method

Returns the Linux distribution we're running on.
public static getLinuxDistro ( ) : string
return string The Linux distribution we're running on

getValue() public static method

Returns the configuration value with the passed key.
public static getValue ( string $key ) : mixed | null
$key string The key to get value for
return mixed | null The configuration value

postInstall() public static method

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
return void

postUpdate() public static method

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
return void

prepareContext() public static method

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
return void

prepareDirectory() public static method

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
return void

prepareOsSpecificPath() public static method

Prepares the passed path to work on the actual OS.
public static prepareOsSpecificPath ( string $path ) : string
$path string The path we want to perpare
return string The prepared path

prepareProperties() public static method

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
return void

processOsSpecificTemplate() public static method

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
return void

processTemplate() public static method

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
return void

Property Details

$defaultProperties protected static property

The available properties we used for parsing the template.
protected static array $defaultProperties
return array

$mergedProperties protected static property

The array with the merged and os specific template variables.
protected static array $mergedProperties
return array

$osProperties protected static property

The OS specific configuration properties.
protected static array $osProperties
return array