phpDocumentor Developer
[ class tree: Developer ] [ index: Developer ] [ all elements ]

Class: DBConnection

Source Location: /core/DBConnection.php

Class DBConnection

Class Overview

This class is a singleton for establishing a connection to the database

Located in /core/DBConnection.php [line 33]



		
				Author(s):
		
		
		
Information Tags:
License:  see

Methods

[ Top ]
Method Summary
static string   escape_value()  
static mixed   exec()   executes a query and triggers logging to the SQL audit log if it's not a SELECT
static boolean   fetchRawDataByIndex()   Retrieves data from the underlying tables, for situations where instantiating the IdP or Profile object is inappropriate
static void   isDataRestricted()   Checks if a raw data pointer is public data (return value FALSE) or if
static int   lastID()   Retrieves the last auto-id of an INSERT. Needs to be called immediately after the corresponding exec() call
void   __clone()   Implemented for safety reasons only. Cloning is forbidden and will tell the user so.

[ Top ]
Methods
static method escape_value  [line 79]

  static string escape_value( string $db, string $value  )

Parameters:
string   $db:  The database to do escapting for
string   $value:  The value to escape

API Tags:
Access:  public


[ Top ]
static method exec  [line 92]

  static mixed exec( $db, string $querystring  )

executes a query and triggers logging to the SQL audit log if it's not a SELECT

Parameters:
string   $querystring:  the query to be executed
   $db: 

API Tags:
Return:  the query result as mysqli_result object; or TRUE on non-return-value statements
Access:  public


[ Top ]
static method fetchRawDataByIndex  [line 121]

  static boolean fetchRawDataByIndex( type $table, type $row  )

Retrieves data from the underlying tables, for situations where instantiating the IdP or Profile object is inappropriate

Parameters:
type   $table:  institution_option or profile_option
type   $row:  rowindex

API Tags:
Access:  public


[ Top ]
static method isDataRestricted  [line 138]

  static void isDataRestricted( $table, $row  )

Checks if a raw data pointer is public data (return value FALSE) or if

yes who the authorised admins to view it are (return array of user IDs)

Parameters:
   $table: 
   $row: 

API Tags:
Access:  public


[ Top ]
static method lastID  [line 177]

  static int lastID( $db  )

Retrieves the last auto-id of an INSERT. Needs to be called immediately after the corresponding exec() call

Parameters:
   $db: 

API Tags:
Return:  the last autoincrement-ID
Access:  public


[ Top ]
__clone  [line 70]

  void __clone( )

Implemented for safety reasons only. Cloning is forbidden and will tell the user so.


API Tags:
Access:  public


[ Top ]

Documentation generated on Thu, 16 Apr 2015 10:26:07 +0000 by phpDocumentor 1.4.4