KWeb  6.4
KWebSearch_Result Class Reference

Objects (KWebObject) read from another data source. More...

Inheritance diagram for KWebSearch_Result:
Collection_Filtered Filter_IFilter Collection_Outer Collection

Public Member Functions

 __construct (Collection $collection, array $options=array())
 matchFilter ($object, $key=null, $iterator=null, array $options=array())
 Returns true if data has passed the filter.
 getObjectsCollection ()
 getIndexCollection ()
 getScore ()
 getIndexField ($field, $default=null)
 getIndexFields ()
 getObject ()

Data Fields

 $objectFilters = array()
 filters for founds object
 $dataFilters = array()
 filters for found meta data
 $onlyObjects = false
 only objects are allowed in the result

Detailed Description

Objects (KWebObject) read from another data source.


Constructor & Destructor Documentation

KWebSearch_Result::__construct ( Collection collection,
array $  options = array() 
)
Parameters:
$dataSource of the data
$objectGenreOrFieldObjects genre, or data field containing the genre prefixed with '.'
$objectIdFieldData field containing the object id or name

Reimplemented from Collection_Outer.


Member Function Documentation

KWebSearch_Result::getIndexCollection ( )
Returns:
Collection
KWebSearch_Result::getIndexField ( field,
default = null 
)
KWebSearch_Result::getIndexFields ( )
KWebSearch_Result::getObject ( )
Returns:
KWebObject
KWebSearch_Result::getObjectsCollection ( )
KWebSearch_Result::getScore ( )
KWebSearch_Result::matchFilter ( data,
key = null,
iterator = null,
array $  options = array() 
)

Returns true if data has passed the filter.

Returns:
boolean

Implements Filter_IFilter.


Field Documentation

KWebSearch_Result::$dataFilters = array()

filters for found meta data

KWebSearch_Result::$objectFilters = array()

filters for founds object

KWebSearch_Result::$onlyObjects = false

only objects are allowed in the result


The documentation for this class was generated from the following file: