PHP Class Clickalicious\PhpMemAdmin\BaseInstaller

Base of installer for phpMemAdmin. This installer automate the single steps of symlink folders to document root. On Windows the symlink functionality requires administrator privileges on *nix platforms you will need the right to symlink to the folder in general.
Show file Open project: clickalicious/phpmemadmin Class Usage Examples

Protected Properties

Property Type Description
$arguments array The arguments from CLI (argv) parsed.
$extra array The extra(s) from composer.json passed.
$installPath string The install path

Protected Methods

Method Description
getArguments ( ) : array Getter for arguments.
getExtra ( ) : array Getter for extra.
getInstallPath ( ) : string Getter for installPath.
getSourcePath ( ) : boolean Detect and return source path containing the bootstrap project structure.
initArguments ( Composer\Script\CommandEvent $event = null ) : boolean Retrieve arguments from global to prepare them for further use.
retrieveInstallPath ( ) : string Returns install path relative to current path.
setArguments ( array $arguments ) : void Setter for arguments.
setExtra ( array $extra ) : void Setter for extra.
setInstallPath ( string $installPath ) : void Setter for installPath.
showBanner ( ) : void Show project banner.
showHelp ( ) : void Shows help dialog.
showVersion ( ) : void Shows phpMemAdmin version banner.
showVhostExample ( string $installPath ) : void Echoes a VHost skeleton with correct path inserted.
validatePath ( string $path ) : boolean Validates a path for installation.
xcopy ( string $source, string $destination, mixed $permissions = 493 ) : boolean Copy a file, or recursively copy a folder and its contents

Method Details

getArguments() protected static method

Getter for arguments.
Author: Benjamin Carl ([email protected])
protected static getArguments ( ) : array
return array The arguments

getExtra() protected static method

Getter for extra.
Author: Benjamin Carl ([email protected])
protected static getExtra ( ) : array
return array Extra

getInstallPath() protected static method

Getter for installPath.
Author: Benjamin Carl ([email protected])
protected static getInstallPath ( ) : string
return string The install path

getSourcePath() protected static method

Detect and return source path containing the bootstrap project structure.
Author: Benjamin Carl ([email protected])
protected static getSourcePath ( ) : boolean
return boolean Returns true on success, false on failure

initArguments() protected static method

Retrieve arguments from global to prepare them for further use.
Author: Benjamin Carl ([email protected])
protected static initArguments ( Composer\Script\CommandEvent $event = null ) : boolean
$event Composer\Script\CommandEvent The Composer event fired to retrieve arguments from
return boolean TRUE on success, otherwise FALSE

retrieveInstallPath() protected static method

Returns install path relative to current path.
Author: Benjamin Carl ([email protected])
protected static retrieveInstallPath ( ) : string
return string The install path

setArguments() protected static method

Setter for arguments.
Author: Benjamin Carl ([email protected])
protected static setArguments ( array $arguments ) : void
$arguments array The arguments to set.
return void

setExtra() protected static method

Setter for extra.
Author: Benjamin Carl ([email protected])
protected static setExtra ( array $extra ) : void
$extra array The extra to set.
return void

setInstallPath() protected static method

Setter for installPath.
Author: Benjamin Carl ([email protected])
protected static setInstallPath ( string $installPath ) : void
$installPath string The installPath to set.
return void

showBanner() protected static method

Show project banner.
Author: Benjamin Carl ([email protected])
protected static showBanner ( ) : void
return void

showHelp() protected static method

Shows help dialog.
Author: Benjamin Carl ([email protected])
protected static showHelp ( ) : void
return void

showVersion() protected static method

Shows phpMemAdmin version banner.
Author: Benjamin Carl ([email protected])
protected static showVersion ( ) : void
return void

showVhostExample() protected static method

Echoes a VHost skeleton with correct path inserted.
Author: Benjamin Carl ([email protected])
protected static showVhostExample ( string $installPath ) : void
$installPath string The install path to insert.
return void

validatePath() protected static method

Validates a path for installation.
Author: Benjamin Carl ([email protected])
protected static validatePath ( string $path ) : boolean
$path string The path to validate
return boolean TRUE if path is valid, otherwise FALSE

xcopy() protected static method

Copy a file, or recursively copy a folder and its contents
Author: Benjamin Carl ([email protected])
protected static xcopy ( string $source, string $destination, mixed $permissions = 493 ) : boolean
$source string Source path
$destination string Destination path
$permissions mixed New folder creation permissions
return boolean Returns true on success, false on failure

Property Details

$arguments protected static property

The arguments from CLI (argv) parsed.
protected static array $arguments
return array

$extra protected static property

The extra(s) from composer.json passed.
protected static array $extra
return array

$installPath protected static property

The install path
protected static string $installPath
return string