| Method |
Description |
|
|
checkPiwikServerWorking ( $piwikServerUrl, boolean $acceptInvalidSSLCertificates = false ) : boolean |
Returns true if the Piwik server appears to be working. |
|
|
getCurrentGitBranch ( ) |
|
|
|
getKnownSegmentsToArchive ( ) : array |
Returns every stored segment to pre-process for each site during cron archiving. |
|
|
getKnownSegmentsToArchiveForSite ( integer $idSite ) : string[] |
Returns the list of stored segments to pre-process for an individual site when executing
cron archiving. |
|
|
getPiwikUrl ( ) : string |
Returns the URL to this Piwik instance, eg. **http://demo.piwik.org/** or **http://example.org/piwik/**. |
|
|
getSalt ( ) : string |
Get salt from [General] section |
|
|
getWebsitesCountToDisplay ( ) : integer |
Number of websites to show in the Website selector |
|
|
isAutoUpdateEnabled ( ) : boolean |
Detect whether user has enabled auto updates. Please note this config is a bit misleading. It is currently
actually used for 2 things: To disable making any connections back to Piwik, and to actually disable the auto
update of core and plugins. |
|
|
isAutoUpdatePossible ( ) : boolean |
Detects whether an auto update can be made. An update is possible if the user is not on multiple servers and if
automatic updates are actually enabled. If a user is running Piwik on multiple servers an update is not possible
as it would be installed only on one server instead of all of them. Also if a user has disabled automatic updates
we cannot perform any automatic updates. |
|
|
isGitDeployment ( ) : boolean |
Returns true if Piwik is deployed using git
FAQ: http://piwik.org/faq/how-to-install/faq_18271/ |
|
|
isHttpsForced ( ) : boolean |
|
|
|
isMultiServerEnvironment ( ) : boolean |
Returns true if Piwik is running on more than one server. For example in a load balanced environment. In this
case we should not make changes to the config and not install a plugin via the UI as it would be only executed
on one server. |
|
|
isPiwikInstalled ( ) : boolean |
Return true if Piwik is installed (installation is done). |
|
|
isSameFingerprintAcrossWebsites ( ) : boolean |
Note: this config settig is also checked in the InterSites plugin |
|
|
isSegmentationEnabled ( ) : boolean |
Returns true if segmentation is allowed for this user, false if otherwise. |
|
|
isUniqueVisitorsEnabled ( string $periodLabel ) : boolean |
Returns true if unique visitors should be processed for the given period type. |
|
|
isUserCredentialsSanityCheckEnabled ( ) : boolean |
Should Piwik check that the login & password have minimum length and valid characters? |
|
|
overwritePiwikUrl ( $currentUrl ) |
|
|
|
rewriteMiscUserPathWithInstanceId ( $path ) : mixed |
If Piwik uses per-domain config file, make sure CustomLogo is unique |
|