www.codeigniter.org.ru

Когда в данном руководстве используется термин "библиотека" то подразумевается класс расположенный в каталоге libraries и описанный в разделе _Справочник Классов_ данного руководства. Но в данном случае будет описан способ создания ваших собственных библиотек в каталоге application/libraries с целью разделения ваших локальных ресурсов и глобальных ресурсов фреймворка.

Кроме того, CodeIgniter позволяет вам наследовать и дополнять системные классы, если вам нужно дополнить или изменить функциональность существующей библиотеки. Либо вы можете полностью заменить системную библиотеку, разместив файл с идентичным названием в каталоге application/libraries. В целом,

• вы можете создавать новые библиотеки;
• вы можете наследовать и расширять системные библиотеки;
• вы можете полностью заменять системные библиотеки своими.

Примечание: системная библиотека Database не может быть наследована или переопределена, кроме того нельзя наследовать или переопределять класс Loader в PHP4. Остальные системные библиотеки могут быть переопределены или наследованы.

Хранение библиотек

Ваши классы библиотек должны храниться в каталоге application/libraries, т.к. CodeIgniter будет проверять этот каталог при инициализации библиотек.

Соглашение об именах

• Имена файлов должны начинаться с заглавной буквы. К примеру: Myclass.php
• Имена классов должны начинаться с заглавной буквы. К примеру: class Myclass
• Имя класса и имя файла должны совпадать.

Файл с классом библиотеки

Класс библиотеки должен быть основан на следующем простом шаблоне:

<?php if (!defined('BASEPATH')) exit('No direct script access allowed');
 
class Someclass {
 
    function some_function()
    {
    }
}
 
?>

Использование класса

Из любого из ваших контроллеров вы можете инициализировать класс библиотеки при помощи кода:

$this->load->library('someclass');

$this->someclass->some_function();  // Экземпляры класса всегда называются в нижнем регистре

Передача параметров при инициализации класса

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

$params = array('type' => 'large', 'color' => 'red');
 
$this->load->library('Someclass', $params);

<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
 
class Someclass {
 
    function Someclass($params)
    {
        // Do something with $params
    }
}
 
?>

Использование ресурсов CodeIgniter в ваших классах

Чтобы использовать ресурсы CodeIgniter в классе библиотеки нужно воспользоваться функцией get_instance(). Эта функция возвращает супер-объект CodeIgniter.
Обычно в классах-контроллерах вы можете использовать ресурсы CodeIgniter при помощи констркуции $this:

$this->load->helper('url');
$this->load->library('session');
$this->config->item('base_url');
....

$CI =& get_instance();

$CI =& get_instance();
 
$CI->load->helper('url');
$CI->load->library('session');
$CI->config->item('base_url');
...

Кроме того, если вы используете PHP4, постарайтесь не использовать get_instance() из конструкторов классов. В PHP4 есть проблема со ссылкой на объект CodeIgniter из конструкторов приложения, т.к. он не существует пока класс полностью не инициализирован.

Заменяем оригинальные библиотеки

Достаточно просто назвать свой класс идентично системному классу CodeIgniter, и он будет использован вместо системного. Чтобы использовать эту функциональность нужно задавать имя файла и объявление класса идентично системному. К примеру, чтобы заменить исходный класс Email, вам понадобиться создать файл application/libraries/Email.php, и объявить в нем класс:

class CI_Email {
 
}

$this->load->library('email');

Расширение базовых библиотек

Если вам необходимо только добавить функциональность к базовой библиотеке - не имеет смысла заменять всю ее функциональность и переписывать её. В этом случае разумнее будет просто расширить базовый класс библиотеки. Расширение класса аналогично его переопределению с небольшими отличиями:

• Объявление класса должно указывать на расширение (наследование) базового класса
• Имя вашего класса должно начинаться с префикса MY_ (Префикс может быть изменен, см. ниже).

К примеру, чтобы расширить базовый класс Email вам понадобиться создать файл application/libraries/MY_Email.php, и в нем сделать следующее объявление класса:

class MY_Email extends CI_Email {
 
}

class MY_Email extends CI_Email {
 
    function My_Email()
    {
        parent::CI_Email();
    }
}

Загрузка вашего под-класса

Для того, чтобы загрузить ваш под-класс нужно использовать стандартный способ загрузки библиотек. НЕ ДОБАВЛЯЙТЕ префикс к имени класса при загрузке. К примеру, чтобы загрузить класс описанный выше, который наследует класс Email, нужно выполнить следующий код:

$this->load->library('email');

$this->email->some_function();

Установка другого префикса

Для того, чтобы установить другой префикс для под-классов, откройте файл application/config/config.php и найдите строку:

$config['subclass_prefix'] = 'MY_';