Class ilPostgresQueryUtils. More...

Inheritance diagram for ilPostgresQueryUtils:

Collaboration diagram for ilPostgresQueryUtils:

Public Member Functions

createTable ($name, $fields, $options=array())

in ($field, $values, $negate=false, $type="")

quote ($value, $type=null)

concat (array $values, $allow_null=true)

locate ($a_needle, $a_string, $a_start_pos=1)

free (ilPDOStatement $statement)

quoteIdentifier ($identifier)

like ($column, $type, $value="?", $case_insensitive=true)

now ()

lock (array $tables)

unlock ()

createDatabase ($a_name, $a_charset="utf8", $a_collation="")

groupConcat ($a_field_name, $a_seperator=",", $a_order=null)

cast ($a_field_name, $a_dest_type)

Parameters

string	$a_field_name
mixed	$a_dest_type

Returns: string

More...

Public Member Functions inherited from ilQueryUtils

__construct (ilDBInterface $ilDBInterface)

ilMySQLQueryUtils constructor. More...

in ($field, $values, $negate=false, $type="")

quote ($value, $type=null)

concat (array $values, $allow_null=true)

locate ($a_needle, $a_string, $a_start_pos=1)

free (ilPDOStatement $statement)

quoteIdentifier ($identifier)

createTable ($name, $fields, $options=array())

like ($column, $type, $value="?", $case_insensitive=true)

now ()

lock (array $tables)

unlock ()

createDatabase ($a_name, $a_charset="utf8", $a_collation="")

groupConcat ($a_field_name, $a_seperator=",", $a_order=null)

Parameters

string	$a_field_name
string	$a_seperator
string	$a_order

Returns: string

More...

cast ($a_field_name, $a_dest_type)

Parameters

string	$a_field_name
mixed	$a_dest_type

Returns: string

More...

Additional Inherited Members
Protected Attributes inherited from ilQueryUtils
	$db_instance

Detailed Description

Class ilPostgresQueryUtils.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 8 of file class.ilPostgresQueryUtils.php.

Member Function Documentation

◆ cast()

ilPostgresQueryUtils::cast	(	$a_field_name,
		$a_dest_type
	)

Parameters

string	$a_field_name
mixed	$a_dest_type

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 325 of file class.ilPostgresQueryUtils.php.

     {
         return "CAST({$a_field_name} AS " . $this->db_instance->getFieldDefinition()->getTypeDeclaration(array("type" => $a_dest_type)) . ")";
     }

◆ concat()

ilPostgresQueryUtils::concat	(	array	$values,
			$allow_null = `true`
	)

Parameters

array	$values
bool	$allow_null

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 115 of file class.ilPostgresQueryUtils.php.

     {
         if (!count($values)) {
             return ' ';
         }
 
         $concat = ' CONCAT(';
         $first = true;
         foreach ($values as $field_info) {
             $val = $field_info[0];
 
             if (!$first) {
                 $concat .= ',';
             }
 
             if ($allow_null) {
                 $concat .= 'COALESCE(';
             }
             $concat .= $val;
 
             if ($allow_null) {
                 $concat .= ",''";
                 $concat .= ')';
             }
 
             $first = false;
         }
         $concat .= ') ';
 
         return $concat;
     }

◆ createDatabase()

ilPostgresQueryUtils::createDatabase	(	$a_name,
		$a_charset = `"utf8"`,
		$a_collation = `""`
	)

Parameters

	$a_name
string	$a_charset
string	$a_collation

Returns: mixed

Implements ilQueryUtilsInterface.

Definition at line 292 of file class.ilPostgresQueryUtils.php.

     {
         if ($a_collation != "") {
             $sql = "CREATE DATABASE " . $a_name . " CHARACTER SET " . $a_charset . " COLLATE " . $a_collation;
         } else {
             $sql = "CREATE DATABASE " . $a_name . " CHARACTER SET " . $a_charset;
         }
 
         return $sql;
     }

◆ createTable()

ilPostgresQueryUtils::createTable	(	$name,
		$fields,
		$options = `array()`
	)

Parameters

	$name
	$fields
array	$options

Returns: string

Exceptions

Implements ilQueryUtilsInterface.

Definition at line 18 of file class.ilPostgresQueryUtils.php.

References $name, $query, $type, and quote().

     {
         if (!$name) {
             throw new ilDatabaseException('no valid table name specified');
         }
         if (empty($fields)) {
             throw new ilDatabaseException('no fields specified for table "' . $name . '"');
         }
         $query_fields_array = array();
         foreach ($fields as $field_name => $field) {
             $query_fields_array[] = $this->db_instance->getFieldDefinition()->getDeclaration($field['type'], $field_name, $field);
         }
 
         $query_fields = implode(', ', $query_fields_array);
 
         if (!empty($options['primary'])) {
             $query_fields .= ', PRIMARY KEY (' . implode(', ', array_keys($options['primary'])) . ')';
         }
 
         $query = "CREATE  TABLE $name ($query_fields)";
 
         $options_strings = array();
 
         if (!empty($options['comment'])) {
             $options_strings['comment'] = 'COMMENT = ' . $this->quote($options['comment'], 'text');
         }
 
         if (!empty($options['charset'])) {
             $options_strings['charset'] = 'DEFAULT CHARACTER SET ' . $options['charset'];
             if (!empty($options['collate'])) {
                 $options_strings['charset'] .= ' COLLATE ' . $options['collate'];
             }
         }
 
         $type = false;
         if (!empty($options['type'])) {
             $type = $options['type'];
         }
         if ($type) {
             $options_strings[] = "ENGINE = $type";
         }
 
         if (!empty($options_strings)) {
             $query .= ' ' . implode(' ', $options_strings);
         }
 
         return $query;
     }

Here is the call graph for this function:

◆ free()

ilPostgresQueryUtils::free ( ilPDOStatement $statement )

Parameters

\ilPDOStatement $statement

Returns: bool

Implements ilQueryUtilsInterface.

Definition at line 173 of file class.ilPostgresQueryUtils.php.

References ilPDOStatement\closeCursor().

     {
         $statement->closeCursor();
 
         return true;
     }

Here is the call graph for this function:

◆ groupConcat()

ilPostgresQueryUtils::groupConcat	(	$a_field_name,
		$a_seperator = `","`,
		$a_order = `null`
	)

Parameters

string	$a_field_name
string	$a_seperator
string	$a_order

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 311 of file class.ilPostgresQueryUtils.php.

References quote().

     {
         if ($a_order === null) {
             $sql = "STRING_AGG(" . $a_field_name . ", " . $this->quote($a_seperator, "text") . ")";
         } else {
             $sql = "STRING_AGG(" . $a_field_name . ", " . $this->quote($a_seperator, "text") . " ORDER BY " . $a_order . ")";
         }
         return $sql;
     }

Here is the call graph for this function:

◆ in()

ilPostgresQueryUtils::in	(	$field,
		$values,
		$negate = `false`,
		$type = `""`
	)

Parameters

string	$field
	string[]	$values
bool	$negate
string	$type

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 75 of file class.ilPostgresQueryUtils.php.

References $type, and quote().

     {
         if (count($values) == 0) {
             // BEGIN fixed mantis #0014191:
             //return " 1=2 ";           // return a false statement on empty array
             return $negate ? ' 1=1 ' : ' 1=2 ';
             // END fixed mantis #0014191:
         }
         if ($type == "") {        // untyped: used ? for prepare/execute
             $str = $field . (($negate) ? " NOT" : "") . " IN (?" . str_repeat(",?", count($values) - 1) . ")";
         } else {                    // typed, use values for query/manipulate
             $str = $field . (($negate) ? " NOT" : "") . " IN (";
             $sep = "";
             foreach ($values as $v) {
                 $str .= $sep . $this->quote($v, $type);
                 $sep = ",";
             }
             $str .= ")";
         }
 
         return $str;
     }

Here is the call graph for this function:

◆ like()

ilPostgresQueryUtils::like	(	$column,
		$type,
		$value = `"?"`,
		$case_insensitive = `true`
	)

Parameters

	$column
	$type
string	$value
bool	$case_insensitive

Returns: string

Exceptions

Implements ilQueryUtilsInterface.

Definition at line 199 of file class.ilPostgresQueryUtils.php.

References $type, quote(), ilDBConstants\T_CLOB, and ilDBConstants\T_TEXT.

     {
         if (!in_array($type, array(
             ilDBConstants::T_TEXT,
             ilDBConstants::T_CLOB,
             "blob",
         ))
         ) {
             throw new ilDatabaseException("Like: Invalid column type '" . $type . "'.");
         }
         if ($value == "?") {
             if ($case_insensitive) {
                 return "UPPER(" . $column . ") LIKE(UPPER(?))";
             } else {
                 return $column . " LIKE(?)";
             }
         } else {
             if ($case_insensitive) {
                 // Always quote as text
                 return " UPPER(" . $column . ") LIKE(UPPER(" . $this->quote($value, 'text') . "))";
             } else {
                 // Always quote as text
                 return " " . $column . " LIKE(" . $this->quote($value, 'text') . ")";
             }
         }
     }

Here is the call graph for this function:

◆ locate()

ilPostgresQueryUtils::locate	(	$a_needle,
		$a_string,
		$a_start_pos = `1`
	)

Parameters

	$a_needle
	$a_string
int	$a_start_pos

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 154 of file class.ilPostgresQueryUtils.php.

     {
         $locate = ' STRPOS(SUBSTR(';
         $locate .= $a_string;
         $locate .= ', ';
         $locate .= $a_start_pos;
         $locate .= '), ';
         $locate .= $a_needle;
         $locate .= ') + ';
         $locate .= --$a_start_pos;
 
         return $locate;
     }

◆ lock()

ilPostgresQueryUtils::lock ( array $tables )

Parameters

array $tables

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 240 of file class.ilPostgresQueryUtils.php.

References ilDBConstants\LOCK_READ, and ilDBConstants\LOCK_WRITE.

     {
         $lock = 'LOCK TABLES ';
 
         $counter = 0;
         foreach ($tables as $table) {
             if ($counter++) {
                 $lock .= ', ';
             }
 
             if (isset($table['sequence']) && $table['sequence']) {
                 $table_name = $this->db_instance->getSequenceName($table['name']);
             } else {
                 $table_name = $table['name'];
             }
 
             $lock .= ($table_name . ' ');
 
             if ($table['alias']) {
                 $lock .= ($table['alias'] . ' ');
             }
 
             switch ($table['type']) {
                 case ilDBConstants::LOCK_READ:
                     $lock .= ' READ ';
                     break;
 
                 case ilDBConstants::LOCK_WRITE:
                     $lock .= ' WRITE ';
                     break;
             }
         }
 
         return $lock;
     }

◆ now()

ilPostgresQueryUtils::now ( )

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 230 of file class.ilPostgresQueryUtils.php.

     {
         return "now()";
     }

◆ quote()

ilPostgresQueryUtils::quote	(	$value,
		$type = `null`
	)

Parameters

mixed	$value
null	$type

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 104 of file class.ilPostgresQueryUtils.php.

References $type.

Referenced by createTable(), groupConcat(), in(), and like().

     {
         return $this->db_instance->quote($value, $type);
     }

Here is the caller graph for this function:

◆ quoteIdentifier()

ilPostgresQueryUtils::quoteIdentifier ( $identifier )

Parameters

$identifier

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 185 of file class.ilPostgresQueryUtils.php.

     {
         return $this->db_instance->quoteIdentifier($identifier);
     }

◆ unlock()

ilPostgresQueryUtils::unlock ( )

Returns: string

Implements ilQueryUtilsInterface.

Definition at line 280 of file class.ilPostgresQueryUtils.php.

     {
         return 'UNLOCK TABLES';
     }

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

Services/Database/classes/QueryUtils/class.ilPostgresQueryUtils.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cast()

◆ concat()

◆ createDatabase()

◆ createTable()

◆ free()

◆ groupConcat()

◆ in()

◆ like()

◆ locate()

◆ lock()

◆ now()

◆ quote()

◆ quoteIdentifier()

◆ unlock()