HKOBA / MOP4Import-Declare-0.062 / Types.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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

              
=head1 NAME
MOP4Import::Types - fields-aware type builder for inner-type
=head1 SYNOPSIS
Create inner-types C<MyApp::Artist> and C<MyApp::CD>
using B<MOP4Import::Types>.
  # Define subtype Artist and CD with their fields.
  package MyApp;
  use MOP4Import::Types
    (Artist => [[fields => qw/artistid name/]]
     , CD   => [[fields => qw/cdid artistid title year/]]);
Above is an equivalent of following:
  package MyApp;
  sub Artist () {'MyApp::Artist'}
  package MyApp::Artist {
     use MOP4Import::Declare [fields => qw/artistid name/];
  }
  sub CD () {'MyApp::CD'}
  package MyApp::CD {
     use MOP4Import::Declare [fields => qw/cdid artistid title year/];
  }
You can use above types like following with compile-time field name
typos detection of L<fields>.
  sub print_artist_cds {
    (my $self, my Artist $artist) = @_; # $artist is typed.
    my @cds = $self->DB->select(
      CD => {
        artistid => $artist->{artistid}  # Checked statically
      }
    );
    foreach my CD $cd (@cds) { # $cd is typed.
      print tsv($cd->{title}, $cd->{year}), "\n"; # Checked statically
    }
  }
=head1 DESCRIPTION
MOP4Import::Types is yet another protocol implementation
of L<MOP4Import|MOP4Import::Declare> family, based on L<MOP4Import::Pairs>
and L<MOP4Import::Declare::Type>.
In contrast to L<MOP4Import::Declare>, which is designed to
modify target module itself,
this module is designed to add new inner-types to target module.
With "inner-type", I mean type declared in some module
and not directly exposed as "require" able module.
=head2 "MetaObject Protocol for Import" in this module
"import()" method of this module takes C<< name => [@pragma_list] >> style
paired arguments and dispatch them
as C<< $myPack->declare_type($opts, $name, @pragma_list) >>.
  use MOP4Import::Types
    (Foo => [[fields => qw/bar baz/]]
    , Cat => [[fields => qw/name birth_year/]]
    );
  # Above is equivalent of followings
  use MOP4Import::Declare::Type [type => Foo => [fields => qw/bar baz/]];
  use MOP4Import::Declare::Type [type => Cat => [fields => qw/name birth_year/]];
=head2 Type names can be imported
  package MyProject::Types;
  use MOP4Import::Types
    (User => [[fields => qw/uid name .../]]
    , Product => [[fields => qw/prodid name .../]]
    , ...
    );
  #------------
  # You can import above types in other module like following:
  #------------
  package MyProject::Web;
  use MyProject::Types qw/User Product/;
=head2 Extending types in derived class
use L<MOP4Import::Types::Extend> instead.
=head2 Specifying base type
C<use MOP4Import::Types> can recognize first HASH argument as option set
and you can specify base type via C<basepkg> option.
  use MOP4Import::Types +{basepkg => 'YourBaseObject'}
    Foo => [[fields => qw/.../]], ...;
=head1 SEE ALSO
L<MOP4Import::Declare>
=head1 AUTHOR
Kobayashi, Hiroaki E<lt>hkoba@cpan.orgE<gt>
=head1 LICENSE
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut