TSLRequestConstraints
in
Esta clase define los constraints que pueden usarse para acceder a un query en la base de datos , define al menos los minimos conocidos pudiendo agregarse mas los cuales seran de interpretacion por las clases.
Por ahora solo acepta busqueda parcial o exacta, soporta ademas multiples campos con diferentes tipos de busqueda cada una.
Table of Contents
| $_FILTER_EXACT | ||
|---|---|---|
| $_FILTER_PARTIAL | ||
| $_FILTER_GREATERTHAN | ||
| $_FILTER_LESSTHAN | ||
| $_FILTER_GREATEROREQUAL | ||
| $_FILTER_LESSOREQUAL | ||
| $currentPage | ||
| $recordsPerPage | ||
| $startRow | ||
| $endRow | ||
| $sortFields | ||
| $listFields | ||
| $filterFields | ||
| $otherParams | ||
| getCurrentPage() | Retorna el numero actual de pagina a procesar, habitualmente para solicitudes de listas paginadas. | int |
| setCurrentPage() | Setea el numero de pagina a procesar. | void |
| getRecordsPerPage() | Retorna el numero de registros a devolver por pagina, habitualmente para el paginado de listas. | int |
| setRecordsPerPage() | Setea el numero de registros a devolver por pagina, habitualmente para el paginado de listas. | void |
| getSortFields() | Retorna un arreglo con los campos a usarse en el sort se usara el orden de entrada al arreglo. | array |
| setSortFields() | Se envia un arreglo de los campos a usarse para el sort. | void |
| getListFields() | Retorna un arreglo con los campos listarse en el select. | array |
| setListFields() | Se envia un arreglo con la lista de campos a usarse en el select. | void |
| addParameter() | Agrega un parametro a usarse por el query estos seran interpretados por contexto. | void |
| getParameter() | Retorna el valor de un parametro , si no esta definido retorna null. | mixed |
| getStartRow() | Retorna la primera fila dentro del resulset total que se tomara en cuenta, usado para paginacion. | int |
| setStartRow() | Setea la primera fila dentro del resulset total que se tomara en cuenta, usado para paginacion | void |
| getEndRow() | Retorna la ultima fila dentro del resulset total que se tomara en cuenta, usado para paginacion. | int |
| setEndRow() | Setea la ultima fila dentro del resulset total que se tomara en cuenta, usado para paginacion. | void |
| getFilterFields() | Retorna un arreglo con los campos a usarse en filtro para el where. | array |
| setFilterFields() | Se envia un arreglo de los campos a usarse para filtro del where. | void |
| getFilterField() | Retorna un camo de filtro basado en su nombre, de no existir retorna NULL. | mixed |
| removeFilterField() | Elimina un campo de filtro , esto es util cuando el campo es usado no en el filtro , por lo que se captura y elimina para que posteriormente el filtro no lo use. | void |
| addSortField() | Agrega un campo de sort a la lista a usarse | void |
| addListField() | Agrega un campo a la lista de campos que conforma el select | mixed |
| getSortFieldsAsString() | Devuelve una lista de los campos de sorteo separada por comas incluyendo la direccion del sort. | string|null |
| getListFieldsAsString() | Devuelve una lista de los campos a recoger en el select deparados por comas | string |
| getFilterFieldsAsString() | Devuelve un string adecuado para el where basado en los constraints y si el filtro es exacto o parcial enn cuyo caso se usara like. | string |
| addFilterField() | Agrega un campo de filtro a la lista a usarse | void |
Properties
$_FILTER_EXACT
private
static mixed
$_FILTER_EXACT
= 'exact'
$_FILTER_PARTIAL
private
static mixed
$_FILTER_PARTIAL
= 'partial'
$_FILTER_GREATERTHAN
private
static mixed
$_FILTER_GREATERTHAN
= 'greaterThan'
$_FILTER_LESSTHAN
private
static mixed
$_FILTER_LESSTHAN
= 'lessThan'
$_FILTER_GREATEROREQUAL
private
static mixed
$_FILTER_GREATEROREQUAL
= 'greaterOrEqual'
$_FILTER_LESSOREQUAL
private
static mixed
$_FILTER_LESSOREQUAL
= 'lessOrEqual'
$currentPage
private
mixed
$currentPage
= -1
$recordsPerPage
private
mixed
$recordsPerPage
= -1
$startRow
private
mixed
$startRow
= ""
$endRow
private
mixed
$endRow
= ""
$sortFields
private
mixed
$sortFields
= \null
$listFields
private
mixed
$listFields
= \null
$filterFields
private
mixed
$filterFields
= \null
$otherParams
private
mixed
$otherParams
= \null
Methods
getCurrentPage()
Retorna el numero actual de pagina a procesar, habitualmente para solicitudes de listas paginadas.
public
getCurrentPage(
)
: int
Return values
int —con el numero actual de pagina a leer
setCurrentPage()
Setea el numero de pagina a procesar.
public
setCurrentPage(
$currentPage :
int
)
: void
Parameters
- $currentPage : int
getRecordsPerPage()
Retorna el numero de registros a devolver por pagina, habitualmente para el paginado de listas.
public
getRecordsPerPage(
)
: int
Return values
int —el numero de registros x pagina.
setRecordsPerPage()
Setea el numero de registros a devolver por pagina, habitualmente para el paginado de listas.
public
setRecordsPerPage(
$recordsPerPage :
int
)
: void
Parameters
- $recordsPerPage : int
getSortFields()
Retorna un arreglo con los campos a usarse en el sort se usara el orden de entrada al arreglo.
public
getSortFields(
)
: array
Return values
array —con la lista de campos a uasrse en el sorteo, esta lista es un par definido por el nombre del campo y el orden del sort.
setSortFields()
Se envia un arreglo de los campos a usarse para el sort.
public
setSortFields(
$sortFields :
array
)
: void
Parameters
- $sortFields : array
arreglo compuesto por pares del nombre del campo y la direccion del sort, la cual puede ser 'ASC' o 'DESC'.
getListFields()
Retorna un arreglo con los campos listarse en el select.
public
getListFields(
)
: array
Return values
array —con la lista de campos.
setListFields()
Se envia un arreglo con la lista de campos a usarse en el select.
public
setListFields(
$listFields :
array
)
: void
Parameters
- $listFields : array
addParameter()
Agrega un parametro a usarse por el query estos seran interpretados por contexto.
public
addParameter(
$parameterName :
string
, $value :
mixed
)
: void
Parameters
- $parameterName : string
nombre del parametro
- $value : mixed
valor del parametro.
getParameter()
Retorna el valor de un parametro , si no esta definido retorna null.
public
getParameter(
$parameterName :
string
)
: mixed
Parameters
- $parameterName : string
nombnre del parametor
Return values
mixed —valor del parametro o null si no existe.
getStartRow()
Retorna la primera fila dentro del resulset total que se tomara en cuenta, usado para paginacion.
public
getStartRow(
)
: int
Return values
intsetStartRow()
Setea la primera fila dentro del resulset total que se tomara en cuenta, usado para paginacion
public
setStartRow(
$startRow :
int
)
: void
Parameters
- $startRow : int
el numero de fila
getEndRow()
Retorna la ultima fila dentro del resulset total que se tomara en cuenta, usado para paginacion.
public
getEndRow(
)
: int
Return values
intsetEndRow()
Setea la ultima fila dentro del resulset total que se tomara en cuenta, usado para paginacion.
public
setEndRow(
$endRow :
int
)
: void
Parameters
- $endRow : int
el numero de fila
getFilterFields()
Retorna un arreglo con los campos a usarse en filtro para el where.
public
getFilterFields(
)
: array
Return values
array —con la lista de campos a : void uasrse en el filtro.
setFilterFields()
Se envia un arreglo de los campos a usarse para filtro del where.
public
setFilterFields(
$filterFields :
array
)
: void
Parameters
- $filterFields : array
getFilterField()
Retorna un camo de filtro basado en su nombre, de no existir retorna NULL.
public
getFilterField(
$fieldName :
string
)
: mixed
Esta funcion es util cuando se necesitan los campos para ser usados fuera del filtro.
Parameters
- $fieldName : string
nombre del campo.
Return values
mixed —con el valor del campo de filtro.
removeFilterField()
Elimina un campo de filtro , esto es util cuando el campo es usado no en el filtro , por lo que se captura y elimina para que posteriormente el filtro no lo use.
public
removeFilterField(
$fieldName :
string
)
: void
Parameters
- $fieldName : string
con el nombre del campo
addSortField()
Agrega un campo de sort a la lista a usarse
public
addSortField(
$sortField :
string
, $direction :
string
)
: void
Parameters
- $sortField : string
nonbre del campo
- $direction : string
ASC o DESC , si no esta definido sera ASC
addListField()
Agrega un campo a la lista de campos que conforma el select
public
addListField(
$listField :
string
)
: mixed
Parameters
- $listField : string
momnbre del campo a agregar
Return values
mixedgetSortFieldsAsString()
Devuelve una lista de los campos de sorteo separada por comas incluyendo la direccion del sort.
public
getSortFieldsAsString(
)
: string|null
Return values
string|nullgetListFieldsAsString()
Devuelve una lista de los campos a recoger en el select deparados por comas
public
getListFieldsAsString(
)
: string
Return values
stringgetFilterFieldsAsString()
Devuelve un string adecuado para el where basado en los constraints y si el filtro es exacto o parcial enn cuyo caso se usara like.
public
getFilterFieldsAsString(
)
: string
Esta funcion en esta primera version solo soporta el operador "and" de ser necesario se implementara otros casos
Return values
stringaddFilterField()
Agrega un campo de filtro a la lista a usarse
public
addFilterField(
$filterField :
string
, $filterValue :
mixed
[, $typeFilter :
string
= 'exact' ]
)
: void
Parameters
- $filterField : string
nomnbre del campo
- $filterValue : mixed
valor del campo
- $typeFilter : string = 'exact'
exact - exacto
substring - parcial