1DBIx::Class::Schema::LoUasdeDerBrI:Cx:o:On:ptCtrliiaobsnusat:le::dS:cDPheeeprmelan:dD:eoLncocuaimdeeesnr(t:3a:)tOipotnional::Dependencies(3)
2
3
4

NAME

6       DBIx::Class::Schema::Loader::Optional::Dependencies - Optional module
7       dependency specifications (for module authors)
8

SYNOPSIS

10       Somewhere in your build-file (e.g. Module::Install's Makefile.PL):
11
12         ...
13
14         configure_requires 'DBIx::Class::Schema::Loader' => '0.07002';
15
16         require DBIx::Class::Schema::Loader::Optional::Dependencies;
17
18         my $use_moose_deps = DBIx::Class::Schema::Loader::Optional::Dependencies->req_list_for ('use_moose');
19
20         for (keys %$use_moose_deps) {
21           requires $_ => $use_moose_deps->{$_};
22         }
23
24         ...
25
26       Note that there are some caveats regarding "configure_requires()", more
27       info can be found at "configure_requires" in Module::Install
28

DESCRIPTION

30       Some of the features of DBIx::Class::Schema::Loader have external
31       module dependencies on their own. In order not to burden the average
32       user with modules he will never use, these optional dependencies are
33       not included in the base Makefile.PL. Instead an exception with a
34       descriptive message is thrown when a specific feature is missing one or
35       several modules required for its operation. This module is the central
36       holding place for  the current list of such dependencies.
37

CURRENT REQUIREMENT GROUPS

39       Dependencies are organized in "groups" and each group can list one or
40       more required modules, with an optional minimum version (or 0 for any
41       version).
42
43   use_moose
44       Modules required for the use_moose option
45
46       ·   Moose >= 1.12
47
48       ·   MooseX::NonMoose >= 0.15
49
50       ·   namespace::autoclean >= 0.09
51
52       Requirement group: use_moose
53

METHODS

55   req_group_list
56       Arguments: $none
57       Returns: \%list_of_requirement_groups
58
59       This method should be used by DBIx::Class packagers, to get a hashref
60       of all dependencies keyed by dependency group. Each key (group name)
61       can be supplied to one of the group-specific methods below.
62
63   req_list_for
64       Arguments: $group_name
65       Returns: \%list_of_module_version_pairs
66
67       This method should be used by DBIx::Class extension authors, to
68       determine the version of modules a specific feature requires in the
69       current version of DBIx::Class::Schema::Loader. See the "SYNOPSIS" for
70       a real-world example.
71
72   req_ok_for
73       Arguments: $group_name
74       Returns: 1|0
75
76       Returns true or false depending on whether all modules required by
77       $group_name are present on the system and loadable
78
79   req_missing_for
80       Arguments: $group_name
81       Returns: $error_message_string
82
83       Returns a single line string suitable for inclusion in larger error
84       messages.  This method would normally be used by
85       DBIx::Class::Schema::Loader maintainers, to indicate to the user that
86       he needs to install specific modules before he will be able to use a
87       specific feature.
88
89       For example if some of the requirements for "use_moose" are not
90       available, the returned string could look like:
91
92        Moose >= 0 (see use_moose for details)
93
94       The author is expected to prepend the necessary text to this message
95       before returning the actual error seen by the user.
96
97   req_errorlist_for
98       Arguments: $group_name
99       Returns: \%list_of_loaderrors_per_module
100
101       Returns a hashref containing the actual errors that occured while
102       attempting to load each module in the requirement group.
103

AUTHOR

105       See "CONTRIBUTORS" in DBIx::Class.
106

LICENSE

108       You may distribute this code under the same terms as Perl itself
109
110
111
112perl v5.12.2            DBIx::Clas2s0:1:0S-c0h9e-m1a1::Loader::Optional::Dependencies(3)