Yawns::Preferences

• NAME
• SYNOPSIS
• DESCRIPTION
  • new
  • getAll
  • getPreference
  • setPreference
  • deleteByUser
  • invalidateCache
• AUTHOR
• LICENSE

NAME

Yawns::Preferences - A module for working with user preferences.

SYNOPSIS

    #!/usr/bin/perl -w

    use Yawns::Preferences;
    use strict;

    my $accessor = Yawns::Preferences->new( username => "bob" );

    # get specific preference
    my $prefs = $accessor->getAll();

    # get single preference.
    my $key   = $accessor->getPreference( "posting_format" );

    # set one
    $accessor->setPreference( "posting_format", "textile" );

DESCRIPTION

This module deals with the contents of the preferences table.

new

  Create a new instance of this object.

getAll

  Get all key and values from a user preferences.

getPreference

  Return a single preference from the database.

setPreference

  Set a single preference for the given user.

deleteByUser

  Delete all preferences for the given user.

invalidateCache

  Clean any cached content we might have.

AUTHOR

Steve Kemp

http://www.steve.org.uk/

LICENSE

Copyright (c) 2007 by Steve Kemp. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license.