zCDE Class Reference
[Common Database Essentials]

Inheritance diagram for zCDE:

[legend]

Collaboration diagram for zCDE:

[legend]

Public Member Functions
	toIterable (&$obj)
	Converts an unIterable Object to an Iterable array.
	toUnIterable ($arr)
	Converts an Iterable array to unIterable Object [returns the First row if multiple Rows Exist].
	toObj ($arr)
	Converts an Array to stdClass Object.
	toArray ($obj)
	Converts an Object to an Array.
	dsnBuilder ($driver, $usr, $psw, $host, $db, $table, $port=null, $schema=null)
	Builds a DSN.
	dsnExplode ($dsn)
	Explode a DNS into an Array.
	createConn ($conAliasName, $drv, $database=null, $host=null, $user=null, $psw=null, $port=null)
	Create a Connection File (returns false if file already exists).
	deleteConn ($conAliasName)
	Delete a Connection File.
	overWriteConn ($conAliasName, $drv, $database=null, $host=null, $user=null, $psw=null, $port=null)
	Creates a Connection File (Over Writes if already exist).
	parseConn ($conAliasName)
	Parse the Connection file into an array.

---

Detailed Description

Common database essential.

Definition at line 60 of file zcde.php.

---

Member Function Documentation

zCDE::toIterable( mixed $obj ) 

Converts an unIterable Object to an Iterable array.

Parameters:

$obj

Returns:

array

Definition at line 67 of file zcde.php.

Show Source

                            {
    if(is_array($obj))return $obj;
    return array($obj);
  }

Top 

zCDE::toUnIterable( array $arr ) 

Converts an Iterable array to unIterable Object [returns the First row if multiple Rows Exist].

Parameters:

$arr

Returns:

mixed

Definition at line 77 of file zcde.php.

Show Source

                             {
    if(!is_array($arr))return $arr;
    if(count($arr)==0)return false;
    foreach($arr as $obj)return $obj;
  }

Top 

zCDE::toObj( array $arr ) 

Converts an Array to stdClass Object.

Parameters:

$arr

Definition at line 87 of file zcde.php.

References $val, and perror().

Show Source

                      {
    if(!is_array($arr))return $arr;
    $retObj = new stdClass();
    foreach($arr as $key => $val){
      if(ctype_digit($key)){
        perror("<code>zigmoyd.cde</code><br />Your Array must not be numarically Indexed to get converted to an object");
      }else{
        $retObj->{$key} = zCDE::toObj($val);
      }
    }
    return $retObj;
  }

Here is the call graph for this function:

Top 

zCDE::toArray( object $obj ) 

Converts an Object to an Array.

Parameters:

$obj

Definition at line 104 of file zcde.php.

References $val.

Show Source

                        {
    if(!is_object($obj))return $obj;
    $ret = array();
    foreach($obj as $key => $val){
      $ret[$key] = zCDE::toArray($val);
    }
    return $ret;
  }

Top 

zCDE::dsnBuilder( string $driver, string $usr, string $psw, string $host, string $db, string $table, string $port = null, string $schema = null )

Builds a DSN.

Parameters:

	$driver
	$usr
	$psw
	$host
	$db
	$table
	$port	Optional
	$schema	Optional

Returns:

string

Definition at line 125 of file zcde.php.

Show Source

                                                                                        {
    if($port)$portStr = ":$port";
    else $portStr = "";
    if($schema)$tableStr = "$schema.$table";
    else $tableStr = $table;
    return "$driver://$usr:$psw@$host$portStr/$db/$tableStr";
  }

Top 

zCDE::dsnExplode( string $dsn ) 

Explode a DNS into an Array.

Parameters:

$dsn

Returns:

array

Definition at line 138 of file zcde.php.

References perror().

Show Source

                           {
    if(preg_match('~(?P<driver>\w+)://(?P<usr>\w+):(?P<psw>\w+)@(?P<host>\w+)(?::(?P<port>\d+))?/(?P<db>\w+)/(?P<schema>\w+)(?:\.(?P<table>\w+))?~', $dsn, $m) < 1){
      perror('<code>zigmoyd.cde.dnsExplode</code><br />Failed to Parse as Invalid DNS Specified');
      return false;
    }
    for($i = 0;$i<count($m);++$i){
      if(isset($m[$i]))unset($m[$i]);
    }
    if(!isset($m['table'])){
      $m['table'] = $m['schema'];
      unset($m['schema']);
    }
    return $m;
  }

Here is the call graph for this function:

Top 

zCDE::createConn( string $conAliasName, string $drv, string $database = null, string $host = null, string $user = null, string $psw = null, int $port = null )

Create a Connection File (returns false if file already exists).

Parameters:

	$conAliasName
	$drv
	$database
	$host	Optional
	$user	Optional
	$psw	Optional
	$port	Optional

Returns:

boolean

Definition at line 164 of file zcde.php.

Show Source

                                                                                                         {
    $path = ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.ZIGSETTINGSDIR.DRS.Z_DIR_ETC_CONF.DRS.$conAliasName.".con.ini.php";
    if(file_exists($path))return false;
    $iniStr = "driver=\"$drv\"\ndatabase=\"$database\"\nhost=\"$host\"\nuser=\"$user\"\npsw=\"$psw\"\nport=\"$port\"";
    return file_put_contents($path, $iniStr);
  }

Top 

zCDE::deleteConn( int $conAliasName ) 

Delete a Connection File.

Parameters:

$connAliasName

string

Returns:

boolean

Definition at line 176 of file zcde.php.

Show Source

                                    {
    $path = ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.ZIGSETTINGSDIR.DRS.Z_DIR_ETC_CONF.DRS.$conAliasName.".con.ini.php";
    if(!file_exists($path))return false;
    return unlink($path);
  }

Top 

zCDE::overWriteConn( string $conAliasName, string $drv, string $database = null, string $host = null, string $user = null, string $psw = null, int $port = null )

Creates a Connection File (Over Writes if already exist).

Parameters:

	$conAliasName
	$drv
	$database
	$host	Optional
	$user	Optional
	$psw	Optional
	$port	Optional

Returns:

boolean

Definition at line 193 of file zcde.php.

Show Source

                                                                                                            {
    $path = ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.ZIGSETTINGSDIR.DRS.Z_DIR_ETC_CONF.DRS.$conAliasName.".con.ini.php";
    $iniStr = "driver=\"$drv\"\ndatabase=\"$database\"\nhost=\"$host\"\nuser=\"$user\"\npsw=\"$psw\"\nport=\"$port\"";
    return file_put_contents($path, $iniStr);
  }

Top 

zCDE::parseConn( string $conAliasName ) 

Parse the Connection file into an array.

Parameters:

$conAliasName

Returns:

array

Definition at line 204 of file zcde.php.

Show Source

                                   {
    $path = ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.ZIGSETTINGSDIR.DRS.Z_DIR_ETC_CONF.DRS.$conAliasName.".con.ini.php";
    if(file_exists($path))return false;
    return parse_ini_file($path);
  }

Top 

---

The documentation for this class was generated from the following file:

• zcde.php