Class JsBaseEngineHelper

Properties summary

• $_callbackArguments protected
  array
  Contains a list of callback names -> default arguments.
• $_optionMap protected
  array

  Collection of option maps. Option maps allow other helpers to use generic names for engine callbacks and options. Allowing uniform code access for all engine types. Their use is optional for end user use though.

• $bufferedMethods public
  array

  An array of lowercase method names in the Engine that are buffered unless otherwise disabled. This allows specific 'end point' methods to be automatically buffered by the JsHelper.

• $selection public
  string
  The js snippet for the current selection.

Method Summary

• _mapOptions() protected

  Maps Abstract options to engine specific option names. If attributes are missing from the map, they are not changed.

• _parseOptions() protected

  Parse an options assoc array into an Javascript object literal. Similar to object() but treats any non-integer value as a string, does not include { }

• _prepareCallbacks() protected

  Prepare callbacks and wrap them with function ([args]) { } as defined in _callbackArgs array.

• _processOptions() protected

  Convenience wrapper method for all common option processing steps. Runs _mapOptions, _prepareCallbacks, and _parseOptions in order.

• _toQuerystring() protected

  Convert an array of data into a query string

• _utf8ToHex() protected

  Encode a string into JSON. Converts and escapes necessary characters.

• alert() public

  Create an alert() message in Javascript

• confirm() public

  Create a confirm() message

• confirmReturn() public

  Generate a confirm snippet that returns false from the current function scope.

• domReady() abstract public

  Create a domReady event. This is a special event in many libraries

• drag() abstract public

  Create a draggable element. Works on the currently selected element. Additional options may be supported by the library implementation.

• drop() abstract public

  Create a droppable element. Allows for draggable elements to be dropped on it. Additional options may be supported by the library implementation.

• each() abstract public

  Create an iteration over the current selection result.

• effect() abstract public

  Trigger an Effect.

• escape() public

  Escape a string to be JSON friendly.

• event() abstract public

  Add an event to the script cache. Operates on the currently selected elements.

• get() abstract public

  Create javascript selector for a CSS rule

• object() public

  Generates a JavaScript object in JavaScript Object Notation (JSON) from an array. Will use native JSON encode method if available, and $useNative == true

• prompt() public

  Create a prompt() Javascript function

• redirect() public

  Redirects to a URL. Creates a window.location modification snippet that can be used to trigger 'redirects' from Javascript.

• request() abstract public

  Make an XHR request

• serializeForm() abstract public

  Serialize the form attached to $selector. Pass true for $isForm if the current selection is a form element. Converts the form or the form element attached to the current selection into a string/json object (depending on the library implementation) for use with XHR operations.

• slider() abstract public

  Create a slider UI widget. Comprised of a track and knob. Additional options may be supported by the library implementation.

• sortable() abstract public

  Create a sortable element. Additional options may be supported by the library implementation.

• value() public

  Converts a PHP-native variable of any type to a JSON-equivalent representation

Method Detail