

[ class tree: classes ] [ index: classes ] [ all elements ]

Class: SearchEngine

Source Location: /class-search.php

Class SearchEngine

Class Overview

Located in /class-search.php [line 20]

Properties

Methods

[ Top ]

Property Summary

mixed	$albums
mixed	$dates
mixed	$dynalbumname
mixed	$fields
mixed	$images
mixed	$page
mixed	$words

[ Top ]

Method Summary

SearchEngine	SearchEngine()	Constuctor
int	getAlbumIndex()	Returns the index of the album within the search albums
array	getAlbums()	Returns an array of album names found in the search.
object	getImage()	Returns a specific image
int	getImageIndex()	Returns the index of this image in the search images
array	getImages()	Returns an array of images found in the search It will return a "page's worth" if $page is non zero
object	getNextAlbum()	Returns the album following the current one
int	getNumAlbums()	Returns the number of albums found in a search
int	getNumImages()	Returns the number of images found in the search
object	getPrevAlbum()	Returns the album preceding the current one
array	getSearchAlbums()	Returns an array of albums found in the search
string	getSearchDate()	Returns the search dates variable
bit	getSearchFields()	Returns the search fields variable
array	getSearchImages()	Returns an array of image names found in the search
string	getSearchParams()	creates a search query from the search words
string	getSearchSQL()	returns the sql string for a search
array	getSearchString()	Parses a search string Items within quotations are treated as atomic
string	getSearchWords()	Returns the search words variable
int	parseQueryFields()	Returns the set of fields from the url query/post
array	searchTags()	Searches the table for tags Returns an array of database records.
void	setSearchParams()	Parses and stores a search string

[ Top ]

Properties

mixed $albums [line 27]

[ Top ]

mixed $dates [line 23]

[ Top ]

mixed $dynalbumname [line 28]

[ Top ]

mixed $fields [line 24]

[ Top ]

mixed $images [line 26]

[ Top ]

mixed $page [line 25]

[ Top ]

mixed $words [line 22]

[ Top ]

Methods

Constructor SearchEngine [line 35]

SearchEngine SearchEngine(
)

Constuctor

[ Top ]

getAlbumIndex [line 639]

int getAlbumIndex(
string
$curalbum 
)

Returns the index of the album within the search albums

Parameters:

string

$curalbum:

The album sought

[ Top ]

getAlbums [line 621]

array getAlbums(
[int
$page = 0] 
)

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

[ Top ]

getImage [line 793]

object getImage(
int
$index 
)

Returns a specific image

Parameters:

int

$index:

the index of the image desired

[ Top ]

getImageIndex [line 773]

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

[ Top ]

getImages [line 741]

array getImages(
[int
$page = 0], [int
$firstPageCount = 0] 
)

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

[ Top ]

getNextAlbum [line 650]

object getNextAlbum(
string
$curalbum 
)

Returns the album following the current one

Parameters:

string

$curalbum:

the name of the current album

[ Top ]

getNumAlbums [line 206]

int getNumAlbums(
)

Returns the number of albums found in a search

[ Top ]

getNumImages [line 682]

int getNumImages(
)

Returns the number of images found in the search

[ Top ]

getPrevAlbum [line 666]

object getPrevAlbum(
string
$curalbum 
)

Returns the album preceding the current one

Parameters:

string

$curalbum:

the name of the current album

[ Top ]

getSearchAlbums [line 576]

array getSearchAlbums(
)

Returns an array of albums found in the search

[ Top ]

getSearchDate [line 118]

string getSearchDate(
)

Returns the search dates variable

[ Top ]

getSearchFields [line 127]

bit getSearchFields(
)

Returns the search fields variable

[ Top ]

getSearchImages [line 694]

array getSearchImages(
)

Returns an array of image names found in the search

[ Top ]

getSearchParams [line 56]

string getSearchParams(
)

creates a search query from the search words

[ Top ]

getSearchSQL [line 248]

string getSearchSQL(
string
$searchstring, string
$searchdate, string
$tbl, int
$fields 
)

returns the sql string for a search

Parameters:

string	$searchstring:	the search target
string	$searchdate:	the date target
string	$tbl:	the database table to search
int	$fields:	which fields to perform the search on

Information Tags:

Since:

1.1.3

[ Top ]

getSearchString [line 139]

array getSearchString(
)

Parses a search string Items within quotations are treated as atomic

Returns an array of search elements

[ Top ]

getSearchWords [line 109]

string getSearchWords(
)

Returns the search words variable

[ Top ]

parseQueryFields [line 218]

int parseQueryFields(
)

Returns the set of fields from the url query/post

Information Tags:

Since:

1.1.3

[ Top ]

searchTags [line 396]

array searchTags(
string
$searchstring, string
$tbl, array
$idlist 
)

Searches the table for tags Returns an array of database records.

Parameters:

string	$searchstring:
string	$tbl:	set to 'albums' or 'images'
array	$idlist:	list of ids seeding the search from the other fields

[ Top ]

setSearchParams [line 78]

void setSearchParams(
string
$paramstr 
)

Parses and stores a search string

Parameters:

string

$paramstr:

the string containing the search words

[ Top ]

classes

Packages:

zenphoto
classes
core
functions
plugins

Files:

class-album.php
class-gallery.php
class-image.php
class-search.php
class-transientimage.php
class-video.php

Classes:

Album
Gallery
Image
SearchEngine
Transientimage
Video

Documentation generated on Tue, 30 Sep 2008 20:23:17 +0200 by phpDocumentor 1.4.1

ZenPhoto

Class: SearchEngine

Class SearchEngine