n2n Page Rocket 1 API

­View

All Implemented Interfaces:

• Payload
• UiComponent

SubTypes

• CsvView
• HtmlView
• JsonView
• XmlView

Property summary

Methods summary

Properties in detail

• contentsBuildContext

  protected ­ ­ ­ contentsBuildContext

Methods in detail

• __construct

  final public __construct ( string scriptPath , string name , Module module , N2nContext n2nContext )

  param

  string scriptPath

  string name

  Module

  N2nContext

• getParams

  public getParams ( )

• setParams

  public setParams ( array params )

• getName

  string public getName ( )

  throws

  UndefinedViewNameException

  return

  string

• getScriptPath

  string public getScriptPath ( )

  return

  string

• getModuleNamespace

  string public getModuleNamespace ( )

  return

  string

• getHttpContext

  HttpContext public getHttpContext ( )

  return

  HttpContext

• getN2nContext

  N2nContext public getN2nContext ( )

  return

  N2nContext

• getN2nLocale

  N2nLocale public getN2nLocale ( )

  return

  N2nLocale

• getRequest

  public getRequest ( )

• setControllerContext

  public setControllerContext ( ControllerContext controllerContext = null )

  param

  ControllerContext

• hasControllerContext

  public hasControllerContext ( )

• getControllerContext

  ControllerContext public getControllerContext ( )

  return

  ControllerContext

• getControllerContextByName

  ControllerContext public getControllerContextByName ( unknown name )

  return

  ControllerContext

• getStateObjs

  protected getStateObjs ( )

• setStateObjs

  protected setStateObjs ( array stateObjs )

• getStateObj

  public getStateObj ( string refTypeName )

• setStateObj

  public setStateObj ( string refTypeName , unknown stateObj )

• isInitialized

  boolean public isInitialized ( )

  return

  boolean

• initialize

  final public initialize ( View contentView = null , BuildContext buildContext = null )

  param

  Response

  View

• initializeFromCache

  public initializeFromCache ( string data )

  param

  string data

  throws

  InvalidArgumentException if not good

• toCacheData

  mixed public toCacheData ( )

  return

  mixed

• build

  public build ( BuildContext buildContext )
  (non-PHPdoc)

  see

  n2n\web\ui\view\n2n\web\ui.UiComponent
  Specified: UiComponent
  Overrides: UiComponent::build()

• getContents

  string public getContents ( )

  return

  string

• setContents

  public setContents ( mixed contents )

  param

  mixed contents

• reset

  final public reset ( )

• getContentsBuildContext

  SimpleBuildContext public getContentsBuildContext ( )

  return

  SimpleBuildContext

• registerStateListener

  public registerStateListener ( ViewStateListener stateListener )

  param

  ViewStateListener

• unregisterStateListener

  public unregisterStateListener ( ViewStateListener stateListener )

  param

  ViewStateListener

• getContentView

  boolean protected getContentView ( )

  return

  boolean

• bufferContents

  final protected bufferContents ( array viewVars , Closure bufferingEnded = null )

  param

  array viewVars

  Closure bufferingEnded

  throws

  ViewPanelNerverEndedException

• isBuffering

  boolean final public isBuffering ( )

  return

  boolean

• getContentBuffer

  final public getContentBuffer ( )

• getActiveBuffer

  final public getActiveBuffer ( )

• ensureContentsAreInitialized

  protected ensureContentsAreInitialized ( )

  throws

  ViewNotInitializedException

• ensureContentsAreNotInitialized

  protected ensureContentsAreNotInitialized ( )

  throws

  ViewIsAlreadyInitializedException

• ensureBufferIsActive

  protected ensureBufferIsActive ( )

  throws

  ViewIsNotBufferingException

• ensureBufferIsNotActive

  protected ensureBufferIsNotActive ( )

  throws

  ViewIsBufferingException

• getContentType

  string public getContentType ( )

  return

  string

• compile

  OutputBuffer protected compile ( OutputBuffer contentBuffer , BuildContext buildContext )
  Builds view content

  return

  OutputBuffer

• prepareForResponse

  public prepareForResponse ( Response response )
  (non-PHPdoc)

  see

  n2n\web\ui\view\n2n\web\http.Payload
  Specified: Payload
  Overrides: Payload::prepareForResponse()

• toKownPayloadString

  public toKownPayloadString ( )
  (non-PHPdoc)

  see

  n2n\web\ui\view\n2n\web\http.Payload
  Specified: Payload
  Overrides: Payload::toKownPayloadString()

• __toString

  public __toString ( )
  (non-PHPdoc)

  see

  n2n\web\ui\view\n2n\web\http.Payload

• getBufferedContents

  public getBufferedContents ( )
  (non-PHPdoc)

  see

  n2n\web\ui\view\n2n\web\http.BufferedPayload
  Specified: Payload
  Overrides: Payload::getBufferedContents()

• getPanels

  array public getPanels ( )

  return

  array

• hasPanel

  boolean public hasPanel ( string panelName )

  param

  string panelName

  return

  boolean

• getOrCreatePanel

  Panel public getOrCreatePanel ( string panelName )

  param

  string panelName

  return

  Panel

• putPanel

  public putPanel ( Panel panel )

  param

  Panel

• appendToPanel

  public appendToPanel ( string panelName , UiComponent uiComponent )

  param

  string panelName

  UiComponent

• getParam

  public getParam ( unknown name , unknown required = true , unknown default = null )

• mergeParams

  public mergeParams ( array params = array )

  param

  array params

• assert

  public assert ( unknown e )

  param

  boolean

• lookup

  Lookupable public lookup ( ReflectionClass useableClassName )

  param

  ReflectionClass useableClassName

  return

  Lookupable

• useTemplate

  public useTemplate ( string viewNameExpression , mixed params = null )

  param

  string viewNameExpression

  mixed params

• panelStart

  public panelStart ( string name , bool append = false )

  param

  string name

  bool append

• panelEnd

  public panelEnd ( )

• import

  public import ( unknown viewNameExpression , array params = null , ViewCacheControl viewCacheControl = null , Module module = null )

  param

  string|View viewName

  array params

• getImport

  public getImport ( unknown viewNameExpression , mixed params = null , ViewCacheControl viewCacheControl = null , Module module = null )

  param

  string|View viewName

  mixed params

• createImportView

  protected createImportView ( string viewNameExpression , array params = null , ViewCacheControl viewCacheControl = null , Module module = null )

• importContentView

  public importContentView ( )

• importPanel

  public importPanel ( string panelName )

  param

  string panelName

• out

  public out ( UiComponent|string contents )

  param

  UiComponent|string contents

• getOut

  public getOut ( UiComponent|string contents )

  param

  UiComponent|string contents

• delayedOut

  public delayedOut ( UiComponent|string contents )

  param

  UiComponent|string contents

• getMessages

  Message public getMessages ( string groupName = null , string severity = null , string translate = true )

  param

  string groupName

  string severity

  string translate

  return

  Message

• getDynamicTextCollection

  DynamicTextCollection public getDynamicTextCollection ( )

  return

  DynamicTextCollection

• setDynamicTextCollection

  public setDynamicTextCollection ( DynamicTextCollection dynamicTextCollection )

  param

  DynamicTextCollection

• getL10nText

  string public getL10nText ( unknown code , array args = null , unknown num = null , array replacements = null , unknown module = null )

  return

  string

• getL10nCurrency

  string public getL10nCurrency ( float value , string currency = null )

  param

  float value

  string currency The 3-letter ISO 4217 currency code indicating the currency to use.

  return

  string

• getL10nNumber

  public getL10nNumber ( unknown value , unknown style = \NumberFormatter )

• getL10nDate

  public getL10nDate ( DateTime value = null , unknown dateStyle = null , DateTimeZone timeZone = null )

• getL10nTime

  public getL10nTime ( DateTime value = null , unknown timeStyle = null , DateTimeZone timeZone = null )

• getL10nDateTime

  public getL10nDateTime ( DateTime value = null , unknown dateStyle = null , unknown timeStyle = null , DateTimeZone timeZone = null )

• getL10nDateTimeFormat

  public getL10nDateTimeFormat ( DateTime value = null , unknown icuPattern , DateTimeZone timeZone = null )

• buildUrl

  public buildUrl ( unknown murl , bool required = true )

• buildUrlStr

  public buildUrlStr ( unknown murl , bool required = true )

• view

  View public static view ( View view )

  param

  View

  return

  View

• request

  Request public static request ( View view )

  param

  View

  return

  Request

• response

  Response public static response ( View view )

  param

  View

  return

  Response

• httpContext

  HttpContext public static httpContext ( View view )

  param

  View

  return

  HttpContext