.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Config::Model::Backend::Yaml 3pm" .TH Config::Model::Backend::Yaml 3pm "2022-10-14" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Config::Model::Backend::Yaml \- Read and write config as a YAML data structure .SH "VERSION" .IX Header "VERSION" version 2.134 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Config::Model ; \& use Data::Dumper ; \& \& # define configuration tree object \& my $model = Config::Model\->new ; \& $model \->create_config_class ( \& name => "MyClass", \& element => [ \& [qw/foo bar/] => { \& type => \*(Aqleaf\*(Aq, \& value_type => \*(Aqstring\*(Aq \& }, \& baz => { \& type => \*(Aqhash\*(Aq, \& index_type => \*(Aqstring\*(Aq , \& cargo => { \& type => \*(Aqleaf\*(Aq, \& value_type => \*(Aqstring\*(Aq, \& }, \& }, \& ], \& rw_config => { \& backend => \*(Aqyaml\*(Aq, \& config_dir => \*(Aq/tmp\*(Aq, \& file => \*(Aqfoo.yml\*(Aq, \& auto_create => 1, \& } \& ) ; \& \& my $inst = $model\->instance(root_class_name => \*(AqMyClass\*(Aq ); \& \& my $root = $inst\->config_root ; \& \& my $steps = \*(Aqfoo=yada bar="bla bla" baz:en=hello \& baz:fr=bonjour baz:hr="dobar dan"\*(Aq; \& $root\->load( steps => $steps ) ; \& $inst\->write_back ; .Ve .PP Now, \f(CW\*(C`/tmp/foo.yml\*(C'\fR contains: .PP .Vb 7 \& \-\-\- \& bar: bla bla \& baz: \& en: hello \& fr: bonjour \& hr: dobar dan \& foo: yada .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is used directly by Config::Model to read or write the content of a configuration tree written with \s-1YAML\s0 syntax in \&\f(CW\*(C`Config::Model\*(C'\fR configuration tree. .PP Note: .IP "\(bu" 4 Undefined values are skipped for list element. I.e. if a list element contains \f(CW\*(C`(\*(Aqa\*(Aq,undef,\*(Aqb\*(Aq)\*(C'\fR, the data structure contains \f(CW\*(Aqa\*(Aq,\*(Aqb\*(Aq\fR. .IP "\(bu" 4 \&\s-1YAML\s0 file is not created (and may be deleted) when no data is to be written. .SS "Class with only one hash element" .IX Subsection "Class with only one hash element" If the root node contains a single hash or list element, only the content of this hash is written in a \s-1YAML\s0 file. .PP For example, if a class contains: .PP .Vb 9 \& element => [ \& baz => { \& type => \*(Aqhash\*(Aq, \& index_type => \*(Aqstring\*(Aq , \& cargo => { \& type => \*(Aqleaf\*(Aq, \& value_type => \*(Aqstring\*(Aq, \& }, \& }, .Ve .PP If the configuration is loaded with: .PP .Vb 1 \& $root\->load("baz:one=un baz:two=deux") .Ve .PP Then the written \s-1YAML\s0 file does \fBnot\fR show \f(CW\*(C`baz\*(C'\fR: .PP .Vb 3 \& \-\-\- \& one: un \& two: deux .Ve .PP Likewise, a \s-1YAML\s0 file for a class with a single list \f(CW\*(C`baz\*(C'\fR element would be written with: .PP .Vb 3 \& \-\-\- \& \- un \& \- deux .Ve .SH "YAML class" .IX Header "YAML class" As of v2.129, this backend uses \s-1YAML::XS\s0 0.69 or later. .PP For security reason, loading a Perl blessed object is disabled. .PP Value of type boolean are written as boolean values in \s-1YAML\s0 files. .SH "backend parameter" .IX Header "backend parameter" .SS "yaml_class" .IX Subsection "yaml_class" This parameter is ignored as of version 2.129. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" Parameters: \f(CW\*(C`( node => $node_obj, name => \*(Aqyaml\*(Aq )\*(C'\fR .PP Inherited from Config::Model::Backend::Any. The constructor is called by Config::Model::BackendMgr. .SS "read" .IX Subsection "read" Read \s-1YAML\s0 file and load into \f(CW$node_obj\fR tree. .PP When a file is read, \f(CW\*(C`read\*(C'\fR returns 1. .SS "write" .IX Subsection "write" Write \s-1YAML\s0 File using \f(CW$node_obj\fR data. .PP \&\f(CW\*(C`write\*(C'\fR returns 1. .SH "AUTHOR" .IX Header "AUTHOR" Dominique Dumont, (ddumont at cpan dot org) .SH "SEE ALSO" .IX Header "SEE ALSO" Config::Model, Config::Model::BackendMgr, Config::Model::Backend::Any, \s-1YAML::XS\s0 .SH "AUTHOR" .IX Header "AUTHOR" Dominique Dumont .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2018 by Dominique Dumont. .PP This is free software, licensed under: .PP .Vb 1 \& The GNU Lesser General Public License, Version 2.1, February 1999 .Ve .SH "SUPPORT" .IX Header "SUPPORT" .SS "Websites" .IX Subsection "Websites" The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources. .IP "\(bu" 4 \&\s-1CPANTS\s0 .Sp The \s-1CPANTS\s0 is a website that analyzes the Kwalitee ( code metrics ) of a distribution. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers .Sp The \s-1CPAN\s0 Testers is a network of smoke testers who run automated tests on uploaded \s-1CPAN\s0 distributions. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers Matrix .Sp The \s-1CPAN\s0 Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers Dependencies .Sp The \s-1CPAN\s0 Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution. .Sp .SS "Bugs / Feature Requests" .IX Subsection "Bugs / Feature Requests" Please report any bugs or feature requests by email to \f(CW\*(C`ddumont at cpan.org\*(C'\fR, or through the web interface at . You will be automatically notified of any progress on the request by the system. .SS "Source Code" .IX Subsection "Source Code" The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :) .PP .PP .Vb 1 \& git clone git://github.com/dod38fr/config\-model\-backend\-yaml.git .Ve