CgiExtension
extends Extension
in package
This is a simple CGI Extension implementation that other CGI Extension can inherit from.
Table of Contents
Properties
- $basePath : array<string, string>
- $baseUrl : string
- $virtualEnvironment : VirtualEnvironment
Methods
- __construct() : mixed
- baseApp() : string
- Retrieve application base path.
- baseCgi() : string
- Retrieve cgi base path.
- baseResource() : string
- Retrieve resource base path.
- baseRoute() : string
- Retrieve route base path.
- baseUrl() : string
- Retrieve base url.
- baseView() : string
- Retrieve view base path.
- env() : string
- Retrieve string value of environment variables.
- envBool() : bool
- Retrieve boolean value of environment variables.
- envFloat() : float
- Retrieve float value of environment variables.
- envInt() : int
- Retrieve integer value of environment variables.
- environments() : array<string, string>
- Retrieve all of environment variables.
- view() : string
- Retrieve rendered view template.
- basePath() : string
- Retrieve base path.
- safeSeparator() : string
- Retrieve path with safe directory separator.
Properties
$basePath
private
array<string, string>
$basePath
= []
$baseUrl
private
string
$baseUrl
= ''
$virtualEnvironment
private
VirtualEnvironment
$virtualEnvironment
= null
Methods
__construct()
public
__construct([array<string, mixed> $config = [] ]) : mixed
Parameters
- $config : array<string, mixed> = []
-
The configuration.
baseApp()
Retrieve application base path.
public
baseApp([string $path = '' ]) : string
Parameters
- $path : string = ''
-
Relative path
Return values
stringbaseCgi()
Retrieve cgi base path.
public
baseCgi([string $path = '' ]) : string
Parameters
- $path : string = ''
-
Relative path
Return values
stringbaseResource()
Retrieve resource base path.
public
baseResource([string $path = '' ]) : string
Parameters
- $path : string = ''
-
Relative path
Return values
stringbaseRoute()
Retrieve route base path.
public
baseRoute([string $path = '' ]) : string
Parameters
- $path : string = ''
-
Relative path
Return values
stringbaseUrl()
Retrieve base url.
public
baseUrl([string $url = '' ]) : string
Parameters
- $url : string = ''
-
Relative url
Return values
stringbaseView()
Retrieve view base path.
public
baseView([string $path = '' ]) : string
Parameters
- $path : string = ''
-
Relative path
Return values
stringenv()
Retrieve string value of environment variables.
public
env(string $name[, string $default = '' ]) : string
Parameters
- $name : string
-
Environment name
- $default : string = ''
-
Default value
Return values
stringenvBool()
Retrieve boolean value of environment variables.
public
envBool(string $name[, bool $default = false ]) : bool
Parameters
- $name : string
-
Environment name
- $default : bool = false
-
Default value
Return values
boolenvFloat()
Retrieve float value of environment variables.
public
envFloat(string $name[, float $default = 0 ]) : float
Parameters
- $name : string
-
Environment name
- $default : float = 0
-
Default value
Return values
floatenvInt()
Retrieve integer value of environment variables.
public
envInt(string $name[, int $default = 0 ]) : int
Parameters
- $name : string
-
Environment name
- $default : int = 0
-
Default value
Return values
intenvironments()
Retrieve all of environment variables.
public
environments() : array<string, string>
Return values
array<string, string>view()
Retrieve rendered view template.
public
view(string $name[, array<string, mixed> $data = [] ]) : string
Parameters
- $name : string
-
View name
- $data : array<string, mixed> = []
-
View data
Return values
stringbasePath()
Retrieve base path.
protected
basePath(string $key[, string $path = '' ]) : string
Parameters
- $key : string
-
The base name
- $path : string = ''
-
Relative path
Return values
stringsafeSeparator()
Retrieve path with safe directory separator.
private
safeSeparator(string $path) : string
Parameters
- $path : string