• Home
• Piwik
• Common

PHP Class Piwik\Common

This is the only non-Tracker class loaded by the **\/piwik.php** file. Mostra file Open project: piwik/piwik Class Usage Examples

Public Properties

Property	Type	Description
$isCliMode

Public Methods

Method	Description
convertUserIdToVisitorIdBin ( $userId ) : string	Converts a User ID string to the Visitor ID Binary representation.
convertVisitorIdToBin ( string $id ) : string	This function will convert the input string to the binary representation of the ID but it will throw an Exception if the specified input ID is not correct
destroy ( mixed &$var )	Marks an orphaned object for garbage collection.
extractCountryCodeFromBrowserLanguage ( string $browserLanguage, array $validCountries, boolean $enableLanguageToCountryGuess ) : array	Returns list of valid country codes
extractLanguageAndRegionCodeFromBrowserLanguage ( string $browserLanguage, array $validLanguages = [] ) : string	Returns the language and region string, based only on the Browser 'accepted language' information.
extractLanguageCodeFromBrowserLanguage ( string $browserLanguage, array $validLanguages = [] ) : string	Returns the language and region string, based only on the Browser 'accepted language' information.
forceDotAsSeparatorForDecimalPoint ( float | string $value ) : string	Force the separator for decimal point to be a dot. See https://github.com/piwik/piwik/issues/6435 If for instance a German locale is used it would be a comma otherwise.
generateUniqId ( ) : string	Returns a 32 characters long uniq ID
getBrowserLanguage ( string | null $browserLang = null ) : string	Returns the browser language code, eg. "en-gb,en;q=0.5"
getCampaignParameters ( ) : array	Returns the list of Campaign parameter names that will be read to classify a visit as coming from a Campaign
getClassLineage ( string $class ) : string[]	Returns the list of parent classes for the given class.
getContinent ( string $country ) : string	Returns the continent of a given country
getContinentsList ( ) : array	Returns list of continent codes
getCountriesList ( boolean $includeInternalCodes = false ) : array	Returns list of valid country codes
getCountry ( string $lang, boolean $enableLanguageToCountryGuess, string $ip ) : string	Returns the visitor country based on the Browser 'accepted language' information, but provides a hook for geolocation via IP address.
getCurrentLocationProviderId ( )	Returns the ID of the current LocationProvider (see UserCountry plugin code) from the Tracker cache.
getLanguageToCountryList ( ) : array	Returns a list of language to country mappings.
getLanguagesList ( ) : array	Returns the list of valid language codes.
getLastJsonError ( ) : string	Returns a human readable error message in case an error occcurred during the last json encode/decode.
getProviderNames ( ) : array	Returns list of provider names
getRandomString ( integer $length = 16, string $alphabet = "abcdefghijklmnoprstuvwxyz0123456789" ) : string	Generate random string.
getRequestVar ( string $varName, string | null $varDefault = null, string | null $varType = null, array | null $requestArrayToUse = null ) : mixed	Gets a sanitized request parameter by name from the $_GET and $_POST superglobals.
getSqlStringFieldsArray ( array | string $fields ) : string	Returns a string with a comma separated list of placeholders for use in an SQL query. Used mainly to fill the `IN (.
hasJsonErrorOccurred ( ) : boolean	Detects whether an error occurred during the last json encode/decode.
hash ( string $str, boolean $raw_output = false ) : string	Configurable hash() algorithm (defaults to md5)
hashStringToInt ( string $string ) : integer	Hashes a string into an integer which should be very low collision risks
hex2bin ( string $str ) : string	Convert hexadecimal representation into binary data.
isActionsPluginEnabled ( )
isGoalPluginEnabled ( )	* Tracker
isPhpCgiType ( ) : boolean	Returns true if PHP is executed as CGI type.
isPhpCliMode ( ) : boolean	Returns true if PHP was invoked from command-line interface (shell)
isRunningConsoleCommand ( ) : boolean	Returns true if the current request is a console command, eg.
isXmlHttpRequest ( ) : boolean	Returns true if the request is an AJAX request.
json_decode ( string $json, boolean $assoc = false ) : mixed	JSON decode wrapper - missing or broken in some php 5.x versions
json_encode ( mixed $value ) : string	JSON encode wrapper - missing or broken in some php 5.x versions
mb_strlen ( string $string ) : integer	Multi-byte strlen() - works with UTF-8
mb_strtolower ( string $string ) : string	Multi-byte strtolower() - works with UTF-8.
mb_substr ( string $string, integer $start ) : string	Multi-byte substr() - works with UTF-8.
prefixTable ( string $table ) : string	Returns a prefixed table name.
prefixTables ( ) : array	Returns an array containing the prefixed table names of every passed argument.
printDebug ( $info = '' )
sanitizeInputValue ( string $value ) : string	Sanitize a single input value and removes line breaks, tabs and null characters.
sanitizeInputValues ( mixed $value, boolean $alreadyStripslashed = false ) : mixed	Sanitizes a string to help avoid XSS vulnerabilities.
sanitizeLineBreaks ( string $value ) : string
sanitizeNullBytes ( string $value ) : string
sendHeader ( string $header, boolean $replace = true )	Sets outgoing header.
sendResponseCode ( integer $code )	Sends the given response code if supported.
stringEndsWith ( $haystack, $needle )
unprefixTable ( string $table ) : string	Removes the prefix from a table name and returns the result.
unsanitizeInputValue ( string $value ) : string	Unsanitizes a single input value and returns the result.
unsanitizeInputValues ( string | array $value ) : string | array	Unsanitizes one or more values and returns the result.

Protected Methods

Method	Description
checkValidLanguagesIsSet ( $validLanguages ) : array

Private Methods

Method	Description
sanitizeString ( $value ) : string	Sanitize a single input value

Method Details

Property Details