www.codeigniter.org.ru

CodeIgniter использует модифицированную версию шаблона проектирования Active Record. Данный шаблон позволяет вставлять, изменять и получать информацию из БД с написанием минимального количества кода. В некоторых случаях одной-двух строк кода достаточно для выполнения действия в БД. CodeIgniter не требует наличия для каждой из таблиц отдельного класса. Вместо этого предоставляется значительно упрощенный интерфейс.

Помимо простоты, вторым преимуществом использования Active Record является возможность написания приложений, не зависящих от типа БД поскольку строку SQL генерирует адаптер доступа к БД. Кроме того, в результате получаются более безопасные запросы, т.к. все данные автоматически экранируются системой.

Примечаение: если вы хотите писать запросы вручную, вы можете отключить класс Active Record в файле конфигурации базы данных, тогда библиотека доступа к БД и адаптер базы данных будут потреблять меньше ресурсов.

Выборка данных

Следующие функции позволяют вам получать SELECT-запросы.
Примечание: если вы используете PHP 5, то вы можете применять цепочки вызовов методов для получения более компактного синтаксиса кода. Подробнее этот вопрос описан в конце данной страницы.

$this->db->get();

Выполняет запрос и возвращает результат. Может быть использован для получения всех записей в таблице:

$query = $this->db->get('mytable');
 
// Запрос: SELECT * FROM mytable

Второй и третий параметры позволяют задать ограничение на количество записей и смещение от начала таблицы:

$query = $this->db->get('mytable', 10, 20);
 
// Запрос: SELECT * FROM mytable LIMIT 20, 10 (для MySQL. Другие БД могут иметь немного другой синтаксис запроса)

Вы могли обратить внимание на то, что результат выполнения функции помещается в переменную $query, которая может быть использована для вывода результатов:

$query = $this->db->get('mytable');
 
foreach ($query->result() as $row)
{
    echo $row->title;
}

Более детальная информация о получении результатов запросов приведена на соответствующей странице.

$this->db->get_where();

Данная функция аналогична предыдущей за исключением того, что в качестве второго параметра передаются условия для WHERE-части запроса, вместо использования функции db->where():

$query = $this->db->get_where('mytable', array('id' => $id), $limit, $offset);

Функция where() описана далее на этой странице.
Примечание: функция get_where() ранее называлась getwhere(), прежнее название функции является устаревшим.

$this->db->select();

функция позволяет задать SELECT-часть запроса.

$this->db->select('title, content, date');
 
$query = $this->db->get('mytable');
 
// Запрос: SELECT title, content, date FROM mytable

$this->db->select() принимает необязательный второй параметр. Если он установлен в FALSE, CodeIgniter не будет пытаться экранировать названия полей и таблиц. Данный вариант использования функции полезен, если вы используете составные запросы.

$this->db->select('(SELECT SUM(payments.amount) FROM payments WHERE payments.invoice_id=4') AS amount_paid', FALSE);
$query = $this->db->get('mytable');

$this->db->select_max();

Функция записывает часть запроса "SELECT MAX(field)". Вы можете также указать необязательный второй параметр для того, чтобы переименовать поле в результате запроса.

$this->db->select_max('age');
$query = $this->db->get('members');
// Запрос: SELECT MAX(age) as age FROM members
 
$this->db->select_max('age', 'member_age');
$query = $this->db->get('members');
// Запрос: SELECT MAX(age) as member_age FROM members

$this->db->select_min();

Записывает часть запроса "SELECT MIN(field)". Как и в случае с select_max() вы можете указать название для поля в результате.

$this->db->select_min('age');
$query = $this->db->get('members');
// Запрос: SELECT MIN(age) as age FROM members

$this->db->select_avg();

Записывает часть запроса "SELECT AVG(field)". Как и в случае с select_max() вы можете задать название для поля в результате запроса.

$this->db->select_avg('age');
$query = $this->db->get('members');
// Запрос: SELECT AVG(age) as age FROM members

$this->db->select_sum();

Записывает часть запроса "SELECT SUM(field)". Как и в случае с select_max() вы можете задать название для поля в результате запроса.

$this->db->select_sum('age');
$query = $this->db->get('members');
// Запрос: SELECT SUM(age) as age FROM members

$this->db->from();

Позволяет задать FROM-часть запроса:

$this->db->select('title, content, date');
$this->db->from('mytable');
 
$query = $this->db->get();
 
// Запрос: SELECT title, content, date FROM mytable

$this->db->join();

Позволяет задать JOIN-часть запроса:

$this->db->select('*');
$this->db->from('blogs');
$this->db->join('comments', 'comments.id = blogs.id');
 
$query = $this->db->get();
 
// Запрос:
// SELECT * FROM blogs
// JOIN comments ON comments.id = blogs.id

Если вам нужно выполнить несколько объединений, вы можете сделать несколько вызвов функции. Если вам нужны отличные от естественного объединения варианты, вы можете задать треьим параметром тип объединения. Допустимые опции: left, right, outer, inner, left outer, right outer.

$this->db->join('comments', 'comments.id = blogs.id', 'left');
 
// В результате: LEFT JOIN comments ON comments.id = blogs.id

$this->db->where();

Позволяет задать условия WHERE-части запроса, используя один из следующих способов:
Примечание: все значения переданные функции экранируются, что повышает безопасность запросов.

1. Простой способ ключ/значение
   

   $this->db->where('name', $name);
    
   // Результат: WHERE name = 'Joe' 

   Обратите внимание, что знак равенства добавлен автоматически. Если вы сделаете несколько вызовов функции, то условия будут объединены операцией AND:

   $this->db->where('name', $name);
   $this->db->where('title', $title);
   $this->db->where('status', $status);
    
   // WHERE = name 'Joe' AND title = 'boss' AND status = 'active' 

2. Произвольное задание ключ/значение

   Вы можете указать оператор в первом параметре чтобы управлять сравнениями:

   $this->db->where('name !=', $name);
   $this->db->where('id <', $id);
    
   // Результат: WHERE name != 'Joe' AND id < 45 

3. Ассоциативный массив параметров
   

    $array = array('name' => $name, 'title' => $title, 'status' => $status);
    
   $this->db->where($array);
    
   // Результат: WHERE name = 'Joe' AND title = 'boss' AND status = 'active' 

   Для этого способа передачи параметров также можно задавать операторы сравнения:

   $array = array('name !=' => $name, 'id <' => $id, 'date >' => $date);
    
   $this->db->where($array);

4. Произвольная строка

   Вы также можете задать условия выборки при помощи произвольной строки

   $where = "name='Joe' AND status='boss' OR status='active'";
    
   $this->db->where($where);

$this->db->where() принимает также опциональный третий параметр. Если он равен FALSE, то CodeIgniter не будет пытаться экранировать имена полей и таблиц.

$this->db->where('MATCH (field) AGAINST ("value")', NULL, FALSE);

$this->db->or_where();

Данная функция идентична предыдущей, за исключением того, что условия будут объединены оператором OR:

$this->db->where('name !=', $name);
$this->db->or_where('id >', $id);
 
// Результат: WHERE name != 'Joe' OR id > 50

$this->db->where_in();

Генерирует условие WHERE field IN ('item', 'item') и объединяет с другими условиями оператором AND при необходимости

$names = array('Frank', 'Todd', 'James');
$this->db->where_in('username', $names);
// Результат: AND WHERE username IN ('Frank', 'Todd', 'James')

$this->db->or_where_in();

Генерирует условие WHERE field IN ('item', 'item') и объединяет с другими условиями оператором OR при необходимости

 $names = array('Frank', 'Todd', 'James');
$this->db->or_where_in('username', $names);
// Результат: OR WHERE username IN ('Frank', 'Todd', 'James')

$this->db->where_not_in();

Генерирует часть запроса WHERE field NOT IN ('item', 'item') и объединяет с другими условиями оператором AND где необходимо.

$names = array('Frank', 'Todd', 'James');
$this->db->where_not_in('username', $names);
// Результат: AND WHERE username NOT IN ('Frank', 'Todd', 'James')

$this->db->or_where_not_in();

Генерирует часть запроса WHERE field NOT IN ('item', 'item') и объединяет с другими условиями оператором OR где необходимо.

$names = array('Frank', 'Todd', 'James');
$this->db->or_where_not_in('username', $names);
// Результат: OR WHERE username NOT IN ('Frank', 'Todd', 'James')

$this->db->like();

Данная функция позволяет задавать LIKE-условия запроса, полезные при запросах поиска.
Примечание: значения переданные в эту функцию автоматически экранируются

1. Передача пар ключ/значение
   

   $this->db->like('title', 'match');
    
   // WHERE title LIKE '%match%' 

   Если вы делаете несколько вызовов этой функции для одного запроса, то условия будут объединены оператором AND:

   $this->db->like('title', 'match');
   $this->db->like('body', 'match');
    
   // WHERE title LIKE '%match%' AND body LIKE '%match%

   Если вы хотите контролировать положение символа '%', можно использовать необязательный третий параметр. Возможные заначения: 'before','after' и 'both' (по умолчанию)

   $this->db->like('title', 'match', 'before');
   // WHERE title LIKE '%match'
    
   $this->db->like('title', 'match', 'after');
   // WHERE title LIKE 'match%'
    
   $this->db->like('title', 'match', 'both');
   // WHERE title LIKE '%match%' 

2. Передача аргументов как ассоциативный массив
   

    $array = array('title' => $match, 'page1' => $match, 'page2' => $match);
    
   $this->db->like($array);
    
   // WHERE title LIKE '%match%' AND page1 LIKE '%match%' AND page2 LIKE '%match%'

$this->db->or_like();

Данная функция аналогична предыдущей, за исключением того, что условие будет соединено с другими при помощи оператора OR:

$this->db->like('title', 'match');
$this->db->or_like('body', $match);
 
// WHERE title LIKE '%match%' OR body LIKE '%match%'

$this->db->not_like();

Функция аналогична like(), за исключением того, что она генерирует условие NOT LIKE :

$this->db->not_like('title', 'match');
 
// WHERE title NOT LIKE '%match%

$this->db->or_not_like();

Функция идентична not_like(), но результат будет соединен с другими условиями оператором OR:

$this->db->like('title', 'match');
$this->db->or_not_like('body', 'match');
 
// WHERE title LIKE '%match% OR body NOT LIKE '%match%'

$this->db->group_by();

Позволяет задать GROUP BY-часть запроса:

$this->db->group_by("title");
 
// Produces: GROUP BY title 

Функция также позволяет передать несколько параметров:

$this->db->group_by(array("title", "date"));
 
// Produces: GROUP BY title, date

$this->db->distinct();

Добавляет в запрос директиву DISTINCT:

$this->db->distinct();
$this->db->get('table');
 
// Produces: SELECT DISTINCT * FROM table

$this->db->having();

Позволяет указать HAVING часть запроса. Существуют два возможных синтаксиса вызова этой функции - с одним и с двумя аргументами:

$this->db->having('user_id = 45');
// HAVING user_id = 45
 
$this->db->having('user_id', 45);
// HAVING user_id = 45

Также функция может принимать множественные параметры:

$this->db->having(array('title =' => 'My Title', 'id <' => $id));
 
// Produces: HAVING title = 'My Title', id < 45

Если вы используете БД для которой CodeIgniter осуществляет экранирование, вы можете отключить экранирование передав в функцию третий необязательный параметр со значением FALSE

$this->db->having('user_id', 45);
//  HAVING `user_id` = 45 Для некоторых БД, таких как MySQL
$this->db->having('user_id', 45, FALSE);
// HAVING user_id = 45

$this->db->or_having();

Функция аналогична предыдущей за исключением того, что условие будет соединено с другими при помощи оператора OR

$this->db->order_by();

Позволяет задать ORDER BY часть запроса. Первый параметр содержит имя поля, по которому нужно осуществить сортировку результата. Второй параметр указывает направление сортировки. Он может принимать значения asc, desc и random.

$this->db->order_by("title", "desc");
 
// ORDER BY title DESC 

Вы также можете передать строку условия первым параметром:

$this->db->order_by('title desc, name asc');
 
// ORDER BY title DESC, name ASC 

При необходимости вы можете сделать несколько вызовов функции чтобы отсортировать результаты поиска по нескольким полям:

$this->db->order_by("title", "desc");
$this->db->order_by("name", "asc");
 
// ORDER BY title DESC, name ASC 

Примечание: устаревшее название этой функции - orderby()
Примечание: случайный порядок сортировки в настоящее время не доступен для БД Oracle и MSSQL. В данных БД порядок сортировки по умолчанию - ASC.

$this->db->limit();

Позволяет ограничить число строк результата:

$this->db->limit(10);
 
// LIMIT 10

Второй параметр функции позволяет задать смещение результата:

$this->db->limit(10, 20);
 
//  LIMIT 20, 10 (в MySQL. Другие БД могут иметь немного другой синтаксис )

$this->db->count_all_results();

Позволяет определить количество строк в результате определенного запроса Active Record. Запрос также может содержать условия выборки, такие как where(), like(), or_like() и т.д.

echo $this->db->count_all_results('my_table');
// Целое число, например 25
 
$this->db->like('title', 'match');
$this->db->from('my_table');
echo $this->db->count_all_results();
// Целое число, например  17 

$this->db->count_all();

Позволяет определить количество записей в определенной таблице. Имя таблицы передается первым параметром:

echo $this->db->count_all('my_table');
 
// В результате число, например 25

Вставка данных

$this->db->insert();

Генерирует строку SQL для вставки данных основываясь на переданные вами параметры и выполняет запрос. Вы можете передать функции либо массив либо объект. Пример использования массива:

$data = array(
               'title' => 'My title' ,
               'name' => 'My Name' ,
               'date' => 'My date'
            );
 
$this->db->insert('mytable', $data);
 
// INSERT INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date')

Первый параметр содержит название таблицы, второй - ассоциативный массив вставляемых значений.

Пример использования объекта:

/*
    class Myclass {
        var $title = 'My Title';
        var $content = 'My Content';
        var $date = 'My Date';
    }
*/
 
$object = new Myclass;
 
 
 
 
$this->db->insert('mytable', $object);
 
// INSERT INTO mytable (title, content, date) VALUES ('My Title', 'My Content', 'My Date')

Первый параметр содержит название таблицы, второй - объект содержащий вставляемые значения.

Все значения автоматически экранируются, что позволяет получить более безопасные запросы.

$this->db->set();

Функция позволяет установить значения полей для вставки или изменения данных.Она может быть использована вместо передачи массива непосредственно функции вставки или изменения:

$this->db->set('name', $name);
$this->db->insert('mytable');
 
// INSERT INTO mytable (name) VALUES ('{$name}')

Если вы осуществляете несколько вызовов функции, они будут корректно обработаны в зависимости от того, осуществляете ли вы вставку или изменение данных:

$this->db->set('name', $name);
$this->db->set('title', $title);
$this->db->set('status', $status);
$this->db->insert('mytable'); 

set() также принимает третий необязательный параметр ($escape), который позволяет отменить экранирование данных если установлен в FALSE. Чтобы показать различия, вот пример использования set() с экранированием и без:

$this->db->set('field', 'field+1', FALSE);
$this->db->insert('mytable');
// INSERT INTO mytable (field) VALUES (field+1)
 
$this->db->set('field', 'field+1');
$this->db->insert('mytable');
// INSERT INTO mytable (field) VALUES ('field+1')

Также вы можете передать в функцию ассоциативный массив:

$array = array('name' => $name, 'title' => $title, 'status' => $status);
 
$this->db->set($array);
$this->db->insert('mytable'); 

или объект:

/*
    class Myclass {
        var $title = 'My Title';
        var $content = 'My Content';
        var $date = 'My Date';
    }
*/
 
$object = new Myclass;
 
$this->db->set($object);
$this->db->insert('mytable'); 

Изменение данных

$this->db->update();

Генерирует строку SQL для изменения данных в БД и выполняет запрос. В функцию могут быть переданы как массив значений, так и объект. Пример использования массива:

$data = array(
               'title' => $title,
               'name' => $name,
               'date' => $date
            );
 
$this->db->where('id', $id);
$this->db->update('mytable', $data);
 
// 
// UPDATE mytable
// SET title = '{$title}', name = '{$name}', date = '{$date}'
// WHERE id = $id

Пример использования объекта:

/*
    class Myclass {
        var $title = 'My Title';
        var $content = 'My Content';
        var $date = 'My Date';
    }
*/
 
$object = new Myclass;
 
$this->db->where('id', $id);
$this->db->update('mytable', $object);
 
// 
// UPDATE mytable
// SET title = '{$title}', name = '{$name}', date = '{$date}'
// WHERE id = $id

Все значения автоматически экранируются

Обратите внимание на использование функции $this->db->where(), которая позволяет установить WHERE-часть запроса и задать условия для изменения данных. Вы также можете передать эти условия в функцию update() как строковый параметр:

$this->db->update('mytable', $data, "id = 4");

либо как массив:

$this->db->update('mytable', $data, array('id' => $id));

При выполнении изменения данных вы также можете использовать функцию set(), как было описано выше.

Удаление данных

$this->db->delete();

Генерирует SQL-строку удаления данных и выполняет запрос.

$this->db->delete('mytable', array('id' => $id));
 
// 
// DELETE FROM mytable
// WHERE id = $i

Первый параметр - имя таблицы, второй - условие. Вы также можете использовать функции where() или or_where() вместо передачи второго параметра функции delete():

$this->db->where('id', $id);
$this->db->delete('mytable');
 
// 
// DELETE FROM mytable
// WHERE id = $id

Также в функцию delete() может быть передан массив имен таблиц, если вам нужно удалить записи из более чем одной таблицы:

$tables = array('table1', 'table2', 'table3');
$this->db->where('id', '5');
$this->db->delete($tables);

Если вам нужно просто удалить все данные из таблицы, вы можете использовать функции truncate() или empty_table().

$this->db->empty_table();

Генерирует и выполняет SQL-строку удаления данных из таблицы:

$this->db->empty_table('mytable');
 
// DELETE FROM mytable

$this->db->truncate();

Генерирует и выполняет SQL-строку очистки таблицы

$this->db->from('mytable');
$this->db->truncate();
// or
$this->db->truncate('mytable');
 
// TRUNCATE mytable 

Цепочки методов

Цепочки вызова методов позволяют вам упростить синтаксис за счет последовательного вызова нескольких функций. Пример:

$this->db->select('title')->from('mytable')->where('id', $id)->limit(10, 20);
 
$query = $this->db->get();

Кеширование Active Record

Не поддерживая кеширование в полном смысле слова, Active Record позволяет вам сохранить (или "кешировать") определенные части запросов для повторного использования. Обычно, когда запрос Active Recrord выполнен, вся сохраненная информация сбрасывается для выполнения последующих запросов. Используя кеширование, вы можете избежать этой очистки и использовать информацию запроса повторно.

Кешированные вызовы накапливаются. Если вы сделаете 2 кешированных вызова select() и 2 не кешированных вызова select(), то в результате будет сделано 4 вызова select(). Существуют три функции управления кешированием:

$this->db->start_cache()

Эта функция должна быть вызвана чтобы начать кеширование запросов. Все запросы Active Record поддерживаемого типа будут сохранены для повторного использования (ниже будет приведен список поддерживаемых для кеширования запросов).

$this->db->stop_cache()

Данная функция прекращает кеширование запросов.

$this->db->flush_cache()

Функция удаляет кеш запросов Active Record.

Пример использования:

$this->db->start_cache();
$this->db->select('field1');
$this->db->stop_cache();
$this->db->get('tablename');
// Results in:
// SELECT `field1` FROM (`tablename`)
 
$this->db->select('field2');
$this->db->get('tablename');
// Results in:
// SELECT `field1`, `field2` FROM (`tablename`)
 
$this->db->flush_cache();
 
$this->db->select('field2');
$this->db->get('tablename');
// Results in:
// SELECT `field2` FROM (`tablename`)

Примечание: Следующие поля могут быть кешированы: ‘select’, ‘from’, ‘join’, ‘where’, ‘like’, ‘groupby’, ‘having’, ‘orderby’, ‘set’