ObjectDraw Class Reference

Inheritance diagram for ObjectDraw:
Draw

Static Public Member Functions


Detailed Description

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


Member Function Documentation

static ObjectDraw::addFavoriteButton (  )  [static]
Returns:
string HTML <span> element
Since:
0.1

Definition at line 25 of file ObjectDraw.class.php.

static ObjectDraw::childLinksAsList ( thumbs = false  )  [static]

Returns a hyperlinked ordered list of each of the pages of the current object wrapped in <li> elements.

The <li> element of the current page is of class dmCurrentPage, and the <ol> element itself is of class dmChildLinks.

For compound objects with more than a few pages, you may want to put this list inside of a div that has a fixed CSS height, and overflow set to 'auto,' which will cause it to appear with a scrollbar, like an iframe.

Parameters:
Boolean thumbs Whether or not to append thumbnails to the pages
Returns:
string (X)HTML ordered list element
See also:
ObjectDraw::childLinksAsPulldown()
Since:
0.1

We need to get the titles, thumbnail URLs, and record URLs of each of the children. Normally we would do this by looping through the object and calling these methods on each of the children. But since there may be hundreds of children, and since each child generates its own HTTP request to the API, that could get slow. So we are going to cheat and load all the data we need straight from the API.

Definition at line 71 of file ObjectDraw.class.php.

static ObjectDraw::childLinksAsPulldown (  )  [static]

Returns a complete HTML form with a pulldown menu consisting of each of the pages of the current object as <option> elements.

Note: This method requires that JavaScript be enabled in the browser. Using childLinksAsList() instead is preferred for usability.

Returns:
string XHTML form element
See also:
ObjectDraw::childLinksAsList()
Since:
0.1

Definition at line 136 of file ObjectDraw.class.php.

static ObjectDraw::commentsSection (  )  [static]

Draws the HTML for the comments section.

Returns:
string HTML form element with varying structure depending on whether the object has any comments.
Since:
0.1

Definition at line 176 of file ObjectDraw.class.php.

static ObjectDraw::compoundObjectPageNumbersInSearchResultsAsString ( separator = ',
 
) [static]
Parameters:
string separator
Returns:
string
Since:
0.1

Definition at line 311 of file ObjectDraw.class.php.

static ObjectDraw::compoundObjectSearchForm ( button_text = 'Search Object Text'  )  [static]
Parameters:
string button_text
Returns:
An HTML form for searching the compound object, or false if the object is not a compound object or if no object has been set in the controller.
Since:
0.1

Definition at line 276 of file ObjectDraw.class.php.

static ObjectDraw::compoundPageFlipLinks ( separator = ' | ',
prev_page_link = '< Previous Page', $next_page_link = 'Next Page >' 
) [static]

Provides navigation links between compound object pages.

Parameters:
string separator
string prev_page_link
string next_page_link
Returns:
string
Since:
0.1

Definition at line 340 of file ObjectDraw.class.php.

static ObjectDraw::highlightedFullText (  )  [static]

Outputs text with highlighted terms in <span> elements with class "dmHighlightedTerm".

Simply apply the CSS background-color property - or whatever other properties you like - to this class.

Returns:
string HTML-escaped string
Since:
0.1

Definition at line 386 of file ObjectDraw.class.php.

static ObjectDraw::metadataAsDL ( ctrld_term_separator = null,
link_ctrld_terms_to_view = null,
add_link_to_feed = true,
omit_title = false,
object = null,
hyperlink_urls = true 
) [static]

Returns object metadata in an HTML definition list, which is probably the most semantic way to mark it up using the HTML element set.

This list can be styled with CSS. Fields that are set as both searchable and controlled in CONTENTdm(R) are automatically hyperlinked to searches.

Parameters:
string ctrld_term_separator Character or character sequence that should separate controlled terms
[string|null|false] link_ctrld_terms_to_view One of 'grid', 'list', 'tile', null (use default view), or false (don't link them)
Boolean add_link_to_feed
Boolean omit_title Whether to omit the title field
dmObject An optional dmObject whose metadata to display. If null or not provided, the current dmObject's metadata is displayed.
hyperlink_urls Whether to add <a> tags around URLs in metadata
Returns:
string
Since:
0.1

Definition at line 415 of file ObjectDraw.class.php.

static ObjectDraw::metadataAsMetaTags (  )  [static]

Returns object metadata as HTML meta tags.

Returns:
string
Since:
0.3

Definition at line 508 of file ObjectDraw.class.php.

static ObjectDraw::previousNextLinks ( separator = ' | ',
prev_text = '< Previous', $results_text = 'Back To Results', $next_text = 'Next >' 
) [static]

Returns a set of HTML anchor elements separated by the $separator string.

Parameters:
string separator
string prev_text
string results_text
string next_text
Returns:
string
Since:
0.1

Definition at line 534 of file ObjectDraw.class.php.

static ObjectDraw::ratingsSection ( min,
max,
multiple_of,
decimal_places = 2 
) [static]
Parameters:
int min
int max
float multiple_of
int decimal_places Ratings will be rounded to this many decimal places for display
Returns:
string HTML form element
Since:
0.1

Definition at line 569 of file ObjectDraw.class.php.

static ObjectDraw::resultsAsUL ( thumbs = false,
max = 5 
) [static]

Returns an ordered list containing objects from the most recently viewed results list.

Parameters:
Boolean thumbs Whether or not to display object thumbnails
int max If larger than the number of results appearing on the last results view page, that number will be used instead
Returns:
string XHTML ordered list
Since:
0.3

Definition at line 634 of file ObjectDraw.class.php.

static ObjectDraw::taggingSection (  )  [static]
Returns:
string XHTML unordered list, or an HTML comment if a data store is not available
Since:
0.3

Definition at line 693 of file ObjectDraw.class.php.

static ObjectDraw::viewer ( width = null,
height = null 
) [static]
Parameters:
int width Width override (normally, width should be set in the Control Panel)
int height Height override (normally, height should be set in the Control Panel)
Since:
0.1

Definition at line 736 of file ObjectDraw.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