Создание и запуск проекта CodeIgniter

Что такое CodeIgniter?

CodeIgniter — это легковесный и высокопроизводительный фреймворк для разработки веб-приложений на PHP. Он реализует паттерн Model-View-Controller (MVC) и позволяет разработчикам быстро создавать функциональные веб-решения. CodeIgniter отличается простотой архитектуры, отличной производительностью и легкостью освоения, благодаря чему многие PHP-разработчики выбирают его для своих проектов.

Основные преимущества и особенности CodeIgniter

• Легковесное ядро: Основная система CodeIgniter предельно минималистична, содержит только необходимые компоненты и обеспечивает быструю загрузку.
• Высокая производительность: Фреймворк оптимизирован для максимальной эффективности и справляется с обработкой большого количества одновременных запросов.
• Простота освоения: Имеет понятную документацию и удобный API, что ускоряет вход для новых пользователей.
• Гибкость: Позволяет интегрировать сторонние библиотеки и расширять функционал под нужды конкретного проекта.
• Активное сообщество: Вокруг CodeIgniter сформировано большое комьюнити, обеспечивающее поддержку и множество полезных ресурсов.

CodeIgniter подходит для разработки как небольших, так и масштабных корпоративных веб-приложений, помогая создавать качественные и быстрые решения.

Настройка среды разработки CodeIgniter с помощью ServBay

ServBay — это инструмент для локальной веб-разработки под macOS и Windows. Он объединяет в себе пакеты PHP, базы данных (MySQL, PostgreSQL, MongoDB), системы кэширования (Redis, Memcached), веб-серверы (Caddy, Nginx, Apache) и удобный интерфейс управления. С ServBay вы легко подготовите и будете контролировать все необходимые компоненты среды для работы CodeIgniter.

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

Необходимые условия

Перед началом убедитесь, что выполнены следующие шаги:

• ServBay установлен и запущен на вашем macOS или Windows.
• В ServBay включена нужная версия PHP, например PHP 8.3.
• В ServBay активированы необходимые пакеты баз данных и кэширования (например, MySQL, PostgreSQL, Redis, Memcached).

Создание проекта CodeIgniter

ServBay рекомендует хранить сайты в следующих директориях — это удобно для управления локальными проектами:

• macOS: /Applications/ServBay/www
• Windows: C:\ServBay\www

1. Установка Composer

   ServBay уже содержит предустановленный Composer, поэтому отдельная установка не требуется. В терминале используйте команду composer.

2. Переход в корневой каталог сайтов

   Откройте терминал и перейдите в рекомендованный каталог:

   macOS:

   cd /Applications/ServBay/www

   Windows:

   cd C:\ServBay\www

3. Создание проекта CodeIgniter

   Запустите Composer для создания нового проекта CodeIgniter 4. Назовите каталог проекта servbay-codeigniter-app:

   composer create-project codeigniter4/appstarter servbay-codeigniter-app

   Composer загрузит каркас приложения CodeIgniter и все зависимости в папку servbay-codeigniter-app.

4. Переход в каталог проекта

   Перейдите в только что созданный проект:

   macOS:

   cd /Applications/ServBay/www/servbay-codeigniter-app

   Windows:

   cd C:\ServBay\www\servbay-codeigniter-app

Первоначальная настройка

Настройка подключения к базе данных

Конфигурация подключения к базе данных находится в файле app/Config/Database.php. Перед использованием базы данных внесите необходимые параметры в этот файл.

Сначала создайте базу данных с именем servbay_codeigniter_app через любой из инструментов управления базами (например, Adminer или phpMyAdmin — доступны в интерфейсе ServBay).

Далее откройте app/Config/Database.php, найдите массив $default и заполните параметры по типу используемой базы данных (MySQL или PostgreSQL). Стандартные логин и пароль для ServBay: root и password.

Пример настройки для MySQL:

public $default = [
    'DSN'      => '',
    'hostname' => '127.0.0.1', // Обычно база данных ServBay работает на 127.0.0.1
    'username' => 'root',     // Стандартное имя пользователя ServBay
    'password' => 'password', // Стандартный пароль ServBay
    'database' => 'servbay_codeigniter_app', // Имя выбранной базы данных
    'DBDriver' => 'MySQLi',   // Для MySQL используйте MySQLi или Pdo
    'DBPrefix' => '',
    'pConnect' => false,
    'DBDebug'  => (ENVIRONMENT !== 'production'),
    'charset'  => 'utf8mb4',
    'DBCollat' => 'utf8mb4_general_ci',
    'swapPre'  => '',
    'encrypt'  => false,
    'compress' => false,
    'strictOn' => false,
    'failover' => [],
    'port'     => 3306,       // Порт MySQL по умолчанию
];

Для подключения к PostgreSQL укажите 'Postgre' в DBDriver, порт обычно 5432, возможно потребуется скорректировать параметры кодировки.

Настройка кэширования (Memcached/Redis)

Если вы планируете использовать Memcached или Redis, откройте файл app/Config/Cache.php и внесите соответствующие изменения.

В ServBay Memcached по умолчанию работает на порту 11211, Redis — на 6379, пароль обычно не требуется.

Пример конфигурации Memcached:

public $memcached = [
    'host'   => '127.0.0.1', // Memcached ServBay работает на 127.0.0.1
    'port'   => 11211,      // Стандартный порт Memcached
    'weight' => 1,
];

Пример для Redis:

public string $handler = 'redis'; // Установите обработчик кэша в redis

public $default = [ // Параметры Redis внутри массива default
    'host'     => '127.0.0.1', // Redis ServBay работает на 127.0.0.1
    'password' => null,       // По умолчанию пароль отсутствует
    'port'     => 6379,       // Стандартный порт Redis
    'timeout'  => 0,
    'database' => 0,
];

Настройте параметры согласно используемым пакетам кэширования.

Настройка веб-сервера (Параметры сайта ServBay)

Используйте функцию Сайт в ServBay для настройки веб-сервера — укажите путь к вашему проекту CodeIgniter.

1. Откройте интерфейс приложения ServBay.
2. Перейдите на вкладку Сайты (Websites).
3. Нажмите на кнопку +, чтобы добавить новый сайт.
4. Заполните параметры:
   • Имя (Name): Название сайта, например My First CodeIgniter Dev Site.
   • Домен (Domain): Придумайте домен для локального доступа, например servbay-codeigniter-test.local. ServBay сам настроит его для работы на вашей машине.
   • Тип сайта (Site Type): Выберите PHP.
   • Версия PHP (PHP Version): Укажите используемую версию, например 8.3.
   • Корень сайта (Document Root): Важно! Главный файл входа CodeIgniter (index.php) находится в папке public вашего проекта. Укажите путь обязательно до папки public: /Applications/ServBay/www/servbay-codeigniter-app/public.
5. Нажмите кнопку Добавить (Add) для сохранения.
6. При появлении запроса на применение изменений — подтвердите действие.

Подробнее процесс описан в этом руководстве.

Добавление демонстрационного кода

Для проверки работоспособности проекта и интеграции с базой данных и кэшем измените контроллер по умолчанию Home, добавив в него методы-демонстрации.

Откройте файл app/Controllers/Home.php и замените его содержимое на следующий код:

<?php

namespace App\Controllers;

use CodeIgniter\Controller;
use CodeIgniter\Database\Exceptions\DatabaseException; // Импорт класса исключений базы данных
use CodeIgniter\Cache\Exceptions\CacheException; // Импорт класса исключений кэша

class Home extends Controller
{
    /**
     * Главный метод для стартовой страницы
     */
    public function index(): string
    {
        // Отобразить приветственное сообщение
        return '<h1>Hello ServBay and CodeIgniter!</h1><p>Your CodeIgniter project is running on ServBay.</p>';
    }

    /**
     * Пример работы с Memcached
     */
    public function memcached(): string
    {
        try {
            $cache = \Config\Services::cache();

            // Сохраняем данные в кэш
            $success = $cache->save('servbay_memcached_key', 'Hello Memcached from CodeIgniter!', 60); // Срок жизни кэша — 60 секунд

            if (!$success) {
                 return 'Error: Failed to save data to Memcached. Check Memcached service and configuration.';
            }

            // Извлекаем из кэша
            $value = $cache->get('servbay_memcached_key');

            if ($value === null) {
                return 'Error: Failed to get data from Memcached. Cache might have expired or service is down.';
            }

            return 'Memcached Test Success: ' . $value;

        } catch (CacheException $e) {
            // Обработка исключений кэша
            return 'Cache Error: ' . $e->getMessage() . '. Ensure Memcached service is running and configured correctly.';
        } catch (\Exception $e) {
            // Обработка других ошибок
            return 'An unexpected error occurred: ' . $e->getMessage();
        }
    }

    /**
     * Пример работы с Redis
     */
    public function redis(): string
    {
        try {
            $cache = \Config\Services::cache();

            // Сохраняем данные в кэш
            $success = $cache->save('servbay_redis_key', 'Hello Redis from CodeIgniter!', 60); // Срок жизни кэша — 60 секунд

             if (!$success) {
                 return 'Error: Failed to save data to Redis. Check Redis service and configuration.';
            }

            // Извлекаем из кэша
            $value = $cache->get('servbay_redis_key');

             if ($value === null) {
                return 'Error: Failed to get data from Redis. Cache might have expired or service is down.';
            }

            return 'Redis Test Success: ' . $value;

        } catch (CacheException $e) {
             // Обработка исключений кэша
            return 'Cache Error: ' . $e->getMessage() . '. Ensure Redis service is running and configured correctly.';
        } catch (\Exception $e) {
            // Обработка других ошибок
            return 'An unexpected error occurred: ' . $e->getMessage();
        }
    }

    /**
     * Запись данных пользователя в базу (MySQL/PostgreSQL)
     */
    public function addUser(): string
    {
        try {
            $db = \Config\Database::connect();

            // Проверяем, существует ли таблица 'users' (примитивная проверка)
            if (!$db->tableExists('users')) {
                 return 'Error: "users" table does not exist. Please run database migrations first.';
            }

            // Записываем данные
            $data = [
                'name' => 'ServBay Demo User',
                'email' => 'user_' . time() . '@servbay.demo', // Уникальный email с использованием time()
            ];

            $db->table('users')->insert($data);

            // Проверяем успех (insert() обычно возвращает true)
            // if ($db->affectedRows() > 0) {
                 return 'User added successfully: ' . $data['email'];
            // } else {
            //      return 'Error: Failed to add user.';
            // }

        } catch (DatabaseException $e) {
            // Обработка ошибок базы данных
            return 'Database Error: ' . $e->getMessage() . '. Check database connection and table structure.';
        } catch (\Exception $e) {
             // Обработка других ошибок
            return 'An unexpected error occurred: ' . $e->getMessage();
        }
    }

    /**
     * Получить список пользователей из базы (MySQL/PostgreSQL)
     */
    public function listUsers(): string
    {
         try {
            $db = \Config\Database::connect();

             // Проверяем, существует ли таблица 'users'
            if (!$db->tableExists('users')) {
                 return 'Error: "users" table does not exist. Please run database migrations first.';
            }

            // Получаем всех пользователей
            $users = $db->table('users')->get()->getResult();

            if (empty($users)) {
                return 'No users found in the database.';
            }

            // Возвращаем список в формате JSON
            return json_encode($users);

        } catch (DatabaseException $e) {
             // Обработка ошибок базы данных
            return 'Database Error: ' . $e->getMessage() . '. Check database connection and table structure.';
        } catch (\Exception $e) {
            // Обработка других ошибок
            return 'An unexpected error occurred: ' . $e->getMessage();
        }
    }
}

В этом контроллере реализованы примеры с понятным выводом и базовой обработкой ошибок для диагностики.

Настройка роутинга

Чтобы получить доступ к добавленным методам контроллера Home через URL, добавьте соответствующие маршруты в файл app/Config/Routes.php.

Найдите определение $routes и добавьте:

// ... другие правила маршрутизации ...

// Пример маршрута для Memcached
$routes->get('/memcached', 'Home::memcached');

// Пример маршрута для Redis
$routes->get('/redis', 'Home::redis');

// Примеры работы с базой
$routes->get('/add-user', 'Home::addUser');
$routes->get('/list-users', 'Home::listUsers');

// ... другие правила маршрутизации ...

Не удаляйте исходные маршруты при добавлении новых.

Доступ к сайту

CodeIgniter-проект теперь работает через ServBay. Откройте браузер и перейдите по настроенному домену:

• Главная страница: https://servbay-codeigniter-test.local На экране должно появиться сообщение Hello ServBay and CodeIgniter!, подтверждающее корректную настройку.

• Проверка Memcached: https://servbay-codeigniter-test.local/memcached При правильном подключении Memcached увидите сообщение вида: Memcached Test Success: Hello Memcached from CodeIgniter!.

• Проверка Redis: https://servbay-codeigniter-test.local/redis Если Redis работает и настроен, вы увидите сообщение: Redis Test Success: Hello Redis from CodeIgniter!.

Примеры работы с базой данных (MySQL/PostgreSQL)

Перед использованием демо-методов с базой данных необходимо применить миграцию для создания таблицы users.

Создание структуры базы (запуск миграции)

1. Откройте терминал и перейдите в каталог проекта CodeIgniter:

   cd /Applications/ServBay/www/servbay-codeigniter-app

2. Создайте файл миграции: Через CLI CodeIgniter выполните:

   php spark make:migration create_users_table

   В каталоге app/Database/Migrations появится новый PHP-файл.

3. Отредактируйте миграцию: Откройте сгенерированный файл (например, YYYY-MM-DD-HHMMSS_CreateUsersTable.php). Определите структуру таблицы в методе up(). Обратите внимание: для MySQL и PostgreSQL синтаксис по умолчанию для timestamp отличается (CURRENT_TIMESTAMP vs NOW()), а CodeIgniter позволяет решать это с помощью RawSql. Пример:

   <?php
   
   namespace App\Database\Migrations;
   
   use CodeIgniter\Database\Migration;
   use CodeIgniter\Database\RawSql; // Импорт класса RawSql
   
   class CreateUsersTable extends Migration
   {
       public function up()
       {
           $this->forge->addField([
               'id'          => [
                   'type'           => 'INT',
                   'constraint'     => 5,
                   'unsigned'       => true,
                   'auto_increment' => true,
               ],
               'name'       => [
                   'type'       => 'VARCHAR',
                   'constraint' => '100',
               ],
               'email'      => [
                   'type'       => 'VARCHAR',
                   'constraint' => '100',
                   'unique'     => true, // Email — уникальный
               ],
               'created_at' => [
                   'type'    => 'TIMESTAMP',
                   // В зависимости от типа базы выбирайте выражение:
                   // MySQL: 'default' => new RawSql('CURRENT_TIMESTAMP'),
                   // PostgreSQL: 'default' => new RawSql('NOW()'),
                   'default' => new RawSql($this->db->getPlatform() === 'MySQLi' ? 'CURRENT_TIMESTAMP' : 'NOW()'), // Автоматический выбор
               ],
               'updated_at' => [
                   'type'    => 'TIMESTAMP',
                   // MySQL: 'default' => new RawSql('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP'),
                   // PostgreSQL: 'default' => new RawSql('NOW()'),
                    'default' => new RawSql($this->db->getPlatform() === 'MySQLi' ? 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP' : 'NOW()'), // Автоматический выбор
               ],
           ]);
           $this->forge->addKey('id', true); // id — первичный ключ
           $this->forge->createTable('users'); // Создание таблицы users
       }
   
       public function down()
       {
           // Откат миграции — удаляем таблицу users
           $this->forge->dropTable('users');
       }
   }

   Примечание: В данном примере автоматически определяется синтаксис для timestamp в зависимости от платформы. В больших проектах рекомендуется прорабатывать миграции для разных типов СУБД отдельно.

4. Запустите миграцию: Выполните команду для применения миграции и создания таблицы:

   php spark migrate

   В случае успеха вы увидите сообщение о завершении миграции в терминале. Проверьте наличие таблицы users в базе через Adminer или другой инструмент.

Тестирование методов работы с базой

Убедитесь, что параметры подключения к базе (в app/Config/Database.php) заполнены корректно, и таблица users создана.

• Добавить пользователя: https://servbay-codeigniter-test.local/add-user Каждый переход по этому URL добавляет новый пользовательский рекорд. Ожидаемый результат — сообщение вида User added successfully: user_XXXXXXXXXX@servbay.demo.

• Получить список пользователей: https://servbay-codeigniter-test.local/list-users Этот маршрут возвращает список данных в формате JSON. Вы увидите массив объектов пользователей.

Вывод

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