A

addCData() - Method in class other_package\SimpleXMLExtended

addCol() - Method in class hiGrid\hgGridRender

Add a column at the first or last position in the colModel and sets a certain properties to it

addUserData() - Method in class hiGrid\jqGrid

Add a custom data to the grid footer row if it is enabled.

array_extend() - Method in class hiGrid\hgGridcommon

"Extend" recursively array $a with array $b values (no deletion in $a, just added and updated values)

B

beginTransaction() - Method in class other_package\hiGridDB

bindValues() - Method in class other_package\hiGridDB

Bind the values for CRUD using the PDO bindValue.

buildSearch() - Method in class hiGrid\jqGrid

Build a search string from filter string posted from the grid Usually use this functio separatley

C

callGridMethod() - Method in class hiGrid\hgGridRender

Construct a code for execution of valid grid method.

checkPrimary() - Method in class hiGrid\hgGridEdit

Check for primary key and if not set try to obtain it Return true on success

closeCursor() - Method in class other_package\hiGridDB

columnCount() - Method in class other_package\hiGridDB

commit() - Method in class other_package\hiGridDB

convertVar() - Method in class higridCharts\higridCharts

D

date_parse() - Method in class hiGrid\hgGridcommon

Converts the string date to array by using the pattern generated by generatePattern() function

debugout() - Method in class hiGrid\jqGrid

Prints all executed SQL queries to file or console

decode() - Method in class hiGrid\hgGridcommon

Decodes json string to PHP array.

delete() - Method in class hiGrid\hgGridEdit

Delete the data into the database according the table element A primaryKey should be set.

deleteTreeNode() - Method in class hgTreeGrid\hgTreeGrid

Delete the data into the database according the table element and tree grid model.

destroy() - Method in class other_package\hgSession

Destroys the current session.

E

editGrid() - Method in class hiGrid\hgGridEdit

Perform the all CRUD operations depending on the oper param send from the grid and the table element If the primaryKey is not set we try to obtain it using hiGridDB::getPrimaryKey If the primary key is not set or can not be obtained the operation is aborted.

editTree() - Method in class hgTreeGrid\hgTreeGrid

Perform the all CRUD operations depending on the oper param send from the grid, the table element and the treegrid model If the primaryKey is not set we try to obtain it using hiGridDB::getPrimaryKey If the primary key is not set or can not be obtained the operation is aborted.

encode() - Method in class hiGrid\hgGridcommon

Encodes a PHP variable into javascript representation.

errorMessage() - Method in class other_package\hiGridDB

Discover primary key column(s) for this table.

execute() - Method in class other_package\hiGridDB

execute() - Method in class hiGrid\jqGrid

Executes a prepared sql statement.

exportToCsv() - Method in class hiGrid\jqGrid

Public method to export a grid data to csv data.

exportToExcel() - Method in class hiGrid\jqGrid

Export the recordset to excel xml file.

exportToPdf() - Method in class hiGrid\jqGrid

Export the recordset to pdf file.

F

fetch_assoc() - Method in class other_package\hiGridDB

fetch_num() - Method in class other_package\hiGridDB

fetch_object() - Method in class other_package\hiGridDB

G

generatePattern() - Method in class hiGrid\hgGridcommon

Internal function which generates regex pattern from date pattern

getChartOptions() - Method in class higridCharts\higridCharts

Return all the option for the Chart

getChildNodes() - Method in class hgTreeGrid\hgTreeGrid

Return all Child nodes for both methods.

getChildren() - Method in class hgTreeGrid\hgTreeGrid

Return the child nodes of a given node.

getColModel() - Method in class hiGrid\hgGridRender

Return the generated colModel

getColumnMeta() - Method in class other_package\hiGridDB

getDbDate() - Method in class hiGrid\jqGrid

Return the current date format used in the undelayed database

getDbTime() - Method in class hiGrid\jqGrid

Return the current datetime format used in the undelayed database

getFields() - Method in class hiGrid\hgGridEdit

Return the fields generated for CRUD operations

getGridOption() - Method in class hiGrid\hgGridRender

Return a jqGrid option specified by the key, false if the option can not be found.

getGridParams() - Method in class hiGrid\jqGrid

Return the associative array which contain the parameters that are sended from the grid to request, search, update delete data.

getInlineOptions() - Method in class hiGrid\hgGridRender

Return a array of the all events and options for the inline navigator

getInterface() - Method in class other_package\hiGridDB

getLastInsertId() - Method in class hiGrid\hgGridEdit

Return the last inserted id from the insert method in cas getLastInsert is set to true

getLeafNodes() - Method in class hgTreeGrid\hgTreeGrid

Return the leaf nodes when the adjacency model is used.

getOption() - Method in class other_package\hgCalendar

getOption() - Method in class hgAutocomplete\hgAutocomplete

Return the the requested option of the autocomplete

GetParam() - Method in class hiGrid\hgGridcommon

Return the value from POST or from GET

getPrimaryKey() - Method in class other_package\hiGridDB

Try to get the primary key of the table automattically

getPrimaryKeyId() - Method in class hiGrid\hgGridEdit

Return the primary key of the table

getRoots() - Method in class hgTreeGrid\hgTreeGrid

Return the root nodes when adjacency model.

getSqlElement() - Method in class hiGrid\jqGrid

Read a xml file and the higridSC and return the sql string Return string if the query is found false if not.

getSQLSerie() - Method in class higridCharts\higridCharts

Return a array representation of the sql query.

getStringForGroup() - Method in class hiGrid\jqGrid

Recursivley build the sql query from a json object

getTableConfig() - Method in class hgTreeGrid\hgTreeGrid

Return the curent configuration for the model used

getTreeModel() - Method in class hgTreeGrid\hgTreeGrid

Returns the currently used tree model

getUserDate() - Method in class hiGrid\jqGrid

Return the current date format used from the client

getUserTime() - Method in class hiGrid\jqGrid

Return the current datetime format used from the client

H

HCaS() - Method in class higridCharts\higridCharts

Add a data to the series with a given name.

HCoP() - Method in class higridCharts\higridCharts

Main method which construct the chart based on the options set with the previous methods

HCsCE() - Method in class higridCharts\higridCharts

Set event listeners for the chart.

HCsCO() - Method in class higridCharts\higridCharts

Options regarding the chart area and plot area as well as general chart options.

HCsE() - Method in class higridCharts\higridCharts

Set options for the Exporting module

HCsL() - Method in class higridCharts\higridCharts

Set the legend.

HCsPO() - Method in class higridCharts\higridCharts

Set the plot options for the chart.

HCsST() - Method in class higridCharts\higridCharts

Set the subtitle of the chart

HCsT() - Method in class higridCharts\higridCharts

Set the main title of the chart

HCsTT() - Method in class higridCharts\higridCharts

Set options for the tooltip that appears when the user hovers over a series or point

HCsX() - Method in class higridCharts\higridCharts

Set the X axis or category axis.

HCsY() - Method in class higridCharts\higridCharts

Set the Y axis or value axis.

hgAutocomplete() - Class in namespace hgAutocomplete

hgCalendar() - Class in namespace other_package

Description of hgCalendar

hgGridcommon() - Class in namespace hiGrid

hgGridEdit() - Class in namespace hiGrid

hgGridRender() - Class in namespace hiGrid

hgSession() - Class in namespace other_package

hgTemplate() - Class in namespace other_package

Simple template engine class (use [@tag] tags in your templates).

hgTreeGrid() - Class in namespace hgTreeGrid

higridCharts() - Class in namespace higridCharts

hiGridDB() - Class in namespace other_package

higridOP() - Method in class hiGrid\hgGridRender

Main method which do allmost everthing for the grid.

higridsCP() - Method in class hiGrid\hgGridRender

Set a new property in the constructed colModel Return true on success.

higridsGO() - Method in class hiGrid\hgGridRender

Set a grid option.

higridsNO() - Method in class hiGrid\hgGridRender

Set options in the navigator for the diffrent actions

higridtreedisplay() - Method in class hgTreeGrid\hgTreeGrid

Main method which do allmost everthing for the tree grid.

I

inlineNavEvent() - Method in class hiGrid\hgGridRender

Set a event for inline editing in particulear module

inlineNavOptions() - Method in class hiGrid\hgGridRender

Set a options for inline editing in particulear module

insert() - Method in class hiGrid\hgGridEdit

Insert the data array into the database according to the table element.

insertTreeNode() - Method in class hgTreeGrid\hgTreeGrid

Insert the data array into the database according to the table element and tree model.

isNotACQuery() - Method in class hgAutocomplete\hgAutocomplete

Check if the autocompleter is already created so that we can do various things like data export.

J

jqGrid() - Class in namespace hiGrid

L

lastInsertId() - Method in class other_package\hiGridDB

Return the last inserted id in a table in case when the serialKey is set to true

limit() - Method in class other_package\hiGridDB

logQuery() - Method in class hiGrid\jqGrid

Log query

M

merge() - Method in class other_package\hgTemplate

Merges the content from an array of templates and separates it with $separator.

MetaMysql() - Method in class other_package\hiGridDB

The meta types for MySQL database

MetaPgsql() - Method in class other_package\hiGridDB

The meta types for PostgreSQL database

MetaSqlite() - Method in class other_package\hiGridDB

The meta types for SQLite database

MetaSqlsrv() - Method in class other_package\hiGridDB

The meta types for SQLite database

MetaType() - Method in class other_package\hiGridDB

Return the meta type of the field based on the underlayng db

O

output() - Method in class other_package\hgTemplate

Outputs the content of the template, replacing the keys for its respective values.

P

parseDate() - Method in class hiGrid\hgGridcommon

Parses a $format and $date value and return the date formated via $newformat.

parseSql() - Method in class hiGrid\jqGrid

Prepares a $sqlElement and binds a parameters $params Return prepared sql statement

phpTojsDate() - Method in class hiGrid\hgGridcommon

Convert the php date string to Java Script date string

prepare() - Method in class other_package\hiGridDB

Q

query() - Method in class other_package\hiGridDB

queryAutocomplete() - Method in class hgAutocomplete\hgAutocomplete

Return the result for the autocomplete as PHP object.

queryForObject() - Method in class hiGrid\jqGrid

Return the object from the query

queryGrid() - Method in class hiGrid\jqGrid

Return the result of the query to jqGrid.

querySubGrid() - Method in class hiGrid\jqGrid

Return the result of the query for the simple subgrid The format depend of dataType variable

queryTree() - Method in class hgTreeGrid\hgTreeGrid

Return the result of the query to hgTreeGrid.

quote() - Method in class hiGrid\hgGridcommon

Quotes a javascript string.

R

renderAutocomplete() - Method in class hgAutocomplete\hgAutocomplete

Main method which do everthing for the autocomplete.

renderCalendar() - Method in class other_package\hgCalendar

rollBack() - Method in class other_package\hiGridDB

rs2excel() - Method in class hiGrid\jqGrid

From a given recordset returns excel xml file.

rs2pdf() - Method in class hiGrid\jqGrid

Convert a recordeset to pdf object

S

selectLimit() - Method in class hiGrid\jqGrid

Will select, getting rows from $offset (1-based), for $nrows.

sendErrorHeader() - Method in class hiGrid\jqGrid

Function to simulate 500 Internal error so that it sends the error to the client.

set() - Method in class other_package\hgTemplate

Sets a value for replacing a specific tag.

setAfterCrudAction() - Method in class hiGrid\hgGridEdit

Run a sql command(s) after the operation from the CRUD is succefull.

setAutocomplete() - Method in class hiGrid\hgGridRender

Construct autocompleter used in the grid.

setBeforeCrudAction() - Method in class hiGrid\hgGridEdit

Run a sql command(s) before the operation from the CRUD.

setButtonOptions() - Method in class hiGrid\hgGridRender

Set a various options for the buttons on the pager.

setColModel() - Method in class hiGrid\hgGridRender

Construct the column model of the grid.

setColors() - Method in class higridCharts\higridCharts

Set array containing the default colors for the chart's series.

setData() - Method in class hgTreeGrid\hgTreeGrid

Se the tree data for future processing

setDatepicker() - Method in class hiGrid\hgGridRender

Construct a pop up calender used in the grid.

setDbDate() - Method in class hiGrid\jqGrid

Set a new database date format using PHP convensions

setDbTime() - Method in class hiGrid\jqGrid

Set a new database datetime format using PHP convensions

setEvent() - Method in class hgAutocomplete\hgAutocomplete

Set a JavaScript event for the autocomplete.

setEvent() - Method in class other_package\hgCalendar

setFilterOptions() - Method in class hiGrid\hgGridRender

Set options for the tolbar filter when enabled

setGridEvent() - Method in class hiGrid\hgGridRender

Set a valid grid event

setGridParams() - Method in class hiGrid\jqGrid

Set a grid parameters to identify the action from the grid Note that these should be set in the grid - i.e the parameters from the grid should equal to the GridParams.

setJSCode() - Method in class hiGrid\hgGridRender

Put a javascript arbitrary code after all things are created.

setJSCode() - Method in class higridCharts\higridCharts

Put a javascript code after all things are created.

setLabels() - Method in class higridCharts\higridCharts

Set HTML labels that can be positioined anywhere in the chart area.

setLanguage() - Method in class higridCharts\higridCharts

Set a language object.

setLeafData() - Method in class hgTreeGrid\hgTreeGrid

Set a leaf nodes for adjacency model

setLength() - Method in class hgAutocomplete\hgAutocomplete

Set the limit of the requested data in case of SQL command

setLoading() - Method in class higridCharts\higridCharts

Set the loading options which control the appearance of the loading screen that covers the plot area on chart operations

setNavEvent() - Method in class hiGrid\hgGridRender

Set a event in the navigator or in the diffrent modules add,edit,del,view, search

setNavigation() - Method in class higridCharts\higridCharts

Set collection of options for buttons and menus appearing in the exporting module.

setOption() - Method in class hgAutocomplete\hgAutocomplete

Set the desired option for autocomplete.

setOption() - Method in class other_package\hgCalendar

setPdfOptions() - Method in class hiGrid\jqGrid

Set options for PDF export.

setPrimaryKeyId() - Method in class hiGrid\hgGridEdit

Set a primary key for the table

setSelect() - Method in class hiGrid\hgGridRender

Construct the select used in the grid.

setSeriesOption() - Method in class higridCharts\higridCharts

Set a various options for a serie.

setSource() - Method in class hgAutocomplete\hgAutocomplete

Set the source need for autocomlete to send a data.

setSubGrid() - Method in class hiGrid\hgGridRender

Prepares a executuion of a simple subgrid Return false if no name options for the subgrid.

setSubGridGrid() - Method in class hiGrid\hgGridRender

Prepares a subgrid in the grid expecting any valid html content provieded via the $suggridurl

setSuccessMsg() - Method in class hiGrid\hgGridEdit

Set the message which will be send to client side grid when succefull CRUD operation is performed.

setTable() - Method in class hiGrid\hgGridEdit

Set table for CRUD and build the fields

setTableConfig() - Method in class hgTreeGrid\hgTreeGrid

Set the configuration fields for the model used.

setTheme() - Method in class higridCharts\higridCharts

Set a theme - Can be grid, gray, dark-blue, dark-green

setTreeModel() - Method in class hgTreeGrid\hgTreeGrid

Set the tree mode used.

setUrl() - Method in class hiGrid\hgGridRender

Set a editing url.

setUserDate() - Method in class hiGrid\jqGrid

Set a new user date format using PHP convensions

setUserTime() - Method in class hiGrid\jqGrid

Set a new user datetime format using PHP convensions

SimpleXMLExtended() - Class in namespace other_package

sprintfn() - Method in class hiGrid\hgGridcommon

version of sprintf for cases where named arguments are desired (php syntax) with sprintf: sprintf('second: %2$s ; first: %1$s', '1st', '2nd'); with sprintfn: sprintfn('second: %second$s ; first: %first$s', array( 'first' => '1st', 'second'=> '2nd' ));

Strip() - Method in class hiGrid\hgGridcommon

Strip slashes from a varaible if PHP magic quotes are on

T

toXml() - Method in class hiGrid\hgGridcommon

Function for converting to an XML document.

U

update() - Method in class hiGrid\hgGridEdit

Update the data into the database according the table element A primaryKey should be set.

updateTreeNode() - Method in class hgTreeGrid\hgTreeGrid

Update the data into the database according the table element A primaryKey should be set.

This document was generated by Online PHP Grids & PHP Charts Last updated:2013-02-23