n2n Page Rocket 1 API

­Page­Config

Methods summary

Methods in detail

• areN2nLocaleUrlsActive

  boolean public areN2nLocaleUrlsActive ( )
  If true the all urls pointing to pages will contain the N2nLocale of the particular page translation.

  return

  boolean

• setN2nLocaleUrlsActive

  public setN2nLocaleUrlsActive ( bool n2nLocalesActive )

  see

  PageConfig::areN2nLocaleUrlsActive()

  param

  bool n2nLocalesActive

• isAutoN2nLocaleRedirectAllowed

  boolean public isAutoN2nLocaleRedirectAllowed ( )
  If true and the user requests the Leaf::isHome() he will redirected to the translation which suits his browser request locale best.

  return

  boolean

• setAutoN2nLocaleRedirectAllowed

  public setAutoN2nLocaleRedirectAllowed ( bool autoLocaleRedirectAllowed )

  see

  PageConfig::isAutoN2nLocaleRedirectAllowed()

  param

  bool autoLocaleRedirectAllowed

• isSslSelectable

  bool public isSslSelectable ( )
  If true the rocket user can select for each page if it must be requested over ssl or not.

  return

  bool

• setSslSelectable

  public setSslSelectable ( bool sslSelectable )

  see

  PageConfig::isSslSelectable()

  param

  bool sslSelectable

• isSslDefault

  boolean public isSslDefault ( )
  If true and PageConfig::isSslSelectable() is true also the default value of the ssl option is ture when adding pages in the rocket.

  return

  boolean

• setSslDefault

  public setSslDefault ( bool sslDefault )

  see

  PageConfig::isSslDefault()

  param

  bool sslDefault

• getHookKeys

  array public getHookKeys ( )
  You can define the avialable hooks which are available for the rocket user. See Hook article for more information.

  return

  array

• getHooks

  public getHooks ( )

• setHooks

  public setHooks ( array hooks )

  see

  PageConfig::getHookKeys()

  param

  array hooks

• isCacheClearedOnPageEvent

  bool public isCacheClearedOnPageEvent ( )
  If true the whole response cache and view cache gets cleared on every \page\event\PageEvent.

  return

  bool

• setCacheClearedOnPageEvent

  public setCacheClearedOnPageEvent ( bool cacheClearedOnPageEvent )

• getPageListenerLookupIds

  string public getPageListenerLookupIds ( )
  Lookup ids for custom PageListener.

  return

  string

• setPageListenerLookupIds

  public setPageListenerLookupIds ( array pageListenerLookupIds )

• addPageControllerConfig

  public addPageControllerConfig ( PageControllerConfig pageControllerConfig )

• getPageControllerConfigs

  PageControllerConfig public getPageControllerConfigs ( )

  return

  PageControllerConfig

• getPageControllerConfigByEiSpecId

  PageControllerConfig public getPageControllerConfigByEiSpecId ( string eiSpecId )

  param

  string eiSpecId

  return

  PageControllerConfig