This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilMySQLQueryUtils:

Collaboration diagram for ilMySQLQueryUtils:

Public Member Functions

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

quote ($value, ?string $type=null)

concat (array $values, bool $allow_null=true)

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

free (ilPDOStatement $statement)

quoteIdentifier (string $identifier)

createTable (string $name, array $fields, array $options=[])

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

now ()

lock (array $tables)

unlock ()

createDatabase (string $name, string $charset="utf8", string $collation="")

groupConcat (string $field_name, string $seperator=",", string $order=null)

cast (string $a_field_name, $a_dest_type)

Parameters

mixed $a_dest_type

More...

Public Member Functions inherited from ilQueryUtils

__construct (ilDBInterface $ilDBInterface)

ilMySQLQueryUtils constructor. More...

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

quote ($value, ?string $type=null)

concat (array $values, bool $allow_null=true)

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

free (ilPDOStatement $statement)

quoteIdentifier (string $identifier)

createTable (string $name, array $fields, array $options=[])

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

now ()

lock (array $tables)

unlock ()

createDatabase (string $name, string $charset="utf8", string $collation="")

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

cast (string $a_field_name, $a_dest_type)

Parameters

mixed $a_dest_type

More...

Additional Inherited Members
Protected Attributes inherited from ilQueryUtils
ilDBInterface	$db_instance

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilMySQLQueryUtils

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

Definition at line 25 of file class.ilMySQLQueryUtils.php.

Member Function Documentation

◆ cast()

ilMySQLQueryUtils::cast	(	string	$a_field_name,
			$a_dest_type
	)

Parameters

mixed $a_dest_type

Implements ilQueryUtilsInterface.

Definition at line 279 of file class.ilMySQLQueryUtils.php.

                                                             : string
     {
         return $a_field_name;
     }

◆ concat()

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

Implements ilQueryUtilsInterface.

Definition at line 61 of file class.ilMySQLQueryUtils.php.

                                                                   : string
     {
         if (count($values) === 0) {
             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;
         }
 
         return $concat . ') ';
     }

◆ createDatabase()

ilMySQLQueryUtils::createDatabase	(	string	$name,
		string	$charset = `"utf8"`,
		string	$collation = `""`
	)

Implements ilQueryUtilsInterface.

Definition at line 252 of file class.ilMySQLQueryUtils.php.

                                                                                                   : string
     {
         if ($collation !== "") {
             $sql = "CREATE DATABASE `" . $name . "` CHARACTER SET " . $charset . " COLLATE " . $collation;
         } else {
             $sql = "CREATE DATABASE `" . $name . "` CHARACTER SET " . $charset;
         }
 
         return $sql;
     }

◆ createTable()

ilMySQLQueryUtils::createTable	(	string	$name,
		array	$fields,
		array	$options = `[]`
	)

Exceptions

Implements ilQueryUtilsInterface.

Definition at line 120 of file class.ilMySQLQueryUtils.php.

References quote().

                                                                                  : string
     {
         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 = [];
         $fd = $this->db_instance->getFieldDefinition();
         if ($fd !== null) {
             foreach ($fields as $field_name => $field) {
                 $query_fields_array[] = $fd->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()

ilMySQLQueryUtils::free ( ilPDOStatement $statement )

Implements ilQueryUtilsInterface.

Definition at line 105 of file class.ilMySQLQueryUtils.php.

References ilPDOStatement\closeCursor().

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

Here is the call graph for this function:

◆ groupConcat()

ilMySQLQueryUtils::groupConcat	(	string	$field_name,
		string	$seperator = `","`,
		string	$order = `null`
	)

Implements ilQueryUtilsInterface.

Definition at line 263 of file class.ilMySQLQueryUtils.php.

References quote().

                                                                                                   : string
     {
         if ($order === null) {
             $sql = "GROUP_CONCAT(" . $field_name . " SEPARATOR " . $this->quote($seperator, "text") . ")";
         } else {
             $sql = "GROUP_CONCAT(" . $field_name . " ORDER BY " . $order . " SEPARATOR " . $this->quote(
                 $seperator,
                 "text"
             ) . ")";
         }
         return $sql;
     }

Here is the call graph for this function:

◆ in()

ilMySQLQueryUtils::in	(	string	$field,
		array	$values,
		bool	$negate = `false`,
		string	$type = `""`
	)

Parameters

string[] $values

Implements ilQueryUtilsInterface.

Definition at line 30 of file class.ilMySQLQueryUtils.php.

References quote().

                                                                                              : string
     {
         if (!is_array($values) || 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()

ilMySQLQueryUtils::like	(	string	$column,
		string	$type,
		string	$value = `"?"`,
		bool	$case_insensitive = `true`
	)

Exceptions

Implements ilQueryUtilsInterface.

Definition at line 179 of file class.ilMySQLQueryUtils.php.

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

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

Here is the call graph for this function:

◆ locate()

ilMySQLQueryUtils::locate	(	string	$a_needle,
		string	$a_string,
		int	$a_start_pos = `1`
	)

Implements ilQueryUtilsInterface.

Definition at line 92 of file class.ilMySQLQueryUtils.php.

                                                                                     : string
     {
         $locate = ' LOCATE( ';
         $locate .= $a_needle;
         $locate .= ',';
         $locate .= $a_string;
         $locate .= ',';
         $locate .= $a_start_pos;
         $locate .= ') ';
 
         return $locate;
     }

◆ lock()

ilMySQLQueryUtils::lock ( array $tables )

Implements ilQueryUtilsInterface.

Definition at line 211 of file class.ilMySQLQueryUtils.php.

References ilDBConstants\LOCK_READ, and ilDBConstants\LOCK_WRITE.

                                        : string
     {
         $lock = 'LOCK TABLES ';
 
         $counter = 0;
         foreach ($tables as $table) {
             if ($counter++ !== 0) {
                 $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'] ?? null) {
                 $lock .= ($table['alias'] . ' ');
             }
 
             switch ($table['type']) {
                 case ilDBConstants::LOCK_READ:
                     $lock .= ' READ ';
                     break;
 
                 case ilDBConstants::LOCK_WRITE:
                     $lock .= ' WRITE ';
                     break;
             }
         }
 
         return $lock;
     }

◆ now()

ilMySQLQueryUtils::now ( )

Implements ilQueryUtilsInterface.

Definition at line 206 of file class.ilMySQLQueryUtils.php.

                          : string
     {
         return "NOW()";
     }

◆ quote()

ilMySQLQueryUtils::quote	(		$value,
		?string	$type = `null`
	)

Parameters

mixed $value

Implements ilQueryUtilsInterface.

Definition at line 56 of file class.ilMySQLQueryUtils.php.

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

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

Here is the caller graph for this function:

◆ quoteIdentifier()

ilMySQLQueryUtils::quoteIdentifier ( string $identifier )

Implements ilQueryUtilsInterface.

Definition at line 112 of file class.ilMySQLQueryUtils.php.

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

◆ unlock()

ilMySQLQueryUtils::unlock ( )

Implements ilQueryUtilsInterface.

Definition at line 247 of file class.ilMySQLQueryUtils.php.

                             : string
     {
         return 'UNLOCK TABLES';
     }

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

Services/Database/classes/QueryUtils/class.ilMySQLQueryUtils.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()