PHP Class Piwik\Plugins\Installation\Controller

Inheritance: extends Piwik\Plugin\ControllerAdmin
Show file Open project: piwik/piwik

Public Properties

Property Type Description
$steps

Public Methods

Method Description
databaseSetup ( ) Installation Step 3: Database Set-up
finished ( ) Installation Step 8: Finished!
firstWebsiteSetup ( ) Installation Step 6: Configure first web-site
getDefaultAction ( ) : string Get default action (first installation step)
getEmptyPageForSystemCheck ( ) : string System check will call this page which should load quickly, in order to look at Response headers (eg. to detect if pagespeed is running)
getInstallationCss ( ) : string Return the base.less compiled to css
getInstallationJs ( ) : string Return the base.less compiled to css
getInstallationSteps ( ) : array Get installation steps
hasEnoughTablesToReuseDb ( $tablesInstalled ) should be private but there's a bug in php 5.3.6
reuseTables ( )
saveLanguage ( ) Save language selection in session-store
setupSuperUser ( ) Installation Step 5: General Set-up (superuser login/password/email and subscriptions)
systemCheck ( ) Installation Step 2: System Check
systemCheckPage ( ) This controller action renders an admin tab that runs the installation system check, so people can see if there are any issues w/ their running Piwik installation.
tablesCreation ( ) Installation Step 4: Table Creation
trackingCode ( ) Installation Step 7: Display JavaScript tracking code
welcome ( ) Installation Step 1: Welcome

Protected Methods

Method Description
registerNewsletter ( $email, $newsletterPiwikORG, $newsletterProfessionalServices )
updateComponents ( ) : array | boolean

Private Methods

Method Description
addTrustedHosts ( $siteUrl ) Add trusted hosts
checkPiwikIsNotInstalled ( )
createConfigFile ( $dbInfos ) Write configuration file from session-store
createSuperUser ( $login, $password, $email )
deleteConfigFileIfNeeded ( )
extractHost ( string $url ) : string | false Extract host from URL
getParam ( $name )
markInstallationAsCompleted ( ) Write configuration file from session-store
redirectToNextStep ( string $currentStep, $parameters = [] ) : void Redirect to next step
resetLanguageCookie ( )

Method Details

databaseSetup() public method

Installation Step 3: Database Set-up
public databaseSetup ( )

finished() public method

Installation Step 8: Finished!
public finished ( )

firstWebsiteSetup() public method

Installation Step 6: Configure first web-site
public firstWebsiteSetup ( )

getDefaultAction() public method

Get default action (first installation step)
public getDefaultAction ( ) : string
return string function name

getEmptyPageForSystemCheck() public method

System check will call this page which should load quickly, in order to look at Response headers (eg. to detect if pagespeed is running)

getInstallationCss() public method

Return the base.less compiled to css
public getInstallationCss ( ) : string
return string

getInstallationJs() public method

Return the base.less compiled to css
public getInstallationJs ( ) : string
return string

getInstallationSteps() public method

Get installation steps
public getInstallationSteps ( ) : array
return array installation steps

hasEnoughTablesToReuseDb() public method

should be private but there's a bug in php 5.3.6
public hasEnoughTablesToReuseDb ( $tablesInstalled )

registerNewsletter() protected method

protected registerNewsletter ( $email, $newsletterPiwikORG, $newsletterProfessionalServices )
$email
$newsletterPiwikORG
$newsletterProfessionalServices

reuseTables() public method

public reuseTables ( )

saveLanguage() public method

Save language selection in session-store
public saveLanguage ( )

setupSuperUser() public method

Installation Step 5: General Set-up (superuser login/password/email and subscriptions)
public setupSuperUser ( )

systemCheck() public method

Installation Step 2: System Check
public systemCheck ( )

systemCheckPage() public method

This admin tab is only viewable by the Super User.
public systemCheckPage ( )

tablesCreation() public method

Installation Step 4: Table Creation
public tablesCreation ( )

trackingCode() public method

Installation Step 7: Display JavaScript tracking code
public trackingCode ( )

updateComponents() protected method

protected updateComponents ( ) : array | boolean
return array | boolean

welcome() public method

Can also display an error message when there is a failure early (eg. DB connection failed)
public welcome ( )

Property Details

$steps public property

public $steps