JDEGUEST / Module-Generic-v0.42.0 / lib / Module / Generic / Dynamic.pod 

            

              
—
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

              
=encoding utf8
=head1 NAME
Module::Generic::Dynamic - Dynamic Object Class
=head1 SYNOPSIS
    package My::Module;
    use parent qw( Module::Generic::Dynamic );
    # Then, instantiating an object
    my $object = My::Module->new({
        name => $some_name,
        quantity => 20,
        metadata => $some_hash_reference,
        tags => [qw( product entrepreneurship capital )],
    });
    # Then the methods corresponding to the data keys can be accessed
    my $product_name = $object->name
    # etc
=head1 VERSION
    v1.2.4
=head1 DESCRIPTION
The purpose of this class/package is to provide a framework to create dynamically created class/package.
For more granular control over the method to be used for each data key-value, use L<Module::Generic/"_set_get_class">
=head1 METHODS
=head2 new
Provided with an hash reference of data, this will create dynamically a class based on the class/pacakge name used to call B<new>
It will then associate helper method sbased on the data type for each key of the hash reference. Precisely:
=over 4
=item * C<hash>
This would create method after the key name and a new class also based on the key name, and use the helper method L<Module::Generic/"_set_get_object">
=item * C<array>
If the array contains hash references, this will create a new class/package dynamically and create an object for each hash reference in the array using L<Module::Generic/"_set_get_object_array">
Otherwise, it will create the method using L<Module::Generic/"_set_get_array">
=item * C<string>
This would create a method using the helper method L<Module::Generic/"_set_get_scalar">
=item * C<boolean>
This would create a method using the helper method L<Module::Generic/"_set_get_boolean">
=back
=head1 SERIALISATION
=for Pod::Coverage FREEZE
=for Pod::Coverage STORABLE_freeze
=for Pod::Coverage STORABLE_thaw
=for Pod::Coverage THAW
=for Pod::Coverage TO_JSON
Serialisation by L<CBOR|CBOR::XS>, L<Sereal> and L<Storable::Improved> (or the legacy L<Storable>) is supported by this package. To that effect, the following subroutines are implemented: C<FREEZE>, C<THAW>, C<STORABLE_freeze> and C<STORABLE_thaw>
=head1 AUTHOR
Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
=head1 COPYRIGHT & LICENSE
Copyright (c) 2000-2024 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated
files under the same terms as Perl itself.
=cut