CWIS Developer Documentation
|
Public Member Functions | |
__construct ($SearchId, $SearchName=NULL, $UserId=NULL, $Frequency=NULL, $SearchParameters=NULL) | |
Object constructor. More... | |
SearchGroups ($NewSearchGroups=NULL) | |
Get/set search parameters from legacy array. More... | |
SearchParameters ($NewParams=NULL) | |
Get/set search parameters. More... | |
SearchName ($NewValue=DB_NOVALUE) | |
Get/set name of search. More... | |
Id () | |
Get ID of search. More... | |
UserId ($NewValue=DB_NOVALUE) | |
Get/set user ID. More... | |
Frequency ($NewValue=DB_NOVALUE) | |
Get/set search frequency. More... | |
UpdateDateLastRun () | |
Update date this search was last run. More... | |
DateLastRun ($NewValue=DB_NOVALUE) | |
Get/set the date this search was last run. More... | |
SaveLastMatches ($ArrayofMatchingIds) | |
Save array of last matches. More... | |
LastMatches () | |
Return array of most recently matched ResourceIds for a search. More... | |
GetSearchGroupsAsUrlParameters () | |
Get search groups as URL parameters (e.g. More... | |
GetSearchGroupsAsUrlParameterArray () | |
Get search groups as an URL parameter array. More... | |
GetSearchGroupsAsTextDescription ($IncludeHtml=TRUE, $StartWithBreak=TRUE, $TruncateLongWordsTo=0) | |
Get multi-line string describing search criteria. More... | |
GetSearchFieldNames () | |
Get list of fields to be searched. More... | |
Delete () | |
Delete saved search. More... | |
GetSearchId () | |
Get search id. More... | |
Static Public Member Functions | |
static | TranslateSearchGroupsToUrlParameters ($SearchGroups) |
Translate search group array into URL parameters (e.g. More... | |
static | TranslateSearchGroupsToUrlParameterArray ($SearchGroups) |
Translate a search group array to an URL parameter array. More... | |
static | TranslateUrlParametersToSearchGroups ($GetVars) |
Translate URL parameters to legacy search group array. More... | |
static | TranslateSearchGroupsToTextDescription ($SearchGroups, $IncludeHtml=TRUE, $StartWithBreak=TRUE, $TruncateLongWordsTo=0) |
Translate search group array into multi-line string describing search criteria. More... | |
static | TranslateSearchGroupsToSearchFieldNames ($SearchGroups) |
Extract list of fields to be searched from search group array. More... | |
static | GetSearchFrequencyList () |
Get array of possible search frequency descriptions. More... | |
Public Attributes | |
const | SEARCHFREQ_NEVER = 0 |
const | SEARCHFREQ_HOURLY = 1 |
const | SEARCHFREQ_DAILY = 2 |
const | SEARCHFREQ_WEEKLY = 3 |
const | SEARCHFREQ_BIWEEKLY = 4 |
const | SEARCHFREQ_MONTHLY = 5 |
const | SEARCHFREQ_QUARTERLY = 6 |
const | SEARCHFREQ_YEARLY = 7 |
Definition at line 10 of file SavedSearch.php.
SavedSearch::__construct | ( | $SearchId, | |
$SearchName = NULL , |
|||
$UserId = NULL , |
|||
$Frequency = NULL , |
|||
$SearchParameters = NULL |
|||
) |
Object constructor.
int | null | $SearchId | Saved search ID or NULL for new search |
string | null | $SearchName | Updated search name (OPTIONAL) |
int | null | $UserId | User who owns this search (OPTIONAL) |
int | null | $Frequency | Search mailing frequency (OPTIONAL) |
mixed | $SearchParameters | SearchParameterSet describing this search (OPTIONAL) |
Definition at line 34 of file SavedSearch.php.
References Frequency(), SearchName(), SearchParameters(), and UserId().
SavedSearch::DateLastRun | ( | $NewValue = DB_NOVALUE | ) |
Get/set the date this search was last run.
mixed | $NewValue | Updated value (OPTIONAL |
Definition at line 216 of file SavedSearch.php.
SavedSearch::Delete | ( | ) |
Delete saved search.
(NOTE: Object is no longer usable after this call!)
Definition at line 793 of file SavedSearch.php.
References MetadataSchema\MDFTYPE_FLAG, MetadataSchema\MDFTYPE_NUMBER, MetadataSchema\MDFTYPE_OPTION, and MetadataSchema\MDFTYPE_USER.
SavedSearch::Frequency | ( | $NewValue = DB_NOVALUE | ) |
Get/set search frequency.
int | $NewValue | New search frequency value. |
Definition at line 195 of file SavedSearch.php.
Referenced by __construct().
SavedSearch::GetSearchFieldNames | ( | ) |
Get list of fields to be searched.
Definition at line 729 of file SavedSearch.php.
References SearchParameters().
|
static |
Get array of possible search frequency descriptions.
Frequencies may be excluded from list by supplying them as arguments.
Definition at line 764 of file SavedSearch.php.
SavedSearch::GetSearchGroupsAsTextDescription | ( | $IncludeHtml = TRUE , |
|
$StartWithBreak = TRUE , |
|||
$TruncateLongWordsTo = 0 |
|||
) |
Get multi-line string describing search criteria.
bool | $IncludeHtml | Whether to include HTML tags for formatting. (OPTIONAL, defaults to TRUE) |
bool | $StartWithBreak | Whether to start string with BR tag. (OPTIONAL, defaults to TRUE) |
int | $TruncateLongWordsTo | Number of characters to truncate long words to (use 0 for no truncation). (OPTIONAL, defaults to 0) |
Definition at line 548 of file SavedSearch.php.
References SearchParameters().
SavedSearch::GetSearchGroupsAsUrlParameterArray | ( | ) |
Get search groups as an URL parameter array.
Definition at line 370 of file SavedSearch.php.
References SearchGroups().
SavedSearch::GetSearchGroupsAsUrlParameters | ( | ) |
Get search groups as URL parameters (e.g.
something like F2=madison&F4=american+history&G22=17-41).
Definition at line 246 of file SavedSearch.php.
References SearchGroups().
SavedSearch::GetSearchId | ( | ) |
Get search id.
Definition at line 1005 of file SavedSearch.php.
References Id(), SaveLastMatches(), SearchParameters(), and UserId().
SavedSearch::Id | ( | ) |
Get ID of search.
Definition at line 175 of file SavedSearch.php.
Referenced by GetSearchId().
SavedSearch::LastMatches | ( | ) |
Return array of most recently matched ResourceIds for a search.
Definition at line 235 of file SavedSearch.php.
SavedSearch::SaveLastMatches | ( | $ArrayofMatchingIds | ) |
Save array of last matches.
array | $ArrayofMatchingIds | Matching Ids for a current search. |
Definition at line 225 of file SavedSearch.php.
Referenced by GetSearchId().
SavedSearch::SearchGroups | ( | $NewSearchGroups = NULL | ) |
Get/set search parameters from legacy array.
This function is for backward compatibility only and should not be used in new code.
array | null | $NewSearchGroups | Updated legacy array |
Definition at line 119 of file SavedSearch.php.
References SearchParameters().
Referenced by GetSearchGroupsAsUrlParameterArray(), and GetSearchGroupsAsUrlParameters().
SavedSearch::SearchName | ( | $NewValue = DB_NOVALUE | ) |
Get/set name of search.
string | $NewValue | New name of search value. |
Definition at line 166 of file SavedSearch.php.
Referenced by __construct().
SavedSearch::SearchParameters | ( | $NewParams = NULL | ) |
Get/set search parameters.
SearchParameterSet | null | $NewParams | Updated search parameters |
Definition at line 137 of file SavedSearch.php.
Referenced by __construct(), GetSearchFieldNames(), GetSearchGroupsAsTextDescription(), GetSearchId(), and SearchGroups().
|
static |
Extract list of fields to be searched from search group array.
array | $SearchGroups | Search group array. |
Definition at line 739 of file SavedSearch.php.
|
static |
Translate search group array into multi-line string describing search criteria.
array | $SearchGroups | Search group array. |
bool | $IncludeHtml | Whether to include HTML tags for formatting. (OPTIONAL, defaults to TRUE) |
bool | $StartWithBreak | Whether to start string with BR tag. (OPTIONAL, defaults to TRUE) |
int | $TruncateLongWordsTo | Number of characters to truncate long words to (use 0 for no truncation). (OPTIONAL, defaults to 0) |
Definition at line 566 of file SavedSearch.php.
References SearchEngine\LOGIC_AND, and StdLib\NeatlyTruncateString().
|
static |
Translate a search group array to an URL parameter array.
array | $SearchGroups | Search group array to translate. |
Definition at line 381 of file SavedSearch.php.
References SearchEngine\LOGIC_AND.
|
static |
Translate search group array into URL parameters (e.g.
something like F2=madison&F4=american+history&G22=17-41). A search group array looks something like this:
where "23" and "25" are the field IDs and "Resource Type" and "Audience" are the corresponding field names.
array | $SearchGroups | Search group array. |
Definition at line 288 of file SavedSearch.php.
|
static |
Translate URL parameters to legacy search group array.
array | $GetVars | Get variables (as from $_GET) |
Definition at line 462 of file SavedSearch.php.
References SearchEngine\LOGIC_AND, and SearchEngine\LOGIC_OR.
SavedSearch::UpdateDateLastRun | ( | ) |
Update date this search was last run.
Definition at line 204 of file SavedSearch.php.
SavedSearch::UserId | ( | $NewValue = DB_NOVALUE | ) |
Get/set user ID.
int | $NewValue | New user ID value. |
Definition at line 185 of file SavedSearch.php.
Referenced by __construct(), and GetSearchId().
const SavedSearch::SEARCHFREQ_BIWEEKLY = 4 |
Definition at line 20 of file SavedSearch.php.
Referenced by SavedSearchFactory\GetSearchesDueToRun().
const SavedSearch::SEARCHFREQ_DAILY = 2 |
Definition at line 18 of file SavedSearch.php.
Referenced by SavedSearchFactory\GetSearchesDueToRun().
const SavedSearch::SEARCHFREQ_HOURLY = 1 |
Definition at line 17 of file SavedSearch.php.
Referenced by SavedSearchFactory\GetSearchesDueToRun().
const SavedSearch::SEARCHFREQ_MONTHLY = 5 |
Definition at line 21 of file SavedSearch.php.
Referenced by SavedSearchFactory\GetSearchesDueToRun().
const SavedSearch::SEARCHFREQ_NEVER = 0 |
Definition at line 16 of file SavedSearch.php.
const SavedSearch::SEARCHFREQ_QUARTERLY = 6 |
Definition at line 22 of file SavedSearch.php.
Referenced by SavedSearchFactory\GetSearchesDueToRun().
const SavedSearch::SEARCHFREQ_WEEKLY = 3 |
Definition at line 19 of file SavedSearch.php.
Referenced by SavedSearchFactory\GetSearchesDueToRun().
const SavedSearch::SEARCHFREQ_YEARLY = 7 |
Definition at line 23 of file SavedSearch.php.
Referenced by SavedSearchFactory\GetSearchesDueToRun().