Sql Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	Sql ($query= '', $dbid='')
	parseSourceQuery ($query)
	setQuery ($query= '')
	setParam ($name, $value, $dieIfUnknown=true)
	setVar ($name, $value)
	setInt ($name, $value)
	setIntList ($name, $values)
	setString ($name, $value)
	setStringList ($name, $values)
	setBoolean ($name, $value)
	setNull ($name)
&	query ()
&	getQuery ()
Öffentliche Attribute
	$src = ''
	$query = ''
	$data = Array()
	$param = array()
	$dbid = ''

---

Ausführliche Beschreibung

Definiert in Zeile 54 der Datei Sql.class.php.

---

Dokumentation der Elementfunktionen

& Sql::getQuery

(

)

Ermittelt die fertige SQL-Anfrage.

Definiert in Zeile 361 der Datei Sql.class.php.

Benutzt query().

Wird benutzt von query().

     {
// Abbruch, wenn es noch nicht gefüllte Parameter gibt.
// Da diese Methode eh kaum verwendet wird, erstmal deaktiviert.
//        if   ( count($this->param) > 0 )
//             die('parameters not bound: '+implode(',',$this->param) );
               
          return $this->query;
     }

Sql::parseSourceQuery

(

$

query

)

Die SQL-Anfrage wird auf Parameter untersucht.

Definiert in Zeile 116 der Datei Sql.class.php.

Benutzt $query, query(), setParam() und table_names().

Wird benutzt von setQuery() und Sql().

     {
          $this->src   = $query; // Wir merken uns die Ur-Abfrage, evtl. für Fehlermeldungen interessant.
          
          while( true )  // Schleife wird solange durchlaufen, solange Parameter gefunden werden.
          {
               $posKlLinks  = strpos($query,'{');
               $posKlRechts = strpos($query,'}');
               
               if   ( $posKlLinks === false )
                    break; // Schleife abbrechen, wenn kein Parameter mehr gefunden wird.
                    
               $nameParam = substr($query,$posKlLinks+1,$posKlRechts-$posKlLinks-1);  // Name Parameter
               
               if   ( !isset($this->param[$nameParam ]))
                    $this->param   [$nameParam ] = array();
                    
               $this->param[$nameParam ][] = $posKlLinks;
               
               $query = substr($query,0,$posKlLinks).substr($query,$posKlRechts+1);
          }
          
          $this->query = $query;

          // Tabellennamen in die Platzhalter setzen.
          // Dies ist noch OpenRat-spezifisch und sollte bei einer sauberen Abstraktion woanders gemacht werden. Aber wo?
          foreach( table_names($this->dbid) as $t=>$name )
          {
               $this->setParam($t,$name,false );
          }
          
//        Html::debug($this->param);    
     }

& Sql::query

(

)

Ermittelt die fertige SQL-Anfrage.
Alias zu getQuery()

Definiert in Zeile 351 der Datei Sql.class.php.

Benutzt getQuery().

Wird benutzt von getQuery(), parseSourceQuery() und setParam().

     {
          return $this->getQuery();
     }

Sql::setBoolean	(	$	name,
		$	value
	)

Setzt einen bool'schen Wert als Parameter.
Ist der Parameterwert wahr, dann wird eine 1 gesetzt. Sonst 0.

Parameter:

	name	Name des Parameters
	value	Inhalt

Definiert in Zeile 325 der Datei Sql.class.php.

Benutzt setInt().

     {
          if   ( $value )
               $this->setInt( $name,1 );
          else $this->setInt( $name,0 );
     }

Sql::setInt	(	$	name,
		$	value
	)

Setzt eine Ganzzahl als Parameter.

Parameter:

	name	Name des Parameters
	value	Inhalt

Definiert in Zeile 250 der Datei Sql.class.php.

Benutzt setParam().

Wird benutzt von setBoolean(), setQuery() und setVar().

     {
          $this->data[ $name ] = array( 'type'=>'int','value'=>$value );
          
          $this->setParam($name,intval($value));
//        $this->query = str_replace( '{'.$name.'}',intval($value),$this->query );
     }

Sql::setIntList	(	$	name,
		$	values
	)

Setzt eine Ganzzahl-Liste als Parameter.

Parameter:

	name	Name des Parameters
	values	Inhalte

Definiert in Zeile 266 der Datei Sql.class.php.

Benutzt setParam().

Wird benutzt von setQuery().

     {
          $this->data[ $name ] = array( 'type'=>'intlist','value'=>$values );
          
          $values  = array_map('intval',$values);
          $this->setParam($name,implode(',',$values) );
//        $this->query = str_replace( '{'.$name.'}',intval($value),$this->query );
     }

Sql::setNull

(

$

name

)

Setzt einen Parameter auf den Wert null.

Parameter:

name

Name des Parameters

Definiert in Zeile 339 der Datei Sql.class.php.

Benutzt setParam().

Wird benutzt von setQuery() und setVar().

     {
          $this->data[ $name ] = array( 'type'=>'null' );
          $this->setParam($name,'NULL');
     }

Sql::setParam	(	$	name,
		$	value,
		$	dieIfUnknown = true
	)

Setzt einen Parameter.
Diese Methode sollte nur intern aufgerufen werden!

Parameter:

	name	Name des Parameters
	value	Inhalt
	dieIfUnknown	wenn true und Parameter unbekannt, dann Abbruch. private

Definiert in Zeile 182 der Datei Sql.class.php.

Benutzt query().

Wird benutzt von parseSourceQuery(), setInt(), setIntList(), setNull(), setString() und setStringList().

     {

          //   Nett gemeint, führt aber aktuell zu Fehlern, weil an vielen Stellen zu viele Parameter gefüllt werden.
          //   Daher erstmal deaktiviert.
          //        if   ( !isset($this->param[$name]) )
          //        {
          //             if   ( $dieIfUnknown )
          //                  die("parameter '$name' unknown. SQL=".$this->src);
          //             else
          //                  return;
          //        }

          if   ( !isset($this->param[$name]) )
               return; // Parameter nicht vorhanden.

          if   ( is_array($this->param[$name]) )
          {
               foreach( $this->param[$name] as $idx=>$xyz )
               {
                    $pos = $this->param[$name][$idx];
                    
                    $this->query = substr( $this->query,0,$pos ).$value.substr( $this->query,$pos );
               
                    foreach( $this->param as $pn=>$par)
                    {
                         foreach( $par as $i=>$p )
                         {
                              if   ( $p > $pos )
                                   $this->param[$pn][$i]=$p+strlen($value);
                         }
                    }
                    
               }
          }
          
          unset( $this->param[$name] );
     }

Sql::setQuery

(

$

query = ''

)

Setzt eine neue SQL-Abfrage.
Bereits vorhandene Parameter werden automatisch wieder gesetzt.

Definiert in Zeile 156 der Datei Sql.class.php.

Benutzt $data, $query, parseSourceQuery(), setInt(), setIntList(), setNull(), setString() und setStringList().

     {
          $this->parseSourceQuery( $query );

          // Bereits vorhande Parameter setzen.        
          foreach( $this->data as $name=>$data )
          {
               if   ( $data['type']=='string'     ) $this->setString    ($name,$data['value'] );
               if   ( $data['type']=='stringlist' ) $this->setStringList($name,$data['value'] );
               if   ( $data['type']=='int'        ) $this->setInt       ($name,$data['value'] );
               if   ( $data['type']=='intlist'    ) $this->setIntList   ($name,$data['value'] );
               if   ( $data['type']=='null'       ) $this->setNull      ($name                );
          }
     }

Sql::setString	(	$	name,
		$	value
	)

Setzt eine Zeichenkette als Parameter.

Parameter:

	name	Name des Parameters
	value	Inhalt

Definiert in Zeile 283 der Datei Sql.class.php.

Benutzt setParam().

Wird benutzt von setQuery() und setVar().

     {
          $this->data[ $name ] = array( 'type'=>'string','value'=>$value );

          //if ( defined('CONF_ADDSLASHES') && CONF_ADDSLASHES )
          
          $value = addslashes( $value );

          $value = "'".$value."'";

          $this->setParam($name,$value);
//        $this->query = str_replace( '{'.$name.'}',$value,$this->query );
     }

Sql::setStringList	(	$	name,
		$	values
	)

Setzt eine Zeichenketten-Liste als Parameter.

Parameter:

	name	Name des Parameters
	values	Inhalte

Definiert in Zeile 305 der Datei Sql.class.php.

Benutzt setParam().

Wird benutzt von setQuery().

     {
          $this->data[ $name ] = array( 'type'=>'stringlist','value'=>$values );

          $values  = array_map('addslashes',$values);
          
          $value = "'".implode("','",$values)."'";

          $this->setParam($name,$value);
     }

Sql::setVar	(	$	name,
		$	value
	)

Setzt einen Parameter.
Der Typ des Parameters wird automatisch ermittelt.

Parameter:

	name	Name des Parameters
	value	Inhalt

Definiert in Zeile 230 der Datei Sql.class.php.

Benutzt setInt(), setNull() und setString().

     {
          if   ( is_string($value) )
               $this->setString( $name,$value );

          if   ( is_null($value) )
               $this->setNull( $name );
          
          if   ( is_int($value) )
               $this->setInt( $name,$value );
     }

Sql::Sql	(	$	query = '',
		$	dbid = ''
	)

Erzeugt ein SQL-Objekt und analysiert die SQL-Anfrage.

Definiert in Zeile 103 der Datei Sql.class.php.

Benutzt $dbid, $query und parseSourceQuery().

     {
          $this->dbid  = $dbid;
          $this->parseSourceQuery( $query );

          $this->data  = array();
     }

---

Dokumentation der Datenelemente

Sql::$data = Array()

Zwischenspeicher für Parameterwerte.

Definiert in Zeile 70 der Datei Sql.class.php.

Wird benutzt von setQuery().

Sql::$dbid = ''

Definiert in Zeile 97 der Datei Sql.class.php.

Wird benutzt von Sql().

Sql::$param = array()

Ein 2-dimensionales Array mit den Positionen der Parameter.

Beispiel:

 Array
 (
    [lid] => Array
    (
       [0] => 65
       [1] => 81
    )
    [oid] => Array
    (
        [0] => 123
    )
 )
 

In der ersten Dimension sind die Parameter vorhanden, jeder Parameter hat eine Liste von Positionen, an denen er steht.
Ein Parameter kann nämlich mehrfach vorkommen!

Definiert in Zeile 94 der Datei Sql.class.php.

Sql::$query = ''

Auszuführende Abfrage.

Definiert in Zeile 64 der Datei Sql.class.php.

Wird benutzt von parseSourceQuery(), setQuery() und Sql().

Sql::$src = ''

Ursprüngliche SQL-Anweisung.

Definiert in Zeile 59 der Datei Sql.class.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• serviceClasses/Sql.class.php