Docs For Class plugin_default

YANA Framework for PHP

Docs For Class plugin_default_library

Class plugin_default_library

Description

Default library for common functions

This plugin is important. It provides functionality that might be usefull for other plugins.

access: public

Plugin
   |
   --plugin_default_library

Method Summary

bool chkembtags (array $ARGS)
bool clear_server_cache (array $ARGS)
bool get_microsummary (array $ARGS)
bool graphic_counter (array $ARGS)
bool preview (array $ARGS)
bool security_check_image (array $ARGS)
bool security_get_image (array $ARGS)
bool sitemap (array $ARGS)
string _sitemap (array $params, Smarty &$smarty)

Methods

check for correct syntax of embedded tags in all textarea fields

bool chkembtags (

array $ARGS

)

List of parameters:

Name	Type	Description
$ARGS	array	array of params passed to the function

Description:

Note: this function ends the program

parameters taken:

array text text to be checked

This functions produces a XML output, containing an array, where index "error" contains an error number and index "text" contains a description.

If no error is found, the result is empty.

List of error codes:

0 = no error
1 = unexpected start tag
2 = unknown or unhandled tag
3 = unexpected end tag
4 = missing an expected tag
5 = missing end tag
6 = unexpected line break

access: public

clear server's template-cache

bool clear_server_cache (

array $ARGS

)

List of parameters:

Name	Type	Description
$ARGS	array	array of params passed to the function

Description:

this function does not expect any arguments

access: public

create a microsummary for a page

bool get_microsummary (

array $ARGS

)

List of parameters:

Name	Type	Description
$ARGS	array	array of params passed to the function

Description:

Technical notes:

parameters taken:

string id identifies summary to get

Note: this function terminates program execution.

Semantic description:

"Microsummaries" are a Firefox 2.0 feature that allows users to create dynamic bookmark titles that automatically updates when the content of the bookmarked page changes.

Have a look at what microsummaries can be:

the numbers of downloads of a file on a download site
the latest news on a news page
current number of unread e-mail in the inbox of a webmail service
current total of donations to a project
the date of latest updates on a database
the latest submission to a guestbook or forum
the number of visitors currently online in a chat room
the latest stock values aso.

Examples of usage:

Setting a microsummary from a plugin:
1. Microsummary::set($this->name, 'Summary text');
Retrieving a microsummary in a plugin:
1. $microsummary = Microsummary::get($this->name);
To indicate that a microsummary exists for your plugin add this as the last line in your plugin constructor
1. Microsummary::publish($this->name);
Calling a microsummary from a browser:
1. index.php?action=get_microsummary&target=guestbook
(where 'guestbook' is the name of the plugin)

access: public

Create graphical visitor counter

bool graphic_counter (

array $ARGS

)

List of parameters:

Name	Type	Description
$ARGS	array	array of params passed to the function

Description:

Note: This function ends the program.

parameters taken:

string id
string target

access: public

create preview message

bool preview (

array $ARGS

)

List of parameters:

Name	Type	Description
$ARGS	array	array of params passed to the function

Description:

Note: this function ends the program

parameters taken:

string eintraege text to be previewed

access: public

test if a string matches the corresponding CAPTCHA

bool security_check_image (

array $ARGS

)

List of parameters:

Name	Type	Description
$ARGS	array	array of params passed to the function

Description:

parameters taken:

int security_image_index index of image to display
string security_image text to compare with CAPTCHA

access: public

create CAPTCHA-image

bool security_get_image (

array $ARGS

)

List of parameters:

Name	Type	Description
$ARGS	array	array of params passed to the function

Description:

parameters taken:

int security_image_index index of image to display

access: public

Show Sitemap

bool sitemap (

array $ARGS

)

List of parameters:

Name	Type	Description
$ARGS	array	array of params passed to the function

Description:

this function does not expect any arguments

access: public

«smarty function» sitemap

string _sitemap (

array $params, Smarty &$smarty

)

List of parameters:

Name	Type	Description
$params	array
&$smarty	Smarty

Description:

access: public

inherited from base classes

Inherited From Plugin

Documentation generated on Sat, 03 Jan 2009 22:22:40 +0100 by phpDocumentor 1.4.0

yana author: Thomas Meyer Homepage: www.yanaframework.net