static void compressedIDList(
array
$idlist
)
|
|
Takes a list of IDs and makes a where clause
Parameters:
|
array |
$idlist: |
list of IDs for a where clause |
API Tags:
Constuctor
Parameters:
|
bool |
$dynamic_album: |
set true for dynamic albums (limits the search fields) |
array allowedSearchFields(
)
|
|
Returns an array of the enabled search fields
string codifySearchString(
string
$quote
)
|
|
recodes the search words replacing the boolean operators with text versions
Parameters:
|
string |
$quote: |
how to represent quoted strings |
int getAlbumIndex(
string
$curalbum
)
|
|
Returns the index of the album within the search albums
Parameters:
|
string |
$curalbum: |
The album sought |
return the list of albums found
array getAlbums(
[int
$page = 0], [string
$sorttype = NULL], [string
$sortdirection = NULL], [bool
$care = true], [bool
$mine = NULL]
)
|
|
Returns an array of album names found in the search.
If $page is not zero, it returns the current page's albums
Parameters:
|
int |
$page: |
the page number we are on |
|
string |
$sorttype: |
what to sort on |
|
string |
$sortdirection: |
what direction |
|
bool |
$care: |
set to false if the order of the albums does not matter |
|
bool |
$mine: |
set true/false to override ownership |
array getArticles(
[int
$articles_per_page = 0], [bool
$published = NULL], [bool
$ignorepagination = false], [string
$sorttype = NULL], [string
$sortdirection = NULL]
)
|
|
Returns a list of News Titlelinks found in the search
Parameters:
|
int |
$articles_per_page: |
The number of articles to get |
|
bool |
$published: |
placeholder for consistent parameter list |
|
bool |
$ignorepagination: |
ignore pagination |
|
string |
$sorttype: |
field to sort on |
|
string |
$sortdirection: |
sort order |
void getCacheTag(
string
$table, string
$search, string
$sort
)
|
|
creates a unique id for a search
Parameters:
|
string |
$table: |
Database table |
|
string |
$search: |
Search string |
|
string |
$sort: |
Sort criteria |
API Tags:
return the list of categories found
object getImage(
int
$index
)
|
|
Returns a specific image
Parameters:
|
int |
$index: |
the index of the image desired |
int getImageIndex(
string
$album, string
$filename
)
|
|
Returns the index of this image in the search images
Parameters:
|
string |
$album: |
The folder name of the image |
|
string |
$filename: |
the filename of the image |
array getImages(
[int
$page = 0], [int
$firstPageCount = 0], [string
$sorttype = NULL], [string
$sortdirection = NULL], [bool
$care = true], [bool
$mine = NULL]
)
|
|
Returns an array of images found in the search It will return a "page's worth" if $page is non zero
Parameters:
|
int |
$page: |
the page number desired |
|
int |
$firstPageCount: |
count of images that go on the album/image transition page |
|
string |
$sorttype: |
what to sort on |
|
string |
$sortdirection: |
what direction |
|
bool |
$care: |
placeholder to make the getImages methods all the same. |
|
bool |
$mine: |
set true/false to overried ownership |
object getNextAlbum(
string
$curalbum
)
|
|
Returns the album following the current one
Parameters:
|
string |
$curalbum: |
the name of the current album |
Returns the number of albums found in a search
Returns the number of images found in the search
array getPages(
[bool
$published = NULL], [bool
$toplevel = false], [int
$number = NULL], [string
$sorttype = NULL], [strng
$sortdirection = NULL]
)
|
|
Returns pages from a search
Parameters:
|
bool |
$published: |
ignored, left for parameter compatibility |
|
bool |
$toplevel: |
ignored, left for parameter compatibility |
|
int |
$number: |
ignored, left for parameter compatibility |
|
string |
$sorttype: |
the sort key |
|
strng |
$sortdirection: |
the sort order |
object getPrevAlbum(
string
$curalbum
)
|
|
Returns the album preceding the current one
Parameters:
|
string |
$curalbum: |
the name of the current album |
Returns the search dates variable
Retrieves search extra parameters
array getSearchFieldList(
)
|
|
Returns a list of search fields display names indexed by the search mask
mixed getSearchFields(
[bool
$array = false]
)
|
|
Returns the search fields variable
Parameters:
|
bool |
$array: |
set to true to return the fields as array elements. Otherwise a comma delimited string is returned |
string getSearchFieldsText(
array
$fields, [string
$param = '&searchfields=']
)
|
|
Returns the "searchstring" element of a query parameter set
Parameters:
|
array |
$fields: |
the fields required |
|
string |
$param: |
the query parameter (possibly with the intro character |
string getSearchParams(
[bool
$long = true]
)
|
|
creates a search query from the search words
Parameters:
|
bool |
$long: |
set to false to omit albumname and page parts |
Parses a search string Items within quotations are treated as atomic AND, OR and NOT are converted to &, |, and !
Returns an array of search elements
Returns the search words variable
array numericFields(
bit
$fields
)
|
|
converts old style bitmask field spec into field list array
Parameters:
API Tags:
Returns the set of fields from the url query/post
Information Tags:
string searchDate(
string
$searchstring, string
$searchdate, string
$tbl, string
$sorttype, string
$sortdirection, [
$whichdate = 'date']
)
|
|
returns the results of a date search
Parameters:
|
string |
$searchstring: |
the search target |
|
string |
$searchdate: |
the date target |
|
string |
$tbl: |
the database table to search |
|
string |
$sorttype: |
what to sort on |
|
string |
$sortdirection: |
what direction |
|
|
$whichdate: |
|
Information Tags:
array searchFieldsAndTags(
array
$searchstring, string
$tbl, string
$sorttype, string
$sortdirection
)
|
|
Searches the table for tags Returns an array of database records.
Parameters:
|
array |
$searchstring: |
|
|
string |
$tbl: |
set DB table name to be searched |
|
string |
$sorttype: |
what to sort on |
|
string |
$sortdirection: |
what direction |
API Tags:
void setSearchExtra(
array
$extra
)
|
|
Stores extra search params for plugin use
Parameters:
void setSearchParams(
string
$paramstr
)
|
|
Parses and stores a search string NOTE!! this function assumes that the 'words' part of the list has been urlencoded!!!
Parameters:
|
string |
$paramstr: |
the string containing the search words |
void setSearchUnpublished(
)
|
|
void setSortDirection(
bool
$val, [string
$what = 'images']
)
|
|
sets sort directions
Parameters:
|
bool |
$val: |
the direction |
|
string |
$what: |
'images' if you want the image direction, 'albums' if you want it for the album |
void setSortType(
string
$sorttype, [string
$what = 'images']
)
|
|
Stores the sort type
Parameters:
|
string |
$sorttype: |
the sort type |
|
string |
$what: |
'images' or 'albums' |
array sortKey(
type
$sorttype, type
$sortdirection, type
$defaulttype, type
$table
)
|
|
get connical sort key and direction parameters.
Parameters:
|
type |
$sorttype: |
sort field desired |
|
type |
$sortdirection: |
DESC or ASC |
|
type |
$defaulttype: |
if no sort type otherwise selected use this one |
|
type |
$table: |
the database table being searched |
API Tags:
void subsetNewsCategories(
)
|
|
Returns an array of News article IDs belonging to the search categories
API Tags:
