GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SPOON::BASE (3)

.ds Aq ’

NAME

Spoon::Base - Generic Spoon Base Class

CONTENTS

SYNOPSIS



    use Spoon::Base -Base;



DESCRIPTION

Base class for application plugins. Provides basic functionality to all modules inheriting from this class.

SUBROUTINES

These subroutines are meant to be called bare, not as an object-method call.

    trace

See Spoon::Trace::trace().

    conf(name, default)

Returns the configuration value for name, if it can be found in the config ($self->hub->config). Returns $default, otherwise.

METHODS

    hub

Return the application’s hub object. See Spoon::Hub.

    init

Inherited by all subclasses. Put your class initialization stuff here.

    assert(boolean)

Die if the supplied argument is false.

    t([label])

Calls Spoon::Trace::mark(). See Spoon::Trace.

    clone

Copies a class instance. The copy is only a shallow one.

    is_in_cgi

Returns a boolean, indicating whether we were called from a CGI interface.

    is_in_test

Returns a boolean, indicating whether we were called from a test suite.

    have_plugin(class_id)

Tries to load a plugin. See Spoon::Hub::load_class().

    plugin_directory

Returns your plugin’s directory. You can use this directory to store state.

    env_check(variable_name)

Sanity check: ensure the specified variable exists in %ENV. If the variable is not found, dies with a useful error message.

    dumper_to_file(filepath, variable1 [, variable2...])

Uses Data::Dumper to save a dump of one or more variables to the specified file.

    has_utf8

Returns a boolean, indicating whether utf8 is available on this platform and version of perl.

    utf8_encode(string)

Encodes the string in utf8, if utf8 is available. Otherwise, returns $string unmodified. See Encode::encode().

    utf8_decode(string)

Decodes the string from utf8, if utf8 is available. Otherwise, returns $string unmodified. See Encode::decode().

    uri_escape(string)

Escapes all invalid URI characters. See CGI::Util::escape().

    uri_unescape(string)

Unescapes all invalid URI characters. See CGI::Util::unescape().

    html_escape(string)

Escapes all reserved characters. The result is suitable for including verbatim in an HTML document. See CGI::escapeHTML().

    html_unescape(string)

Escapes all reserved characters. The result is suitable for including verbatim in an HTML document. See CGI::unescapeHTML().

    base64_encode(string)

Encodes the specified string into Base64. See MIME::Base64::encode_base64().

    base64_encode(base64_data)

Decodes the specified data from Base64. See MIME::Base64::decode_base64().

TODO

* Document what Spoon::Base->debug() does.

AUTHOR

Brian Ingerson <INGY@cpan.org>

COPYRIGHT

Copyright (c) 2004. Brian Ingerson. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 SPOON::BASE (3) 2006-11-09

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.