The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
OpusVL-Preferences-0.27
River stage zero No dependents
++
/ OpusVL::Preferences::RolesFor::Result::PrfOwner

NAME

OpusVL::Preferences::RolesFor::Result::PrfOwner

VERSION

version 0.27

SYNOPSIS

DESCRIPTION

If you are using DBIx::Class::Schema::Loader add the necessary link fields manually, otherwise add the following line to add the fields to your result class.

    __PACKAGE__->prf_owner_init;

METHODS

prf_owner_init

Tries to add the columns and relationships for your result class. Call it like this,

    __PACKAGE__->prf_owner_init;

Your mileage may vary.

prf_defaults

ResultSet for the defaults.

prf_preferences

ResultSet of the preference values.

prf_get

Gets the setting. If the object doesn't have the setting specified but there is a default, the default will be returned.

prf_set

Sets the setting for the object.

prf_reset

Resets the settings against the object. prf_get may still return a value if there is a default for the setting.

preferences_to_array

Returns an array of the current results preferences.

    $object->preferences_to_array();
    # [{
    #     name => $_->name, 
    #     value => $_->value,
    #     param => # assocaited PrfDefault parameter definition.
    # } ];

safe_preferences_in_array

Returns the same as preferences_to_array but instead of the param object it returns the field label. The safe refers to the fact that all the items in the hash are base types and therefore are trivially serializable.

safe_prefs_to_hash

Returns the same as safe_prefs_to_hash but converts it to a hash for easier use.

COPYRIGHT and LICENSE

Copyright (C) 2011 OpusVL

This software is licensed according to the "IP Assignment Schedule" provided with the development project.

prf_id_column

Provides the default column that contains the preferences identifier.

If your Result doesn't have a standard integer primary key called 'id', override this with the name of another column that is an identifying integer

AUTHOR

OpusVL - www.opusvl.com

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by OpusVL - www.opusvl.com.

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