ResultsDraw Class Reference

Inheritance diagram for ResultsDraw:
Draw FavoritesDraw ObjectResultsDraw

Static Public Member Functions

Static Protected Member Functions


Detailed Description

Definition at line 19 of file ResultsDraw.class.php.


Member Function Documentation

static ResultsDraw::facetsAsUL ( term_cutoff = 0  )  [static]

Returns an HTML unordered list of facets.

The outer <ul> element has class dmFacetList; the inner <ul> elements have class dmFacet; the facet term <li> elements have class dmFacetTerm; and the facet term count <span> elements have class dmFacetTermCount. If no facets are available, returns null.

Parameters:
int term_cutoff Omit any more than this number of terms within a facet; 0 = disable
Returns:
string

Definition at line 35 of file ResultsDraw.class.php.

static ResultsDraw::linkedSuggestion ( dmQuery q  )  [static]

Returns a search suggestion (e.g.

"Did you mean...") hyperlinked to a search for that suggestion.

Parameters:
dmQuery q
Returns:
string|null
Since:
0.5

Definition at line 113 of file ResultsDraw.class.php.

static ResultsDraw::numResults (  )  [static]

Equivalent to calling dmQuery::getCurrent()->getNumResults().

Returns:
int
Since:
0.1

Definition at line 129 of file ResultsDraw.class.php.

static ResultsDraw::pageLinks ( max_page_links = 10,
page_list_separator = ' ',
current_page_element = 'strong',
first_symbol = '<<', $prev_symbol = '<', $next_symbol = '>', $last_symbol = '>>' 
) [static]
Parameters:
int max_page_links The maximum number of links (not numbers) allowed
string page_list_separator A string that should separate the page links
string current_page_element The name of the HTML element that should wrap the current page number (without angle brackets)
string first_symbol
string prev_symbol
string next_symbol
string last_symbol
Returns:
string
Since:
0.1

Definition at line 147 of file ResultsDraw.class.php.

static ResultsDraw::results (  )  [static]

Returns an HTML table element corresponding to the requested results view, specified by the "view" query string parameter.

If not present, defaults to grid view. To enable this method to work with views other than the default, overload it in an extension and alter the switch cases.

Returns:
string
See also:
ResultsDraw::viewLinks()

Reimplemented in ObjectResultsDraw.

Definition at line 283 of file ResultsDraw.class.php.

static ResultsDraw::resultsAsGrid ( thumbs = true  )  [static]
Parameters:
Boolean thumbs Whether to include thumbnails in the table
Since:
0.1

Definition at line 302 of file ResultsDraw.class.php.

Referenced by results().

static ResultsDraw::resultsAsList ( thumbs = true  )  [static]
Parameters:
Boolean thumbs Whether to include thumbnails in the table
Since:
0.1

Definition at line 422 of file ResultsDraw.class.php.

Referenced by results().

static ResultsDraw::resultsAsTiles ( thumbs = true  )  [static]
Parameters:
Boolean thumbs Whether to include thumbnails in the table
Since:
0.1

Definition at line 544 of file ResultsDraw.class.php.

Referenced by results().

static ResultsDraw::searchTerms (  )  [static]
Returns:
Comma-separated, HTML-escaped list of search terms
Since:
0.1

Definition at line 636 of file ResultsDraw.class.php.

static ResultsDraw::sortLinksAsUL ( current_sort_tag = 'strong'  )  [static]

Returns null if fewer than two fields are sortable.

Parameters:
string current_sort_tag HTML tag without the angle brackets
Returns:
string
Since:
0.4

Definition at line 677 of file ResultsDraw.class.php.

static ResultsDraw::thumbsToggleLink (  )  [static]
Returns:
HTML anchor tag
Since:
0.1

Definition at line 735 of file ResultsDraw.class.php.

static ResultsDraw::viewLinks ( separator = ' | ',
array $  views = array() 
) [static]

Renders the view toggle links that allow selection of different results view styles.

Built-in views include grid, list, and tile. It is possible to override this by overloading ResultsDraw::results() in an extension.

Parameters:
string separator
array views Array of arrays with 'name' and 'url' keys corresponding to the name of the view and the URL query string value ("?view=X") respectively (see $views as defined in the method)
Returns:
string
Since:
0.1

Definition at line 760 of file ResultsDraw.class.php.


The documentation for this class was generated from the following file:

Generated on Fri Aug 20 13:16:50 2010 for dmBridge PHP API by  doxygen 1.6.1