Index of all elements
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ o ]
[ r ]
[ s ]
[ u ]
[ x ]
[ _ ]
top
b
- bind
- in file DataSource.php, method Structures_DataGrid_DataSource::bind()
Datasource binding method prototype
- bind
- in file DataGrid.php, method Structures_DataGrid::bind()
A simple way to add a record set to the datagrid
- bind
- in file DataSource.php, method Structures_DataGrid_DataSource_SQLQuery::bind()
Bind
- bindDataSource
- in file DataGrid.php, method Structures_DataGrid::bindDataSource()
Bind an already instantiated DataSource driver
- build
- in file Renderer.php, method Structures_DataGrid_Renderer::build()
Build the grid
- build
- in file DataGrid.php, method Structures_DataGrid::build()
Build the datagrid
- buildBody
- in file Renderer.php, method Structures_DataGrid_Renderer::buildBody()
Build the body
- buildEmptyRow
- in file Renderer.php, method Structures_DataGrid_Renderer::buildEmptyRow()
Build an empty row
- buildFooter
- in file Renderer.php, method Structures_DataGrid_Renderer::buildFooter()
Build the footer
- buildHeader
- in file Renderer.php, method Structures_DataGrid_Renderer::buildHeader()
Build the header
- buildRow
- in file Renderer.php, method Structures_DataGrid_Renderer::buildRow()
Build a body row
- bind-atom.php
- procedural page bind-atom.php
- bind-dataobject.php
- procedural page bind-dataobject.php
- bind-dbtable.php
- procedural page bind-dbtable.php
- bind-sql.php
- procedural page bind-sql.php
- bind-xml1.php
- procedural page bind-xml1.php
- bind-xml2.php
- procedural page bind-xml2.php
top
top
d
- DATAGRID_ERROR_UNSUPPORTED
- in file DataGrid.php, constant DATAGRID_ERROR_UNSUPPORTED
- DATAGRID_RENDER_CONSOLE
- in file DataGrid.php, constant DATAGRID_RENDER_CONSOLE
- DATAGRID_RENDER_CSV
- in file DataGrid.php, constant DATAGRID_RENDER_CSV
- DATAGRID_RENDER_DEFAULT
- in file DataGrid.php, constant DATAGRID_RENDER_DEFAULT
- DATAGRID_RENDER_PAGER
- in file DataGrid.php, constant DATAGRID_RENDER_PAGER
- DATAGRID_RENDER_SMARTY
- in file DataGrid.php, constant DATAGRID_RENDER_SMARTY
- DATAGRID_RENDER_SORTFORM
- in file DataGrid.php, constant DATAGRID_RENDER_SORTFORM
- DATAGRID_RENDER_TABLE
- in file DataGrid.php, constant DATAGRID_RENDER_TABLE
- DATAGRID_RENDER_XLS
- in file DataGrid.php, constant DATAGRID_RENDER_XLS
- DATAGRID_RENDER_XML
- in file DataGrid.php, constant DATAGRID_RENDER_XML
- DATAGRID_RENDER_XUL
- in file DataGrid.php, constant DATAGRID_RENDER_XUL
- DATAGRID_SOURCE_ARRAY
- in file DataGrid.php, constant DATAGRID_SOURCE_ARRAY
- DATAGRID_SOURCE_CSV
- in file DataGrid.php, constant DATAGRID_SOURCE_CSV
- DATAGRID_SOURCE_DATAOBJECT
- in file DataGrid.php, constant DATAGRID_SOURCE_DATAOBJECT
- DATAGRID_SOURCE_DB
- in file DataGrid.php, constant DATAGRID_SOURCE_DB
- DATAGRID_SOURCE_DBQUERY
- in file DataGrid.php, constant DATAGRID_SOURCE_DBQUERY
- DATAGRID_SOURCE_DBTABLE
- in file DataGrid.php, constant DATAGRID_SOURCE_DBTABLE
- DATAGRID_SOURCE_MDB2
- in file DataGrid.php, constant DATAGRID_SOURCE_MDB2
- DATAGRID_SOURCE_RSS
- in file DataGrid.php, constant DATAGRID_SOURCE_RSS
- DATAGRID_SOURCE_XML
- in file DataGrid.php, constant DATAGRID_SOURCE_XML
- dataSourceFactory
- in file DataGrid.php, method Structures_DataGrid::dataSourceFactory()
Datasource driver Factory
- defaultCellFormatter
- in file Renderer.php, method Structures_DataGrid_Renderer::defaultCellFormatter()
Default formatter for all cells
- delete
- in file DataSource.php, method Structures_DataGrid_DataSource::delete()
Record deletion method prototype
- dump
- in file DataSource.php, method Structures_DataGrid_DataSource::dump()
Dump the data as returned by fetch().
- dump
- in file DataGrid.php, method Structures_DataGrid::dump()
Method used for debugging purposes only. Displays a dump of the DataGrid object.
- DataSource.php
- procedural page DataSource.php
- DataGrid.php
- procedural page DataGrid.php
top
top
f
- $fieldName
- in file Column.php, variable Structures_DataGrid_Column::$fieldName
The name of the field to map to
- fetch
- in file DataSource.php, method Structures_DataGrid_DataSource::fetch()
Fetching method prototype
- fetch
- in file DataSource.php, method Structures_DataGrid_DataSource_SQLQuery::fetch()
Fetch
- fill
- in file DataGrid.php, method Structures_DataGrid::fill()
Fill a rendering container with data
- finalize
- in file Renderer.php, method Structures_DataGrid_Renderer::finalize()
Finish building the datagrid.
- flatten
- in file Renderer.php, method Structures_DataGrid_Renderer::flatten()
Retrieve output from the container object
- format
- in file Column.php, method Structures_DataGrid_Column::format()
Choose a format preset
- formatter
- in file Column.php, method Structures_DataGrid_Column::formatter()
Formatter
- free
- in file DataSource.php, method Structures_DataGrid_DataSource_SQLQuery::free()
Disconnect from the database, if needed
- free
- in file DataSource.php, method Structures_DataGrid_DataSource::free()
Resources cleanup method prototype
- fill-pager.php
- procedural page fill-pager.php
- fill-sortform.php
- procedural page fill-sortform.php
- format.php
- procedural page format.php
top
g
- generateColumns
- in file DataGrid.php, method Structures_DataGrid::generateColumns()
Generate columns from a fields list
- getAttributes
- in file Column.php, method Structures_DataGrid_Column::getAttributes()
Get the column XML/HTML attributes
- getAutoFillValue
- in file Column.php, method Structures_DataGrid_Column::getAutoFillValue()
Get auto fill value
- getColumnByField
- in file DataGrid.php, method Structures_DataGrid::getColumnByField()
Find a column by field name
- getColumnByName
- in file DataGrid.php, method Structures_DataGrid::getColumnByName()
Find a column by name (label)
- getColumnCount
- in file DataGrid.php, method Structures_DataGrid::getColumnCount()
Returns the number of columns
- getColumns
- in file DataSource.php, method Structures_DataGrid_DataSource::getColumns()
Generate columns if options are properly set
- getColumns
- in file DataGrid.php, method Structures_DataGrid::getColumns()
Return the current columns
- getContainer
- in file Renderer.php, method Structures_DataGrid_Renderer::getContainer()
Return the container used by the driver
- getCurrentPage
- in file DataGrid.php, method Structures_DataGrid::getCurrentPage()
Retrieves the current page number when paging is implemented
- getCurrentRecordNumberEnd
- in file DataGrid.php, method Structures_DataGrid::getCurrentRecordNumberEnd()
Returns the number of the last record of the current page
- getCurrentRecordNumberStart
- in file DataGrid.php, method Structures_DataGrid::getCurrentRecordNumberStart()
Returns the number of the first record of the current page
- getDataSource
- in file DataGrid.php, method Structures_DataGrid::getDataSource()
Get the currently loaded DataSource driver
- getDefaultDirection
- in file Column.php, method Structures_DataGrid_Column::getDefaultDirection()
Return the default direction to order this column by
- getFeatures
- in file DataSource.php, method Structures_DataGrid_DataSource::getFeatures()
List special driver features
- getFeatures
- in file Renderer.php, method Structures_DataGrid_Renderer::getFeatures()
List special driver features
- getField
- in file Column.php, method Structures_DataGrid_Column::getField()
Get name of the field for the column to be mapped to
- getLabel
- in file Column.php, method Structures_DataGrid_Column::getLabel()
Get column label
- getOrderBy
- in file Column.php, method Structures_DataGrid_Column::getOrderBy()
Get the field name to order the data by
- getOutput
- in file DataGrid.php, method Structures_DataGrid::getOutput()
Return the datagrid output
- getOutput
- in file Renderer.php, method Structures_DataGrid_Renderer::getOutput()
Returns the output from the renderer (e.g. HTML table, XLS object, ...)
- getPageCount
- in file DataGrid.php, method Structures_DataGrid::getPageCount()
Returns the total number of pages
- getPrimaryKey
- in file DataSource.php, method Structures_DataGrid_DataSource::getPrimaryKey()
Return the primary key specification
- getRecordCount
- in file DataGrid.php, method Structures_DataGrid::getRecordCount()
Returns the total number of records
- getRenderer
- in file DataGrid.php, method Structures_DataGrid::getRenderer()
Get the current or default Rendering driver
- getUrlMapper
- in file Renderer.php, method Structures_DataGrid_Renderer::getUrlMapper()
Return the URL mapper
- GuestBook_Table
- in file bind-dbtable.php, class GuestBook_Table
top
top
top
top
top
s
- $sql
- in file bind-dbtable.php, variable GuestBook_Table::$sql
- setAttributes
- in file Column.php, method Structures_DataGrid_Column::setAttributes()
Set the column XML/HTML attributes
- setAutoFillValue
- in file Column.php, method Structures_DataGrid_Column::setAutoFillValue()
Set auto fill value
- setColumns
- in file Renderer.php, method Structures_DataGrid_Renderer::setColumns()
Provide columns
- setContainer
- in file Renderer.php, method Structures_DataGrid_Renderer::setContainer()
Attach a container object
- setCurrentPage
- in file DataGrid.php, method Structures_DataGrid::setCurrentPage()
Define the current page number.
- setCurrentSorting
- in file Renderer.php, method Structures_DataGrid_Renderer::setCurrentSorting()
Specify how the datagrid is currently sorted
- setDataSourceOption
- in file DataGrid.php, method Structures_DataGrid::setDataSourceOption()
Set a single datasource option
- setDataSourceOptions
- in file DataGrid.php, method Structures_DataGrid::setDataSourceOptions()
Set multiple datasource options
- setDefaultDirection
- in file Column.php, method Structures_DataGrid_Column::setDefaultDirection()
Set the default direction to order this column by
- setDefaultSort
- in file DataGrid.php, method Structures_DataGrid::setDefaultSort()
Set default sorting specification
- setField
- in file Column.php, method Structures_DataGrid_Column::setField()
Set name of the field for the column to be mapped to
- setFormatter
- in file Column.php, method Structures_DataGrid_Column::setFormatter()
Set Formatter Callback
- setLabel
- in file Column.php, method Structures_DataGrid_Column::setLabel()
Set column label
- setLimit
- in file Renderer.php, method Structures_DataGrid_Renderer::setLimit()
Specify page and row limits
- setOption
- in file Renderer.php, method Structures_DataGrid_Renderer::setOption()
Set a single option
- setOption
- in file DataSource.php, method Structures_DataGrid_DataSource::setOption()
Set a single option
- setOptions
- in file DataSource.php, method Structures_DataGrid_DataSource::setOptions()
Set options
- setOptions
- in file Renderer.php, method Structures_DataGrid_Renderer::setOptions()
Set multiple options
- setOrderBy
- in file Column.php, method Structures_DataGrid_Column::setOrderBy()
Set the field name to order the data by
- setRendered
- in file Renderer.php, method Structures_DataGrid_Renderer::setRendered()
Sets the rendered status. This can be used to "flush the cache" in case you need to render the datagrid twice with the second time having changes
- setRenderer
- in file DataGrid.php, method Structures_DataGrid::setRenderer()
Set Renderer
- setRendererOption
- in file DataGrid.php, method Structures_DataGrid::setRendererOption()
Set a single renderer option
- setRendererOptions
- in file DataGrid.php, method Structures_DataGrid::setRendererOptions()
Set multiple renderer options
- setRequestPrefix
- in file Renderer.php, method Structures_DataGrid_Renderer::setRequestPrefix()
Set the HTTP Request prefix
- setRequestPrefix
- in file DataGrid.php, method Structures_DataGrid::setRequestPrefix()
Set the global GET/POST variables prefix
- setStreaming
- in file Renderer.php, method Structures_DataGrid_Renderer::setStreaming()
Tell the renderer whether streaming is enabled or not
- setUrlFormat
- in file DataGrid.php, method Structures_DataGrid::setUrlFormat()
Enable and configure URL mapping
- setUrlMapper
- in file Renderer.php, method Structures_DataGrid_Renderer::setUrlMapper()
Set the URL mapper
- sort
- in file DataSource.php, method Structures_DataGrid_DataSource_SQLQuery::sort()
This can only be called prior to the fetch method.
- sort
- in file DataSource.php, method Structures_DataGrid_DataSource::sort()
Sorting method prototype
- sortRecordSet
- in file DataGrid.php, method Structures_DataGrid::sortRecordSet()
Sorts the records by the defined field.
- streamBody
- in file Renderer.php, method Structures_DataGrid_Renderer::streamBody()
Stream a chunk of records
- strripos
- in file DataSource.php, function strripos()
- Structures_DataGrid
- in file DataGrid.php, class Structures_DataGrid
Structures_DataGrid Class
- Structures_DataGrid
- in file DataGrid.php, method Structures_DataGrid::Structures_DataGrid()
Constructor
- smarty-simple.php
- procedural page smarty-simple.php
- Structures_DataGrid_Column
- in file Column.php, class Structures_DataGrid_Column
Structures_DataGrid_Column Class
- Structures_DataGrid_Column
- in file Column.php, method Structures_DataGrid_Column::Structures_DataGrid_Column()
Constructor
- Structures_DataGrid_DataSource
- in file DataSource.php, class Structures_DataGrid_DataSource
Base abstract class for DataSource drivers
- Structures_DataGrid_DataSource
- in file DataSource.php, method Structures_DataGrid_DataSource::Structures_DataGrid_DataSource()
Constructor
- Structures_DataGrid_DataSource_SQLQuery
- in file DataSource.php, class Structures_DataGrid_DataSource_SQLQuery
Base abstract class for SQL query based DataSource drivers
- Structures_DataGrid_Exception
- in file Exception.php, class Structures_DataGrid_Exception
- Structures_DataGrid_Renderer
- in file Renderer.php, class Structures_DataGrid_Renderer
Base class of all Renderer drivers
- Structures_DataGrid_Renderer
- in file Renderer.php, method Structures_DataGrid_Renderer::Structures_DataGrid_Renderer()
Instantiate the driver and set default options and features
- structures_datagrid_strripos
- in file DataSource.php, function structures_datagrid_strripos()
Replace strripos()
top
top
top
_
- $_columns
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_columns
Columns' fields names and labels
- $_columnsNum
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_columnsNum
Number of columns
- $_currentSort
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_currentSort
Fields/directions the data is currently sorted by
- $_defaultDirections
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_defaultDirections
The default directions to sort by
- $_features
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_features
Special driver features
- $_features
- in file DataSource.php, variable Structures_DataGrid_DataSource::$_features
Special driver features
- $_firstRecord
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_firstRecord
First record number (starting from 1), in the current page
- $_handle
- in file DataSource.php, variable Structures_DataGrid_DataSource_SQLQuery::$_handle
Instantiated database object
- $_lastRecord
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_lastRecord
Last record number (starting from 1), in the current page
- $_multiSort
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_multiSort
Whether the backend support sorting by multiple fields
- $_options
- in file DataSource.php, variable Structures_DataGrid_DataSource::$_options
Common and driver-specific options
- $_options
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_options
Common and driver-specific options
- $_page
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_page
Current page
- $_pageLimit
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_pageLimit
Number of records per page
- $_pagesNum
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_pagesNum
Number of pages
- $_query
- in file DataSource.php, variable Structures_DataGrid_DataSource_SQLQuery::$_query
SQL query
- $_records
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_records
Records content
- $_recordsNum
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_recordsNum
Number of records in the current page
- $_requestPrefix
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_requestPrefix
GET/POST/Cookie parameters prefix
- $_sortableFields
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_sortableFields
Which fields the datagrid may be sorted by
- $_sortSpec
- in file DataSource.php, variable Structures_DataGrid_DataSource_SQLQuery::$_sortSpec
Fields/directions to sort the data by
- $_totalRecordsNum
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_totalRecordsNum
Total number of records as reported by the datasource
- $_urlMapper
- in file DataGrid.php, variable Structures_DataGrid::$_urlMapper
URL mapper instance, if activated
- $_urlMapper
- in file Renderer.php, variable Structures_DataGrid_Renderer::$_urlMapper
URL mapper instance, if provided
- _addDefaultOptions
- in file DataSource.php, method Structures_DataGrid_DataSource::_addDefaultOptions()
Adds some default options.
- _addDefaultOptions
- in file Renderer.php, method Structures_DataGrid_Renderer::_addDefaultOptions()
Adds some default options.
- _buildOnMoveCall
- in file Renderer.php, method Structures_DataGrid_Renderer::_buildOnMoveCall()
Build a Javascript handler call for a given page and sorting spec
- _buildSortingHttpQuery
- in file Renderer.php, method Structures_DataGrid_Renderer::_buildSortingHttpQuery()
Build an HTTP query for sorting a given column
- _noSupport
- in file Renderer.php, method Structures_DataGrid_Renderer::_noSupport()
Return an error related to an unsupported public method
- _setFeatures
- in file Renderer.php, method Structures_DataGrid_Renderer::_setFeatures()
Add special driver features
- _setFeatures
- in file DataSource.php, method Structures_DataGrid_DataSource::_setFeatures()
Add special driver features
- __construct
- in file DataSource.php, method Structures_DataGrid_DataSource_SQLQuery::__construct()
Constructor
top
Documentation generated on Mon, 11 Mar 2019 15:47:20 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|