Inherited Variables
Inherited Constants
Inherited Methods
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__get()
- VObject::__isset()
- VObject::__set()
- VObject::__toString()
- Return object as a string
- VObject::__unset()
Class Details
VWP Search Library
This class provides search support.
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch 2011 - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
static $default_max_new_age = 1209600
[line 152]
Max New Age
Tags:
- var - Max new age
- access - protected
Type: integer
Overrides:
[ Top ]
static $max_description_length = 155
[line 131]
Max Description Length
Tags:
- var - Length
- access - protected
Type: integer
Overrides:
[ Top ]
static $max_results = 1000
[line 142]
Max Results
Tags:
- var - Max results
- access - protected
Type: integer
Overrides:
[ Top ]
static $max_title_length = 70
[line 111]
Max Title Length
Tags:
- var - Length
- access - protected
Type: integer
Overrides:
[ Top ]
static $max_url_length = 70
[line 121]
Max URL Length
Tags:
- var - Length
- access - protected
Type: integer
Overrides:
[ Top ]
$count
[line 101]
Result Count
Tags:
- var - Count
- access - protected
Type: integer
Overrides:
[ Top ]
$filters = array()
[line 66]
Filters
Tags:
- var - Filters
- access - protected
Type: array
Overrides:
[ Top ]
$location
[line 57]
Location
Tags:
- var - Location
- access - protected
Type: mixed
Overrides:
[ Top ]
$min_score = 0
[line 83]
Minimum score
Tags:
- var - Score
- access - protected
Type: float
Overrides:
[ Top ]
$options
[line 48]
Search Options
Tags:
- var - Options
- access - protected
Type: array
Overrides:
[ Top ]
$query
[line 39]
Search String
Tags:
- var - Query
- access - protected
Type: string
Overrides:
[ Top ]
$results
[line 75]
Results
Tags:
- var - Results
- access - protected
Type: array
Overrides:
[ Top ]
$scouts = array()
[line 92]
Scouts
Tags:
- var - Scouts
- access - protected
Type: array
Overrides:
[ Top ]
Class Methods
static query
static VSearch &query(
string
$query, array
$options, mixed
$location, [array
$filters = null])
[line 470]
Generate a search
Tags:
- return - Search
- access - public
Parameters:
- string $query - Search query
- array $options - Search options
- mixed $location - Reserved
- array $filters - Search filters
[ Top ]
__construct
VSearch __construct(
string
$query, array
$options, mixed
$location)
[line 662]
Class Constructor
Tags:
- access - public
Overrides VObject::__construct() (Class Constructor)
Parameters:
- string $query - Query
- array $options - Options
- mixed $location - Reserved
[ Top ]
addFilter
void addFilter(
object
$filter)
[line 195]
Add Filter
Tags:
- access - public
Parameters:
- object $filter - Search filter
[ Top ]
addResult
void addResult(
string
$sysKey, string
$url, string
$title, string
$description, string
$mime_type, float
$relevance, float
$popularity, float
$authority, float
$friendliness, integer
$age, object
$location)
[line 309]
Add Search Result
Tags:
- access - public
Parameters:
- string $sysKey - Reserved
- string $url - URL
- string $title - Title
- string $description - Description
- string $mime_type - Mime type
- float $relevance - Relevance 0 to 100
- float $popularity - Popularity -10 to 10
- float $authority - Authority -10 to 10
- float $friendliness - Friendliness -10 to 10
- integer $age - Age in seconds
- object $location - Location Reserved
[ Top ]
calculateDistance
mixed calculateDistance(
mixed
$l1, mixed
$l2)
[line 211]
Calculate Distance
Reserved for future use
Tags:
- return - distance
- access - public
Parameters:
- mixed $l1 - Location 1
- mixed $l2 - Location 2
[ Top ]
calculateScore
float calculateScore(
array
$result)
[line 239]
Calculate score
Tags:
- return - Score
- access - public
Parameters:
- array $result - Result
[ Top ]
fetch
void fetch(
)
[line 524]
Fetch
Tags:
- access - public
Parameters:
[ Top ]
get
void &get(
string
$vname, [mixed
$default = null])
[line 582]
Get Property
Tags:
- access - public
Overrides VObject::get() (Get value)
Parameters:
- string $vname - Property
- mixed $default - Default value
[ Top ]
getMaxDistance
mixed getMaxDistance(
)
[line 183]
Get Maximum Distance
Reserved for future use
Tags:
- return - Distance
- todo - Implement VSearch:getMaxDistance
- access - public
Parameters:
[ Top ]
getMaxNewAge
integer getMaxNewAge(
)
[line 223]
Get Maximum New Age
Tags:
- return - Age in seconds
- access - public
Parameters:
[ Top ]
getResults
array getResults(
)
[line 161]
Get Results
Tags:
- return - Results
- access - public
Parameters:
[ Top ]
getStringTokens
array getStringTokens(
)
[line 602]
Get String Tokens
Tags:
- return - Tokens
- access - public
Parameters:
[ Top ]
registerResource
void registerResource(
array
$callback, integer
$results)
[line 489]
Register Search Resource
Tags:
- access - public
Parameters:
- array $callback - Callback method
- integer $results - Number of results
[ Top ]
scan
void scan(
)
[line 510]
Scan
Tags:
- access - public
Parameters:
[ Top ]
set
mixed &set(
string
$vname, mixed
$value)
[line 554]
Set Property
Tags:
- return - Value
- access - public
Overrides VObject::set() (Set a value)
Parameters:
- string $vname - Property
- mixed $value - Value
[ Top ]