Cisco XML Framework Documentation

With the start of 2011 came the official release of the ‘CiscoIPPhone‘ PHP Framework. The framework is aimed at simplifying the creation and manipulation of the various Cisco XML service objects. Additions and updates are already in the works for the next release version of the framework. The following documentation will be kept as up to date as possible as the framework evolves and updates are issued. For more information and documentation on the use of the XML service objects with Cisco Systems, see www.cisco.com.

OBJECT CLASSES:

CiscoXMLService

CiscoIPPhoneMenu
CiscoIPPhoneText
CiscoIPPhoneInput
CiscoIPPhoneDirectory
CiscoIPPhoneImageFile
CiscoIPPhoneGraphicFileMenu
CiscoIPPhoneIconFileMenu
CiscoIPPhoneExecute

* NOTE: not all XML objects are included in the framework as they are not yet supported.

FUNCTION REFERENCE:

CiscoXMLService (abstract)

The base class for all Cisco XML service objects. This is an abstract superclass object only and contains global object functionality. Methods available to CiscoXMLService are inherently available to all other Cisco XML service object classes.

• addSoftKey($name, $url, $position)
  Insert a custom softkey for the current service object pointing to $url in at slot $position and with the button titled $name.
• applyXSLT($file)
  Returns the output of the service object after the XSLT stylesheet $file has been applied.
• toXML()
  Returns the formatted XML output of the current service object. All subclasses implement a custom override method for of this and call this parent method to render any associated softkeys to the object.

CiscoIPPhoneMenu

• __construct()
  Creates new instance of CiscoIPPhoneMenu.
• setTitle($title)
  Specify a title for the current menu.
• setPrompt($prompt)
  Add a prompt message to the current menu.
• addItem($name, $url)
  Adds a new menu item to the current menu point to $url and identified by $name.
• toXML()
  Returns formatted XML for the current menu.

CiscoIPPhoneText

• __construct()
  Creates a new instance of CiscoIPPhoneText.
• setTitle($title)
  Specify a title for the current text block.
• setPrompt($prompt)
  Add a prompt message to the current text block.
• setText($text)
  Insert block of ASCII, $text, into the text object.
• toXML()
  Returns formatted XML for the text object.

CiscoIPPhoneInput

• __construct()
  Creates a new isntance of CiscoIPPhoneInput.
• setTitle($title)
  Specify a title for the current input object.
• setPrompt($prompt)
  Add a prompt message to the input object.
• setURL($url)
  Assign $url as the location to pass the information requested by the input object.
• addItem($name, $param, $default = “”, $mask = “A”)
  Insert an input field into the current input object. The new item will be labelled $name and the value passed with the name $param. A default value can be specified by provided $default. An input mask can be applied by providing $mask as well (see Cisco documentation for valid input mask values).
• toXML()
  Returns formatted XML for the input object.

CiscoIPPhoneDirectory

• __construct()
  Creates a new instance of CiscoIPPhoneDirectory.
• setTitle($title)
  Specify a title for the directory object.
• setPrompt($prompt)
  Add a prompt message to the directory object.
• addItem($name, $number)
  Insert a new directory entry identifed by $name and with a telephone number of $number. If directory entry with the same $name and $number already exists, the item will NOT be added.
• toXML()
  Returns formatted XML for the directory object.

CiscoIPPhoneImageFile

• __construct()
  Creates a new instance of CiscoIPPhoneImageFile.
• setTitle($title)
  Specify a title for the image display object.
• setPrompt($prompt)
  Add a prompt message to the image display object.
• setImageURL($url)
  Specify the location, $url, of the image to display.
• setPosition($x, $y)
  Provide a point of origin for the image display. The top-left corner of the image will be anchored to point ($x, $y) on the services display panel.
• toXML()
  Returns formatted XML for the directory object.

CiscoIPPhoneGraphicFileMenu

• __construct()
  Creates a new instance of CiscoIPPhoneGraphicFileMenu.
• setTitle($title)
  Specify a title for the graphical menu object.
• setPrompt($prompt)
  Add a prompt message to the graphical menu object.
• setImageURL($url)
  Specify the location, $url, of the image file to display as the graphical menu.
• setPosition($x, $y)
  Provide a point of origin for the image display. The top-left corner of the image will be anchored to point ($x, $y) on the services display panel.
• addItem($name, $url, $area)
  Add a menu item to the graphical menu object. The $name provided is merely a placeholder and will not be displayed, common practice is to use the title of the current graphical menu object. The menu item will direct the user to $url when selected. The menu item will be selectable by touching the screen area defined by $area, an array of four integers. The first two integers are X1 and Y1; the top left corner of the touch area. The second two integers are X2 and Y2; the bottom right corner of the touch area for the menu item being added.
• toXML()
  Returns formatted XML for the directory object.

CiscoIPPhoneIconFileMenu

• __construct()
  Creates a new instance of CiscoIPPhoneIconFileMenu.
• setTitle($title)
  Specify a title for the icon menu object.
• setPrompt($prompt)
  Add a prompt message to the icon menu object.
• addIcon($url, $index)
  Add an icon item to the icon menu object. The location of the icon image is given by $url. Each icon must also be provided an $index value between 0 and 9. Icon indices are used to associate menu items to icon items.
• addItem($name, $url, $icon)
  Add a menu item to the icon menu object. The menu item will be identified by $name, and direct users to $url when selected. The menu item will display the icon associated to icon item $index.
• toXML()
  Returns formatted XML for the directory object.

CiscoIPPhoneExecute

• __construct()
  Creates a new instance of CiscoIPPhoneExecute.
• addItem($url, $priority = 0)
  Adds an item to be executed by the destined Cisco device. The device will attempt to execute $url and return response codes based on the success or failure of the execution. If a $priority value is not specified, 0 is used to cause the execution to happen immediately. See Cisco documentation for valid priority values.
• toXML()
  Returns formatted XML for the directory object.

The most recent version of the CiscoIPPhone Framework is available at http://www.minded.ca/default/2010-12-29/cisco-xml-services-framework/.