phpDocumentor
[ all elements ]

Index of All Elements

Package Indexes


[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ x ] [ _ ]

a

a

$add
in file jqGrid.php, variable jqGridEdit::$add
    Enables/disables adding of record into the table
$addOptions
in file jqGrid.php, variable jqGridRender::$addOptions
    Default add form dialog options
$ajaxtype
in file jqAutocomplete.php, variable jqAutocomplete::$ajaxtype
    Determines the ajax type made to the server. Defaut is GET. Can be a POST
$aoptions
in file jqAutocomplete.php, variable jqAutocomplete::$aoptions
    Stores the default options for the autocomplete
addCData
in file jqGrid.php, method SimpleXMLExtended::addCData()
addCol
in file jqGrid.php, method jqGridRender::addCol()
    Add a column at the first or last position in the colModel and sets a certain
addUserData
in file jqGrid.php, method jqGrid::addUserData()
    Add a custom data to the grid footer row if it is enabled.
array_extend
in file jqGrid.php, method jqGridUtils::array_extend()
    "Extend" recursively array $a with array $b values (no deletion in $a, just added and updated values)
b

b

$buildfields
in file jqGrid.php, variable jqGridEdit::$buildfields
    Tell the class if the fields should be get from the query.
$buttonIcon
in file jqCalendar.php, variable jqCalendar::$buttonIcon
$buttonOnly
in file jqCalendar.php, variable jqCalendar::$buttonOnly
c

c

$cache
in file jqAutocomplete.php, variable jqAutocomplete::$cache
    When set to true enables client side caching of the results.
$cachearray
in file jqAutocomplete.php, variable jqAutocomplete::$cachearray
    Defines the uniquie cheche array (used in java script) when a cache is enabled.
$cacheCount
in file jqGrid.php, variable jqGrid::$cacheCount
$colModel
in file jqGrid.php, variable jqGridRender::$colModel
    Holds the colModel for the grid. Can be passed as param or created
$conn
in file jqAutocomplete.php, variable jqAutocomplete::$conn
    Stores the database connection
$coptions
in file jqCalendar.php, variable jqCalendar::$coptions
$customClass
in file jqGrid.php, variable jqGrid::$customClass
    Custom call can be used again with custom function customFunc. We can call
$customCode
in file jqGrid.php, variable jqGridRender::$customCode
    Custom java script code which is set after creation of the grid
$customFunc
in file jqGrid.php, variable jqGrid::$customFunc
    Custom function which can be called to modify the grid output. Parameters
callGridMethod
in file jqGrid.php, method jqGridRender::callGridMethod()
    Construct a code for execution of valid grid method. This code is putted
d

d

$dataType
in file jqGrid.php, variable jqGrid::$dataType
    The output format for the grid. Can be json or xml
$datearray
in file jqGrid.php, variable jqGrid::$datearray
    Store the names which are dates. The name should correspond of the name
$dbdateformat
in file jqGrid.php, variable jqGrid::$dbdateformat
    Date format accepted in the database. See getDbDate
$dbtimeformat
in file jqGrid.php, variable jqGrid::$dbtimeformat
    Datetime format accepted in the database. See getDbTime
$dbtype
in file jqGrid.php, variable jqGrid::$dbtype
    This is detected automatically from the passed connection. Used to
$dbtype
in file jqAutocomplete.php, variable jqAutocomplete::$dbtype
    Stores the database type needed in some db functions
$debug
in file jqGrid.php, variable jqGrid::$debug
    Enable disable debuging
$decodeinput
in file jqGrid.php, variable jqGridEdit::$decodeinput
    Decodes the input for update and insert opeartions using the html_entity_decode
$del
in file jqGrid.php, variable jqGridEdit::$del
    Enables/disables deleting of record into the table
$delOptions
in file jqGrid.php, variable jqGridRender::$delOptions
    Default delete form dialog options
debugout
in file jqGrid.php, method jqGrid::debugout()
    Prints all executed SQL queries to file or console
decode
in file jqGrid.php, method jqGridUtils::decode()
    Decodes json string to PHP array. The function is used
delete
in file jqGrid.php, method jqGridEdit::delete()
    Delete the data into the database according the table element
e

e

$edit
in file jqGrid.php, variable jqGridEdit::$edit
    Enables/disables updating of record into the table
$editOptions
in file jqGrid.php, variable jqGridRender::$editOptions
    Default editing form dialog options
$element
in file jqAutocomplete.php, variable jqAutocomplete::$element
    Stores the Id of the element. Should be uniquie value in order to have multiple autocomplates defined in one file.
$encoding
in file jqGrid.php, variable jqGrid::$encoding
    Default enconding passed to the browser
$export
in file jqGrid.php, variable jqGridRender::$export
    Enable/disable the export to excel
$ExportCommand
in file jqGrid.php, variable jqGrid::$ExportCommand
    Set the sql command for excel export. If not set a _setSQL
$exportfile
in file jqGrid.php, variable jqGridRender::$exportfile
    The export to file to excel
editGrid
in file jqGrid.php, method jqGridEdit::editGrid()
    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 jqGridDB::getPrimaryKey If the primary key is not set or can not be obtained the operation is aborted.
encode
in file jqGrid.php, method jqGridUtils::encode()
    Encodes a PHP variable into javascript representation.
execute
in file jqGrid.php, method jqGrid::execute()
    Executes a prepared sql statement. Also if limit is set to true is used
exportToExcel
in file jqGrid.php, method jqGrid::exportToExcel()
    Export the recordset to excel xml file.
f

f

$fields
in file jqGrid.php, variable jqGridEdit::$fields
    Field names and data types from the table
$filterOptions
in file jqGrid.php, variable jqGridRender::$filterOptions
    Default fileter toolbar search options
g

g

$gridMethods
in file jqGrid.php, variable jqGridRender::$gridMethods
    Holds the grid methods.
$gridOptions
in file jqGrid.php, variable jqGridRender::$gridOptions
    Default grid parameters
$GridParams
in file jqGrid.php, variable jqGrid::$GridParams
    Holds the parameters that are send from the grid to the connector.
$gSQLMaxRows
in file jqGrid.php, variable jqGrid::$gSQLMaxRows
    Maximum number of rows to be exported for the excel export
getACData
in file jqAutocomplete.php, method jqAutocomplete::getACData()
    This method is internally used to get the data.
getColModel
in file jqGrid.php, method jqGridRender::getColModel()
    Return the generated colModel
getDbDate
in file jqGrid.php, method jqGrid::getDbDate()
    Return the current date format used in the undelayed database
getDbTime
in file jqGrid.php, method jqGrid::getDbTime()
    Return the current datetime format used in the undelayed database
getFields
in file jqGrid.php, method jqGridEdit::getFields()
    Return the fields generated for CRUD operations
getGridOption
in file jqGrid.php, method jqGridRender::getGridOption()
    Return a jqGrid option specified by the key, false if the option can not be found.
getGridParams
in file jqGrid.php, method jqGrid::getGridParams()
    Return the associative array which contain the parameters that are sended from the grid to request, search, update delete data.
getOption
in file jqAutocomplete.php, method jqAutocomplete::getOption()
    Return the the requested option of the autocomplete
getOption
in file jqCalendar.php, method jqCalendar::getOption()
GetParam
in file jqGrid.php, method jqGridUtils::GetParam()
    Return the value from POST or from GET
getPrimaryKeyId
in file jqGrid.php, method jqGridEdit::getPrimaryKeyId()
    Return the primary key of the table
getSqlElement
in file jqGrid.php, method jqGrid::getSqlElement()
    Read a xml file and the SelectCommand and return the sql string Return string if the query is found false if not.
getUserDate
in file jqGrid.php, method jqGrid::getUserDate()
    Return the current date format used from the client
getUserTime
in file jqGrid.php, method jqGrid::getUserTime()
    Return the current datetime format used from the client
h

h

$height
in file jqAutocomplete.php, variable jqAutocomplete::$height
    Determines the height of the autocomplete elemnt. Work only if $scroll option is set to true.
i

i

$I
in file jqGrid.php, variable jqGrid::$I
    Used to perform case insensitive search in PostgreSQL. The variable is
$itemLength
in file jqAutocomplete.php, variable jqAutocomplete::$itemLength
    Set the maximum rows send from the query to the autocomplete. If set to
insert
in file jqGrid.php, method jqGridEdit::insert()
    Insert the data array into the database according to the table element.
j

j

$jsonencode
in file jqGrid.php, variable jqGrid::$jsonencode
    If set to true uses the PHP json_encode if available. If this is set to
jqAutocomplete
in file jqAutocomplete.php, class jqAutocomplete
jqAutocomplete.php
procedural page jqAutocomplete.php
jqCalendar
in file jqCalendar.php, class jqCalendar
    Description of jqCalendar
jqCalendar.php
procedural page jqCalendar.php
jqGrid
in file jqGrid.php, class jqGrid
jqGrid.php
procedural page jqGrid.php
jqGridEdit
in file jqGrid.php, class jqGridEdit
jqGridRender
in file jqGrid.php, class jqGridRender
jqGridUtils
in file jqGrid.php, class jqGridUtils
l

l

$loadAll
in file jqAutocomplete.php, variable jqAutocomplete::$loadAll
    Determines if the data should be loaded at once from the SQL siurce.
$logtofile
in file jqGrid.php, variable jqGrid::$logtofile
    Determines if the log should be written to file or echoed.
logQuery
in file jqGrid.php, method jqGrid::logQuery()
    Log query
m

m

$mtype
in file jqGrid.php, variable jqGridEdit::$mtype
    Determines the type of accepting the input data. Can be POST or GET
n

n

$navigator
in file jqGrid.php, variable jqGridRender::$navigator
    Enable/disable navigator in the grid. Default false
$navOptions
in file jqGrid.php, variable jqGridRender::$navOptions
    Default navigaror options
o

o

$optimizeSearch
in file jqGrid.php, variable jqGrid::$optimizeSearch
    Optimizes the search SQL when used in MySQL with big data sets.
p

p

$pdo
in file jqGrid.php, variable jqGrid::$pdo
    Stores the connection passed to the constructor
$primaryKey
in file jqGrid.php, variable jqGridEdit::$primaryKey
    Holds the primary key for the table
parseDate
in file jqGrid.php, method jqGridUtils::parseDate()
    Parses a $format and $date value and return the date formated via $newformat.
parseSql
in file jqGrid.php, method jqGrid::parseSql()
    Prepares a $sqlElement and binds a parameters $params
phpTojsDate
in file jqGrid.php, method jqGridUtils::phpTojsDate()
    Convert the php date string to Java Script date string
q

q

$queryLog
in file jqGrid.php, variable jqGrid::$queryLog
queryAutocomplete
in file jqAutocomplete.php, method jqAutocomplete::queryAutocomplete()
    Return the result for the autocomplete as PHP object. Determines automatically
queryForObject
in file jqGrid.php, method jqGrid::queryForObject()
    Return the object from the query
queryGrid
in file jqGrid.php, method jqGrid::queryGrid()
    Return the result of the query to jqGrid. Support searching
querySubGrid
in file jqGrid.php, method jqGrid::querySubGrid()
    Return the result of the query for the simple subgrid
quote
in file jqGrid.php, method jqGridUtils::quote()
    Quotes a javascript string.
r

r

$readFromXML
in file jqGrid.php, variable jqGrid::$readFromXML
    Obtain the SQL qurery from XML file.
$runAll
in file jqAutocomplete.php, variable jqAutocomplete::$runAll
    Internal variable to determine whnever the script is run for first time.
$runSetCommands
in file jqGrid.php, variable jqGridRender::$runSetCommands
    When set to false some set comands are not executed for spped improvements Usual this is done after setColModel.
renderAutocomplete
in file jqAutocomplete.php, method jqAutocomplete::renderAutocomplete()
    Main method which do everthing for the autocomplete. Should be called after all settings are done. Note that in one file we can have more than one autocomplete definitions.
renderCalendar
in file jqCalendar.php, method jqCalendar::renderCalendar()
renderGrid
in file jqGrid.php, method jqGridRender::renderGrid()
    Main method which do allmost everthing for the grid
rs2excel
in file jqGrid.php, method jqGrid::rs2excel()
    From a given recordset returns excel xml file. If the summary array is defined add summary formula at last row.
s

s

$scroll
in file jqAutocomplete.php, variable jqAutocomplete::$scroll
    Determines if the content in autocomplete should have a scroll. Use this option with the height option - see below. If this option is not set the content will have height equal of the responce rows.
$searchOptions
in file jqGrid.php, variable jqGridRender::$searchOptions
    Default search options
$searchType
in file jqAutocomplete.php, variable jqAutocomplete::$searchType
    Set the search type for the LIKE SQL operator.
$select
in file jqGrid.php, variable jqGrid::$select
    Holds the modified select command used into grid
$SelectCommand
in file jqGrid.php, variable jqGrid::$SelectCommand
    In case if no table is set, this holds the sql command for
$SelectCommand
in file jqAutocomplete.php, variable jqAutocomplete::$SelectCommand
    Defines the select command for obtaining the data from the database.
$serialKey
in file jqGrid.php, variable jqGridEdit::$serialKey
    Defines if the primary key is serial (autoincrement)
$source
in file jqAutocomplete.php, variable jqAutocomplete::$source
    Stores the source for the autocomplete. Can be a string which should point to file from where to obtain the data. It can be array too.
$SubgridCommand
in file jqGrid.php, variable jqGrid::$SubgridCommand
    Set a sql command used for the simple subgrid
selectLimit
in file jqGrid.php, method jqGrid::selectLimit()
    Will select, getting rows from $offset (1-based), for $nrows.
setAutocomplete
in file jqGrid.php, method jqGridRender::setAutocomplete()
    Construct autocompleter used in the grid. The autocomplete can be used in the editing modules or/and in search module.
setColModel
in file jqGrid.php, method jqGridRender::setColModel()
    Construct the column model of the grid. The model can be passed as array
setColProperty
in file jqGrid.php, method jqGridRender::setColProperty()
    Set a new property in the constructed colModel Return true on success.
setDatepicker
in file jqGrid.php, method jqGridRender::setDatepicker()
    Construct a pop up calender used in the grid. The datepicker can be used in the editing modules or/and in search module.
setDbDate
in file jqGrid.php, method jqGrid::setDbDate()
    Set a new database date format using PHP convensions
setDbTime
in file jqGrid.php, method jqGrid::setDbTime()
    Set a new database datetime format using PHP convensions
setEvent
in file jqCalendar.php, method jqCalendar::setEvent()
setEvent
in file jqAutocomplete.php, method jqAutocomplete::setEvent()
    Set a JavaScript event for the autocomplete. For all the possible events
setFilterOptions
in file jqGrid.php, method jqGridRender::setFilterOptions()
    Set options for the tolbar filter when enabled
setGridEvent
in file jqGrid.php, method jqGridRender::setGridEvent()
    Set a valid grid event
setGridOptions
in file jqGrid.php, method jqGridRender::setGridOptions()
    Set a grid option. The method uses array with keys corresponding
setGridParams
in file jqGrid.php, method jqGrid::setGridParams()
    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
in file jqGrid.php, method jqGridRender::setJSCode()
    Put a javascript arbitrary code after all things are created. The method is executed only once when the grid is created.
setLength
in file jqAutocomplete.php, method jqAutocomplete::setLength()
    Set the limit of the requested data in case of SQL command
setNavEvent
in file jqGrid.php, method jqGridRender::setNavEvent()
    Set a event in the navigator or in the diffrent modules add,edit,del,view, search
setNavOptions
in file jqGrid.php, method jqGridRender::setNavOptions()
    Set options in the navigator for the diffrent actions
setOption
in file jqAutocomplete.php, method jqAutocomplete::setOption()
    Set the desired option for autocomplete. For a full list of the option refer
setOption
in file jqCalendar.php, method jqCalendar::setOption()
setPrimaryKeyId
in file jqGrid.php, method jqGridEdit::setPrimaryKeyId()
    Set a primary key for the table
setSelect
in file jqGrid.php, method jqGridRender::setSelect()
    Construct the select used in the grid. The select element can be used in the
setSource
in file jqAutocomplete.php, method jqAutocomplete::setSource()
    Set the source need for autocomlete to send a data. Can be a string or array. If the option is string then this is the url from where to obtain the data.
setSubGrid
in file jqGrid.php, method jqGridRender::setSubGrid()
    Prepares a executuion of a simple subgrid Return false if no name options for the subgrid.
setSubGridGrid
in file jqGrid.php, method jqGridRender::setSubGridGrid()
    Prepares a subgrid in the grid expecting any valid html content provieded
setTable
in file jqGrid.php, method jqGridEdit::setTable()
    Set table for CRUD and build the fields
setUrl
in file jqGrid.php, method jqGridRender::setUrl()
    Set a editing url. Note that this set a url from where to obtain and/or edit data.
setUserDate
in file jqGrid.php, method jqGrid::setUserDate()
    Set a new user date format using PHP convensions
setUserTime
in file jqGrid.php, method jqGrid::setUserTime()
    Set a new user datetime format using PHP convensions
SimpleXMLExtended
in file jqGrid.php, class SimpleXMLExtended
Strip
in file jqGrid.php, method jqGridUtils::Strip()
    Strip slashes from a varaible if PHP magic quotes are on
t

t

$table
in file jqGrid.php, variable jqGrid::$table
    set a table to display a data to the grid
$term
in file jqAutocomplete.php, variable jqAutocomplete::$term
    Stores the term parameter send from autocomplete and then used in query
$toolbarfilter
in file jqGrid.php, variable jqGridRender::$toolbarfilter
    Enable/disable tollbar search. Default false
$trans
in file jqGrid.php, variable jqGridEdit::$trans
    If true every CRUD is enclosed within begin transaction - commit/rollback
toXml
in file jqGrid.php, method jqGridUtils::toXml()
    Function for converting to an XML document.
u

u

$userdata
in file jqGrid.php, variable jqGrid::$userdata
    Used to store the additional userdata which will be transported
$userdateformat
in file jqGrid.php, variable jqGrid::$userdateformat
    The date format used by the user when a search is performed and CRUD operation
$usertimeformat
in file jqGrid.php, variable jqGrid::$usertimeformat
    The datetime format used by the user when a search is performed and CRUD operation
update
in file jqGrid.php, method jqGridEdit::update()
    Update the data into the database according the table element
v

v

$version
in file jqGrid.php, variable jqGrid::$version
    Get te current version
$version
in file jqCalendar.php, variable jqCalendar::$version
$version
in file jqAutocomplete.php, variable jqAutocomplete::$version
    Info about the version
$viewOptions
in file jqGrid.php, variable jqGridRender::$viewOptions
    Default view form dialog options
x

x

$xmlCDATA
in file jqGrid.php, variable jqGrid::$xmlCDATA
    Defines if the xml otput should be enclosed in CDATA when xml output is enabled
_

_

_buildFields
in file jqGrid.php, method jqGridEdit::_buildFields()
    Build the fields array with a database fields from the table.
_buildSearch
in file jqGrid.php, method jqGrid::_buildSearch()
    Builds the search where clause when the user perform a search Return arrray the first element is a strinng with the where clause, the second element is array containing the value parameters passed to the sql.
_getcount
in file jqGrid.php, method jqGrid::_getcount()
    Returns object which holds the total records in the query and optionally
_gridResponse
in file jqGrid.php, method jqGrid::_gridResponse()
    Check in which format data should be returned to the grid based on dataType property
_setSQL
in file jqGrid.php, method jqGrid::_setSQL()
    Bulid the sql based on $readFromXML, $SelectCommand and $table variables
_setSrc
in file jqAutocomplete.php, method jqAutocomplete::_setSrc()
    Internal method used to set the source
__construct
in file jqCalendar.php, method jqCalendar::__construct()
__construct
in file jqAutocomplete.php, method jqAutocomplete::__construct()
    Constructor
__construct
in file jqGrid.php, method jqGrid::__construct()
    Constructor

Documentation generated on Thu, 16 Sep 2010 11:18:54 +0300 by phpDocumentor 1.4.3