Find

Return to documentation ↩

public $admin
public $cache
public $ids
public $ids_after
public $ids_before
public $count = 0
public $count_result = 0
public $offset_length
public $order
public $finds
public $first
public $first_reverse
public $last
public $last_modified
public $last_reverse
public $page
public $page_begin
public $page_count
public $page_limit
public $page_limit_current
public $page_limit_first
public $page_next
public $page_next_uri
public $page_previous
public $page_previous_uri
public $sets
public $table
public $table_id
public $table_prefix
public $tags
public $with
public $query
private $call
protected $sql
protected $sql_conds
protected $sql_limit
protected $sql_sorts
protected $sql_from
protected $sql_tables
protected $sql_join
protected $sql_join_type
protected $sql_join_tables
protected $sql_join_on
protected $sql_group_by
protected $sql_having
protected $sql_having_fields
protected $sql_params
protected $sql_order_by
protected $sql_where
public __construct($table=null, $ids=null, $auto_guest=true, $process_request=true, $ignore_deleted=true)
Initiates Find class
string Table to perform search
string $ids Limit results to select IDs in table
bool $auto_guest Set guest access restrictions
bool $process_request Automatically employ the $_REQUEST array to issue methods (for searches)
bool $ignore_deleted Ignore "deleted" table rows (except in recovery mode)
public __destruct()
Terminates object, closes the database connection
return void
public __call($method, $arguments)
Save methods (by appending an underscore to the method name) to memory for saving methods to sets, saved searches, etc.
string $method Method name
array $arguments Method arguments
return mixed
public __get($name)
Retrieve page numbers on demand
$name page_::_uri
public __toString()
Translate $this->ids array to comma-separated string
return string Comma-separated IDs
public hook($orbit=null)
Perform Orbit hook
Orbit $orbit
return void
public taken($begin=null, $end=null)
Find by date taken
string $begin Date begin
string $end Date end
return bool True if successful
public modified($begin=null, $end=null)
Find by date modified
string $begin Date begin
string $end Date end
return bool True if successful
public published($begin=true, $end=null)
Find by date published or publish status
string $begin Date begin or publish status
string $end Date end
return bool True if successful
public created($begin=null, $end=null)
Find by date created
string $begin Date begin
string $end Date end
return bool True if successful
public uploaded($begin=null, $end=null)
Find by date uploaded
string $begin Date begin
string $end Date end
return bool True if successful
public views($min=null, $max=null)
Find by number of views
string $min Minimum views
string $max Maximum views
return bool True if successful
public tags($tags=null)
Find by tag search
string $tags Tag search, can include boolean operators
return bool True if successful
public anyTags($tags=null, $count=1)
Find by string|int|array joined by OR
string $tags Tags to search for
string $count Minimum number of tags to find
return bool True if successful
public allTags($tags=null)
Find by tags joined by AND
string $tags Tags to search for
return bool True if successful
public notTags($tags=null)
Find by tags joined by NOT
string $tags Tags to search for
return bool True if successful
public sets($set=null)
Find by set
int $set Set ID or set title
return void
public response($response=true)
Find by whether response or not
bool $response Is a response
return bool True if successful
public title($title)
Find by title URL
bool $title Title
return bool True if successful
public memory($call=null)
Recall memory
array $call set_call field, else uses recent memory
return bool True if successful
public rights($right=null)
Find by rights set
int $right Right ID or right title
return void
public user($users=null)
Find by user (who uploaded or created the item)
int $users User IDs
return bool True if successful
public category($categories=null)
Find by categories
string $categories Categories
return bool True if successful
public search($search=null, $fields=null)
Find by search Images: image title, image description, image geography, and image tags Posts: post title, post text Comments: comment text, comment author name, comment author URI, comment author email, comment author IP
string $search Search query
string $fields Required for tables not built into Alkaline (or for overriding built-in search parameters)
return bool True if successful
public hide($search=null, $fields=null)
Find by negative search Images: image title, image description, image geography, and image tags Posts: post title, post text Comments: comment text, comment author name, comment author URI, comment author email, comment author IP
string $search Search query
string $fields Required for tables not built into Alkaline (or for overriding built-in search parameters)
return bool True if successful
public privacy($privacy=null, $all=true, $auto_guest=true)
Find by privacy levels
int $privacy Privacy ID or string
string $all Also include all images of lower privacy levels
bool $auto_guest Automatically handle guest privacy
return bool True if successful
public hsl($h_min, $h_max, $s_min, $s_max, $l_min, $l_max)
Find by color (HSL)
string $h_min
string $h_max
string $s_min
string $s_max
string $l_min
string $l_max
return bool True if successful
public ratio($min=null, $max=null, $equal=null)
Find by image ratio (width/height)
string $min Minimum ratio (0)
string $max Maximum ratio (infinite)
string $equal Search for precise ratio (1 = square)
return bool True if successful
public pages($id=null)
Find by pages
int $id Page IDs
return bool True if successful
public posts($post_ids=null)
Find by post association
int $id Posts IDs
return bool True if successful
public image($image_ids=null)
Find by image association
int $image_ids Image IDs
return bool True if successful
public ids($ids=null)
Find by ID numbers
int $image_ids IDs
return bool True if successful
public status($status=null)
Find by comment status
int $status Comment status
return bool True if successful
public exifs($value, $name=null)
Find by EXIF value
string $value EXIF value
string $name EXIF name (key)
return bool True if successful
public guest($id=null)
Find by guest simulation
int $id Guest ID
return bool True if successful
public with($id)
Locate page that contains a particular ID
int $id ID
return bool True if successful
public page($page=null, $limit=null, $first=null)
Paginate results
int $page Page number
int $limit Number of items per page
int $first Number of items on the first page (if different)
return bool True if successful
public offset($length)
Set number of offset items (items that appear just before and after the requested page)
int $length Number of items
return bool True if successful
public location($geo='', $radius=50)
Find by location
string $geo City name or latitude, longitude
string $radius Search radius (in miles)
return bool True if successful
public sort($column, $sort='ASC')
Sort results by table column
string $column Table column
string $sort Sort order (ASC or DESC)
return bool True if successful
public notnull($field)
Find by table fields not null
string $field Table field
return bool True if successful
public null($field)
Find by table fields null
string $field Table field
return bool True if successful
public find()
Execute Find class to determine class variables
return array Result IDs
public saveMemory()
Save memory (after executing)
return bool True if successful
public recentMemory()
Execute recent memory
return string|false
protected smart($kind)
Smart searches, use GET[id] values where necessary
string $kind Untagged, unpublished, displayed, modified, nonpublic, untitled, views, tags, guests, sets, me, users, rights, pages
return bool True if successful
protected special($kind)
Special searches
string $kind Unpublished, untitled, uncategorized
return void
static clearMemory()
Clear the memory
return void