noble (3) DBIx::Class::InflateColumn::ClassTypeEnum.3pm.gz

Provided by: libclass-type-enum-perl_0.014-2_all bug

NAME
       DBIx::Class::InflateColumn::ClassTypeEnum - Inflate enum-like columns to your Class::Type::Enum classes


VERSION
       version 0.014


SYNOPSIS
         package My::Schema::Result::Toast {
           __PACKAGE__->load_components(qw/ InflateColumn::ClassTypeEnum Core /);

           # Assuming Toast::Status is one of your enum classes...

           use Toast::Status;  # Ensure it is loaded.

           __PACKAGE__->add_columns(
             status => {
               data_type => 'varchar',
               extra     => {
                 enum_class => 'Toast::Status',
               },
             }
           );
         }


DESCRIPTION
       Inflate DBIC columns into instances of your Class::Type::Enum classes.  The storage "data_type" doesn't
       matter here, only whether or not enums should inflate/deflate to symbols (strings) or ordinals
       (integers).


METHODS
   register_column($column, $info)
       This method chains with "register_column" in DBIx::Class::Row and checks for two subkeys inside the
       "extra" key of the column info:

       enum_class
           Required to enable column inflation.  Specify the complete class name that this column should be
           inflated to.  It should already be loaded and must be a subclass of Class::Type::Enum.

       enum_ordinal_storage
           If true, the column is inflated from and deflated to ordinal values.


SEE ALSO
       •   Class::Type::Enum

       •   DBIx::Class::InflateColumn::Object::Enum


AUTHOR
       Meredith Howard <mhoward@cpan.org>


       This software is copyright (c) 2018 by Meredith Howard.

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