Krai Framework Homepage - Framework API - Krai/Db/Krai_Db_Handler

Krai

Packages:

Krai
Demo

Classes:

Module
Krai_Module
Krai_Module_Action
Krai_Module_Exception
Krai_Module_Exception_Adone
Krai_Module_Exception_Mdone

Log
Krai_Log
Krai_Log_Logger
Krai_Log_Logger_Console
Krai_Log_Logger_Email
Krai_Log_Logger_Local
Krai_Log_Logger_Syslog
Krai_Log_Session

Db
Krai_Db
Krai_Db_Exception
Krai_Db_Handler
Krai_Db_Handler_Mysql
Krai_Db_Handler_Pdo
Krai_Db_Object
Krai_Db_Query

Struct
Krai_Struct
Krai_Struct_Dbquery
Krai_Struct_Dbquery_Delete
Krai_Struct_Dbquery_Insert
Krai_Struct_Dbquery_Select
Krai_Struct_Dbquery_Update
Krai_Struct_Exception
Krai_Struct_Loginfo
Krai_Struct_Mail
Krai_Struct_Mailconf

Krai
Krai_Exception

Markup
Krai_Markup
Krai_Markup_Exception

Mail
Krai_Mail
Krai_Mail_Exception

Router
Krai_Router
Krai_Router_Exception
Krai_Router_Route

Lib
Krai_Lib_Inflector
Nakor
Spyc

Files:

Exception.php
Krai.php

Cache
Cache.php
Exception.php

Db
Db.php
Exception.php
Handler.php
Mysql.php
Object.php
Pdo.php
Query.php

Lib
Inflector.php
Lib.php
Nakor.php
Spyc.php

Log
Console.php
Email.php
Local.php
Log.php
Logger.php
Session.php
Syslog.php

Mail
Exception.php
Mail.php

Markup
Exception.php
Markup.php

Module
Action.php
Adone.php
Exception.php
Mdone.php
Module.php

Router
Exception.php
Route.php
Router.php

Struct
Dbquery.php
Delete.php
Exception.php
Insert.php
Loginfo.php
Mail.php
Mailconf.php
Select.php
Struct.php
Update.php

Class Krai_Db_Handler_Mysql

Class Overview

MySQL database handler

This class is a wrapper around the http://www.php.net/mysqli database connection functionality, implementing the Krai_Db_Handler pattern.

Located in /Krai/Db/Handler/Mysql.php [line 23]

Krai_Db_Handler
   |
   --Krai_Db_Handler_Mysql

Properties

$_dbc

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Krai_Db_Handler

Krai_Db_Handler::$CONFIG

Inherited From Krai_Db_Handler

Krai_Db_Handler::__construct()

Constructor.

Krai_Db_Handler::DeleteQuery()

Generate a query struct for a delete query

Krai_Db_Handler::Fetch()

Fetch a database record from a query as an object

Krai_Db_Handler::FetchArray()

Fetch a database record from a query as an array

Krai_Db_Handler::FetchOne()

Fetch just one column from the result.

Krai_Db_Handler::GetJoins()

Generate the joins from a table array

Krai_Db_Handler::InsertQuery()

Generate a query struct for an insert query

Krai_Db_Handler::Process()

Process a query struct according to its type.

Krai_Db_Handler::Query()

Execute an SQL query

Krai_Db_Handler::SelectQuery()

Generate a query struct for a find query

Krai_Db_Handler::Transaction()

Transaction controller

Krai_Db_Handler::UpdateQuery()

Generate a query struct for an update query

[ Top ]

Property Summary

mysqli

$_dbc

Holds the database connection proper

[ Top ]

Method Summary

void	__construct()	Constructor
mixed	Escape()	Escape the parameter so it is safe to insert into a query
void	Fetch()
void	FetchArray()
void	FetchOne()
array	ParseQueryParams()	Parse the query parameters, escaping and whatnot
void	Process()
void	Query()
void	Transaction()

[ Top ]

Properties

mysqli $_dbc [line 32]

Holds the database connection proper

This variable holds the actual database connection using http://www.php.net/mysqli

API Tags:

Access:

private

[ Top ]

Methods

Constructor __construct [line 43]

void __construct(

$dbinfo 
)

Constructor

This function initializes the database with the provided info. Expected array keys are '_host', '_user', '_pass', and '_name'.

Parameters:

array

$dbinfo:

Database connection information

API Tags:

Access:

public

Redefinition of:

Krai_Db_Handler::__construct(): Constructor.

[ Top ]

Escape [line 298]

mixed Escape(
mixed
$val 
)

Escape the parameter so it is safe to insert into a query

This function escapes a value so it is safe to use in an sql query

Parameters:

mixed

$val:

API Tags:

Access:

protected

[ Top ]

Fetch [line 260]

void Fetch(
Krai_Db_Query
&$qid 
)

Parameters:

Krai_Db_Query

&$qid:

API Tags:

Access:

public

Redefinition of:

Krai_Db_Handler::Fetch(): Fetch a database record from a query as an object

[ Top ]

FetchArray [line 270]

void FetchArray(
Krai_Db_Query
&$qid 
)

Parameters:

Krai_Db_Query

&$qid:

API Tags:

Access:

public

Redefinition of:

Krai_Db_Handler::FetchArray(): Fetch a database record from a query as an array

[ Top ]

FetchOne [line 280]

void FetchOne(
Krai_Db_Query
&$qid 
)

Parameters:

Krai_Db_Query

&$qid:

API Tags:

Access:

public

Redefinition of:

Krai_Db_Handler::FetchOne(): Fetch just one column from the result.

[ Top ]

ParseQueryParams [line 217]

array ParseQueryParams(
[
$params = array()] 
)

Parse the query parameters, escaping and whatnot

This function is a replacement for prepared statements with mysqli since the parameter passing to that and data retrieval is terribly un-elegant.

This function generates regular expressions to pick out the '?' terms in the sql query and an array of replacement syntax, having used Krai_Db_Handler_Mysql::Escape() to clean the values.

Parameters:

array

$params:

The raw parameters

API Tags:

Return:	Regexes for replacement and the clean parameters
Access:	protected

[ Top ]

Process [line 49]

void Process(
Krai_Struct_Dbquery
$query 
)

Parameters:

Krai_Struct_Dbquery

$query:

API Tags:

Access:

public

Redefinition of:

Krai_Db_Handler::Process(): Process a query struct according to its type.

[ Top ]

Query [line 144]

void Query(

$querytype, 
$sql, [
$params = array()] 
)

Parameters:

	$querytype:
	$sql:
array	$params:

API Tags:

Access:

public

Redefinition of:

Krai_Db_Handler::Query(): Execute an SQL query

[ Top ]

Transaction [line 177]

void Transaction(

$_action 
)

Parameters:

$_action:

API Tags:

Access:

public

Redefinition of:

Krai_Db_Handler::Transaction(): Transaction controller

[ Top ]

Documentation generated on Fri, 25 Jul 2008 15:19:40 -0400 by phpDocumentor 1.4.2