YANA 4 PHP Framework
Docs For Class Microsummary
«utility» Microsummary
This class provides static methods to read and write persistent microsummaries.
"Microsummaries" are a Firefox 2.0 feature that allows users to create dynamic bookmark titles that automatically update when the content of the bookmarked page changes.
Have a look at what microsummaries can be:
Examples of usage:
- index.php?action=get_microsummary&target=guestbook
Located in /plugins/default_library/class_microsummary.php
Utility | --Microsummary
Name | Type | Description |
---|---|---|
$id | string | identifies the summary to get |
Reads the microsummary string identified by $id and returns it. This function returns bool(false) if no corresponding summary exists.
Example of usage:
Retrieving a microsummary in a plugin:
Name | Type | Description |
---|---|---|
$id | string | identifies the summary to get |
Adds the microsummary identified by $id to the list of microsummaries to be printed to the browser.
Example of usage:
Add this to your output function
Name | Type | Description |
---|---|---|
$id | string | identifies the summary to get |
$text | string | the text of the microsummary |
Saves the microsummary string identified by $id for later use. This function returns bool(false) if the input is invalid or the entry could not be saved.
Example of usage:
Retrieving a microsummary in a plugin:
Inherited From Utility
Documentation generated on Sun, 11 Mar 2007 15:02:38 +0100 by phpDocumentor 1.3.1