denisok94/yii-helper

--

0.0.3 2022-07-02 21:19 UTC

Requires

• denisok94/helper: >=0.8.0|dev-develop
• denisok94/helper-composer: >0.0.2
• yiisoft/yii2: ~2.0.0

Conflicts

• denisok94/helper: <0.8.0

BSD-3-Clause

• Denisok94

• yii2-extension

README

Installation

Run:

composer require --prefer-dist denisok94/yii-helper
# or
php composer.phar require --prefer-dist denisok94/yii-helper

or add to the require section of your composer.json file:

"denisok94/yii-helper": "*"

composer update
# or
php composer.phar update

Use

• StatusController
• ConsoleController
• Helper

StatusController

For communication in the json format.

Method	Parameters	default code	Description
send	$data	200	custom responses
sendSuccess	$data	200	Report Success
sendResponse	$data, $message, $status, $code	200	custom responses
sendError	$message, $status, $code	400	Report an error
sendBadRequest	$message	400
sendUnauthorized	$message	401
sendForbidden	$message	403
sendNotFound	$message	404
sendInternalServerError	$message	500
getPost	$name	--	Получить параметр из сообщения
success	$data	--	outdated
error	$error, $text, $data	--	outdated

namespace app\controllers;
use \denisok94\helper\yii2\StatusController;

class MyController extends StatusController
{
    // code
}

// получить все данные
$message = $this->post; // array
// получить параметр из данных
$phone = $this->getPost('phone'); // phone or null

Report Success

// Сообщить об успешной обработки
return $this->sendSuccess(); // http status code 200
// ['code' => '200', 'status' => 'OK', 'data' => []];
// Вернуть результат работы
return $this->sendSuccess($data);  // http status code 200
// ['code' => '200', 'status' => 'OK', 'data' => $data];

Report an error

return $this->sendError(); // http status code 400
// ['code' => '400', 'status' => 'FAIL', 'message' => 'Error', 'data' => []]
return $this->sendError($message); // http status code 400
// ['code' => '400', 'status' => 'FAIL', 'message' => $message, 'data' => []]
return $this->sendError($message, $data); // http status code 400
// ['code' => '400', 'status' => 'FAIL', 'message' => $message, 'data' => $data]
return $this->sendError($message, $data, 401); // http status code 401
// ['code' => '401', ...]

// return ['code', 'status', 'message'];
return $this->sendBadRequest(); // http status code 400
return $this->sendUnauthorized(); // http status code 401
return $this->sendForbidden(); // http status code 403
return $this->sendNotFound(); // http status code 404
return $this->sendInternalServerError(); // http status code 500

if (!$this->post) {
    return $this->sendBadRequest("Request is null"); // http status code 400
    // ['code' => '400', 'status' => 'FAIL', 'message' => 'Request is null']
}

try {
    //code...
} catch (\Exception $e) {
    return $this->sendInternalServerError($e->getMessage()); // http status code 500
    // ['code' => '500', 'status' => 'FAIL', 'message' => '...']
}

Custom response format

return $this->send([...]); // http status code 200
// [...];
return $this->send(['code' => 204]); // http status code 204
// ['code' => '204'];
return $this->send(['code' => 201, 'data' => $data]); // http status code 201
// ['code' => '201', 'data' => $data];

return $this->sendResponse($data); // http status code 200
// ['code' => '200', 'status' => 'OK', 'message' => '', 'data' => $data]
return $this->sendResponse($data, $message); // http status code 200
// ['code' => '200', 'status' => 'OK', 'message' => $message, 'data' => $data]
return $this->sendResponse($data, $message, $status, 999); // http status code 999
// ['code' => '999', 'status' => $status, 'message' => $message, 'data' => $data]

ConsoleController

namespace app\commands;
use \denisok94\helper\yii2\ConsoleController;

class MyController extends ConsoleController
{
    // code
}

Вызвать action консольного контроллера:

use \denisok94\helper\yii2\Helper as H;
H::exec('controller/action', [params]);

Консольный контроллер, не подразумевает ответ. Вся выводящая информация (echo, print и тд) будет записана в лог файл. При вызове через H::exec(), по умолчанию логи находятся в /runtime/logs/consoleOut.XXX.log (можно переопределить)

Получить переданные параметры

$init = $this->params;

Пример:

namespace app\commands;
use \denisok94\helper\yii2\ConsoleController;

class MyController extends ConsoleController
{
	public function actionTest()
	{
		$init = $this->params; // ['test' => 'test1']
		$test = $this->params['test']; // 'test1'
	}
}
//
use \denisok94\helper\yii2\Helper as H;
H::exec('my/test', ['test' => 'test1']);

Helper

use \denisok94\helper\yii2\Helper as H;
H::methodName($arg);

yii2\Helper наследует все от Helpers

Method	Description
exec	Выполнить консольную команду
log	Записать данные в лог файл. Файлы хранятся в runtime/logs/
setCache	Запомнить массив в кэш
getCache	Взять массив из кэша
deleteCache	Удалить кэш
clearCache

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

namespace app\components;
use app\components\H;

class Filter
{
    //.....
    /**
     * @return array
     */
    public static function getTypes()
    {
        $types = H::getCache('types'); // dir: app/cache/types.json
        if ($types) {
            return $types;
        } else {
            $types = \app\models\Types::find()
                ->select(['id', 'name'])->all();
            $array = [];
            foreach ($types as $key => $value) {
                $array[$value->id] = ucfirst($value->name);
            }
            H::setCache('types', $array);
            return $array;
        }
    }
}