~ubuntu-branches/ubuntu/wily/libclass-accessor-grouped-perl/wily

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Fabrizio Regalli, Ansgar Burchardt, Salvatore Bonaccorso, Fabrizio Regalli
  • Date: 2011-12-01 23:52:13 UTC
  • mfrom: (1.1.11)
  • Revision ID: package-import@ubuntu.com-20111201235213-nppamlddtxqzgo5e
Tags: 0.10004-1
[ Ansgar Burchardt ]
* debian/control: Convert Vcs-* fields to Git.

[ Salvatore Bonaccorso ]
* debian/copyright: Replace DEP5 Format-Specification URL from
  svn.debian.org to anonscm.debian.org URL.

[ Fabrizio Regalli ]
* Imported Upstream version 0.10004
* Update d/copyright to latest .174 revision of DEP-5 format
* Fixed missing-license-text-in-dep5-copyright lintian message
* Added version (>= 1.11) to libclass-xsaccessor-perl dependency
* Added version (>= 0.05) to libsub-name-perl dependency
* Added libdevel-hide-perl as B-D-I

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
METHODS
18
18
  mk_group_accessors
19
 
     __PACKAGE__->mk_group_accessors(simple => 'hair_length');
 
19
     __PACKAGE__->mk_group_accessors(simple => 'hair_length', [ hair_color => 'hc' ]);
20
20
 
21
21
    Arguments: $group, @fieldspec
22
22
        Returns: none
36
36
    expected to be of the form [ $accessor, $field ].
37
37
 
38
38
  mk_group_ro_accessors
39
 
     __PACKAGE__->mk_group_ro_accessors(simple => 'birthdate');
 
39
     __PACKAGE__->mk_group_ro_accessors(simple => 'birthdate', [ social_security_number => 'ssn' ]);
40
40
 
41
41
    Arguments: $group, @fieldspec
42
42
        Returns: none
46
46
    rather than setting the value.
47
47
 
48
48
  mk_group_wo_accessors
49
 
     __PACKAGE__->mk_group_wo_accessors(simple => 'lie');
 
49
     __PACKAGE__->mk_group_wo_accessors(simple => 'lie', [ subject => 'subj' ]);
50
50
 
51
51
    Arguments: $group, @fieldspec
52
52
        Returns: none
55
55
    "mk_group_accessors" but accessors will throw an error if not passed a
56
56
    value rather than getting the value.
57
57
 
58
 
  make_group_accessor
59
 
     __PACKAGE__->make_group_accessor(simple => 'hair_length', 'hair_length');
60
 
 
61
 
    Arguments: $group, $field, $method
62
 
        Returns: \&accessor_coderef ?
63
 
 
64
 
    Called by mk_group_accessors for each entry in @fieldspec. Either
65
 
    returns a coderef which will be installed at "&__PACKAGE__::$method", or
66
 
    returns "undef" if it elects to install the coderef on its own.
67
 
 
68
 
  make_group_ro_accessor
69
 
     __PACKAGE__->make_group_ro_accessor(simple => 'birthdate', 'birthdate');
70
 
 
71
 
    Arguments: $group, $field, $method
72
 
        Returns: \&accessor_coderef ?
73
 
 
74
 
    Called by mk_group_ro_accessors for each entry in @fieldspec. Either
75
 
    returns a coderef which will be installed at "&__PACKAGE__::$method", or
76
 
    returns "undef" if it elects to install the coderef on its own.
77
 
 
78
 
  make_group_wo_accessor
79
 
     __PACKAGE__->make_group_wo_accessor(simple => 'lie', 'lie');
80
 
 
81
 
    Arguments: $group, $field, $method
82
 
        Returns: \&accessor_coderef ?
83
 
 
84
 
    Called by mk_group_wo_accessors for each entry in @fieldspec. Either
85
 
    returns a coderef which will be installed at "&__PACKAGE__::$method", or
86
 
    returns "undef" if it elects to install the coderef on its own.
87
 
 
88
58
  get_simple
89
59
    Arguments: $field
90
60
        Returns: $value
147
117
 
148
118
        $self->result_class->method();
149
119
 
 
120
INTERNAL METHODS
 
121
    These methods are documented for clarity, but are never meant to be
 
122
    called directly, and are not really meant for overriding either.
 
123
 
150
124
  get_super_paths
151
125
    Returns a list of 'parent' or 'super' class names that the current class
152
 
    inherited from.
 
126
    inherited from. This is what drives the traversal done by
 
127
    "get_inherited".
 
128
 
 
129
  make_group_accessor
 
130
     __PACKAGE__->make_group_accessor('simple', 'hair_length', 'hair_length');
 
131
     __PACKAGE__->make_group_accessor('simple', 'hc', 'hair_color');
 
132
 
 
133
    Arguments: $group, $field, $accessor
 
134
        Returns: \&accessor_coderef ?
 
135
 
 
136
    Called by mk_group_accessors for each entry in @fieldspec. Either
 
137
    returns a coderef which will be installed at "&__PACKAGE__::$accessor",
 
138
    or returns "undef" if it elects to install the coderef on its own.
 
139
 
 
140
  make_group_ro_accessor
 
141
     __PACKAGE__->make_group_ro_accessor('simple', 'birthdate', 'birthdate');
 
142
     __PACKAGE__->make_group_ro_accessor('simple', 'ssn', 'social_security_number');
 
143
 
 
144
    Arguments: $group, $field, $accessor
 
145
        Returns: \&accessor_coderef ?
 
146
 
 
147
    Called by mk_group_ro_accessors for each entry in @fieldspec. Either
 
148
    returns a coderef which will be installed at "&__PACKAGE__::$accessor",
 
149
    or returns "undef" if it elects to install the coderef on its own.
 
150
 
 
151
  make_group_wo_accessor
 
152
     __PACKAGE__->make_group_wo_accessor('simple', 'lie', 'lie');
 
153
     __PACKAGE__->make_group_wo_accessor('simple', 'subj', 'subject');
 
154
 
 
155
    Arguments: $group, $field, $accessor
 
156
        Returns: \&accessor_coderef ?
 
157
 
 
158
    Called by mk_group_wo_accessors for each entry in @fieldspec. Either
 
159
    returns a coderef which will be installed at "&__PACKAGE__::$accessor",
 
160
    or returns "undef" if it elects to install the coderef on its own.
153
161
 
154
162
PERFORMANCE
155
163
    To provide total flexibility Class::Accessor::Grouped calls methods