CWIS Developer Documentation
Public Member Functions | Static Public Member Functions | List of all members
SPTRecommender Class Reference
Inheritance diagram for SPTRecommender:
Inheritance graph
[legend]
Collaboration diagram for SPTRecommender:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 SPTRecommender object constructor. More...
 
 GetFieldValue ($ItemId, $FieldName)
 Get value for a given field. More...
 
 QueueUpdateForItem ($ItemOrItemId, $TaskPriority=NULL)
 Queue a background update for a specified item. More...
 
- Public Member Functions inherited from Recommender
 __construct (&$DB, $ItemTableName, $RatingTableName, $ItemIdFieldName, $UserIdFieldName, $RatingFieldName, $ContentFields)
 
 DebugLevel ($Setting)
 
 Recommend ($UserId, $StartingResult=0, $NumberOfResults=10)
 
 AddResultFilterFunction ($FunctionName)
 
 NumberOfResults ()
 
 SearchTime ()
 
 GetSourceList ($UserId, $RecommendedItemId)
 
 FindSimilarItems ($ItemId, $FieldList=NULL)
 
 RecommendFieldValues ($ItemId, $FieldList=NULL)
 
 UpdateForItems ($StartingItemId, $NumberOfItems)
 
 UpdateForItem ($ItemId, $FullPass=FALSE)
 
 DropItem ($ItemId)
 
 PruneCorrelations ()
 
 GetItemIds ()
 Retrieve all item IDs. More...
 

Static Public Member Functions

static RunUpdateForItem ($SourceItemId, $StartingIndex)
 Perform recommender db updates for a specified item (usually in the background) More...
 
static SetUpdatePriority ($NewPriority)
 Set the default priority for background tasks. More...
 
- Static Public Member Functions inherited from Recommender
static ClearCaches ()
 Clear internal caches of item and correlation data. More...
 

Additional Inherited Members

- Public Attributes inherited from Recommender
const CONTENTFIELDTYPE_TEXT = 1
 
const CONTENTFIELDTYPE_NUMERIC = 2
 
const CONTENTFIELDTYPE_CONTROLLEDNAME = 3
 
const CONTENTFIELDTYPE_DATE = 4
 
const CONTENTFIELDTYPE_DATERAMGE = 5
 
- Protected Member Functions inherited from Recommender
 LoadItemIds ()
 
 GetFieldData ($ItemId, $FieldName)
 
 CalculateContentCorrelation ($ItemIdA, $ItemIdB, $FieldList=NULL)
 
 UpdateContentCorrelation ($ItemIdA, $ItemIdB)
 
 NormalizeAndParseText ($Text)
 
 CalcTextCorrelation ($WordsA, $WordsB)
 
 ContentCorrelation ($ItemIdA, $ItemIdB, $NewCorrelation=-1)
 
 FilterOnSuppliedFunctions ($Results)
 

Detailed Description

Definition at line 10 of file SPTRecommender.php.

Constructor & Destructor Documentation

SPTRecommender::__construct ( )

Member Function Documentation

SPTRecommender::GetFieldValue (   $ItemId,
  $FieldName 
)

Get value for a given field.

Parameters
int$ItemIdItem to retreive value from
string$FieldNameField name to retrieve
Returns
mixed Value for requested field

Definition at line 102 of file SPTRecommender.php.

SPTRecommender::QueueUpdateForItem (   $ItemOrItemId,
  $TaskPriority = NULL 
)

Queue a background update for a specified item.

Parameters
mixed$ItemOrItemIdItem or an int item id to update
mixed$TaskPriorityPriority to use for this task, if the default is not suitable

Definition at line 133 of file SPTRecommender.php.

static SPTRecommender::RunUpdateForItem (   $SourceItemId,
  $StartingIndex 
)
static

Perform recommender db updates for a specified item (usually in the background)

Parameters
int$SourceItemIdItemId for the source item in this update
int$StartingIndexStarting index of the destination items

Definition at line 164 of file SPTRecommender.php.

References Database\Caching(), and ApplicationFramework\PRIORITY_LOW.

static SPTRecommender::SetUpdatePriority (   $NewPriority)
static

Set the default priority for background tasks.

Parameters
mixed$NewPriorityNew task priority (one of ApplicationFramework::PRIORITY_*)

Definition at line 249 of file SPTRecommender.php.

References ApplicationFramework\PRIORITY_BACKGROUND.


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