Useful Tips: How to Work With Yii2 Framework Effectively

<?php

$params = array_merge(
    require(__DIR__ . '/../../common/config/params.php'),
    file_exists(__DIR__ . '/../../common/config/params-env.php') ? require(__DIR__ . '/../../common/config/params-env.php') : [],
    file_exists(__DIR__ . '/../../common/config/params-local.php') ? require(__DIR__ . '/../../common/config/params-local.php') : [],
    require(__DIR__ . '/params.php'),
    file_exists(__DIR__ . '/params-env.php') ? require(__DIR__ . '/params-env.php') : [],
    file_exists(__DIR__ . '/params-local.php') ? require(__DIR__ . '/params-local.php') : []
);

class Customer extends ActiveRecord
{
    public static function find()
    {
        return (new CustomerQuery(get_called_class()))->orderBy(['created_at' => SORT_DESC]);
    }
}

class CustomerQuery extends ActiveQuery
{
    public function active()
    {
        return $this->filterWhere(['active' => 1]);
    }
}

User::find()->filterWhere(['od' => Customer::find()->select('id')->where('id > 0') ]);

/**
     * @return \yii\db\ActiveQuery
     */
    public function getAccessToken()
    {
        return $this->hasOne(AccessToken::className(), ['user_id' => 'id'])->from(['accessToken' => AccessToken::tableName()]);
    }

class MemberQuery extends ActiveQuery
{
    public function byProgramType($type = ProgramType::TYPE_INNER_CIRCLE)
    {
        return $this->innerJoinWith([
            'program' => function(ActiveQuery $query) use ($type) {
                $query->innerJoinWith([
                    'type' => function(ActiveQuery $query) use ($type) {
                        $query->andFilterWhere(['type' => $type]);
                    }
                ]);
            }
        ]);
    }
}

public function actionIndex()
    {
        $models = User::find();
        $this->addPagination($models);
        $this->addFilters($models, ['name' => true]);
        $expand = $this->addWith($models, ['comments', 'posts']);
        $this->returnQueryResult($models, $expand);
    }

public function addPagination(Query &$models)
    {
        $count = $models->count();
        header('X-Count: ' . $count);

        if (!$count) {
            $models->limit(0);
        }

        if ($limit = \Yii::$app->request->get('limit')) $models->limit($limit);
        if ($offset = \Yii::$app->request->get('offset')) $models->offset($offset);
    }

/**
     * Add filters from GET
     *
     * value will be taken from $filtersData or $_GET[column]
     *
     * @param Query $models
     * @param array $columns
     *  [
     *      'column' => true, // SQL: 'column = value' or 'column LIKE value' or  'column IN (value, ...)'
     *      'column' => 'someTable.someColumn', // alias for column. Example: 'column = value' will be 'someTable.someColumn = value'
     *      '%column%' => <true|columnAlias>, // wrap value with "%". Example: '%column%' => true, SQL: 'column = LIKE "%value%"'
     *      '%column%' => new Expression('someColumn = DATE(NOW()) AND column LIKE :column') // add expression in where condition
     *  ]
     *
     *  @param array $filtersData optional, values for filters. If not set, values will be taken from $_GET
     */
    public function addFilters(Query &$models, $columns = [], $filtersData = null, $forOne = null)
    {
        $tableName = $models->from ? (!empty($models->from[0]) ? $models->from[0] : key($models->from)) . '.' : '';

        if (is_null($filtersData)) $filtersData = \Yii::$app->request->get();

        if (!empty($filtersData['one']) && is_array($forOne) && !array_intersect($forOne, array_keys(\Yii::$app->request->get()))) {
            $models->where('1=0');
            $models->params([]);
            return;
        }

        /**
         * @var string $name
         * @var Expression|string $expression
         */
        foreach($columns as $name => $expression) {

            $normalName = str_replace('%', '', $name);
            $hasPercent = strlen($normalName) != strlen($name);

            if (isset($filtersData[$normalName]) && !is_null($filtersData[$normalName]) && $filtersData[$normalName] !== '') {
                $value = $filtersData[$normalName];
                $value = $hasPercent ? '%' . $value . '%' : $value;

                if (strpos($value, ',') !== false) {
                    $value = explode(',', $value);
                }

                if ($expression === true) {
                    $models = $models->andFilterWhere([$tableName . $normalName => $value]);
                } else if ($expression instanceof Expression) {
                    $models = $models->andWhere($expression->expression, array_merge($expression->params, [':' . $normalName => $value]));
                } else {
                    $models = $models->andWhere([$expression => $value]);
                }
            }
        }
    }

@param array $columns
 [
     'column' => true, // SQL: 'column = value' or 'column LIKE value' or  'column IN (value, ...)'
     'column' => 'someTable.someColumn', // alias for column. Example: 'column = value' will be 'someTable.someColumn = value'
     '%column%' => <true|columnAlias>, // wrap value with "%". Example: '%column%' => true, SQL: 'column = LIKE "%value%"'
     '%column%' => new Expression('someColumn = DATE(NOW()) AND column LIKE :column') // add expression in where condition
 ]

/**
     * Add nested data
     *
     * @param Query $models
     * @param $allowedWithArray
     * @param null $with
     * @param array $withColumns ['withName' => ['<GET Param Name>', <GET Param Name>', ... ], ...]
     * @return array
     */
    public function addWith(Query &$models, $allowedWithArray, $with = null, $withColumns = [])
    {
        $expand = [];

        if ($with === null) $with = \Yii::$app->request->get('with', []);
        if (is_string($with)) $with = explode(',', $with);

        $allowedWithExp =  str_replace('()', '', '/(' . join(')|(', $allowedWithArray) . ')/');

        foreach ($withColumns as $withName => $columns) {
            if ((array_intersect(array_keys(\Yii::$app->request->get()), $columns) || in_array(\Yii::$app->request->get('sort'), $columns)) && !in_array($withName, $with)) {
                $with[] = $withName;
            }
        }


        foreach($with as $withItem) {
            if (preg_match($allowedWithExp, $withItem)) {

                // try to call $model->withSomeRelation()
                if (method_exists($models, 'with' . ucfirst($withItem))) {
                    call_user_func([$models, 'with' . ucfirst($withItem)]);
                } else {
                    $models->joinWith($withItem, true, 'LEFT JOIN');
                }

                $expandItem = explode('.', $withItem);
                $expand[] = reset($expandItem);
            }
        }

        return $expand;
    }