n2n Page Rocket 1 API

­Html­Ui­Payload

All Implemented Interfaces:

• Payload

Methods summary

Methods in detail

• __construct

  public __construct ( unknown uiComponent )

• getBufferedContents

  string public getBufferedContents ( )
  Returns the buffered content of this response object. See Payload::isBufferable() for more information.

  see

  BufferedPayload

  return

  string

  throws

  IllegalStateException if Payload returns false.
  Specified: Payload
  Overrides: Payload::getBufferedContents()

• prepareForResponse

  public prepareForResponse ( Response response )

  This method gets called before the respone object is flushed to the client and is supposed to make necessary
  changes to the http header of the Response (e.g. Content-Type).
  
  Example implementation:
  
  	public function prepareForResponse(Response $response) {@
  		$response->setHeader('Content-Type: text/html; charset=utf-8');
  	
  

  see

  Payload::prepareForResponse()

  param

  Response
  Specified: Payload
  Overrides: Payload::prepareForResponse()

• toKownPayloadString

  string public toKownPayloadString ( )
  Returns a string which describes this object. This string is mainly used to be displayed in error messages.

  see

  Payload::toKownPayloadString()

  return

  string
  Specified: Payload
  Overrides: Payload::toKownPayloadString()