Docs For Class WFDieselHit

Description

The WFDieselHit object represents a result row from a WFDieselSearch.

The itemsAtIndex() call will return an array of WFDieselHit objects.

The WFDieselHit object encapsulates the relavance score, custom loaded callback objects, and data loaded from the index columns directly.

Located in /framework/WFDieselpoint.php (line 695)

WFObject
   |
   --WFDieselHit

Variable Summary

object WFDieselHitDataObject $data

mixed $itemID

mixed $object

integer $relevanceScore

Method Summary

WFDieselHit __construct ( $itemID, [ $relevanceScore = NULL], [ $object = NULL])

void addData (string $key, mixed $value)

object WFDieselHitDataObject getData ()

mixed getDataForCol (string $col)

mixed itemID ()

mixed object ()

string relevancePercent ()

integer relevanceScore ()

void setObject (mixed $o)

Variables

object WFDieselHitDataObject $data (line 712)

var: - A KVC-compliant proxy object so we can bind to DP result data. Bindings like: object.description, object.pkId
access: protected

mixed $itemID (line 704)

var: The unique itemId of the hit.
access: protected

mixed $object (line 708)

var: The object var is a placeholder for callbacks to put "objects" that map to the itemID into the WFDieselHit.
access: protected

integer $relevanceScore (line 700)

var: The relevance of the hit, on a scale of 0-100.
access: protected

Methods

Constructor __construct (line 714)

WFDieselHit __construct ( $itemID, [ $relevanceScore = NULL], [ $object = NULL])

$itemID
$relevanceScore
$object

Redefinition of:

WFObject::__construct()

addData (line 730)

Add data to the hit object for the given key/value pair.

This is used to add data loaded from the dieselpoint index directly into a KVC-accesible format.

void addData (string $key, mixed $value)

string $key: Data column name
mixed $value: Data value

getData (line 740)

Get the WFDieselHitDataObject for this row.

object WFDieselHitDataObject getData ()

getDataForCol (line 751)

Get the value for a particular column.

return: Column value

mixed getDataForCol (string $col)

string $col: Column name

itemID (line 804)

Get the unique itemID for this hit.

return: THe unique id.

mixed itemID ()

object (line 773)

Get the custom object for this hit.

mixed object ()

relevancePercent (line 793)

Get the relevance score for this hit, in % format.

return: Score as percentage match (100% is highest possible)

string relevancePercent ()

relevanceScore (line 783)

Get the relevance score for this hit.

integer relevanceScore ()

setObject (line 763)

Set the custom object for this hit.

This will be set by the Propel dataloader or the custom dataloader.

void setObject (mixed $o)

mixed $o: The object represented by this hit.

Inherited Methods

Inherited From WFObject

WFObject::__construct()
WFObject::exposedProperties()
WFObject::getClass()
WFObject::keyPathToTargetAndKey()
WFObject::setValueForKey()
WFObject::setValueForKeyPath()
WFObject::setValuesForKeys()
WFObject::validatedSetValueForKey()
WFObject::validatedSetValueForKeyPath()
WFObject::validateObject()
WFObject::validateValueForKey()
WFObject::validateValueForKeyPath()
WFObject::valueForKey()
WFObject::valueForKeyPath()
WFObject::valueForStaticKey()
WFObject::valueForStaticKeyPath()
WFObject::valueForTargetAndKeyPath()
WFObject::valueForUndefinedKey()
WFObject::valueForUndefinedStaticKey()
WFObject::valuesForKeyPaths()
WFObject::valuesForKeys()
WFObject::_valueForStaticKey()
WFObject::__toString()