APIHelper is a class designed to simplify the sharing of data between applications. More...

Public Member Functions
	__construct ($class, $searchFilter=null, $outputFilter=null, $constraints="")
	Creates an APIHelper for the specified class. More...

	query ()
	Process an API query. More...

	registerFormat ($name, $formatter)
	Register a format and its associated formatter. More...

Public Attributes
	$class

	$constraints

	$searchFilter

	$outputFilter

	$format = "json"

	$formatterMap = array()

Detailed Description

APIHelper is a class designed to simplify the sharing of data between applications.

It allows you to very quickly implement a RESTful web service that queries a given DataItem class and return the results in many different formats. Output formatting is extensible, but by default supports JSON, XML (in the canonical Fakoli format), Excel and CSV for all objects.

You can provide search and output filters to be applied to your queries, as well as standard constraints as need. Finally, you can easily provide templated output rendering using the easy-to-use template formatter, and full custom output rendering by implementing your own APIFormatter.

Author: andy

Definition at line 232 of file api_helper.inc.

Constructor & Destructor Documentation

◆ __construct()

APIHelper::__construct	(	$class,
		$searchFilter = `null`,
		$outputFilter = `null`,
		$constraints = `""`
	)

Creates an APIHelper for the specified class.

Parameters

string	$class	the class name for the DataItem class
Filter	$searchFilter	(optional) InclusionFilter or ExclusionFilter limiting the search fields
Filter	$outputFilter	(optional) InclusionFilter or ExclusionFilter limiting the output fields
string	$constraints	(optional) standard SQL constraint to apply to all queries

Definition at line 248 of file api_helper.inc.

      {
           $this->class = $class;
           $this->searchFilter = $searchFilter;
           $this->outputFilter = $outputFilter;
           $this->constraints = $constraints;
           $this->format = isset($_GET["_format"]) ? $_GET["_format"] : "json";
           
           $this->registerFormat("json", new APIJSONFormatter());
           $this->registerFormat("xml", new APICanonicalXMLFormatter());
           $this->registerFormat("excel", new APIExcelFormatter());
           $this->registerFormat("csv", new APICSVFormatter());
      }

Member Function Documentation

◆ query()

APIHelper::query ( )

Process an API query.

Exceptions

FakoliException

Definition at line 266 of file api_helper.inc.

      {
           $target = new $this->class;
           $target->filter = $this->searchFilter;
           
           $parameters = new SearchParameters($target);
           $parameters->fromGET();
           
           $constraints = (Sconstraints) ? $constraints : "WHERE 1=1 ";
           
           $query = $parameters->generateConstraint();
           
           $results = Query::create($this->class, $query)
                               ->filter($this->outputFilter)
                               ->execute();
           
           if (!array_key_exists($this->format, $this->formatterMap))
           {
                throw new FakoliException("Unknown format");
           }
  
           return $this->formatterMap[$this->format]->format($results);
      }

◆ registerFormat()

APIHelper::registerFormat	(	$name,
		$formatter
	)

Register a format and its associated formatter.

Parameters

string	$name	the name of the format.
APIFormatter	$formatter	the formatter object that will handle requests in this format.

Definition at line 296 of file api_helper.inc.

      {
           $formatter->parent = $this;
           $this->formatterMap[$name] = $formatter;
      }

Member Data Documentation

◆ $class

APIHelper::$class

Definition at line 234 of file api_helper.inc.

◆ $constraints

APIHelper::$constraints

Definition at line 235 of file api_helper.inc.

◆ $format

APIHelper::$format = "json"

Definition at line 238 of file api_helper.inc.

◆ $formatterMap

APIHelper::$formatterMap = array()

Definition at line 239 of file api_helper.inc.

◆ $outputFilter

APIHelper::$outputFilter

Definition at line 237 of file api_helper.inc.

◆ $searchFilter

APIHelper::$searchFilter

Definition at line 236 of file api_helper.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/api_helper.inc

Public Member Functions

Public Attributes