• Home
• PiwikTracker

PHP Class PiwikTracker, piwik-php-tracker

ファイルを表示 Open project: piwik/piwik-php-tracker Class Usage Examples

Public Properties

Property	Type	Description
$DEBUG_APPEND_URL
$DEBUG_LAST_REQUESTED_URL		Used in tests to output useful error messages.
$URL	string	Piwik base URL, for example http://example.org/piwik/ Must be set before using the class by calling PiwikTracker::$URL = 'http://yourwebsite.org/piwik/';

Public Methods

Method	Description
__construct ( integer $idSite, string $apiUrl = '' )	Builds a PiwikTracker object, used to track visits, pages and Goal conversions for a specific website, by using the Piwik Tracking API.
addEcommerceItem ( string $sku, string $name = '', string | array $category = '', float | integer $price, integer $quantity = 1 )	Adds an item in the Ecommerce order.
clearCustomTrackingParameters ( )	Clear / reset all previously set custom tracking parameters.
clearCustomVariables ( )	Clears any Custom Variable that may be have been set.
deleteCookies ( )	Deletes all first party cookies from the client
disableCookieSupport ( )	By default, PiwikTracker will read first party cookies from the request and write updated cookies in the response (using setrawcookie).
disableSendImageResponse ( )	If image response is disabled Piwik will respond with a HTTP 204 header instead of responding with a gif.
doBulkTrack ( ) : string	Sends all stored tracking actions at once. Only has an effect if bulk tracking is enabled.
doPing ( ) : mixed	Sends a ping request.
doTrackAction ( string $actionUrl, string $actionType ) : mixed	Tracks a download or outlink
doTrackContentImpression ( string $contentName, string $contentPiece = 'Unknown', string | boolean $contentTarget = false ) : mixed	Tracks a content impression
doTrackContentInteraction ( string $interaction, string $contentName, string $contentPiece = 'Unknown', string | boolean $contentTarget = false ) : mixed	Tracks a content interaction. Make sure you have tracked a content impression using the same content name and content piece, otherwise it will not count. To do so you should call the method doTrackContentImpression();
doTrackEcommerceCartUpdate ( float $grandTotal ) : mixed	Tracks a Cart Update (add item, remove item, update item).
doTrackEcommerceOrder ( string | integer $orderId, float $grandTotal, float $subTotal, float $tax, float $shipping, float $discount ) : mixed	Tracks an Ecommerce order.
doTrackEvent ( string $category, string $action, string | boolean $name = false, float | boolean $value = false ) : mixed	Tracks an event
doTrackGoal ( integer $idGoal, float $revenue ) : mixed	Records a Goal conversion
doTrackPageView ( string $documentTitle ) : mixed	Tracks a page view
doTrackSiteSearch ( string $keyword, string $category = '', boolean | integer $countResults = false ) : mixed	Tracks an internal Site Search query, and optionally tracks the Search Category, and Search results Count.
enableBulkTracking ( )	Enables the bulk request feature. When used, each tracking action is stored until the doBulkTrack method is called. This method will send all tracking data at once.
enableCookies ( string $domain = '', string $path = '/' )	Enable Cookie Creation - this will cause a first party VisitorId cookie to be set when the VisitorId is set or reset
getAttributionInfo ( ) : string	Returns the currently assigned Attribution Information stored in a first party cookie.
getCustomVariable ( integer $id, string $scope = 'visit' ) : mixed	Returns the currently assigned Custom Variable.
getRequestTimeout ( )	Returns the maximum number of seconds the tracker will spend waiting for a response from Piwik. Defaults to 600 seconds.
getUrlTrackAction ( string $actionUrl, string $actionType ) : string	Builds URL to track a new action.
getUrlTrackContentImpression ( string $contentName, string $contentPiece, string | false $contentTarget ) : string	Builds URL to track a content impression.
getUrlTrackContentInteraction ( string $interaction, string $contentName, string $contentPiece, string | false $contentTarget ) : string	Builds URL to track a content impression.
getUrlTrackEcommerceCartUpdate ( $grandTotal )	Returns URL used to track Ecommerce Cart updates Calling this function will reinitializes the property ecommerceItems to empty array so items will have to be added again via addEcommerceItem()
getUrlTrackEcommerceOrder ( $orderId, $grandTotal, $subTotal, $tax, $shipping, $discount )	Returns URL used to track Ecommerce Orders Calling this function will reinitializes the property ecommerceItems to empty array so items will have to be added again via addEcommerceItem()
getUrlTrackEvent ( string $category, string $action, string | boolean $name = false, float | boolean $value = false ) : string	Builds URL to track a custom event.
getUrlTrackGoal ( integer $idGoal, float $revenue ) : string	Builds URL to track a goal with idGoal and revenue.
getUrlTrackPageView ( string $documentTitle = '' ) : string	Builds URL to track a page view.
getUrlTrackSiteSearch ( string $keyword, string $category, integer $countResults ) : string	Builds URL to track a site search.
getUserId ( ) : boolean	Returns the User ID string, which may have been set via: $v->setUserId('[email protected]');
getUserIdHashed ( $id ) : string	Hash function used internally by Piwik to hash a User ID into the Visitor ID.
getVisitorId ( ) : string	If the user initiating the request has the Piwik first party cookie, this function will try and return the ID parsed from this first party cookie (found in $_COOKIE).
setAttributionInfo ( string $jsonEncoded )	Sets the attribution information to the visit, so that subsequent Goal conversions are properly attributed to the right Referrer URL, timestamp, Campaign Name & Keyword.
setBrowserHasCookies ( boolean $bool )	Sets if the browser supports cookies This is reported in "List of plugins" report in Piwik.
setBrowserLanguage ( string $acceptLanguage )	Sets the Browser language. Used to guess visitor countries when GeoIP is not enabled
setCity ( string $city )	Sets the city of the visitor. If not used, Piwik may try to find the city using the visitor's IP address (if configured to do so).
setCountry ( string $country )	Sets the country of the visitor. If not used, Piwik will try to find the country using either the visitor's IP address or language.
setCustomTrackingParameter ( string $trackingApiParameter, string $value )	Sets a custom tracking parameter. This is useful if you need to send any tracking parameters for a 3rd party plugin that is not shipped with Piwik itself. Please note that custom parameters are cleared after each tracking request.
setCustomVariable ( integer $id, string $name, string $value, string $scope = 'visit' )	Sets Visit Custom Variable.
setDebugStringAppend ( string $string )	Will append a custom string at the end of the Tracking request.
setEcommerceView ( string $sku = '', string $name = '', string | array $category = '', float $price )	Sets the current page view as an item (product) page view, or an Ecommerce Category page view.
setForceNewVisit ( )	Forces Piwik to create a new visit for the tracking request.
setForceVisitDateTime ( string $dateTime )	Overrides server date and time for the tracking requests.
setGenerationTime ( integer $timeMs )	Sets the time that generating the document on the server side took.
setIdSite ( integer $idSite )	Sets the current site ID.
setIp ( string $ip )	Overrides IP address
setLatitude ( float $lat )	Sets the latitude of the visitor. If not used, Piwik may try to find the visitor's latitude using the visitor's IP address (if configured to do so).
setLocalTime ( string $time )	Sets local visitor time
setLongitude ( float $long )	Sets the longitude of the visitor. If not used, Piwik may try to find the visitor's longitude using the visitor's IP address (if configured to do so).
setNewVisitorId ( )	Sets the current visitor ID to a random new one.
setPageCharset ( string $charset = '' )	By default, Piwik expects utf-8 encoded values, for example for the page URL parameter values, Page Title, etc.
setPlugins ( boolean $flash = false, boolean $java = false, boolean $director = false, boolean $quickTime = false, boolean $realPlayer = false, boolean $pdf = false, boolean $windowsMedia = false, boolean $gears = false, boolean $silverlight = false )	Sets visitor browser supported plugins
setProxy ( string $proxy, integer $proxyPort = 80 )	If a proxy is needed to look up the address of the Piwik site, set it with this
setRegion ( string $region )	Sets the region of the visitor. If not used, Piwik may try to find the region using the visitor's IP address (if configured to do so).
setRequestTimeout ( integer $timeout )	Sets the maximum number of seconds that the tracker will spend waiting for a response from Piwik.
setResolution ( integer $width, integer $height )	Sets user resolution width and height.
setTokenAuth ( string $token_auth )	Some Tracking API functionality requires express authentication, using either the Super User token_auth, or a user with 'admin' access to the website.
setUrl ( string $url )	Sets the current URL being tracked
setUrlReferer ( $url )
setUrlReferrer ( string $url )	Sets the URL referrer used to track Referrers details for new visits.
setUserAgent ( string $userAgent )	Sets the user agent, used to detect OS and browser.
setUserId ( string $userId )	Force the action to be recorded for a specific User. The User ID is a string representing a given user in your system.
setVisitorId ( string $visitorId )	Forces the requests to be recorded for the specified Visitor ID.

Protected Methods

Method	Description
domainFixup ( $domain )	Fix-up domain
getBaseUrl ( )	Returns the base URL for the piwik server.
getCookieMatchingName ( string $name ) : string	Returns a first party cookie which name contains $name
getCookieName ( string $cookieName ) : string	Get cookie name with prefix and domain hash
getCurrentHost ( ) : string	If current URL is "http://example.org/dir1/dir2/index.php?param1=value1¶m2=value2" will return "http://example.org"
getCurrentQueryString ( ) : string	If current URL is "http://example.org/dir1/dir2/index.php?param1=value1¶m2=value2" will return "?param1=value1¶m2=value2"
getCurrentScheme ( ) : string	If the current URL is 'http://example.org/dir1/dir2/index.php?param1=value1¶m2=value2" will return 'http'
getCurrentScriptName ( ) : string	If current URL is "http://example.org/dir1/dir2/index.php?param1=value1¶m2=value2" will return "/dir1/dir2/index.php"
getCurrentUrl ( ) : string	Returns the current full URL (scheme, host, path and query string.
getCustomVariablesFromCookie ( ) : boolean | mixed
getRequest ( $idSite )
getTimestamp ( ) : string | integer	Returns current timestamp, or forced timestamp/datetime if it was set
getUrlTrackEcommerce ( $grandTotal, $subTotal, $tax, $shipping, $discount )	Returns URL used to track Ecommerce orders
loadVisitorIdCookie ( ) : boolean	Loads values from the VisitorId Cookie
sendRequest ( $url, $method = 'GET', $data = null, $force = false )
setCookie ( $cookieName, $cookieValue, $cookieTTL )	Sets a first party cookie to the client to improve dual JS-PHP tracking.
setFirstPartyCookies ( )	Sets the first party cookies as would the piwik.js All cookies are supported: 'id' and 'ses' and 'ref' and 'cvar' cookies.

Private Methods

Method	Description
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.
getProxy ( )	If the proxy IP and the proxy port have been set, with the setProxy() function returns a string, like "173.234.92.107:80"

Method Details

Property Details