PHP Class Pimcore\Tool

Show file Open project: pimcore/pimcore Class Usage Examples

Protected Properties

Property Type Description
$isFrontend null
$notFoundClassNames array
$validLanguages array

Public Methods

Method Description
classExists ( $class ) : boolean
exitWithError ( $message )
getAnonymizedClientIp ( ) : string
getClientIp ( ) : mixed
getCustomViewConfig ( ) : array | boolean
getDefaultLanguage ( ) : null | string
getFallbackLanguagesFor ( $language ) : array
getHostUrl ( string $useProtocol = null ) : string Returns the host URL
getHostname ( ) : string
getHttpClient ( string $type = "Zend_Http_Client", array $options = [] ) : Zend_Http_Client
getHttpData ( $url, array $paramsGet = [], array $paramsPost = [] ) : boolean | string
getLanguageFlagFile ( $language ) : string
getMail ( null $recipients = null, null $subject = null, null $charset = null ) : Mail
getModelClassMapping ( $sourceClassName ) : string
getRequestScheme ( ) : string
getRoutingDefaults ( ) : array
getSupportedLocales ( ) : array | mixed
getValidCacheKey ( string $key ) : string returns a valid cache key/tag string
getValidLanguages ( ) : array
interfaceExists ( $class ) : boolean
isFrontend ( ) : boolean
isFrontentRequestByAdmin ( ) eg. editmode, preview, version preview, always when it is a "frontend-request", but called out of the admin
isHtmlResponse ( Zend_Controller_Response_Abstract $response ) : boolean
isInstaller ( ) : boolean
isValidLanguage ( $language ) : boolean
isValidPath ( $path ) : boolean
useFrontendOutputFilters ( Zend_Controller_Request_Abstract $request ) : boolean

Protected Methods

Method Description
classInterfaceExists ( $class, $type ) : boolean

Method Details

classExists() public static method

public static classExists ( $class ) : boolean
$class
return boolean

classInterfaceExists() protected static method

protected static classInterfaceExists ( $class, $type ) : boolean
$class
$type
return boolean

exitWithError() public static method

public static exitWithError ( $message )
$message

getAnonymizedClientIp() public static method

public static getAnonymizedClientIp ( ) : string
return string

getClientIp() public static method

public static getClientIp ( ) : mixed
return mixed

getCustomViewConfig() public static method

public static getCustomViewConfig ( ) : array | boolean
return array | boolean

getDefaultLanguage() public static method

public static getDefaultLanguage ( ) : null | string
return null | string

getFallbackLanguagesFor() public static method

public static getFallbackLanguagesFor ( $language ) : array
$language
return array

getHostUrl() public static method

Returns the host URL
public static getHostUrl ( string $useProtocol = null ) : string
$useProtocol string use a specific protocol
return string

getHostname() public static method

public static getHostname ( ) : string
return string

getHttpClient() public static method

public static getHttpClient ( string $type = "Zend_Http_Client", array $options = [] ) : Zend_Http_Client
$type string
$options array
return Zend_Http_Client

getHttpData() public static method

public static getHttpData ( $url, array $paramsGet = [], array $paramsPost = [] ) : boolean | string
$url
$paramsGet array
$paramsPost array
return boolean | string

getLanguageFlagFile() public static method

public static getLanguageFlagFile ( $language ) : string
$language
return string

getMail() public static method

public static getMail ( null $recipients = null, null $subject = null, null $charset = null ) : Mail
$recipients null
$subject null
$charset null
return Mail

getModelClassMapping() public static method

Deprecation:
public static getModelClassMapping ( $sourceClassName ) : string
$sourceClassName
return string

getRequestScheme() public static method

public static getRequestScheme ( ) : string
return string

getRoutingDefaults() public static method

public static getRoutingDefaults ( ) : array
return array

getSupportedLocales() public static method

public static getSupportedLocales ( ) : array | mixed
return array | mixed

getValidCacheKey() public static method

returns a valid cache key/tag string
public static getValidCacheKey ( string $key ) : string
$key string
return string

getValidLanguages() public static method

public static getValidLanguages ( ) : array
return array

interfaceExists() public static method

public static interfaceExists ( $class ) : boolean
$class
return boolean

isFrontend() public static method

public static isFrontend ( ) : boolean
return boolean

isFrontentRequestByAdmin() public static method

eg. editmode, preview, version preview, always when it is a "frontend-request", but called out of the admin
public static isFrontentRequestByAdmin ( )

isHtmlResponse() public static method

public static isHtmlResponse ( Zend_Controller_Response_Abstract $response ) : boolean
$response Zend_Controller_Response_Abstract
return boolean

isInstaller() public static method

public static isInstaller ( ) : boolean
return boolean

isValidLanguage() public static method

public static isValidLanguage ( $language ) : boolean
$language
return boolean

isValidPath() public static method

public static isValidPath ( $path ) : boolean
$path
return boolean

useFrontendOutputFilters() public static method

public static useFrontendOutputFilters ( Zend_Controller_Request_Abstract $request ) : boolean
$request Zend_Controller_Request_Abstract
return boolean

Property Details

$isFrontend protected static property

protected static null $isFrontend
return null

$notFoundClassNames protected static property

protected static array $notFoundClassNames
return array

$validLanguages protected static property

protected static array $validLanguages
return array