1
0
mirror of https://github.com/dg/dibi.git synced 2025-10-29 12:46:15 +01:00

updated phpDoc

This commit is contained in:
David Grudl
2010-08-03 22:48:44 +02:00
parent 9a4f1e6e36
commit 0d7b9c32c9
18 changed files with 125 additions and 121 deletions

View File

@@ -46,7 +46,16 @@ class DibiConnection extends DibiObject
/**
* Creates object and (optionally) connects to a database.
* Connection options: (see driver-specific options too)
* - lazy (bool) => if TRUE, connection will be established only when required
* - result (array) => result set options
* - detectTypes (bool) => detect the types of result set fields?
* - formatDateTime => date-time format (if empty, DateTime objects will be returned)
* - profiler (array or bool)
* - run (bool) => enable profiler?
* - class => profiler class name (default is DibiProfiler)
* - substitutes (array) => map of driver specific substitutes (under development)
* @param mixed connection parameters
* @param string connection name
* @throws DibiException

View File

@@ -497,7 +497,7 @@ class DibiColumnInfo extends DibiObject
*/
public function getFullName()
{
return $this->info['fullname'];
return isset($this->info['fullname']) ? $this->info['fullname'] : NULL;
}
@@ -613,7 +613,7 @@ class DibiColumnInfo extends DibiObject
* Heuristic type detection.
* @param string
* @return string
* @internal
* @internal
*/
public static function detectType($type)
{

View File

@@ -95,7 +95,7 @@ class DibiFluent extends DibiObject implements IDataSource
/** @var array */
private $cursor;
/** @var DibiLazyStorage normalized clauses */
/** @var DibiLazyStorage normalized clauses */
private static $normalizer;
@@ -476,7 +476,7 @@ class DibiFluent extends DibiObject implements IDataSource
* Format camelCase clause name to UPPER CASE.
* @param string
* @return string
* @internal
* @internal
*/
public static function _formatClause($s)
{

View File

@@ -13,7 +13,7 @@
/**
* dibi result-set.
* dibi result set.
*
* <code>
* $result = dibi::query('SELECT * FROM [table]');
@@ -28,10 +28,6 @@
* unset($result);
* </code>
*
* Result options:
* - 'detectTypes' - whether call automatically detectTypes()
* - 'formatDateTime' - how to format datetime
*
* @copyright Copyright (c) 2005, 2010 David Grudl
* @package dibi
*
@@ -648,7 +644,7 @@ class DibiResult extends DibiObject implements IDataSource
/**
* Displays complete result-set as HTML table for debug purposes.
* Displays complete result set as HTML table for debug purposes.
* @return void
*/
final public function dump()

View File

@@ -13,7 +13,7 @@
/**
* Result-set single row.
* Result set single row.
*
* @copyright Copyright (c) 2005, 2010 David Grudl
* @package dibi

View File

@@ -556,7 +556,7 @@ final class DibiTranslator extends DibiObject
* Apply substitutions to indentifier and delimites it.
* @param string indentifier
* @return string
* @internal
* @internal
*/
public function delimite($value)
{

View File

@@ -221,8 +221,7 @@ interface IDibiDriver
/**
* Returns metadata for all columns in a result set.
* @return array
* @throws DibiException
* @return array of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}
*/
function getColumnsMeta();
@@ -248,21 +247,21 @@ interface IDibiReflector
/**
* Returns list of tables.
* @return array
* @return array of {name [, (bool) view ]}
*/
function getTables();
/**
* Returns metadata for all columns in a table.
* @param string
* @return array
* @return array of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}
*/
function getColumns($table);
/**
* Returns metadata for all indexes in a table.
* @param string
* @return array
* @return array of {name, (array of names) columns [, (bool) unique, (bool) primary ]}
*/
function getIndexes($table);