• Home
• Piwik
• Site

PHP Class Piwik\Site

**Data Cache** Site data can be cached in order to avoid performing too many queries. If a method needs many site entities, it is more efficient to query all of what you need beforehand via the **SitesManager** API, then cache it using {@link setSites()} or {@link setSitesFromArray()}. Subsequent calls to new Site($id) will use the data in the cache instead of querying the database. ### Examples **Basic usage** $site = new Site($idSite); $name = $site->getName(); **Without allocation** $name = Site::getNameFor($idSite); Show file Open project: piwik/piwik Class Usage Examples

Protected Properties

Property	Type	Description
$id	integer | null
$infoSites	array

Public Methods

Method	Description
__construct ( integer $idsite )	Constructor.
__toString ( ) : string	Returns a string representation of the site this instance references.
clearCache ( )	Clears the site data cache.
clearCacheForSite ( $idSite )	Clears the site data cache.
getCreationDate ( ) : Date	Returns the creation date of the site.
getCreationDateFor ( integer $idsite ) : string	Returns the creation date of the site with the specified ID.
getCurrency ( ) : string	Returns the currency of the site.
getCurrencyFor ( integer $idsite ) : string	Returns the currency of the site with the specified ID.
getCurrencyList ( ) : array	Returns the list of all known currency symbols.
getCurrencySymbolFor ( integer $idsite ) : string	Returns the currency of the site with the specified ID.
getExcludedIps ( ) : string	Returns the excluded ips of the site.
getExcludedIpsFor ( integer $idsite ) : string	Returns the excluded IP addresses of the site with the specified ID.
getExcludedQueryParameters ( ) : string	Returns the excluded query parameters of the site.
getExcludedQueryParametersFor ( integer $idsite ) : string	Returns the excluded query parameters for the site with the specified ID.
getGroupFor ( integer $idsite ) : string	Returns the group of the site with the specified ID.
getId ( ) : integer	Returns the id of the site.
getIdSitesFromIdSitesString ( string | array $ids, boolean | string $_restrictSitesToLogin = false ) : array	Checks the given string for valid site IDs and returns them as an array.
getMainUrl ( ) : string	Returns the main url of the site.
getMainUrlFor ( integer $idsite ) : string	Returns the url for the site with the specified ID.
getMinMaxDateAcrossWebsites ( array $siteIds ) : Date[]	The Multisites reports displays the first calendar date as the earliest day available for all websites.
getName ( ) : string	Returns the name of the site.
getNameFor ( integer $idsite ) : string	Returns the name of the site with the specified ID.
getSearchCategoryParameters ( ) : string	Returns the site search category query parameters for the site.
getSearchKeywordParameters ( ) : string	Returns the site search keyword query parameters for the site.
getSite ( $idsite )
getSites ( )	Returns all websites pre-cached
getTimezone ( ) : string	Returns the timezone of the size.
getTimezoneFor ( integer $idsite ) : string	Returns the timezone of the site with the specified ID.
getType ( ) : string	Returns the website type (by default "website", which means it is a single website).
getTypeFor ( $idsite ) : string	Returns the type of the site with the specified ID.
isEcommerceEnabled ( ) : boolean	Returns whether ecommerce is enabled for the site.
isEcommerceEnabledFor ( integer $idsite ) : string	Returns whether the site with the specified ID is ecommerce enabled or not.
isSiteSearchEnabled ( ) : boolean	Returns whether Site Search Tracking is enabled for the site.
isSiteSearchEnabledFor ( integer $idsite ) : string	Returns whether the site with the specified ID is Site Search enabled.
setSiteFromArray ( $idSite, $infoSite )	Sets a site information in memory (statically cached).
setSites ( array $sites )	Sets the cached site data with an array that associates site IDs with individual site data.
setSitesFromArray ( array $sites )	Sets the cached Site data with a non-associated array of site data.

Protected Methods

Method	Description
get ( string $name ) : mixed	Returns a site property by name.
getFor ( integer $idsite, string $field ) : string	Utility function. Returns the value of the specified field for the site with the specified ID.

Private Methods

Method	Description
triggerSetSitesEvent ( &$sites )

Method Details

Property Details