Файлы и модели в Coresky - energy-coresky/air GitHub Wiki

Код первого крыла, содержащий классы SKY и HEAVEN, находится в файле sky.php. Файлы второго крыла в папке w2 (wing 2), смотрите таблицу:

Всего в папке w2: 49 файлов. Другой основной код Coresky, смотрите в следующей таблице:

Итого Coresky это: 57 файлов, 19091 строк кода, 835.1 kBytes. В глобальной области видимости: 40 именованных функций PHP, 58 классов PHP, из них 3 интерфейса, 4 трейта и 0 перечислений.

Любой код для повторного использования, содержит некоторые части кода, которые используются чаще или реже в различных веб-приложениях написанных на нём. Если вообразить, что все веб-приложения на Земле (или хотя бы большая, значительная их часть), переписаны с использованием некоторого единого кода для повторного использования, который значительно помог упростить разработку этих приложений, то окажется, что часть такого кода, используется всегда. Имеет смысл разделить код для повторного использования, по частоте потенциально возможного применения. Назовем "крыло 1" (wing 1), код, который используется всегда. Такому коду следует уделить наибольшее внимание. Другой код Coresky - крыло 2, содержится в папке wing 2 (main/w2). В папке main/w3 (крыло 3) содержатся классы продуктов и код приложений. Остальной код приложений (контроллеры, модели и представления) уникален, явно наследует повторяющуюся архитектуру MVC и использует код крыльев 1,2,3. Классы в папке main/mvc всегда имеют однобуквенные префиксы и постфиксы в противоположность классам крыльев, это гарантирует, что их имена не пересекутся. Для классов в папках main/w3, рекомендуется использовать нотации без подчеркивания: PascalCase или camelCase.

Классы Coresky, кроме SKY и HEAVEN находятся в папке main/w2. Этот список всегда можно увидеть с помощью утилиты "глобальные определения". Для классов крыльев, в том числе в папке main/w3 продуктов, необходим глобальный реестр (и модерация продуктов) в репозитории кода Coresky для обеспечения уникальности имен, в том числе с классами PHP. Это скорее хорошо, чем плохо: к сожалению, в репозитории https://packagist.org/ много мусорного кода. Кроме того, продукты могут содержать классы, использующие пространства имен, которые соответствуют именам продуктов. Классы с namespace рекомендуется использовать для PROD-продуктов. Читайте о разрешении коллизий в именах в статье "Coresky планы и продукты".

Контроллеры и модели приложений, располагаются в папке main/mvc. Первые имеют однобуквенный префикс или постфикс c_ в имени файлов, а модели, в основном, используют префикс m_ или t_. Классы моделей приложений, должны наследовать базовые классы Model_m и Model_t соответственно, смотрите файл main/w2/mvc.php. Другой код, осуществляющий бизнес логику приложений, для которого не требуется наследование вышеуказанных базовых классов, располагается в папке main/w3. Ядро Coresky осуществляет автозагрузку классов, для любого такого кода, автоматически и для основного приложения и для продуктов.

М-модели это "пустышки", точнее они содержат некоторый функционал, но класс Model_m является базовым для определений других базовых моделей, например Model_t. Тем не менее, можно создавать модели приложений на базе М-моделей, если базовые методы модели Model_t не нужны и/или код модели не связан с конкретной таблицей в некоторой базе данных. Пример файла main/mvc/m_test.php:

class m_test extends Model_m
{
    protected $table = 'tbl';

    function head_y() {
        return SQL::open('other-db-connection');
    }

    function some_row() {
        return $this->sql('-select * from $_ where id=1');
    }
}

В примере выше - перегружено свойство protected $table и метод m_test::head_y(). Свойство переопределяет дежурную таблицу, а метод - соединение с БД по умолчанию. Обычно, такую перегрузку делать не нужно, так как дежурная таблица может установится автоматически по имени класса модели (test). А соединение с БД скопируется автоматически из соединения по умолчанию в классе SQL - SQL::$dd.

В таких моделях можно использовать прототипы глобальных функций sql(..), sqlf(..), qp(..), вызывая их через $this->. В этом случае будет использоваться дежурная таблица и соединение с БД, определенные в модели. Метод ::head_y() всегда вызывается автоматически, во время выполнения конструктора класса. Его рекомендуется использовать (а не конструктор класса), если алгоритмически нужна некоторая инициализация модели.

Из контроллеров и моделей, доступ к другим моделям, осуществляется без использования каких-либо специальных действий. Создание объекта модели, выполняется автоматически при первом вызове, в магическом методе __get(..), далее объект используется как singletone. Редко, но все-же, может потребоваться второй экземпляр объекта модели, в этом случае используйте new:

class m_test extends Model_m
{
    . . .
    function method() {
        # nothing special to access other model, do not required:
        # include file, operator new, dependency injection
        $r = $this->m_other_model->method(); # create instance & run method
        echo $this->m_other_model->public_property; # access same instance
        
        
        # use `new` for second instance
        $second_instance = new m_other_model;
        $r2 = $second_instance->method();
    }
}

Такие модели следует использовать, когда необходимо привязать код модели к некоторой конкретной таблице в БД. Имя класса модели следует выбирать в соответствии с именем таблицы с префиксом t_. Например, для таблицы article - класс t_article, файл - main/mvc/t_article.php.

Базовый класс Model_t, в сравнении с Model_m, дополнительно содержит методы, которые можно использовать в T-моделях приложений. В основном это методы-обертки для сокращения кода работы с SQL запросами:

Model_t::where($rule) - для составления кляузы WHERE

Model_t::cell($rule = '', String $what = 'count(1)') - для чтения единственного значения из БД

Model_t::one($rule = null, String $pref = '>') - для чтения одного ряда значений из БД

Model_t::all($rule = '', $what = '*', String $pref = '#') - для чтения всех рядов результата запроса к БД

Model_t::insert(Array $ary) - для вставки ряда данных в БД

Model_t::update($what, $rule = null) - для обновления данных в БД

Model_t::delete($rule = null) - для удаления данных из БД

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

class m_test extends Model_m
{
    . . .
    function method($table = 'variable_name') {
        $all_rows = (new Model_t($table))->all();
        
        . . .
    }
}

В T-моделях, при вызове методов моделей, также происходит переключение соединения с БД по умолчанию и дежурной таблицы в классе SQL, так что можно использовать глобальные функции sql(..), sqlf(..), qp(..), а не их протоnиты с $this->. И по шаблону $_ будет подразумеваться таблица, определенная как дежурная в текущей модели (и соединение с БД).

Модели продуктов, использующие пространства имен, могут быть сохранены в файлах с префиксом x_. Создание экземпляров таких моделей из потомков MVC_BASE также производится с помощью этого префикса, например $this->x_able. Но внутри файла, префикс имени класса модели должен быть m_ или t_. Смотрите определение модели из продукта Upload, файл upload/mvc/x_able.php:

<?php

namespace upload;

class t_able extends \Model_t
{
. . .
}

Префикс x_ сообщает ядру Coresky, что необходимо сделать автозагрузку такой модели и создание её экземпляра класса, которая использует пространство имен. Подразумевается, что имя namespace совпадает с текущим Plan::$ware.

Виртуальные X-модели используются для разрешения возможных коллизий в именах классов PROD-продуктов и моделей кода приложений.

В папке mvc можно также создать модели наследующие, например базовый класс MVC_BASE с произвольным префиксом, например файл y_test.php:

<?php

namespace warename_or_main;

class y_test extends \MVC_BASE
{
    function __construct() {
        # your own code
    }
    . . .
}

В этом случае, создание экземпляра класса будет возможно только с помощью new:

$instance = new \warename_or_main\y_test();