gstudio/g2

There is no license information available for the latest version (dev-master) of this package.

This is Generatioin 2 Framework

dev-master 2019-12-05 13:31 UTC

Unknown License

README

Разработчик backend всегда работает только в папке /app/

Например, у нас есть такой Url, который возвращается json данные с базы данных. Данный адрес это API для метода getListUsers(). Данный момент получает список всех пользователей системы.

site.ru/api/test/getListUsers

Возвращает json с данными на экран

{"result":[{"id":"1","name":"Олег","surname":"Антипов","patronymic":"Алексеевич","status":"active","role":"user","avatar":null,"parent_id":null,"nickname":"oleg_antipov"},{"id":"4","name":"Второй","surname":"","patronymic":"","status":"unverified","role":"user","avatar":null,"parent_id":null,"nickname":""},{"id":"5","name":"Третий","surname":"","patronymic":"","status":"unverified","role":"user","avatar":null,"parent_id":null,"nickname":""}]}

Ключевое слово api

/api/  -  это ключевое слово для обращения к API методам системы, которые взаимодествуют с данными БД, иначе говоря CRUD методы.

Все начинается с presenter!

Для каждого микросервиса существует свой presenter. Это обычный класс, которые наследуется от базового презентера /app/presenters/_MainPresenter.php В нем реализованы работы с фронтэндом, вывод страниц, виджетов, работа с переводом!

/api/test - слово test обозначает какой presenter используется, который в дальнейшем и запускает метод.
			Для этого в проекте существует файл /app/presenters/TestPresenter.php

После создания своего презентера, обязательно наследуйте _MainPresenter.php

Создадим тестовый презентер. В нем метод getListUsers, который создает экземпляр класса Users, и вызывает метод getListUsers.

<?php

/*
 * TestPresenter work to test
 */

class TestPresenter extends MainPresenter {

	public function getListUsers(){

		if($this->isSecurity()){
			echo (new Users())->getListUsers();
		} 

	}

}

?>

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

Фреймворк проверяет ключ автоматически и выводит ошибку если ключа нет при проверке доступа!

if($this->isSecurity()){
	...
}

Полный Url с доступом к Api

/api/test/getListUsers - слово getListUsers обозначает название метода, который запускает TestPresenter.php. 
			Сам метод getListUsers осуществляет запрос к БД на получения данных о пользователях.

Если есть необходимость передать в url API какой - либо GET параметр, необзодимо писать так site.ru/api/test/getListUsers?var=1&var2=str

Работа с моделями

Модели хранятся в папке /app/models/ Модель представляет собой обычный класс, в котором описаны методы для взаимодествия с базой данных.

Требования к модели:

• простота реализации в методах
• методы вызываемые презентером должны иметь доступ public
• методы должны возвращать все в формате JSON (данные из БД, и ошибки)

Пример модели Users. В модели есть метод для получения списка пользователей в формате JSON.

<?php
 
class Users {


    public function getListUsers(){
        $result = _MainModel::table("users_cards")->get()->send();
        
        _MainModel::viewJSON($result);   
    }

}

?>

Работа с БД

В фреймворке существует базовая модель _MainModel.php, которая упрощает работу с запросами к БД. В ней реализован механизм PDO. Обратите внимание, что не все запросы можно выполнить с помощью базовой модели.

В системной модели _DB.php реализован механизм подключения к базе данных. Свое подключения реализовывать нет необходимости.

Измените данные конфигурации к подключению БД

В корне проекта находится файл config.php Замените данные подключения в файле.

<?php

self::$config['database'] = array(
    'hostname' => 'localhost',
    'username' => 'user_login',
    'password' => 'password',
    'dbname' => 'db'
);

self::$config['salt'] = "dlkcmdfv(4&*4mvnKDNAP)_)kdldi12cdl::L847GTe]|";

?>

1.Выборка

_MainModel::table("table")->get(array("id", "login"))->filter(array("id" => 1))->sort("id", "desc")->pagination(0,6)->send();

объяснение:

->get(array("field1", "field2")) - список полей, которые получаем из таблицы
->get() - получаем все поля из таблицы

->filter(array("field1" => 1, "field2" => "example")) -  аналог WHERE SQL запросе, field - столбец, 1 - значение, которому должен быть равен.
Если перевести на SQL запрос
WHERE field1 = 1 AND field2 = "example"


->sort("id", "desc") - аналог ORDER BY в SQL запросе, сортировка поля id по возрастанию, DESC 
->sort("id", "asc") - аналог ORDER BY в SQL запросе, сортировка поля id по убыванию, ASC

->pagination(0,6) - аналог LIMIT 0, 6 ы SQL запросе

->send() - отправка запроса и возвращение данных с запроса! 

2.Добавление новых записей

_MainModel::table("table")->add(array("login" => "[e-mail]", "pass" => "dfvkldfmlcdkfv"))->send(); 

->add(array("login" => "[e-mail]", "pass" => "dfvkldfmlcdkfv")) - заполняем поле таблицы login и pass данными

Если перевести в SQL запрос
INSERT INTO `table` (`login`, `pass`) VALUES ("[e-mail]", "dfvkldfmlcdkfv");

->send() - отправка запроса и получение id вставленной записи!

3.Редактирование записей

_MainModel::table("table")->edit(array("field1" => "значение1", "field2" => "значение2"), array("id" => 1))->send()

->edit(array("field1" => "значение1", "field2" => "значение2") - заполняем поля таблицы данными, которые хотим отредактировать

->send() - отправка запроса, при редактировании нечего не возвращается.

UPDATE `table` SET `field1` = 'значение1', `field2` = 'значение2' WHERE `table`.`id` = 1;

4.Удаление

_MainModel::table("table")->delete(array("id" => 4))->send();

Если перевести в SQL запрос

DELETE FROM table WHERE id = 4;

->send() - отправка запроса, при редактировании нечего не возвращается.

5.Собственный запрос PDO

$stmt = self::$db->prepare("SELECT * FROM  `x16_table` WHERE id= :id AND status = :status");

$result_query = $stmt->execute(array(":id" => _MainModel::$params_url['id'], ":status" => _MainModel::$params_url['status']));

$rows = $stmt->fetchAll(PDO::FETCH_ASSOC); 

_MainModel::viewJSON($rows);

// где _MainModel::$params_url['id'] - это GET или POST параметр, переданный в запросе.

5. Метод _MainModel::getQuery()

Получение отправляемого запроса в БД

SELECT id FROM x16_users WHERE login= :filter_login AND password= :filter_password

Пример вывода ошибок

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

_MainModel::viewJSON(["error" => "text error"]);

Frontend. Работа со страницами и их содержимым.

Разработчик frontend всегда работает только в папках /assets/, /layouts/, /widgets/

В данном фреймворке реализована работа с Web компонентами. Подробней можно почитать в официальной документации

Папка assets

В ней хранятся все внешние библиотеки которые используются в проекте. Например, Bootstra4, jQuery, различные API.

Папка layouts

В ней хранятся каталоги (subproject), которые есть в проекте.

Например, у нас есть интернет-магазин, который состоит из:

• сайта с товарами
• личного кабинет для пользователей (список заказов, корзина и т.д.)
• панель администрирования интернет-магазином (добавление товаров, категорий и т.д.)

В данном примере мы выделили 3 основных составляющих для subproject. Они и будут разделять на три каталога.

Пример:

• /layouts/site/
• /layouts/account/
• /layouts/admin/

Далее отдельные страницы для сайта (страница авторизации, вывода товаров и категорий, страница с формой оформления заказа и так далее) будут хранится так же в отдельных папках:

• /layouts/site/page1/
• /layouts/site/page2/
• /layouts/site/pageN/
• ...

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

• index.html - страница,
• style.css - каскадная таблица стилей CSS,
• script.js - скрипт написанный на языке JavaScript.

Папка widgets

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

Каталог отдельного виджета состоит из:

• index.html - виджет,
• style.css - каскадная таблица стилей CSS для виджета,
• script.js - скрипт написанный на языке JavaScrip для виджета.