Руководство по CSpeed — расширенному фреймворку на основе C# v2. 1. 11

namespace app\modules\admin;
class User extends \Cs\rpc\Server
{
    public function initialise()
    {
        $this->handle($this);
    }

    /**
     * Параметры передаются от клиента
     */
    function listsRpc()
    {
        return ['kernel' => 'CSpeed', 'version' => '2. 1. 11'];
    }
}

$client = new \Cs\rpc\Client('http://xxx.xxx.com/admin/user');
$data = $client->lists();
// Также можно отправить данные на сервер
$results = $client->lists(['age' => '20']);

class BootInit implements \Cs\BootInit
{
    /**
     * Инициализация базы данных
     */
    function __initDb()
    {
    }
```    /**
     * Инициализация других данных, таких как фабрика IOC
     */
    function __initData()
    {
    }
}

$model = new app\models\User();
// Устанавливаем соединение с основной базой данных
$model->setDb('master');
// Выполняем какие-то действия...
// Переключаемся на соединение с резервной базой данных
$model->setDb('slave');

$di->set('master', function(){
    return new \Cs\db\pdo\Adapter();
});
$di->set('slave', function(){
    return new \Cs\db\pdo\Adapter([
        'dsn' => 'mysql:host=localhost;port=3306;dbname=supjos',
        'username' => 'root',
        'password' => 'root'
    ]);
});
```**Класс \Cs\db\pdo\Adapter** поддерживает инициализационные параметры **PDO**, такие как установка постоянного соединения:

```php
$di->set('slave', function(){
    return new \Cs\db\pdo\Adapter([
        'dsn' => 'mysql:host=localhost;port=3306;dbname=supjos',
        'username' => 'root',
        'password' => 'root',
        'options'  => [
            \PDO::ATTR_PERSISTENT => true, // Постоянное соединение
            \PDO::ATTR_AUTOCOMMIT => 0     // Автоматическое выполнение отключено
        ]
    ]);
});
```4. Поддержка AR-характеристик модели [в настоящее время незавершена]
5. Загрузка конфигурационных файлов [ini] по требованию: класс **\Cs\tool\Config**
```php
$config = new \Cs\tool\Config();
$config->loadConfig('xxx/xxx.ini');
$configs = $config->getConfigs();
// Или получить значение соответствующего свойства
$configValue = $config->getConfigs('db');

// Если в контроллере существует этот метод, он будет выполнен с вершины его родительского класса до завершения инициализации
// Обратите внимание, что конструктор __construct() не будет вызван: любое указание внутри него не будет применяться
// Метод initialise является методом инициализации контроллера
function initialise()
{
    $this->on(self::EVENT_BEFORE_ACTION, function(){
        echo 'Привет, первая функция';
    });
}

namespace app\modules\index\controllers;
class Goods extends \Cs\mvc\Controller {
    function initialise($object)
    {
        // Тогда $object представляет объект текущего контроллера: Goods, вывод следующий:
        echo '<pre>';
        print_r($object);
        echo '</pre>';
    }
}

Используется наиболее распространенной моделью разработки в B/S: MVC

Пользователь может выполнять инициализацию всех классов в файле BootInit, что позволяет легко отделить модель от бизнес-логики:
Предположим, что конфигурационный файл фабрики PHP-классов пользователя выглядит так:
<?php
return [
    'rsa' => [
        'class'      => '\app\models\User',
        'properties' => [
            'name' => '\app\models\Tools',
            'two'  => '\app\models\Tools'
        ],
        'values'     => [
            'abc' => new \stdClass()
        ]
]

'properties' => [
    'name' => '\app\models\Tools',
    'two'  => '\app\models\Tools'
]

$user = new \app\models\User();
$user->setName(new \app\models\Tools());

'values' => [
    'abc' => new \stdClass(),
    'linux' => 'Да, мне нравится Linux',
    'windows' => 'Нет, если нет выбора'
],

'attrs' => [
    'private' => true,
    'public' => true,
    'protected' => false
]

$task = new \Cs\console\Task();
// Также можно инициализировать систему с помощью параметров, формат которых аналогичен(Cs\App)
$task = new \Cs\console\Task("xxx/xxx.ini", "dev");
// Выполнение командной строки
$task->run($argv[1]);

php -f index.php hello/world/lists

$router = new \Cs\mvc\Router();
$router->add('/back/:action:/id:', '/shop/list/$1');
$router->add('/shop/:controller:/action:/any:', '/get/\1/\2/\3');
$router->addFromArray([
    '/shop/:controller:/action:/any:' => '/get/\1/\2/\3',
    '/admin/:controller:/action:/any:' => '/put/\1/\2/\3',
]);
$router->addFromIni('./app/router.ini');

[core]
core.application                = '../app'               ; директория WEB
core.bootstrap                 = '../app/bootstrap.php'   ; указание пути к классу Bootstrap
core.bootstrap.method.string    = '__init'               ; указание префикса метода инициализации класса Bootstrap
core.router.modules             = index, home, back       ; регистрация нескольких модулей
core.router.default.module       = index                  ; по умолчанию используется модуль index
core.router.default.controller   = index                  ; по умолчанию используется контроллер index
core.router.default.action       = index                  ; по умолчанию используется метод index
core.view.

**\Cs\BootInit** класс вызывает все методы, названия которых начинаются с префикса, указанного в конфигурационном файле. При этом автоматически передаются два параметра: **$di** и **$router**, представляющие контейнер внедрения зависимостей и маршрутизатор соответственно, чтобы разработчики могли выполнять настройку и инициализацию всей системы.## Пример структуры контроллера ##
```php
namespace app\modules\hello\controllers;
class Cspeed extends \Cs\mvc\Controllers
{
    /**
     * Метод инициализации. Если этот метод будет создан, то метод initialize начнёт выполняться от родительского класса до этого метода для выполнения инициализации.
     */
    public function initialize()
    {
        // Код инициализации
    }

    /**
     * Конкретный метод. Внутри фреймворка CSpeed URL методы заканчиваются на Action.
     */
    public function newsAction()
    {
        // Код действия
    }
}

namespace app\models;
class User extends \Cs\mvc\Model
{
    /**
     * Если существует конструктор, обязательно явно вызывайте конструктор родительского класса.
     * Вы можете использовать возможность привязки событий внутри конструктора.
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Возвращает имя таблицы.
     */
    public function tableName()
    {
        return 'www_product';
    }
}

/**
 * Конструктор.
 * @param string $iniConfigPath Путь к конфигурационному файлу, который следует загрузить в движок.
 * @param string $iniNodeName Название узла в конфигурационном файле INI.
 */
public function __construct($iniConfigPath, $iniNodeName);

/**
 * Запуск фреймворка.
 */
public function run();

/**
 * Инициализация движка.
 */
public function bootstrap();

/**
 * Получение объекта App.
 */
public function getApp();

/**
 * Установка псевдонима для системной загрузки.
 * @param string $aliasKey Псевдоним для загрузки.
 * @param string $aliasFullPath Полный путь, представленный псевдонимом.
 */
public function setAlias($aliasKey, $aliasFullPath);
``````markdown
/**
 * Соответствие запросу GET.
 * @param string $url URL для соответствия.
 * @param Closure $closure Закрытый метод для выполнения при успешном соответствии.
 */
public function get($url, $closure);

/**
 * Соответствие запросу POST.
 * @param string $url URL для соответствия.
 * @param Closure $closure Закрытый метод для выполнения при успешном соответствии.
 */
public function post($url, $closure);

/**
 * Соответствие запросу PUT.
 * @param string $url URL для соответствия.
 * @param Closure $closure Вызов обратного вызова после успешного соответствия.
 */
function put($url, $closure);

/**
 * Обрабатывает запрос PATCH.
 * @param string $url URL для соответствия.
 * @param Closure $closure Вызов обратного вызова после успешного соответствия.
 */
function patch($url, $closure);

/**
 * Обрабатывает запрос DELETE.
 * @param string $url URL для соответствия.
 * @param Closure $closure Вызов обратного вызова после успешного соответствия.
 */
function delete($url, $closure);

/**
 * Обрабатывает запрос HEAD.
 * @param string $url URL для соответствия.
 * @param Closure $closure Вызов обратного вызова после успешного соответствия.
 */
function head($url, $closure);

/**
 * Обрабатывает запрос OPTIONS.
 * @param string $url URL для соответствия.
 * @param Closure $closure Вызов обратного вызова после успешного соответствия.
 */
function options($url, $closure);

   /**
   * FROM
   * @param string $table    Название таблицы данных для запроса
   * @return ModelInterface
   */
  function from($table);

   /**
   * WHERE
   * @param array|string $whereCondition    Условие WHERE
   * @return ModelInterface
   */
  function where($whereCondition);

   /**
   * GROUP BY
   * @param array|string $groupBy          Условие GROUP BY
   * @return ModelInterface
   */
  function groupBy($groupBy);

   /**
   * HAVING
   * @param array|string $having           Условие HAVING
   * @return ModelInterface
   */
  function having($having);

   /**
   * ORDER BY
   * @param array|string $orderBy           Условие ORDER BY
   * @return ModelInterface
   */
  function orderBy($orderBy);

   /**
   * LIMIT
   * @param int $count        Количество записей
   * @param int $offset       Оффсет
   * @return ModelInterface
   */
  function limit($count, $offset);

   /**
   * @param $rawSql               Исходная SQL-строка
   * @param array $bindParams     Привязанные параметры SQL
   * @return ModelInterface
   */
  function query($rawSql, array $bindParams);

   /**
   * Выполняет SQL-запрос через метод query и возвращает результат
   */
  function execute();

 /**
  * Конструктор PDO.
  * @param array $connectionOptions  Опциональные параметры соединения, такие как \PDO::ATTR_PERSISTENT.
  */
 function __construct(array $connectionOptions = []);

 /**
  * Устанавливает поля для выборки.
  * @param array|string $fields Поле или массив полей для выборки.
  * @return $this|Adapter
  */
 function select($fields);

 /**
  * Указывает таблицу для запроса.
  * @param string $table Название таблицы.
  * @return $this|Adapter
  */
 function from($table);    function from($table)
 /**
  * Устанавливает условие WHERE.
  * @param array|string $whereCondition Условие WHERE.
  * @return $this
  */
 function where($whereCondition)
 /**
  * Устанавливает условие GROUP BY.
  * @param array|string $groupBy Условие GROUP BY.
  * @return $this
  */
 function groupBy($groupBy)
 /**
  * Устанавливает условие HAVING.
  * @param array|string $having Условие HAVING.
  * @return $this|Adapter
  */
 function having($having)
 /**
  * Устанавливает условие ORDER BY.
  * @param array|string $orderBy Условие ORDER BY, например: orderBy(['id DESC', 't ASC']).
  * @return $this|Adapter
  */
 function orderBy($orderBy)
 /**
  * Устанавливает ограничение LIMIT.
  * @param int $count Количество записей.
  * @param int $offset Смещение.
  * @return $this|Adapter
  */
 function limit($count, $offset)
 /**
  * Выполняет SQL-запрос с привязанными параметрами.
  * @param string $rawSql Исходный SQL-запрос.
  * @param array $bindParams Привязанные параметры.
  * @return $this|Adapter
  */
 function query($rawSql, array $bindParams)
 /**
  * Возвращает результат выполнения метода query.
  * @return mixed
  */
 function execute()
 /**
  * Добавляет дополнительное условие WHERE.
  * @param $whereCondition Условие WHERE.
  * @return $this|Adapter
  */
 function andWhere($whereCondition)
 /**
  * Начинает транзакцию.
  */
 function begin()
 /**
  * Откатывает транзакцию.
  */
 function rollback()
 /**
  * Подтверждает транзакцию.
  */
 function commit()
 /**
  * Возвращает последний вставленный ID.
  * @return mixed
  */
 function lastInsertId()
 /**
  * Возвращает количество затронутых строк.
  */
 function rowCount()
 /**
  * Возвращает одну строку из результата запроса.
  */    function find()
 /**
  * Возвращает все строки из результатов запроса.
  */
 function findAll()### Cs\di\Di ###
/**
 * Конструктор DI.
 */
function __construct()
/**
 * @param $key Ключ ассоциативного массива контейнера внедрения зависимостей.
 * @return object|mixed
 */
function get($key)
/**
 * @param $key      Ключ объекта, хранящегося в контейнере внедрения зависимостей
 * @param $closure  Коллбэк-функция, значение которой будет помещено в контейнер внедрения зависимостей
 */
function set($key, $closure)

/**
 * @var $di \Cs\di\Di Объект контейнера внедрения зависимостей Di
 */
public $di;
/**
 * @var $view \Cs\mvc\View Объект представления View
 */
public $view;
/**
 * @var $router \Cs\mvc\Router Объект маршрутизатора Router
 */
public $router;

/**
 * Метод инициализации маршрута.
 * Инициализация от родительского класса до текущего.
 */
function initialise()### Cs\Mvc\Model ###

/**
 * Конструктор модели Model
 */
public function __construct();

/**
 * Возвращает объект модели, который требует выполнения операции UPDATE
 * @return Model
 */
static function find();

/**
 * Возвращает имя таблицы, связанной с моделью
 */
function tableName();

/**
 * @param array|string $fields Условие SELECT
 * @return $this
 */
function select($fields);

/**
 * @param array|string $where Условие WHERE
 * @return $this
 */
function where($where);

/**
 * @param array|string $where Условие WHERE
 * @return $this
 */
function andWhere($where);

/**
 * @param array|string $orderBy Условие ORDER BY
 * @return $this
 */
function orderBy($orderBy);

/**
 * @param array|string $groupBy Условие GROUP BY
 * @return $this
 */
function groupBy($groupBy);

/**
 * Возвращает одну запись
 */
function one();

/**
 * Возвращает все записи из результата запроса
 */
function all();

/**
 * Выполняет операцию UPDATE или INSERT
 * Для новых моделей выполняется INSERT, а для найденных - UPDATE
 */
function save();

/**
 * Выполняет операцию DELETE
 */
function delete();

/**
 * Получает объект PDO, используемый текущей моделью
 * Можно использовать этот метод для вызова методов PDO
 */
function getDb();

/**
 * Получает объект адаптера \Cs\Db\Pdo\Adapter, связанный с текущей моделью
 */
function getAdapter();
```### Cs\mvc\View ###
      /**
      * Конструктор представления View
      */
     function __construct()```markdown
### Рendering шаблонов

    /**
     * Rendering шаблона
     * @param $templateFileName имя файла шаблона для рендера без расширения
     * @param $variables данные, передаваемые в шаблон
     */
    function render($templateFileName, $variables)
    
    /**
     * Установка расширения шаблона, по умолчанию .phtml
     * @param $suffixName новое расширение шаблона
     */
    function setSuffix($suffixName)
    
    /**
     * Добавление данных в шаблон
     * @param $varName имя переменной
     * @param $varValue значение переменной
     */
    function setVar($varName, $varValue)
    
    /**
     * Получение результата рендера
     * @param $templateFileName имя файла шаблона для рендера без расширения
     * @param $variables данные, передаваемые в шаблон
     */
    function getRender($templateFileName, $variables)
    
    /**
     * Установка директории хранения шаблонов
     * @param $viewDir путь к директории хранения шаблонов
     */
    function setViewDir($viewDir)
    
    /**
     * Рендеринг частичного шаблона
     * @param $templateFileName имя файла шаблона для рендера без расширения
     * @param $variables данные, передаваемые в шаблон
     */
    function partial($templateFileName, $variables)

### Cs\net\Request    /**
     * Получение значения HTTP_HOST
     */
    function getHttpHost()

    /**
     * Получение значения HTTP_USER_AGENT
     */
    function getHttpUserAgent()

    /**
     * Получение значения SERVER_NAME
     */
    function getServerName()

    /**
     * Получение значения SERVER_ADDR
     */
    function getServerAddr()

    /**
     * Получение значения REMOTE_PORT
     */
    function getRemotePort()

    /**
     * Получение значения REMOTE_ADDR
     */
    function getRemoteAddr()

    /**
     * Получение значения REQUEST_SCHEME
     */
    function getRequestScheme()

    /**
     * Получение значения SERVER_PROTOCOL
     */
    function getServerProtocol()

    /**
     * Получение значения DOCUMENT_ROOT
     */
    function getDocumentRoot()

    /**
     * Получение значения REQUEST_URI
     */
    function getRequestUri()

    /**
     * Получение значения SCRIPT_NAME
     */
    function getScriptName()

    /**
     * Получение значения PATH_INFO
     */
    function getPathInfo()

    /**
     * Получение значения QUERY_STRING
     */
    function getQueryString()

    /**
     * Проверка является ли запрос GET
     */
    function isGet()

    /**
     * Проверка является ли запрос PUT
     */
    function isPut()

    /**
     * Является ли запрос PATCH
     */
    function isPatch()

    /**
     * Является ли запрос DELETE
     */
    function isDelete()

    /**
     * Является ли запрос HEAD
     */
    function isHead()

    /**
     * Является ли запрос OPTIONS
     */
    function isOptions()

    /**
     * Получение данных $_GET
     */
    function get()

    /**
     * Получение данных $_POST
     */
    function getPost()### Cs\net\Response ###
      /**
      * Конструктор класса Response.
      */
     function __construct()
      /**
      * Установка HTTP-заголовков.
      * Например: setHeader('Content-Type', 'application/json;charset=UTF-8');
      * @param $headerKey        Название HTTP-заголовка
      * @param $headerValue      Значение HTTP-заголовка
      */
     function setHeader($headerKey, $headerValue)
      /**
      * Удаление HTTP-заголовков.
      * @param $headerKey       Название HTTP-заголовка для удаления, функция должна вызываться до send()
      */
     function unsetHeader($headerKey)
      /**
      * Отправка HTTP-заголовков и содержимого ответа.
      */
     function send()
      /**
      * Установка JSON-контента в ответе.
      * @param array $jsonArray
      */
     function setJsonContent(array $jsonArray)
      /**
      * Установка сырого контента.
      * @param $rawContent   Сырой контент
      */
     function setRawContent($rawContent)
      /**
      * Перенаправление на указанный URL.
      * Например: redirect('/index/lists') перенаправляет на: http://host/index/lists
      * @param $url          URL для перенаправления
      */
     function redirect($url)

### Cs\tool\Config ###
      /**
      * Конструктор класса Config.
      */
     function __construct()
      /**
     * Загрузка данных из INI файла.
      * @param string $configFilePath    Относительный путь к INI файлу
      */
     function loadConfig($configFilePath)
      /**
      * Возврат данных из INI файла, с учетом разделителей.
      */
     function getConfigs()
      /**
      * Возврат данных из INI файла, соответствующих указанному ключу.
      */
     function getConfig($configKey)### Cs\mvc\Router ###
      /**
      * Конструктор класса Router.
      */
     function __construct()
      /**
      * Добавление маршрута в Router.
      * @param $destUrl Поддерживает регулярные выражения для URL маршрутов
      * @param $toUrl   URL маршрута после соответствия
      */
     function add($destUrl, $toUrl)
      /**
      * Добавление маршрутов из INI конфигурационного файла
      * @param $iniFile INI конфигурационный файл, содержащий маршруты
      */
     function addFromIni($iniFile)
      /**
      * Добавление маршрутов из массива
      * @param $arrayRouters Массив маршрутов, где ключи — это маршрутизируемые URL, а значения — URL для переадресации при успешной совпадении
      */
     function addFromArray($arrayRouters)
     {
     }

### Cs\tool\Component ###
  	/**
 	 * Конструктор
  	*/
  	/**
 	 * Привязка события
 	 * @param $eventName Название события для привязки
 	 * @param $callBack Функция, которая будет вызвана при возникновении события
 	 */
 	function on($eventName, $callBack);
  	/**
 	 * Отвязка события
 	 * @param $eventName Название события для отвязки
 	 * @param $callBack Обработчик события, NULL отвязывает все события с одинаковым названием
 	 */
 	function off($eventName, $callBack = NULL);
  	/**
 	 * Вызов события
 	 * @param $eventName Название события для вызова
 	 */
 	function trigger($eventName);

### Cs\ObjectFactory ###
  	/**
 	 * Инициализация IOC объектного фабричного класса по конфигурационному файлу
 	 * @param $factoryConfig Конфигурационный файл для управления IOC
 	 */
 	function init($factoryConfig);
  	/**
 	 * Получение объекта из IOC фабрики
 	 * @param $id Уникальный идентификатор объекта для получения
 	 */
 	function getObject($id);