Overview

Classes

Interfaces

Traits

Exceptions

Functions

Trait Detection

Direct Known Users

MvcCore\Environment

Namespace: MvcCore\Environment
Located at mvccore/src/MvcCore/Environment/Detection.php

Methods summary
`public static string`	# `DetectByIps( )` Returns string Detected environment string. Inheritdocs
`public static string`	# `DetectBySystemConfig( array $environmentsSectionData = [] )` Parameters `$environmentsSectionData` System config environment section data part. Returns string Detected environment string. Inheritdocs
`protected static stdClass`	# `detectByConfigSectionData( mixed $environmentSection, string\|null $clientIp )` Parse system config environment section data from various declarations into specific detection structure. Parse system config environment section data from various declarations into specific detection structure. Parameters `$environmentSection` `$clientIp` Returns stdClass
`protected static`	# `detectByConfigClientIps( stdClass & $data, mixed $rawClientIps )` Parse system config environment section data from various declarations about client IP addresses into specific detection structure. Parse system config environment section data from various declarations about client IP addresses into specific detection structure. Parameters `$data` `$rawClientIps`
`protected static`	# `detectByConfigPaths( stdClass & $data, mixed $rawPaths )` Parse system config environment section data from various declarations about application document root path into specific detection structure. Parse system config environment section data from various declarations about application document root path into specific detection structure. Parameters `$data` `$rawPaths`
`protected static`	# `detectByConfigServerNames( stdClass & $data, mixed $rawHostNames )` Parse system config environment section data from various declarations about server host names into specific detection structure. Parse system config environment section data from various declarations about server host names into specific detection structure. Parameters `$data` `$rawHostNames`
`protected static`	# `detectByConfigEnvVariables( stdClass & $data, mixed $rawServerVariable )` Parse system config environment section data from various declarations about server environment variables into specific detection structure. Parse system config environment section data from various declarations about server environment variables into specific detection structure. Parameters `$data` `$rawServerVariable`
`protected static boolean`	# `detectByConfigSection( stdClass & $data, MvcCore\Request $req, string\|null & $clientIp, string\|null & $appRoot, string\|null & $serverHostName, array\|null & $serverGlobals )` Detect environment by specifically parsed environment configuration data. This method is called for all founded environments in system config in order by system config and it tries to detect environment by following order: - by client IP address (if defined) - by IPs list (if defined) - by regular expression (if defined) - by server hostname (if defined) - by host names list (if defined) - by regular expression (if defined) - by server variable(s) (if defined) - by existence (if defined) - by value (if defined) - by regular expression (if defined) Method returns `TRUE` to stop environment detection or `FALSE`, if environment was not detected by given data. Detect environment by specifically parsed environment configuration data. This method is called for all founded environments in system config in order by system config and it tries to detect environment by following order: - by client IP address (if defined) - by IPs list (if defined) - by regular expression (if defined) - by server hostname (if defined) - by host names list (if defined) - by regular expression (if defined) - by server variable(s) (if defined) - by existence (if defined) - by value (if defined) - by regular expression (if defined) Method returns `TRUE` to stop environment detection or `FALSE`, if environment was not detected by given data. Parameters `$data` `$req` `$clientIp` `$appRoot` `$serverHostName` `$serverGlobals` Returns boolean If `TRUE`, environment has been detected and detection procedure could stop.
`protected static boolean`	# `detectRegExpCheck( string $rawValue )` Check if given string is PHP regular expression syntax. Check if given string is PHP regular expression syntax. Parameters `$rawValue` Returns boolean
`protected static string`	# `detectRegExpConvert( string $regExpWithTrailingSlashes )` Convert given regular expression into hash trailing characters form. Convert given regular expression into hash trailing characters form. Parameters `$regExpWithTrailingSlashes` Returns string