Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/mitarbeiter/sven/public_html/tmp/devcon_php_base/admin_panel/tk/dbisearch.php
dev/con php base -

tk_dbisearch_query

tk_dbisearch_query

Search description object.

 

public class tk_dbisearch_query

Search description object.

 

Public Method Summary

void

tk_dbisearch_init(object application &$this)

Initialise the toolkit.
void

tk_dbisearch(object application &$this)

Full-text search event handler.
object cursor_merged

tk_dbisearch_get_results(object application &$this)

Get cursor with results.
int

tk_dbisearch_has_result(object application &$this)

Check if a search was performed or not and if records were found.
object tk_dbisearch_query

tk_dbisearch_get_query_object(object application &$this)

Get query object of last result.

Private Method Summary

void

_tk_dbisearch_query_sql_cursors(object application &$this, object tk_dbisearch &$qo)

Create queried cursor_sql objects.
void

_tk_dbisearch_create_sql_queries(object application &$this, object tk_dbisearch &$query)

Create queries for all form fields if not already done.
void

&_tk_dbisearch_get_field(object application &$query, object tk_dbisearch $field, $element)

Get element from field desribtion or from member variable in query object.
void

_tk_dbisearch_create_query(object application &$this, object tk_dbisearch &$query, string $field)

Create an SQL query for a single form field.

Private Field Summary

string

$not_all

string

$empty_fields

string

$base_exp

string

$where

array

$fields

integer

$size

integer

$limit

integer

$offset

string

$order

array

$_sql_queries

Private Constant Summary

TK_DBISEARCH_NOT_SEARCHED >>0<< Warning: documentation is missing.
TK_DBISEARCH_NOT_FOUND >>1<< Warning: documentation is missing.
TK_DBISEARCH_FOUND >>2<< Warning: documentation is missing.

Public Method Details

tk_dbisearch_init

public void tk_dbisearch_init( object application &$this )

  Initialise the toolkit.

Parameter
object application &$this
Returns void


tk_dbisearch

public void tk_dbisearch( object application &$this )

  Full-text search event handler.
Event argument 'query' must contain a tk_dbisearch_query object.

Parameter
object application &$this
Returns void


tk_dbisearch_get_results

public object cursor_merged tk_dbisearch_get_results( object application &$this )

  Get cursor with results.

Parameter
object application &$this
Returns object cursor_merged


tk_dbisearch_has_result

public int tk_dbisearch_has_result( object application &$this )

  Check if a search was performed or not and if records were found.

Parameter
object application &$this
Returns int

Status flags: TK_DBISEARCH_NOT_SEARCHED,
TK_DBISEARCH_NOT_FOUND or TK_DBISEARCH_FOUND.


tk_dbisearch_get_query_object

public object tk_dbisearch_query tk_dbisearch_get_query_object( object application &$this )

  Get query object of last result.

Parameter
object application &$this
Returns object tk_dbisearch_query

.


Private Method Details

_tk_dbisearch_query_sql_cursors

private void _tk_dbisearch_query_sql_cursors( object application &$this, object tk_dbisearch &$qo )

  Create queried cursor_sql objects.
The cursors are stored in array $this->tk_dbisearch->cursors.

Parameter
object application &$this
object tk_dbisearch &$qo
Returns void


_tk_dbisearch_create_sql_queries

private void _tk_dbisearch_create_sql_queries( object application &$this, object tk_dbisearch &$query )

  Create queries for all form fields if not already done.

Parameter
object application &$this
object tk_dbisearch &$query
Returns void


&_tk_dbisearch_get_field

private void &_tk_dbisearch_get_field( object application &$query, object tk_dbisearch $field, $element )

  Get element from field desribtion or from member variable in query object.
tk_dbisearch_query->fields should contain superclasses of the object.

Parameter
object application &$query
object tk_dbisearch $field
$element
Warning: documentation is missing.
Returns void


_tk_dbisearch_create_query

private void _tk_dbisearch_create_query( object application &$this, object tk_dbisearch &$query, string $field )

  Create an SQL query for a single form field.
The query is stored $query->_sql_queries.

Parameter
object application &$this
object tk_dbisearch &$query
string $field
Form field name.
Returns void


Private Field Details

$not_all

private string $not_all

>>''<<



$empty_fields

private string $empty_fields

>>'skip'<<



$base_exp

private string $base_exp

>>'AND'<<



$where

private string $where

>>''<<



$fields

private array $fields

>>array ()<<



$size

private integer $size

>><<



$limit

private integer $limit

>><<



$offset

private integer $offset

>><<



$order

private string $order

>>''<<



$_sql_queries

private array $_sql_queries

>>array ()<<



Private Constant Details

TK_DBISEARCH_NOT_SEARCHED

define( TK_DBISEARCH_NOT_SEARCHED, >>0<< )
Case: default: case sensitive



TK_DBISEARCH_NOT_FOUND

define( TK_DBISEARCH_NOT_FOUND, >>1<< )
Case: default: case sensitive



TK_DBISEARCH_FOUND

define( TK_DBISEARCH_FOUND, >>2<< )
Case: default: case sensitive




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta