Referencia de la Clase KumbiaRest

Diagrama de herencias de KumbiaRest

Métodos públicos
	__construct ($module, $controller, $action, $parameters)
Métodos públicos heredados desde Controller
	__construct ($module, $controller, $action, $parameters)
	k_callback ($init=FALSE)

Métodos públicos estáticos
static	accept ()

Métodos protegidos
	initREST ()
	actionExist ($name)
	param ()
	setCode ($num)
Métodos protegidos heredados desde Controller
	before_filter ()
	after_filter ()
	initialize ()
	finalize ()

Métodos protegidos estáticos
static	parseJSON ($input)
static	parseXML ($input)
static	parseCSV ($input)
static	parseForm ($input)

Atributos protegidos
	$_fInput = null
	$_inputType
	$_fOutput = null
	$_outputType

Otros miembros heredados
Campos de datos heredados desde Controller
	$module_name
	$controller_name
	$action_name
	$parameters
	$limit_params = TRUE
	$scaffold

Descripción detallada

Definición en la línea 17 del archivo kumbia_rest.php.

Documentación del constructor y destructor

__construct	(		$module,
			$controller,
			$action,
			$parameters
	)

Definición en la línea 58 del archivo kumbia_rest.php.

Documentación de las funciones miembro

static accept ( )

static

Retorna los formato aceptados por el cliente ordenados por prioridad interpretando la cabecera HTTP_ACCEPT y

Devuelve

array

Definición en la línea 196 del archivo kumbia_rest.php.

actionExist (   $name)

protected

Verifica si existe la acción $name existe

Parámetros

string

$name

nombre de la acción

Devuelve

boolean

Definición en la línea 106 del archivo kumbia_rest.php.

initREST ( )

protected

Hacer el router de la petición y envia los parametros correspondientes a la acción, adema captura formatos de entrada y salida

reescribimos la acción a ejecutar, ahora tendra será el metodo de la peticion: get(:id), getAll , put, post, delete, etc.

Definición en la línea 67 del archivo kumbia_rest.php.

param ( )

protected

Retorna los parametros de la petición el función del formato de entrada de los mismos. Hace uso de los parser definidos en la clase

Definición en la línea 118 del archivo kumbia_rest.php.

static parseCSV (   $input)

staticprotected

Parse CSV

Convierte CSV en arrays numéricos, cada item es una linea

Parámetros

string

$input

Devuelve

array

Definición en la línea 259 del archivo kumbia_rest.php.

static parseForm (   $input)

staticprotected

Realiza la conversion de formato de Formulario a array

Parámetros

string

$input

Devuelve

arrat

Definición en la línea 277 del archivo kumbia_rest.php.

static parseJSON (   $input)

staticprotected

Parse JSON Convierte formato JSON en array asociativo

Parámetros

string

$input

Devuelve

array|string

Definición en la línea 221 del archivo kumbia_rest.php.

static parseXML (   $input)

staticprotected

Parse XML

Convierte formato XML en un objeto, esto será necesario volverlo estandar si se devuelven objetos o arrays asociativos

Parámetros

string

$input

Devuelve

|string

Definición en la línea 239 del archivo kumbia_rest.php.

setCode (   $num)

protected

Envia el codigo de respuesta $num al cliente

Parámetros

int

$num

Definición en la línea 135 del archivo kumbia_rest.php.

Documentación de los campos

$_fInput = null

protected

Definición en la línea 24 del archivo kumbia_rest.php.

$_fOutput = null

protected

Definición en la línea 44 del archivo kumbia_rest.php.

$_inputType

protected

Valor inicial:

= array(
        'application/json' => array('RestController', 'parseJSON'),
        'application/xml' => array('RestController', 'parseXML'),
        'text/xml' => array('RestController', 'parseXML'),
        'text/csv' => array('RestController', 'parseCSV'),
        'application/x-www-form-urlencoded' => array('RestController', 'parseForm'),
    )

Permite definir parser personalizados por MIME TYPE Esto es necesario para interpretar las entradas Se define como un MIME type como clave y el valor debe ser un callback que devuelva los datos interpretado

Definición en la línea 32 del archivo kumbia_rest.php.

$_outputType

protected

Valor inicial:

= array(
        'application/json' => 'json',
        'application/xml' => 'xml',
        'text/xml' => 'xml',
        'text/csv' => 'csv',
    )

Permite definir las salidas disponibles, de esta manera se puede presentar la misma salida en distintos formatos a requerimientos del cliente

Definición en la línea 51 del archivo kumbia_rest.php.

---

La documentación para esta clase fue generada a partir del siguiente fichero:

• /home/joan/git/KumbiaPHP/core/kumbia/kumbia_rest.php