FFCMS\Traits\SearchController

Complexity

Total Complexity

73

Size/Duplication

Total Lines	359
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	url()	0	1	?
C	checkOrderField()	0	28	8
B	checkFieldsExist()	0	18	6
F	getListingResults()	0	119	27
F	getSearchResults()	0	146	32

<?php

namespace FFCMS\Traits;

/**
 * Controller Methods which utilise a mapper to search and list results
 */
trait SearchController
{
    /**
     * Create an internal URL
     * Uses method from
     * @see \FFCMS\Helpers\UrlHelper
     * @param string $url
     * @param array $params
     */
    abstract public function url(string $url, array $params = []): string;


    /**
     * Check the order by field is valid and return it corrected
     *
     * @param null|string $order order field in form of: "field1 ASC/DESC,field 2 ASC/DESC.."
     * @param array $allFields the list of fields which are valid to order by
     * @return string $validFields
     */
    public static function checkOrderField(string $order = null, array $allFields = []): string
    {
        if (empty($order)) {
            return join(',', $allFields);
        }

        $orderClauses = empty($order) ? [] : preg_split("/[,]/", $order);
        foreach ($orderClauses as $k => $field) {
            // split into field, asc/desc
            $field = preg_split("/[\s]+/", trim($field));
            if (!in_array($field[0], $allFields)) {
                // invalid field
                unset($orderClauses[$k]);
                continue;
            } elseif (count($field) == 1) {
                $field[1] = 'asc';
            } elseif (count($field) == 2) {
                if (!in_array($field[1], ['asc', 'desc'])) {
                    $field[1] = 'asc';
                }
            }
            $orderClauses[$k] = $field[0] . ' ' . $field[1];
        }
        ksort($orderClauses);
        $order = join(',', $orderClauses);

        return $order;
    }


    /**
     * Check the fields exist and return only the existing ones
     *
     * @param array $checkFieldsExist [id => 'field1,field2'...]
     * @param array $fieldsList the list of fields which are valid
     * @return array $validFields
     */
    public static function checkFieldsExist(array $checkFieldsExist = [], array $fieldsList = []): array
    {
        // fields to return and fields to search - validate
        $validFields = [];
        foreach ($checkFieldsExist as $id => $fields) {
            if (empty($fields)) {
                continue;
            }
            $fields = empty($fields) ? [] : preg_split("/[,]/", $fields);
            foreach ($fields as $k => $field) {
                if (!in_array($field, $fieldsList)) {
                    unset($fields[$k]);
                }
            }
            $validFields[$id] = join(',', $fields);
        }
        return $validFields;
    }


   /**
     * list objects (list is a reserved keyword) of mapper
     *
     * @param \Base $f3
     * @param \FFCMS\Mappers\Mapper $m
     * @return array
     */
    protected function &getListingResults(\Base $f3, \FFCMS\Mappers\Mapper $m, string $users_uuid = null): array
    {
        // set up paging limits
        $minPerPage = 5;
        $maxPerPage = 1024;
        $perPage = (int) $f3->get('REQUEST.per_page');
        if ($perPage < $minPerPage) {
            $perPage = $minPerPage;
        }
        if ($perPage > $maxPerPage) {
            $perPage = $maxPerPage;
        }

        $page = $f3->get('REQUEST.page');
        if ($page < 1) {
            $page = 1;
        }

        // fetch data (paging is 0 based)
        $allFields = $m->fields();

        // validate order field
        $order = self::checkOrderField($f3->get('REQUEST.order'), $allFields);

        // validated fields to return
        $validFields = self::checkFieldsExist([$f3->get('REQUEST.fields')], $allFields);
        $fields = empty($validFields['fields']) ? join(',', $allFields) : $validFields['fields'];

        // count rows
        $data = [];

        // count rows
        $isAdmin = $f3->get('isAdmin');
        $rows = 0;
        if  (in_array('users_uuid', $allFields) && !empty($users_uuid)) {
            $rows = $m->count(['users_uuid = ?', $users_uuid]);
        } elseif ($isAdmin && empty($users_uuid)) {
            $rows = $m->count();
        }
        if ($rows < 1) {
            return $data;
        }

        // if fewer results than per page, set per_page
        if ($page == 1 && $perPage > $rows) {
            $perPage = $rows;
        }

        $pagination = [];
        $pagination['count'] = ceil($rows / $perPage);

        // too high page number?
        if ($page > $pagination['count']) {
            $page = $pagination['count'];
        }

        // set up page URLs
        $url = $f3->get('PATH');
        $urlParams = [
            'per_page' => $perPage,
        ];
        if (!empty($order)) {
            $urlParams['order'] = $order;
        }
        if (!empty($fields)) {
            $urlParams['fields'] = $fields;
        }
        ksort($urlParams);

        // next/previous page url
        $prevPage = (1 > $page - 1 ) ? null : $page - 1;
        $nextPage = (1 + $page > $pagination['count']) ? null : $page + 1;

        $resultsFrom = round($page * ($rows / $pagination['count'])) - $perPage + 1;
        $resultsTo = $resultsFrom + $perPage - 1;

        // return data
        $data['pagination'] = [
            'url_base' => $this->url($url, $urlParams),
            'url_current' => $this->url($url, $urlParams + ['page' => $page]),
            'url_first' => $this->url($url, $urlParams + ['page' => 1]),
            'url_last' => $this->url($url, $urlParams + ['page' => $pagination['count']]),
            'url_next' => (null == $nextPage) ? null : $this->url($url, $urlParams + ['page' => $nextPage]),
            'url_previous' => (null == $prevPage) ? null : $this->url($url, $urlParams + ['page' => $prevPage]),
            'results' => $rows,
            'results_from' => $resultsFrom,
            'results_to' => $resultsTo,
            'per_page' => $perPage,
            'pages' => $pagination['count'],
            'page' => $page,
            'object' => $m->table(),
            'fields' => preg_split("/[,]/", $fields),
            'view' => $f3->get('REQUEST.view')
        ];


        // fetch results
        if ($isAdmin && empty($users_uuid)) {
            $m->load(null, [
                'order' => $order,
                'offset' => (1 == $page) ? 0 : ($page - 1) * $perPage,
                'limit' => $perPage
            ]);
        } else {
            $m->load(['users_uuid = ?', $users_uuid], [
                'order' => $order,
                'offset' => (1 == $page) ? 0 : ($page - 1) * $perPage,
                'limit' => $perPage
            ]);
        }

        $adminView = $isAdmin || ($isAdmin && 'admin' == $f3->get('REQUEST.view'));
        do {
            $data['objects'][] = $adminView ? $m->castFields($fields) : $m->exportArray($fields);
        }
        while ($m->skip());

        return $data;
    }

    /**
     * search objects of given mapper
     *
     * @param \Base $f3
     * @param \FFCMS\Mappers\Mapper $m
     * @param string|null $users_uuid uuid of user to get results for
     * @return array $results
     */
    protected function &getSearchResults(\Base $f3, \FFCMS\Mappers\Mapper $m, string $users_uuid = null): array
    {
        // set up paging limits
        $minPerPage = 10;
        $maxPerPage = 100;
        $perPage = (int) $f3->get('REQUEST.per_page');
        if ($perPage < $minPerPage) {
            $perPage = $minPerPage;
        }
        if ($perPage > $maxPerPage) {
            $perPage = $maxPerPage;
        }

        $page = $f3->get('REQUEST.page');
        if ($page < 1) {
            $page = 1;
        }

        // fetch data (paging is 0 based)
        $allFields = $m->fields();

        // validate order field
        $order = self::checkOrderField($f3->get('REQUEST.order'), $allFields);
        $validFields = self::checkFieldsExist([$f3->get('REQUEST.fields'), $f3->get('REQUEST.search_fields')], $allFields);

        // validated fields to return
        $fields = empty($validFields['fields']) ? join(',', $allFields) : $validFields['fields'];

        // validated fields to search in, use all if empty
        $searchFields = empty($validFields['search_fields']) ? join(',', $allFields) : $validFields['search_fields'];

        // get search type
        $search = $f3->get('REQUEST.search');
        if (!empty($search)) {
            $search = trim(strtolower($search));
        }
        $search_type = $f3->get('REQUEST.search_type');
        if (empty($search_type)) {
            $search_type = 'exact';
        } elseif ($search_type !== 'exact') {
            $search_type = 'fuzzy';
        }

        // construct search query
        $db = \Registry::get('db');
        $sqlClauses = [];
        $searchFieldsArray = preg_split("/[,]/", $searchFields);
        foreach ($searchFieldsArray as $field) {
            $sqlClauses[] = 'LOWER(' . $db->quotekey($field) . ') = ' . $db->quote($search);
            if ($search_type == 'fuzzy') {
                $sqlClauses[] = 'LOWER(' . $db->quotekey($field) . ') LIKE ' . $db->quote('%' . $search . '%');
            }
        }


        // get total results
        $isAdmin = $f3->get('isAdmin');
        $query = 'SELECT COUNT(*) AS results FROM ' . $db->quotekey($m->table()) . ' WHERE ';
        if  (in_array('users_uuid', $allFields) && !empty($users_uuid)) {
            $query .= ' users_uuid = ' . $db->quote($users_uuid)  . ' AND ('.  join(' OR ', $sqlClauses) . ')';
        } elseif ($isAdmin && empty($users_uuid)) {
            $query .= join(' OR ', $sqlClauses);
        }

        $data = [];
        $rows = $db->exec($query);
        $rows = (int) $rows[0]['results'];
        if ($rows < 1) {
            return $data;
        }

        // if fewer results than per page, set per_page
        if ($page == 1 && $perPage > $rows) {
            $perPage = $rows;
        }

        $pagination = [];
        $pagination['count'] = (int) ceil($rows / $perPage);

        // too high page number?
        if ($page > $pagination['count']) {
            $page = $pagination['count'];
        }

        // set up page URLs
        $url = $f3->get('PATH');
        $urlParams = [
            'per_page' => $perPage,
            'search' => $search,
            'search_type' => $search_type,
        ];
        if (!empty($order)) {
            $urlParams['order'] = $order;
        }
        if (!empty($fields)) {
            $urlParams['fields'] = $fields;
        }
        ksort($urlParams);

        // previous page url
        $prevPage = (1 > $page - 1 ) ? null : $page - 1;
        $nextPage = (1 + $page > $pagination['count']) ? null : $page + 1;

        $resultsFrom = 1 + ($page * $perPage) - $perPage;
        $resultsTo = $resultsFrom + $perPage - 1;
        if ($resultsTo > $rows) {
            $resultsTo = $rows;
        }

        // return data
        $data['pagination'] = [
            'url_base' => $this->url($url, $urlParams),
            'url_current' => $this->url($url, $urlParams + ['page' => $page]),
            'url_first' => $this->url($url, $urlParams + ['page' => 1]),
            'url_last' => $this->url($url, $urlParams + ['page' => $pagination['count']]),
            'url_next' => (null == $nextPage) ? null : $this->url($url, $urlParams + ['page' => $nextPage]),
            'url_previous' => (null == $prevPage) ? null : $this->url($url, $urlParams + ['page' => $prevPage]),
            'results' => $rows,
            'results_from' => $resultsFrom,
            'results_to' => $resultsTo,
            'per_page' => $perPage,
            'pages' => $pagination['count'],
            'page' => $page,
            'object' => $m->table(),
            'fields' => preg_split("/[,]/", $fields),
            'view' => $f3->get('REQUEST.view')
        ];


        // retrieve results
        $query = 'SELECT * FROM ' . $db->quotekey($m->table()) . ' WHERE ';
        if (empty($users_uuid)) {
             $query .= join(' OR ', $sqlClauses);
        } else {
             $query .= ' users_uuid = ' . $db->quote($users_uuid)  . ' AND ('.  join(' OR ', $sqlClauses) . ')';
        }
        $query .= sprintf(' LIMIT %d,%d', (1 == $page) ? 0 : ($page - 1) * $perPage, $perPage);

        $adminView = $isAdmin || ($isAdmin && 'admin' == $f3->get('REQUEST.view'));
        $results = $db->exec($query);
        foreach ($results as $row) {
            $data['objects'][] = $adminView ? $m->castFields($fields, $row) : $m->exportArray($fields, $row);
        }

        return $data;
    }

}