OptionsTrait::setConfigOptions() - Code Metrics - Inspection of "#159. Add setMetaPageInfo for index http request t..." - SoliDry/api-generator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c00f72...cf3945 )

by Arthur

created 2019-05-09 09:51 UTC

OptionsTrait::setConfigOptions() A

↳ Parent: OptionsTrait

Complexity

Conditions	5
Paths	4

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	11
dl	0
loc	19
rs	9.6111
c	0
b	0
f	0
cc	5
nc	4
nop	1

<?php

namespace SoliDry\Extension;

use Illuminate\Http\Request;
use SoliDry\Helpers\ConfigHelper;
use SoliDry\Helpers\ConfigOptions;
use SoliDry\Helpers\Json;
use SoliDry\Helpers\MigrationsHelper;
use SoliDry\Helpers\SqlOptions;
use SoliDry\Types\ConfigInterface;
use SoliDry\Types\ModelsInterface;
use SoliDry\Types\ApiInterface;

/**
 * Trait OptionsTrait
 * @package SoliDry\Extension
 *
 * @property ConfigOptions configOptions
 */
trait OptionsTrait
{
    // default query params value
    private $defaultPage = ModelsInterface::DEFAULT_PAGE;
    private $defaultLimit = ModelsInterface::DEFAULT_LIMIT;
    private $defaultSort = '';
    private $isTree = false;

    /**
     * Sets SqlOptions params
     * @param Request $request
     * @return SqlOptions
     */
    private function setSqlOptions(Request $request) : SqlOptions
    {
        $sqlOptions = new SqlOptions();
        $page = ($request->input(ModelsInterface::PARAM_PAGE) === null) ? $this->defaultPage :
            $request->input(ModelsInterface::PARAM_PAGE);
        $limit = ($request->input(ModelsInterface::PARAM_LIMIT) === null) ? $this->defaultLimit :
            $request->input(ModelsInterface::PARAM_LIMIT);
        $sort = ($request->input(ModelsInterface::PARAM_SORT) === null) ? $this->defaultSort :
            $request->input(ModelsInterface::PARAM_SORT);

        $data = ($request->input(ModelsInterface::PARAM_DATA) === null) ? ModelsInterface::DEFAULT_DATA
            : Json::decode($request->input(ModelsInterface::PARAM_DATA));
        $orderBy = ($request->input(ModelsInterface::PARAM_ORDER_BY) === null) ? [ApiInterface::RAML_ID => $sort]
            : Json::decode($request->input(ModelsInterface::PARAM_ORDER_BY));
        $filter = ($request->input(ModelsInterface::PARAM_FILTER) === null) ? [] : Json::decode($request->input(ModelsInterface::PARAM_FILTER));

        $sqlOptions->setLimit($limit);
        $sqlOptions->setPage($page);
        $sqlOptions->setData($data);
        $sqlOptions->setOrderBy($orderBy);
        $sqlOptions->setFilter($filter);

        return $sqlOptions;
    }

    /**
     * Sets options based on config.php settings
     * @param string $calledMethod
     */
    private function setConfigOptions(string $calledMethod) : void
    {
        $this->configOptions = new ConfigOptions();
        $this->configOptions->setCalledMethod($calledMethod);
        $this->configOptions->setJwtIsEnabled(ConfigHelper::getNestedParam(ConfigInterface::JWT, ConfigInterface::ENABLED));
        $this->configOptions->setJwtTable(ConfigHelper::getNestedParam(ConfigInterface::JWT, ModelsInterface::MIGRATION_TABLE));
        if ($this->configOptions->getJwtIsEnabled() === true && $this->configOptions->getJwtTable() === MigrationsHelper::getTableName($this->entity)) {// if jwt enabled=true and tables are equal
            $this->configOptions->setIsJwtAction(true);
        }

        $this->setOptionsOnNotDelete($calledMethod);

        // set those only for create/update
        $this->setOptionsOnCreateUpdate($calledMethod);

        // set those only for index
        if ($calledMethod === JSONApiInterface::URI_METHOD_INDEX || $calledMethod === JSONApiInterface::URI_METHOD_VIEW) {
            $this->customSql = new CustomSql($this->entity);

            $this->setCacheOpts();
        }
    }

    /**
     *  Sets cache options: xFetch, cacheBeta, time to live etc
     */
    private function setCacheOpts() : void
    {
        $entityCache = ConfigHelper::getNestedParam(ConfigInterface::CACHE, strtolower($this->entity));
        if ($entityCache !== null) {
            $this->configOptions->setIsCached($entityCache[ConfigInterface::ENABLED]);
            if (empty($entityCache[ConfigInterface::CACHE_STAMPEDE_XFETCH]) === false) {
                $this->configOptions->setIsXFetch($entityCache[ConfigInterface::CACHE_STAMPEDE_XFETCH]);
            }

            if (empty($entityCache[ConfigInterface::CACHE_STAMPEDE_BETA]) === false) {
                $this->configOptions->setCacheBeta($entityCache[ConfigInterface::CACHE_STAMPEDE_BETA]);
            }

            if (empty($entityCache[ConfigInterface::CACHE_TTL]) === false) {
                $this->configOptions->setCacheTtl($entityCache[ConfigInterface::CACHE_TTL]);
            }
        }
    }

    /**
     * @param string $calledMethod
     */
    private function setOptionsOnNotDelete(string $calledMethod) : void
    {
        if ($calledMethod !== JSONApiInterface::URI_METHOD_DELETE) {
            $bitMaskParams = ConfigHelper::getNestedParam(ConfigInterface::BIT_MASK, MigrationsHelper::getTableName($this->entity));
            if ($bitMaskParams !== null) {
                $this->configOptions->setBitMask(true);
                $this->bitMask = new BitMask($bitMaskParams);

            }
        }
    }

    /**
     * @param string $calledMethod
     */
    private function setOptionsOnCreateUpdate(string $calledMethod) : void
    {
        if (in_array($calledMethod, [JSONApiInterface::URI_METHOD_CREATE, JSONApiInterface::URI_METHOD_UPDATE]) === true) {
            // state machine for concrete entity == table
            $stateMachine = ConfigHelper::getNestedParam(ConfigInterface::STATE_MACHINE, MigrationsHelper::getTableName($this->entity));
            if ($stateMachine !== null) {
                $this->configOptions->setStateMachine(true);
            }

            // spell check if enabled
            $spellCheck = ConfigHelper::getNestedParam(ConfigInterface::SPELL_CHECK, MigrationsHelper::getTableName($this->entity));
            if ($spellCheck !== null) {
                $this->configOptions->setSpellCheck(true);
            }
        }
    }

    /**
     *  Sets the default config based parameters
     */
    private function setDefaults() : void
    {
        $this->defaultPage = ConfigHelper::getQueryParam(ModelsInterface::PARAM_PAGE);
        $this->defaultLimit = ConfigHelper::getQueryParam(ModelsInterface::PARAM_LIMIT);
        $this->defaultSort = ConfigHelper::getQueryParam(ModelsInterface::PARAM_SORT);
        $this->isTree = ConfigHelper::getNestedParam(ConfigInterface::TREES, $this->entity, true);
    }

    /**
     * Sets meta page info requested with index http request
     * for page, limit, count
     *
     * @param array $meta
     * @param SqlOptions $sqlOptions
     * @param int $count
     */
    private function setMetaPageInfo(array &$meta, SqlOptions $sqlOptions, int $count): void
    {
        $meta[ModelsInterface::PARAM_PAGE] = $sqlOptions->getPage();
        $meta[ModelsInterface::PARAM_LIMIT] = $sqlOptions->getLimit();
        $meta[ModelsInterface::COUNT] = $count;
    }
}

1			<?php
2
3			namespace SoliDry\Extension;
4
5			use Illuminate\Http\Request;
6			use SoliDry\Helpers\ConfigHelper;
7			use SoliDry\Helpers\ConfigOptions;
8			use SoliDry\Helpers\Json;
9			use SoliDry\Helpers\MigrationsHelper;
10			use SoliDry\Helpers\SqlOptions;
11			use SoliDry\Types\ConfigInterface;
12			use SoliDry\Types\ModelsInterface;
13			use SoliDry\Types\ApiInterface;
14
15			/**
16			* Trait OptionsTrait
17			* @package SoliDry\Extension
18			*
19			* @property ConfigOptions configOptions
20			*/
21			trait OptionsTrait
22			{
23			// default query params value
24			private $defaultPage = ModelsInterface::DEFAULT_PAGE;
25			private $defaultLimit = ModelsInterface::DEFAULT_LIMIT;
26			private $defaultSort = '';
27			private $isTree = false;
28
29			/**
30			* Sets SqlOptions params
31			* @param Request $request
32			* @return SqlOptions
33			*/
34			private function setSqlOptions(Request $request) : SqlOptions
35			{
36			$sqlOptions = new SqlOptions();
37			$page = ($request->input(ModelsInterface::PARAM_PAGE) === null) ? $this->defaultPage :
38			$request->input(ModelsInterface::PARAM_PAGE);
39			$limit = ($request->input(ModelsInterface::PARAM_LIMIT) === null) ? $this->defaultLimit :
40			$request->input(ModelsInterface::PARAM_LIMIT);
41			$sort = ($request->input(ModelsInterface::PARAM_SORT) === null) ? $this->defaultSort :
42			$request->input(ModelsInterface::PARAM_SORT);
43
44			$data = ($request->input(ModelsInterface::PARAM_DATA) === null) ? ModelsInterface::DEFAULT_DATA
45			: Json::decode($request->input(ModelsInterface::PARAM_DATA));
46			$orderBy = ($request->input(ModelsInterface::PARAM_ORDER_BY) === null) ? [ApiInterface::RAML_ID => $sort]
47			: Json::decode($request->input(ModelsInterface::PARAM_ORDER_BY));
48			$filter = ($request->input(ModelsInterface::PARAM_FILTER) === null) ? [] : Json::decode($request->input(ModelsInterface::PARAM_FILTER));
49
50			$sqlOptions->setLimit($limit);
51			$sqlOptions->setPage($page);
52			$sqlOptions->setData($data);
53			$sqlOptions->setOrderBy($orderBy);
54			$sqlOptions->setFilter($filter);
55
56			return $sqlOptions;
57			}
58
59			/**
60			* Sets options based on config.php settings
61			* @param string $calledMethod
62			*/
63			private function setConfigOptions(string $calledMethod) : void
64			{
65			$this->configOptions = new ConfigOptions();
66			$this->configOptions->setCalledMethod($calledMethod);
67			$this->configOptions->setJwtIsEnabled(ConfigHelper::getNestedParam(ConfigInterface::JWT, ConfigInterface::ENABLED));
68			$this->configOptions->setJwtTable(ConfigHelper::getNestedParam(ConfigInterface::JWT, ModelsInterface::MIGRATION_TABLE));
69			if ($this->configOptions->getJwtIsEnabled() === true && $this->configOptions->getJwtTable() === MigrationsHelper::getTableName($this->entity)) {// if jwt enabled=true and tables are equal
70			$this->configOptions->setIsJwtAction(true);
71			}
72
73			$this->setOptionsOnNotDelete($calledMethod);
74
75			// set those only for create/update
76			$this->setOptionsOnCreateUpdate($calledMethod);
77
78			// set those only for index
79			if ($calledMethod === JSONApiInterface::URI_METHOD_INDEX \|\| $calledMethod === JSONApiInterface::URI_METHOD_VIEW) {
80			$this->customSql = new CustomSql($this->entity);
			0 ignored issues – show Bug Best Practice introduced 2019-02-09 12:55 UTC by Report Bug Copy Issue Report The property `customSql` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
81			$this->setCacheOpts();
82			}
83			}
84
85			/**
86			* Sets cache options: xFetch, cacheBeta, time to live etc
87			*/
88			private function setCacheOpts() : void
89			{
90			$entityCache = ConfigHelper::getNestedParam(ConfigInterface::CACHE, strtolower($this->entity));
91			if ($entityCache !== null) {
92			$this->configOptions->setIsCached($entityCache[ConfigInterface::ENABLED]);
93			if (empty($entityCache[ConfigInterface::CACHE_STAMPEDE_XFETCH]) === false) {
94			$this->configOptions->setIsXFetch($entityCache[ConfigInterface::CACHE_STAMPEDE_XFETCH]);
95			}
96
97			if (empty($entityCache[ConfigInterface::CACHE_STAMPEDE_BETA]) === false) {
98			$this->configOptions->setCacheBeta($entityCache[ConfigInterface::CACHE_STAMPEDE_BETA]);
99			}
100
101			if (empty($entityCache[ConfigInterface::CACHE_TTL]) === false) {
102			$this->configOptions->setCacheTtl($entityCache[ConfigInterface::CACHE_TTL]);
103			}
104			}
105			}
106
107			/**
108			* @param string $calledMethod
109			*/
110			private function setOptionsOnNotDelete(string $calledMethod) : void
111			{
112			if ($calledMethod !== JSONApiInterface::URI_METHOD_DELETE) {
113			$bitMaskParams = ConfigHelper::getNestedParam(ConfigInterface::BIT_MASK, MigrationsHelper::getTableName($this->entity));
114			if ($bitMaskParams !== null) {
115			$this->configOptions->setBitMask(true);
116			$this->bitMask = new BitMask($bitMaskParams);
			0 ignored issues – show Bug Best Practice introduced 2019-02-09 12:55 UTC by Report Bug Copy Issue Report The property `bitMask` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
117			}
118			}
119			}
120
121			/**
122			* @param string $calledMethod
123			*/
124			private function setOptionsOnCreateUpdate(string $calledMethod) : void
125			{
126			if (in_array($calledMethod, [JSONApiInterface::URI_METHOD_CREATE, JSONApiInterface::URI_METHOD_UPDATE]) === true) {
127			// state machine for concrete entity == table
128			$stateMachine = ConfigHelper::getNestedParam(ConfigInterface::STATE_MACHINE, MigrationsHelper::getTableName($this->entity));
129			if ($stateMachine !== null) {
130			$this->configOptions->setStateMachine(true);
131			}
132
133			// spell check if enabled
134			$spellCheck = ConfigHelper::getNestedParam(ConfigInterface::SPELL_CHECK, MigrationsHelper::getTableName($this->entity));
135			if ($spellCheck !== null) {
136			$this->configOptions->setSpellCheck(true);
137			}
138			}
139			}
140
141			/**
142			* Sets the default config based parameters
143			*/
144			private function setDefaults() : void
145			{
146			$this->defaultPage = ConfigHelper::getQueryParam(ModelsInterface::PARAM_PAGE);
147			$this->defaultLimit = ConfigHelper::getQueryParam(ModelsInterface::PARAM_LIMIT);
148			$this->defaultSort = ConfigHelper::getQueryParam(ModelsInterface::PARAM_SORT);
149			$this->isTree = ConfigHelper::getNestedParam(ConfigInterface::TREES, $this->entity, true);
150			}
151
152			/**
153			* Sets meta page info requested with index http request
154			* for page, limit, count
155			*
156			* @param array $meta
157			* @param SqlOptions $sqlOptions
158			* @param int $count
159			*/
160			private function setMetaPageInfo(array &$meta, SqlOptions $sqlOptions, int $count): void
161			{
162			$meta[ModelsInterface::PARAM_PAGE] = $sqlOptions->getPage();
163			$meta[ModelsInterface::PARAM_LIMIT] = $sqlOptions->getLimit();
164			$meta[ModelsInterface::COUNT] = $count;
165			}
166			}

SoliDry / api-generator

Push — master ( c00f72...cf3945 )

OptionsTrait::setConfigOptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like