Class cfSearchHelper

cfSearchHelper Class

Base class for helper object used by search modules to access data within other modules.

Direct known subclasses

contentSearchHelper

Abstract
Package: clearFusionCMS
Copyright: Copyright (c) 2012 - 2013 clearFusionCMS. All rights reserved.
Located at system/app/cfSearchHelper.php

Methods summary

`public`	# `__construct( flDb $db )` Create the helper object. Create the helper object. Parameters `$db` The database object.
`abstract public`	# `getContentCount( )` Get the number of content items. Get the number of content items.
`abstract public`	# `reindex( integer $start, integer $items )` Reindex the block of items. Reindex the block of items. Parameters `$start` The index to start working from. `$items` The number of items to index.
`abstract public array`	# `getSearchSummary( string $id, string $order = null, integer $words = 30 )` Get the search summary for the given search path. Get the search summary for the given search path. Parameters `$id` The ID of the element to get a summary of. `$order` The order to use data to generate the summary or null for the default. `$words` The number of words to return in the summary. Returns array The summary data.
`abstract public string`	# `getURI( string $id, boolean $absolute = true )` Get the URI of the page holding the content. Get the URI of the page holding the content. Parameters `$id` The ID of the element to get the page URI of. `$absolute` true if an absolute URI should be returned; else false for a relative URI. Returns string The URI of the page or false if not found.
`public static cfSearchHelper`	# `getHelper( string $module )` Get the search helper for a module. Get the search helper for a module. Parameters `$module` The name of the module to get the search helper for. Returns `cfSearchHelper` The helper object or null if not found.

Properties summary

`protected flDb`	`$db` The database object. The database object.	#

Packages

Classes

Interfaces

Exceptions

Class cfSearchHelper

Direct known subclasses

Methods summary

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Properties summary