Wirebird Library

NAME

VERSION

SYNOPSIS

    use Wirebird;
    my $status = Wirebird->new($configfile, $sitename);
    ...

EXPORT

METHODS

new($configfile, $sitename)

site

    $wirebird->site($siteblock)

Change the active site within a multi-site config.

load_groupinfo

    $wirebird->load_groupinfo($forcereload);

Load the category/group/topic structure (

cats

    my $cats = $wirebird->cats();

Returns a reference to a list of names of the categories - including private ones, so use it cautiously.

groups

    my $groups = $wirebird->groups();

Returns a reference to a list of names of the groups - including private ones, so use it cautiously.

topics

    my $topics = $wirebird->topics( 'groupname' );

Given a group, returns a list of the topic names.

sanitize

    print $wirebird->sanitize($content);

Uses HTML::Scrubber and HTML::Truncate to clean up HTML fragments.

phrasebook

    my $stmt_count = $wirebird->phrasebook('filename');

Registers the phrases in a file, returning the count.

rawquery

    my $data = $wirebird->rawquery('queryname');

Returns the raw query string for a particular query tag.

requires

    if ($wirebird->requires('queryname', 'parm1') ) { ... }

Tests whether a particular query requires a given parameter.

query

    my $data = $wirebird->query('queryname', {
        parm1   => $parm1,
        parm2   => $parm2,
    });

Prepares and executes a non-SELECT query.

Really should return a more informative result.

queryfetch

    my $data = $self->queryfetch('queryname', {
        parm1   => $parm1,
        parm2   => $parm2,
    });

Prepares and executes a SELECT query. Returns an array of hashes containing the result.

FUNCTIONS

iscat($catname)

    if ( $wirebird->iscat('testcategory') ) { ... }

Tests a catname to see if it exists. Categories are defined by their existence in the wbf_groups table.

isgroup($groupname)

    if ( $wirebird->isgroup('testgroup') ) { ... }

Tests a groupname to see if it exists. Groups are defined by their existence in the wbf_groups table.

istopic($groupname, $topicname)

    if ( $wirebird->istopic('testgroup', 'testtopic') ) { ... }

Tests a topicname to see if it exists. Test requires a valid group.

ispage($groupname, $topicname, $pagename)

    if ( $wirebird->ispage('testgroup', 'testtopic', 'testpage') ) { ... }

Tests a pagename to see if it exists. Test requires a valid group and topic.

SEE ALSO

Wirebird has a Wirebird-based forum/blog/news site at <http://www.wirebird.com/>.

AUTHOR

    perldoc Wirebird