1Config::MVP::Sequence(3U)ser Contributed Perl DocumentatiCoonnfig::MVP::Sequence(3)
2
3
4
6 Config::MVP::Sequence - an ordered set of named configuration sections
7
9 version 2.200013
10
12 A Config::MVP::Sequence is an ordered set of configuration sections,
13 each of which has a name unique within the sequence.
14
15 For the most part, you can just consult Config::MVP to understand what
16 this class is and how it's used.
17
19 This module should work on any version of perl still receiving updates
20 from the Perl 5 Porters. This means it should work on any version of
21 perl released in the last two to three years. (That is, if the most
22 recently released version is v5.40, then this module should work on
23 both v5.40 and v5.38.)
24
25 Although it may work on older versions of perl, no guarantee is made
26 that the minimum required version will not be increased. The version
27 may be increased for any reason, and there is no promise that patches
28 will be accepted to lower the minimum required perl.
29
31 is_finalized
32 This attribute is true if the sequence has been marked finalized, which
33 will prevent any changes (via methods like "add_section" or
34 "delete_section"). It can be set with the "finalize" method.
35
37 add_section
38 $sequence->add_section($section);
39
40 This method adds the given section to the end of the sequence. If the
41 sequence already contains a section with the same name as the new
42 section, an exception will be raised.
43
44 delete_section
45 my $deleted_section = $sequence->delete_section( $name );
46
47 This method removes a section from the sequence and returns the removed
48 section. If no section existed, the method returns false.
49
50 section_named
51 my $section = $sequence->section_named( $name );
52
53 This method returns the section with the given name, if one exists in
54 the sequence. If no such section exists, the method returns false.
55
56 section_names
57 my @names = $sequence->section_names;
58
59 This method returns a list of the names of the sections, in order.
60
61 sections
62 my @sections = $sequence->sections;
63
64 This method returns the section objects, in order.
65
67 Ricardo Signes <cpan@semiotic.systems>
68
70 This software is copyright (c) 2022 by Ricardo Signes.
71
72 This is free software; you can redistribute it and/or modify it under
73 the same terms as the Perl 5 programming language system itself.
74
75
76
77perl v5.36.0 2023-01-20 Config::MVP::Sequence(3)