This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Controller_Block_Search

Displays a search prompt and results.

Concrete5_Library_Controller
Extended by Controller
Extended by Concrete5_Library_BlockController
Extended by BlockController
Extended by Concrete5_Controller_Block_Search

Direct known subclasses

SearchBlockController

Package: Blocks\Search
Copyright: Copyright (c) 2003-2012 Concrete5. (http://www.concrete5.org)
License: MIT License
Author: Andrew Embler andrew@concrete5.org
Located at core/controllers/blocks/search.php

Methods summary

public
# highlightedMarkup( $fulltext, $highlight )
public
public
# highlightedExtendedMarkup( $fulltext, $highlight )
public
# setHighlightColor( $color )
public string
# getBlockTypeDescription( )

Used for localization. If we want to localize the name/description we have to include this

public string
# getBlockTypeName( )

Returns the name of the block type

public
# getJavaScriptStrings( )

Returns a key/value array of strings that is used to translate items when used in javascript

public
# __construct( BlockType $obj = null )

Instantiates the block controller.

public
public
# view( )
public
# save( array $data )

Run when a block is added or edited. Automatically saves block data against the block's database table. If a block needs to do more than this (save to multiple tables, upload files, etc... it should override this.

Properties summary

protected string $btTable
# 'btSearch'
protected string $btInterfaceWidth
# "400"
protected string $btInterfaceHeight
# "240"
protected string $btWrapperClass
# 'ccm-ui'
public string $title
# ""
public string $buttonText
# ">"
public string $baseSearchPath
# ""
public string $resultsURL
# ""
public string $postTo_cID
# ""
protected string $hColor
# '#EFE795'
public array $reservedParams
# array('page=','query=','search_paths[]=','submit=','search_paths%5B%5D=' )