zOrm_magic Class Reference
[Object-relational mapping.]

Inheritance diagram for zOrm_magic:

[legend]

Collaboration diagram for zOrm_magic:

[legend]

Public Member Functions
	fetchCol ()
	fetchColAsAlias ()
	setCol ($value)
	identifyByCol ($value)
	identifyByColOp ($value)
	findCol1ByCol2 ($value, $indxCol=null, $ordCol=null, $ordMode=ZIGORM_ORDER_ASC)
	findCol1ByCol2Op ($value, $indxCol=null, $ordCol=null, $ordMode=ZIGORM_ORDER_ASC)
	findCol ($indxCol=null, $ordCol=null, $ordMode=ZIGORM_ORDER_ASC)
Private Member Functions
	lexize ($clause, $args)
	__call ($methodName, $args, &$return)

---

Detailed Description

Holds all Magic Methods of an ORM Class.

Definition at line 31 of file magic.php.

---

Member Function Documentation

zOrm_magic::lexize	(	$	clause,
		$	args
	)			[private]

For internal use only.

Definition at line 36 of file magic.php.

References zOrm_core::$lex.

Referenced by __call().

                                 {
    //{ Analyze the Column Name and Opcode and may
    $opcode = array(
              'equals',
              'greaterthan',
              'greaterthanequals',
              'lessthan',
              'lessthanquals',
              'like',
              'notequals'
              );
    foreach($opcode as $op)array_push($opcode, 'may'.$op);
    $opcode = array_reverse($opcode);
    for($i=0;$i<count($opcode);$i++)$opcode[$i] = strrev($opcode[$i]);
    $var = preg_match('~('.implode('|', $opcode).')?(\w+)~i', strrev($clause), $m);
    //{{ Assign Actual Symbol for the Textual Classes
    $opcode = array(
                'equals' => '=',
                'notequals' => '!=',
                'greaterthan' => '>',
                'greaterthanequals' => '>=',
                'lessthan' => '<',
                'lessthanequals' => '<=',
                'like' => 'LIKE'
              );
    foreach($opcode as $op => $smb)$opcode['may'.$op] = $smb;
    //}}
    for($i=0;$i<count($m);$i++)$m[$i] = strrev($m[$i]);
    if(!strlen($m[1]))$m[1] = 'equals';//If no Symbol is given Make it Equals
    $lex = new stdClass();
    (eregi('may', $m[1])) ? $lex->may=false : $lex->may=true;
    $lex->op = $opcode[$m[1]];
    $lex->col = $m[2];
    $lex->val = $args[0];
    //}
    return $lex;
  }

zOrm_magic::__call	(	$	methodName,
		$	args,
		&$	return
	)			[private]

For internal use only.

Definition at line 77 of file magic.php.

References zOrm_core::$lex, $val, zOrm_noMagic::fetch(), zOrm_noMagic::fetchAs(), zOrm_noMagic::find(), zOrm_noMagic::identifyBy(), lexize(), zOrm_base::order(), and perror().

                                               {
    switch(true){
      case (preg_match('~identifyBy(\w+)~i', $methodName, $m) >= 1):
          if(!isset($args[0])){
            perror('<code>zigmoyd.orm.'.$methodName.'($value)</code><br />you must supply at least 1 Argument No argument has been Suplied');
            $return = false;
            return true;
          }
          if(eregi('pk', $m[1])){
            $val = array();
            $listArgs = func_get_args();
            $listArgs = $listArgs[1];
            foreach($listArgs as $value){
              if(!is_array($value)){
                $val[] = $value;
              }else{
                foreach($value as $innerVal){
                  $val[] = $innerVal;
                }
              }
            }
          }else{
            $val = $args[0];
          }
          $lex = $this->lexize(strtolower($m[1]), $args);
          $return = $this->identifyBy($lex->col, $val, $lex->op, $lex->may);
          return true;
        break;
      case (preg_match('~set(\w+)~i', $methodName, $m) >= 1):
          if(!isset($args[0])){
            perror('<code>zigmoyd.orm.'.$methodName.'($value)</code><br />you must supply 1 Argument No argument has been Suplied');
            $return = false;
            return true;
          }
          $return = $this->set($m[1], $args[0]);
          return true;
        break;
      case (preg_match('~fetch(\w+)As(\w+)~i', $methodName, $m) >= 1):
          if(isset($this->lex['alias'][strtolower("$m[1]As$m[2]")])){//If a Column exists with this name
            if(!isset($args[0]))$args[0] = true;
            $return = $this->fetch(strtolower("$m[1]As$m[2]"), $args[0]);
            return true;
          }
          if(eregi('all', $m[1])){
            perror("use fetchAll() Instead, cause fetchAllAsSomeThing() doesn't have a meaning");
            $return = false;
            return true;
          }
          $return = $this->fetchAs($m[1], $m[2]);
          return true;
        break;
      case (preg_match('~fetch(\w+)~i', $methodName, $m) >= 1):
          if(!isset($args[0]))$args[0] = true;
          $return = $this->fetch($m[1], $args[0]);
          return true;
        break;
      case (preg_match('~find(\w+)~i', $methodName, $m) >= 1):
          if(isset($args[1]) && strlen($args[1])){//The Order Column Is Given
            $ordWay = isset($args[2]) ? $args[2] : ZIGORM_ORDER_ASC;
            $this->order($args[1], $ordWay);
          }
          if(isset($args[0]) && strlen($args[0])){//The Index Column is Given
            $return = $this->find($m[1], $args[0]);
          }else{
            $return = $this->find($m[1]);
          }
          return true;
        break;
      case (preg_match('~get(\w+)As(\w+)~i', $methodName, $m) >= 1):
          perror('<code>zigmoyd.orm.'.$this->__struct->alias.'.'.$methodName.'()</code><br />Method doesn\'t exists Plese Check the Documentation Properly<br />However I think You meant find or fetch instead of get');
          return false;
        break;
      default:
        perror('<code>zigmoyd.orm.'.$this->__struct->alias.'.'.$methodName.'()</code><br />Method doesn\'t exists Plese Check the Documentation Properly');
        exit;
    }
  }

Here is the call graph for this function:

zOrm_magic::fetchCol

(

)

Fetch a Column more customized SELECT Operation. Find methods are Simple to use.But you can use only one Where clause at a time.But What if you need to use two where Clause at a time for that situation there is fetch a more customized approach. find methods just set one Column to be selected. If you want to select two columns use fetchCol1() and fetchCol2() so that both Col1 and Col2 will be flagged as to be selected.

Note:

This is a Magic Method so no such method really exists Physically. and you need to write appropiate strings in the place Holders of the method name. e.g. fetchCol() means you need to replace Col with your Column Name like fetchName()

Returns:

void

Definition at line 164 of file magic.php.

{}

zOrm_magic::fetchColAsAlias

(

)

Fetch a Column with a Different Temporary Alias name. Works just like fetchCol() However On the returned RowSet (after invoking zOrm_base::export()) the provided alias Name will be used. Instead of Alias name set in ORM Map. This meant to be used to handle rare Column Alias Name Conflicts.

See also:

fetchCol()

Definition at line 171 of file magic.php.

{}

zOrm_magic::setCol

(

$

value

)

Set a Value on a Column. you can set value to a Column just like setName("Foo") Which will be updated or inserted or deleted after invoking update() or insert() or delete() operation.

Warning:

dont forget to set a where caluse by identifyByCol() while executing update() or delete() else all rows might be affected unnecessarily.

Parameters:

$value

string value to be set on that column.

Note:

This is a Magic Method so no such method really exists Physically. and you need to write appropiate strings in the place Holders of the method name. e.g. setCol() means you need to replace Col with your Column Name like setName().

Returns:

void

Definition at line 183 of file magic.php.

{}

zOrm_magic::identifyByCol

(

$

value

)

Set Criteria for a Column works like identifyById(1). sets a Criteria for the Col with = (equal) operator. e.g. identifyById(1) set's an where clause id equals 1

Parameters:

$value

string Value of the Column in the Criteria

Attention:

You can use 'pk' at the place of 'Col' to use the Primary Key for The Criteria e.g. identifyByPk(1)

Warning:

Magic Method overload must be supported (However Its supported in most of the cases)

Note:

This is a Magic Method so no such method really exists Physically. and you need to write appropiate strings in the place Holders of the method name. e.g. identifyByColOp() means you need to replace Col with your Column Name like identifyById(1)

Returns:

void

Definition at line 196 of file magic.php.

{}

zOrm_magic::identifyByColOp

(

$

value

)

Find one or all Column(s) By another Column or Primary Key with a Custom Single Criteria like findNameByIdEquals(1). fetch's value of one Column while adds a Criteria to another column and executes select Query and returns. value of the fetched Column.e.g. If you use findNameByIdGreaterThan(1) it will return a string data representing the name who's id is greater than one else returns false. see identifyByColOp() for a set of Operators.

Attention:

You can use 'pk' at the place of 'Col2' to use the Primary Key for The Criteria e.g. findNameByPkEquals(1).

You can use 'all' at the place of 'Col1' to fetch All Columns e.g. Full Row. which will return an object/array you can use it like findAllByIdEquals(1).

Warning:

Magic Method overload must be supported (However Its supported in most of the cases)

Note:

This is a Magic Method so no such method really exists Physically. and you need to write appropiate strings in the place Holders of the method name. e.g. findCol1ByCol2Op() means you need to replace Col1 with your Column Name that has to be fetched and Col2 with the Column Name against which you want to bind some Criteria(s) and Op should be replaced by Operation text like 'Equals' 'GreaterThanEquals' etc.. like findNameByIdEquals(1)

Warning:

This method may return a rowset Object or an array of RowSet Objects when findAllBySomethingEquals(1) has been executed. If number of rows in the SELECT output is more than one it returns an array of rowSet Object. But if only one row has been returned it returns a RowSet Object. In the Same Way when you code findColumnBySomethingEquals(1) it may return a string containing the value of that Column. or an array of strings. If your Code is written in such way that it expects iterable output from this method you should use zCDE Module and zCDE::toIterable() on its output. If your Criteria and fetch has generated multi Row result it will return an aray of strings. else it will return a string. However PHP doesn't have Strict type safty so that string will implecitely get converted to any premitive datatype in internal coertion.

Parameters:

$value

string Value of the column against which criteria has to be set.

Returns:

mixed

Definition at line 224 of file magic.php.

{}

zOrm_magic::findCol1ByCol2	(	$	value,
		$	indxCol = null,
		$	ordCol = null,
		$	ordMode = ZIGORM_ORDER_ASC
	)

Find one or all Column(s) By another Column or Primary Key like findNameById(1). fetch's value of one Column while adds an Equals Criteria to another column and executes select Quiry and returns. value of the fetched Column.e.g. If you use findNameById(1) it will return a string data representing the name who's id is one else returns false.

Attention:

You can use 'pk' at the place of 'Col2' to use the Primary Key for The Criteria e.g. findNameByPk(1).

You can use 'all' at the place of 'Col1' to fetch All Columns e.g. Full Row. which will return an object/array you can use it like findAllById(1).

Warning:

Magic Method overload must be supported (However Its supported in most of the cases)

Note:

This is a Magic Method so no such method really exists Physically. and you need to write appropiate strings in the place Holders of the method name. e.g. findCol1ByCol2() means you need to replace Col1 with your Column Name that has to be fetched and Col2 with the Column Name against which you want to wnat to bind some Criteria(s) like findNameById(1)

Warning:

This method may return a rowset Object or an array of RowSet Objects when findAllBySomething() has been executed. If number of rows in the SELECT output is more than one it returns an array of rowSet Object. But if only one row has been returned it returns a RowSet Object. In the Same Way when you code findColumnBySomething() it may return a string containing the value of that Column. or an array of strings. If your Code is written in such way that it expects iterable output from this method you should use zCDE Module and zCDE::toIterable() on its output. If your Criteria and fetch has generated multi Row result it will return an aray of strings. else it will return a string. However PHP doesn't have Strict type safty so that string will implecitely get converted to any premitive datatype in internal coertion.

Note:

You can optionally supply an additional argument for indexing the resultant array. if an additional Index Column is supplied the result array will be indexed with values coming from the index Column

You can optionally supply an additional argument for ordering. e.g. an order Column cn be given. You can specify order Types as ZIGORM_ORDER_ASC and ZIGORM_ORDER_DESC

Parameters:

	$value	string Value of the column against which criteria has to be set.
	$indxCol	string Optional the Index Column with which to index the array defaults to null.
	$ordCol	string Optional order Column whith which to order defaults to null
	$ordMode	int Optional order Mode Ascending(ZIGORM_ORDER_ASC) or descending(ZIGORM_ORDER_DESC) defaults to ZIGORM_ORDER_ASC

Returns:

mixed

Definition at line 255 of file magic.php.

{}

zOrm_magic::findCol1ByCol2Op	(	$	value,
		$	indxCol = null,
		$	ordCol = null,
		$	ordMode = ZIGORM_ORDER_ASC
	)

Find one or all Column(s) By another Column or Primary Key with a Custom Single Criteria like findNameByIdEquals(1). fetch's value of one Column while adds a Criteria to another column and executes select Query and returns. value of the fetched Column.e.g. If you use findNameByIdGreaterThan(1) it will return a string data representing the name who's id is greater than one else returns false. see identifyByColOp() for a set of Operators.

Attention:

You can use 'pk' at the place of 'Col2' to use the Primary Key for The Criteria e.g. findNameByPkEquals(1).

You can use 'all' at the place of 'Col1' to fetch All Columns e.g. Full Row. which will return an object/array you can use it like findAllByIdEquals(1).

Warning:

Magic Method overload must be supported (However Its supported in most of the cases)

Note:

This is a Magic Method so no such method really exists Physically. and you need to write appropiate strings in the place Holders of the method name. e.g. findCol1ByCol2Op() means you need to replace Col1 with your Column Name that has to be fetched and Col2 with the Column Name against which you want to bind some Criteria(s) and Op should be replaced by Operation text like 'Equals' 'GreaterThanEquals' etc.. like findNameByIdEquals(1)

Warning:

This method may return a rowset Object or an array of RowSet Objects when findAllBySomethingEquals(1) has been executed. If number of rows in the SELECT output is more than one it returns an array of rowSet Object. But if only one row has been returned it returns a RowSet Object. In the Same Way when you code findColumnBySomethingEquals(1) it may return a string containing the value of that Column. or an array of strings. If your Code is written in such way that it expects iterable output from this method you should use zCDE Module and zCDE::toIterable() on its output. If your Criteria and fetch has generated multi Row result it will return an aray of strings. else it will return a string. However PHP doesn't have Strict type safty so that string will implecitely get converted to any premitive datatype in internal coertion.

Note:

You can optionally supply an additional argument for indexing the resultant array. if an additional Index Column is supplied the result array will be indexed with values coming from the index Column

You can optionally supply an additional argument for ordering. e.g. an order Column cn be given. You can specify order Types as ZIGORM_ORDER_ASC and ZIGORM_ORDER_DESC

Parameters:

	$value	string Value of the column against which criteria has to be set.
	$indxCol	string Optional the Index Column with which to index the array defaults to null.
	$ordCol	string Optional order Column whith which to order defaults to null
	$ordMode	int Optional order Mode Ascending(ZIGORM_ORDER_ASC) or descending(ZIGORM_ORDER_DESC) defaults to ZIGORM_ORDER_ASC

Returns:

mixed

Definition at line 288 of file magic.php.

{}

zOrm_magic::findCol	(	$	indxCol = null,
		$	ordCol = null,
		$	ordMode = ZIGORM_ORDER_ASC
	)

Find all Values of a Column as an array. you can execute findName() to get all Names. However you can also use findAll() which returns an array of RowSet Objects.

Attention:

You can use 'all' at the place of 'Col' to fetch All Columns e.g. Full Row. which will return an object/array you can use it like findAll().

Warning:

Magic Method overload must be supported (However Its supported in most of the cases)

Note:

This is a Magic Method so no such method really exists Physically. and you need to write appropiate strings in the place Holders of the method name. e.g. findCol() means you need to replace Col with your Column Name or 'All' that has to be fetched findName()

You can optionally supply an additional argument for indexing the resultant array. if an additional Index Column is supplied the result array will be indexed with values coming from the index Column

You can optionally supply an additional argument for ordering. e.g. an order Column cn be given. You can specify order Types as ZIGORM_ORDER_ASC and ZIGORM_ORDER_DESC

Parameters:

	$indxCol	string Optional the Index Column with which to index the array defaults to null.
	$ordCol	string Optional order Column whith which to order defaults to null
	$ordMode	int Optional order Mode Ascending(ZIGORM_ORDER_ASC) or descending(ZIGORM_ORDER_DESC) defaults to ZIGORM_ORDER_ASC

Returns:

mixed

Definition at line 305 of file magic.php.

{}

---

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

• magic.php