Class SearchController

Search engine controller.

Alpha\Controller\SearchController implements Alpha\Controller\ControllerInterface

Namespace: Alpha\Controller
Copyright: Copyright (c) 2015, 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>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.0
Located at Controller/SearchController.php

Methods summary
`public`	# `__construct( string $visibility = 'Public' )` constructor to set up the object. constructor to set up the object. Parameters `$visibility` string $visibility The name of the rights group that can access this controller. Since 1.0 Overrides `Alpha\Controller\Controller::__construct()`
`public Alpha\Util\Http\Response`	# `doGET( Alpha\Util\Http\Request $request )` Handle GET requests. Handle GET requests. Parameters `$request` Alpha\Util\Http\Request $request Returns `Alpha\Util\Http\Response` Alpha\Util\Http\Response Throws `Alpha\Exception\IllegalArguementException` Alpha\Exception\IllegalArguementException Since 1.0 Overrides `Alpha\Controller\Controller::doGET()` Implementation of `Alpha\Controller\ControllerInterface::doGET()`
`protected string`	# `renderResultList( array $results, string $query = '', boolean $showTags = true )` Renders the search result list. Renders the search result list. Parameters `$results` array $results `$query` string $query `$showTags` bool $showTags Returns `string` string Since 1.0
`public string`	# `after_displayPageHead_callback( )` Displays a search form on the top of the page. Displays a search form on the top of the page. Returns `string` string Since 1.0 Overrides `Alpha\Controller\Controller::after_displayPageHead_callback()`
`public string`	# `before_displayPageFoot_callback( )` Method to display the page footer with pageination links. Method to display the page footer with pageination links. Returns `string` string Since 1.0
`protected string`	# `renderPageLinks( )` Method for rendering the pagination links. Method for rendering the pagination links. Returns `string` string Since 1.0
`public integer`	# `getResultCount( )` Get the search result count. Get the search result count. Returns `integer` int Since 1.2.4
`protected`	# `setResultCount( integer $resultCount )` Set the search result count. Set the search result count. Parameters `$resultCount` int $resultCount Since 1.2.4
`public string`	# `getSearchQuery( )` Get the search query. Get the search query. Returns `string` string Since 1.2.4
`protected`	# `setSearchQuery( string $query )` Set the search query. Set the search query. Parameters `$query` string $query Since 1.2.4

Methods inherited from Alpha\Controller\Controller
abort(), accessError(), checkIfAccessingFromSecureURL(), checkRights(), checkSecurityFields(), clearUnitOfWorkAttributes(), commit(), doDELETE(), doHEAD(), doOPTIONS(), doPATCH(), doPOST(), doPUT(), doTRACE(), generateSecurityFields(), generateURLSlug(), getCustomControllerName(), getDescription(), getDirtyObjects(), getEndTime(), getFirstJob(), getKeywords(), getLastJob(), getMAXDuration(), getName(), getNewObjects(), getNextJob(), getPreviousJob(), getRecord(), getRequest(), getStartTime(), getStatusMessage(), getTitle(), getUnitDuration(), getVisibility(), loadControllerDef(), markDirty(), markNew(), process(), setDescription(), setKeywords(), setName(), setRecord(), setRequest(), setStatusMessage(), setTitle(), setUnitEndTime(), setUnitMAXDuration(), setUnitOfWork(), setUnitStartTime(), setVisibility()

Properties summary
`protected integer`	`$startPoint`		# The start number for list pageination. The start number for list pageination. Since 1.0
`protected integer`	`$resultCount`	`0`	# The result count from the search. The result count from the search. Since 1.0
`protected string`	`$query`		# The search query supplied. The search query supplied. Since 1.0

Properties inherited from Alpha\Controller\Controller
`$description, $dirtyObjects, $firstJob, $keywords, $lastJob, $name, $newObjects, $nextJob, $previousJob, $record, $request, $statusMessage, $title, $unitEndTime, $unitMAXDuration, $unitOfWork, $unitStartTime, $visibility`

Namespaces

Classes

Interfaces

Class SearchController

Parameters

Since

Overrides

Parameters

Returns

Throws

Since

Overrides

Implementation of

Parameters

Returns

Since

Returns

Since

Overrides

Returns

Since

Returns

Since

Returns

Since

Parameters

Since

Returns

Since

Parameters

Since

Since

Since

Since