프로퍼티 | 타입 | 설명 | |
---|---|---|---|
$id | integer | null | ||
$infoSites | array |
메소드 | 설명 | |
---|---|---|
__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 ( ) : |
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 ) : |
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. |
메소드 | 설명 | |
---|---|---|
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. |
메소드 | 설명 | |
---|---|---|
triggerSetSitesEvent ( &$sites ) |
public __construct ( integer $idsite ) | ||
$idsite | integer | The ID of the site we want data for. |
public static clearCache ( ) |
public static clearCacheForSite ( $idSite ) |
public getCreationDate ( ) : |
||
리턴 |
public static getCreationDateFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public static getCurrencyFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public static getCurrencyList ( ) : array | ||
리턴 | array | An array mapping currency codes to their respective currency symbols and a description, eg, `array('USD' => array('$', 'US dollar'))`. |
public static getCurrencySymbolFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public getExcludedIps ( ) : string | ||
리턴 | string |
public static getExcludedIpsFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public getExcludedQueryParameters ( ) : string | ||
리턴 | string |
public static getExcludedQueryParametersFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public static getGroupFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public static getIdSitesFromIdSitesString ( string | array $ids, boolean | string $_restrictSitesToLogin = false ) : array | ||
$ids | string | array | Comma separated idSite list, eg, `'1,2,3,4'` or an array of IDs, eg, `array(1, 2, 3, 4)`. |
$_restrictSitesToLogin | boolean | string | Implementation detail. Used only when running as a scheduled task. |
리턴 | array | An array of valid, unique integers. |
public static getMainUrlFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public static getMinMaxDateAcrossWebsites ( array $siteIds ) : |
||
$siteIds | array | Array of IDs for each site being displayed. |
리턴 | of two Date instances. First is the min-date & the second is the max date. |
public static getNameFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public getSearchCategoryParameters ( ) : string | ||
리턴 | string |
public getSearchKeywordParameters ( ) : string | ||
리턴 | string |
public static getTimezoneFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public static getTypeFor ( $idsite ) : string | ||
$idsite | ||
리턴 | string |
public isEcommerceEnabled ( ) : boolean | ||
리턴 | boolean |
public static isEcommerceEnabledFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public isSiteSearchEnabled ( ) : boolean | ||
리턴 | boolean |
public static isSiteSearchEnabledFor ( integer $idsite ) : string | ||
$idsite | integer | The site ID. |
리턴 | string |
public static setSiteFromArray ( $idSite, $infoSite ) | ||
$idSite | ||
$infoSite |
public static setSitesFromArray ( array $sites ) | ||
$sites | array | The array of sites data. eg, array( array('idsite' => '1', 'name' => 'Site 1', ...), array('idsite' => '2', 'name' => 'Site 2', ...), ) |