controllers/BaseApiController.php at master · arikaim/controllers · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?php
/**
 * Arikaim
 *
 * @link        http://www.arikaim.com
 * @copyright   Copyright (c)  Konstantin Atanasov <info@arikaim.com>
 * @license     http://www.arikaim.com/license
 *
 */
namespace Arikaim\Core\Controllers;

use Arikaim\Core\Controllers\Traits\Base\BaseController;
use Arikaim\Core\Controllers\Traits\Base\ApiResponse;
use Arikaim\Core\Controllers\Traits\Base\UserAccess;

/**
 * BaseApiController class
*/
class BaseApiController
{
    use
        BaseController,
        UserAccess,
        ApiResponse;

    /**
     * Errors list
     *
     * @var array
     */
    protected $errors = [];

    /**
     * Container ref
     * @var Container|null
     */
    protected $container;

    /**
     * Constructor
     *
     * @param object|null $container
     */
    public function __construct(?object &$container = null)
    {
        $this->container = $container;
        $this->init();

        $this->clearResult();
    }

    /**
     * Init controller, override this method in child classes
     *
     * @return void
    */
    public function init(): void
    {
    }

    /**
     * Add error
     *
     * @param string $message
     * @return void
    */
    public function addError(string $message): void
    {
        $this->errors[] = $message;
    }

    /**
     * Return true if response have error
     *
     * @return boolean
     */
    public function hasError(): bool
    {
        return (\count($this->errors) > 0);
    }
}