File Controller/SearchController.php | Alpha Framework 3.0.0 API Documentation

  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  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394

<?php

namespace Alpha\Controller;

use Alpha\Util\Logging\Logger;
use Alpha\Util\Logging\KPI;
use Alpha\Util\Logging\LogProviderFile;
use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Http\Request;
use Alpha\Util\Http\Response;
use Alpha\Util\Service\ServiceFactory;
use Alpha\View\View;
use Alpha\View\Widget\Button;
use Alpha\Controller\Front\FrontController;

/**
 * Search engine controller.
 *
 * @since 1.0
 *
 * @author John Collins <dev@alphaframework.org>
 * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
 * @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
 * All rights reserved.
 *
 * <pre>
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the
 * following conditions are met:
 *
 * * Redistributions of source code must retain the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer.
 * * Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer in the documentation and/or other
 *   materials provided with the distribution.
 * * Neither the name of the Alpha Framework nor the names
 *   of its contributors may be used to endorse or promote
 *   products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * </pre>
 */
class SearchController extends Controller implements ControllerInterface
{
    /**
     * Trace logger.
     *
     * @var \Alpha\Util\Logging\Logger
     *
     * @since 1.0
     */
    private static $logger = null;

    /**
     * The start number for list pageination.
     *
     * @var int
     *
     * @since 1.0
     */
    protected $startPoint;

    /**
     * The result count from the search.
     *
     * @var int
     *
     * @since 1.0
     */
    protected $resultCount = 0;

    /**
     * The search query supplied.
     *
     * @var string
     *
     * @since 1.0
     */
    protected $query;

    /**
     * constructor to set up the object.
     *
     * @param string $visibility The name of the rights group that can access this controller.
     *
     * @since 1.0
     */
    public function __construct($visibility = 'Public')
    {
        self::$logger = new Logger('SearchController');
        self::$logger->debug('>>__construct(visibility=['.$visibility.'])');

        // ensure that the super class constructor is called, indicating the rights group
        parent::__construct($visibility);

        self::$logger->debug('<<__construct');
    }

    /**
     * Handle GET requests.
     *
     * @param \Alpha\Util\Http\Request $request
     *
     * @return \Alpha\Util\Http\Response
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\IllegalArguementException
     */
    public function doGET($request)
    {
        self::$logger->debug('>>doGET($request=['.var_export($request, true).'])');

        $params = $request->getParams();

        if (isset($params['start']) ? $this->startPoint = $params['start'] : $this->startPoint = 0);

        $config = ConfigProvider::getInstance();

        $KPI = new KPI('search');

        $body = '';

        if (isset($params['query'])) {
            $this->query = $params['query'];

            // replace any %20 on the URL with spaces
            $params['query'] = str_replace('%20', ' ', $params['query']);

            $this->setTitle('Search results - '.$params['query']);
            $body .= View::displayPageHead($this);

            // log the user's search query in a log file
            $log = new LogProviderFile();
            $log->setPath($config->get('app.file.store.dir').'logs/search.log');
            $log->writeLine(array($params['query'], date('Y-m-d H:i:s'), $request->getUserAgent(), $request->getIP()));

            $KPI->logStep('log search query');

            $provider = ServiceFactory::getInstance('Alpha\Util\Search\SearchProviderTags', 'Alpha\Util\Search\SearchProviderInterface');

            // if a Record name is provided, only search tags on that class, otherwise search all records
            if (isset($params['ActiveRecordType'])) {
                $results = $provider->search($params['query'], $params['bo'], $this->startPoint);
            } else {
                $results = $provider->search($params['query'], 'all', $this->startPoint);
            }

            $this->resultCount = $provider->getNumberFound();

            $KPI->logStep('search completed using SearchProviderTags provider');

            $body .= $this->renderResultList($results, $params['query']);
        } else {
            $this->setTitle('Search results');
            $body .= View::displayPageHead($this);
            self::$logger->debug('No search query provided!');
        }

        $body .= View::displayPageFoot($this);

        $KPI->log();

        self::$logger->debug('<<doGET');

        return new Response(200, $body, array('Content-Type' => 'text/html'));
    }

    /**
     * Renders the search result list.
     *
     * @param array  $results
     * @param string $query
     * @param bool   $showTags
     *
     * @since 1.0
     *
     * @return string
     */
    protected function renderResultList($results, $query = '', $showTags = true)
    {
        $body = '';

        if (!empty($query)) {
            $body .= '<h2>Displaying results for &quot;'.$query.'&quot;</h2>';
        }

        foreach ($results as $bo) {
            if ($bo instanceof \Alpha\Model\Article && $bo->get('published') == false) {
                --$this->resultCount;
            } else {
                $view = View::getInstance($bo);
                $URI = $this->request->getURI();
                $body .= $view->listView(array('formAction' => $URI));

                if ($showTags) {
                    $tags = $bo->getPropObject('tags')->getRelated();

                    if (count($tags) > 0) {
                        $body .= '<p>Tags: ';

                        $queryTerms = explode(' ', mb_strtolower($query));

                        foreach ($tags as $tag) {
                            $body .= (in_array($tag->get('content'), $queryTerms) ? '<strong>'.$tag->get('content').' </strong>' : $tag->get('content').' ');
                        }

                        $body .= '</p>';
                    }
                }
            }
        }

        return $body;
    }

    /**
     * Displays a search form on the top of the page.
     *
     * @return string
     *
     * @since 1.0
     */
    public function after_displayPageHead_callback()
    {
        $config = ConfigProvider::getInstance();

        $body = parent::after_displayPageHead_callback();

        $body .= '<div align="center" class="form-group"><form class="form-inline" method="GET" id="search_form" onsubmit="document.location = \''.$config->get('app.url').'search/\'+document.getElementById(\'q\').value; return false;">';
        $body .= '<label for="q">Search for</label><input type="text" name="q" id="q" class="form-control" style="width:50%; margin:10px;"/>';
        $button = new Button('document.location = \''.$config->get('app.url').'/search/\'+document.getElementById(\'q\').value', 'Search', 'searchButton');
        $body .= $button->render();
        $body .= '</p></form></div>';

        return $body;
    }

    /**
     * Method to display the page footer with pageination links.
     *
     * @return string
     *
     * @since 1.0
     */
    public function before_displayPageFoot_callback()
    {
        $body = $this->renderPageLinks();

        $body .= '<br>';

        return $body;
    }

    /**
     * Method for rendering the pagination links.
     *
     * @return string
     *
     * @since 1.0
     */
    protected function renderPageLinks()
    {
        $config = ConfigProvider::getInstance();

        $params = $this->request->getParams();

        $body = '';

        $end = ($this->startPoint+$config->get('app.list.page.amount'));

        if ($end > $this->resultCount) {
            $end = $this->resultCount;
        }

        if ($this->resultCount > 0) {
            $body .= '<p align="center">Displaying '.($this->startPoint+1).' to '.$end.' of <strong>'.$this->resultCount.'</strong>.&nbsp;&nbsp;';
        } else {
            if (!empty($this->query)) {
                $body .= View::displayUpdateMessage('There were no search results for your query.');
            }
        }

        $body .= '<ul class="pagination">';

        if ($this->startPoint > 0) {
            // handle secure URLs
            if (isset($params['tk'])) {
                $body .= '<li><a href="'.FrontController::generateSecureURL('act=Search&q='.$this->query.'&start='.($this->startPoint-$config->get('app.list.page.amount'))).'">&laquo;</a></li>';
            } else {
                $body .= '<li><a href="'.$config->get('app.url').'/search/'.$this->query.'/'.($this->startPoint-$config->get('app.list.page.amount')).'">&laquo;</a></li>';
            }
        } elseif ($this->resultCount > $config->get('app.list.page.amount')) {
            $body .= '<li class="disabled"><a href="#">&laquo;</a></li>';
        }

        $page = 1;

        for ($i = 0; $i < $this->resultCount; $i += $config->get('app.list.page.amount')) {
            if ($i != $this->startPoint) {
                // handle secure URLs
                if (isset($params['tk'])) {
                    $body .= '<li><a href="'.FrontController::generateSecureURL('act=Search&q='.$this->query.'&start='.$i).'">'.$page.'</a></li>';
                } else {
                    $body .= '<li><a href="'.$config->get('app.url').'/search/'.$this->query.'/'.$i.'">'.$page.'</a></li>';
                }
            } elseif ($this->resultCount > $config->get('app.list.page.amount')) {
                $body .= '<li class="active"><a href="#">'.$page.'</a></li>';
            }

            ++$page;
        }

        if ($this->resultCount > $end) {
            // handle secure URLs
            if (isset($params['tk'])) {
                $body .= '<li><a href="'.FrontController::generateSecureURL('act=Search&q='.$this->query.'&start='.($this->startPoint+$config->get('app.list.page.amount'))).'">Next-&gt;&gt;</a></li>';
            } else {
                $body .= '<li><a href="'.$config->get('app.url').'/search/'.$this->query.'/'.($this->startPoint+$config->get('app.list.page.amount')).'">&raquo;</a></li>';
            }
        } elseif ($this->resultCount > $config->get('app.list.page.amount')) {
            $body .= '<li class="disabled"><a href="#">&raquo;</a></li>';
        }

        $body .= '</ul>';
        $body .= '</p>';

        return $body;
    }

    /**
     * Get the search result count.
     *
     * @return int
     *
     * @since 1.2.4
     */
    public function getResultCount()
    {
        return $this->resultCount;
    }

    /**
     * Set the search result count.
     *
     * @param int $resultCount
     *
     * @since 1.2.4
     */
    protected function setResultCount($resultCount)
    {
        $this->resultCount = $resultCount;
    }

    /**
     * Get the search query.
     *
     * @return string
     *
     * @since 1.2.4
     */
    public function getSearchQuery()
    {
        return $this->query;
    }

    /**
     * Set the search query.
     *
     * @param string $query
     *
     * @since 1.2.4
     */
    protected function setSearchQuery($query)
    {
        $this->query = $query;
    }
}

Namespaces

Classes

Interfaces

Exceptions