\ZenFlow

Just dynamic content update abstraction layer

Synopsis

class ZenFlow {

• // constants
• const ROUTE_ZENFLOW = 'zenflow';
• // members
• protected integer $timeout = 3000;
• protected string $flowId = '';
• protected string $content = '';
• protected bool $debug = false;
• protected string $soundOnChange = '';
• protected bool $containerSpanType = false;
• // methods
• public void __construct()
• protected void setFlowId()
• protected void setTimeout()
• public void setDebug()
• public void setContainerSpanType()
• public void setSoundOnChange()
• protected void setContent()
• public string render()
• protected bool listener()
}


Constants

Name	Value
ROUTE_ZENFLOW	'zenflow'

Members

protected

• $containerSpanType — bool
  AJAX Container span type flag
• $content — string
  Content string to render in container area
• $debug — bool
  Debug flag
• $flowId — string
  Contains current zen-flow ID string
• $soundOnChange — string
  Contains sound path to be played if content updates
• $timeout — int
  Container refresh timeout in ms.

Methods

protected

• listener() — Listens for some flow callback, checks is this current instance flow and renders content.
• setContent() — Puts content data from constructor into protected property.
• setFlowId() — Sets current instance flow ID
• setTimeout() — Sets instance refresh rate in ms.

public

• __construct() — Creates new Zen-flow instance
• render() — Renders initial zen-container with some prefilled content.
• setContainerSpanType() — Sets AJAX Container type div (false) or span (true)
• setDebug() — Sets the debug state. Enables debug timestamp output on content update.
• setSoundOnChange() — Set sound file path to be played on content updates