Existing Users

Documentation

PHP Client Package / Return Types

Module Object - Services_BistyBox_Module

Methods

  • string getAttribute( ) - Returns a attribute for the module
  • array getItems( ) - Returns an array of Item Objects (Services_BistyBox_Item)
  • object getItemById( int $id ) - Returns a Item Object for the given $id
  • object getItemByKey( string $key ) - Returns a Item Object for the give $key
  • object getFirstItem() - Returns the first item in the module
  • object getItemAtIndex( int $index ) - Returns the item at the given $index
  • mixed getField( string $fieldName, [ int $index ] ) - returns a field from the item at $index (first item by default)
  • bool isLastPage() - returns true if the current set of items is the results last page of items in the module
  • bool isFirstPage() - returns true if the current set of items is the first results page of items in the module
  • int nextPage() - returns the next page results number; returns false isLastPage() == true
  • int previousPage() - returns the previous results page number; returns false isFirstPage == true

Properties

  • object raw - SimpleXML object that represents the API response
  • int id - Id of the Module
  • string key - KeyId of the Module
  • string type - Type of the Module
  • int numOfItems - number of items within the module
  • int numOfPages - number of result pages of items within the module
  • int numPerPage - number of items per results page
  • int onPage - current results page

Item Object - Services_BistyBox_Item

Methods

  • array of Field Objects getFields( [string $type] ) - Returns an array of Field Objects. If $type is given, will return items of only that type
  • mixed getField( string $name, [bool $returnValue] ) - Returns the field bu $name. By default a Field Object is returned. Set $returnValue = true to return the field value

Properties

  • object raw - SimpleXML object that represents the API response
  • int id - Id of the Item
  • string key - KeyId of the Item

Field Object - Services_BistyBox_Field

Methods

  • string resize($x,$y) - If $type = 'image', will return a new image of $x,$y proportions.

Properties

  • object raw - SimpleXML object that represents the API response
  • string name - Name of the field
  • string value - Value of the field
  • string type - Type of the field

About BitsyBox

BitsyBox is a hosted content storage platform that offers two products that work in perfect harmony. The first is an easy-to-use web interface that lets site owners edit and update their content. The second is a robust API for developers to quickly access that content from their website or application code.

Resources

We've fully documented BitsyBox to make it easy -- so easy in fact, we guarantee you can integrate a new or existing website in just a few minutes. More Support

Screencasts

Check out our library of streaming videos, professionally produced to help guide you through your integration with BitsyBox.
View Screencasts

© Copyright 2009 BitsyBox LLC - Terms of Service - Privacy - Service Status