Website

Extends Object. The Website Object provides various settings for the website and is available on all pages within the 'website' variable.  

Properties
links

Type Object

An object containing social media links for the website, currently these are:.

  • facebook
  • flickr
  • googlePlus
  • linkedIn
  • pinterest
  • instagram
  • twitter
  • vimeo
  • youTube


Methods
allowCartEnquiries()

Returns Boolean

True if the website allows users to add products to cart as an enquiry mechanism.

allowCartPurchases()

Returns Boolean

True if the website allows users to purchase products online and the Account has a Commerce subscription.

catalogue()

Returns Category or False

False if the website does not allow products and does not have a Catalogue subscription. Otherwise the website's root product category is returned.

favicon()

Returns String or Null

The favicon image for the website if set, else null.

featuredCategories()

Returns CategoryCollection

The categories featured by the administrators of the website in sequence order.

featuredProducts()

Returns ProductSearch

The products marked as featured. Unlike featuredCategories products do not have a pre-determined sort order, so this method returns the full ProductSearch object allowing you to refine sort order.

hasCart()

Returns Boolean

True if the website supports a shopping cart in its subscription.

hasFeaturedCategories()

Returns Boolean

True if the website has any featured categories.

hasMultipleLocales()

Returns Boolean

True if the website has more than one international locale or language settings.

hasNewsletter()

Returns Boolean

True if the website has a default campaign recipient list as a newsletter.

hasUsers()

Returns Boolean

True if the website subscription supports registered users.

homepage()

Returns Page

Gets the Page object for the homepage of the website..

inEditMode()

Returns Boolean

True if the current user has signed into the Evance control panel and has edited CMS Pages, Category or Product content. This method allows us to give special consideration to interactive elements of the site when editing the site.

isCatalogue()

Returns Boolean

True if the website subscription supports a product catalogue.

isCommerce()

Returns Boolean

True if the website subscription supports a online purchases.

languages()

Returns Array

The list of available languages for the current locale.

logo()

Returns String or Null

The logo Url for the website represented as a String.

locale()

Returns Locale

The current locale for the website's visitor.

locales()

Returns Array

A list of all available locales for the website. Each element of the array returned contains a Locale object.