oracular (3) XML::LibXSLT::Quick.3pm.gz

NAME

       XML::LibXSLT::Quick - an easier to use (= "quicker") interface to XML::LibXSLT

SYNOPSIS

           use XML::LibXSLT::Quick ();

           my $stylesheet =
               XML::LibXSLT::Quick->new( { location => 'example/1.xsl', } );
           my $xml1_text = _utf8_slurp('example/1.xml');
           my $out_fn = 'foo.xml';
           $stylesheet->generic_transform(
               +{
                   type => 'file',
                   path => $out_fn,
               },
               $xml1_text,
           );

DESCRIPTION

       This is a module that wraps XML::LibXSLT with an easier to use interface.

       It can be used to process XML documents using XSLT (Extensible Stylesheet Language Transformations)
       <https://en.wikipedia.org/wiki/XSLT> stylesheets.

METHODS

   XML::LibXSLT::Quick->new({ location=>"./xslt/my.xslt", });
       TBD.

   $obj->stylesheet()
       The result of parse_stylesheet().

   $obj->xml_parser()
       The XML::LibXML instance.

   $obj->generic_transform($dest, $source)
       To be discussed.

       See "t/using-quick-wrapper.t" .

       $dest can be:

       "\$my_string_var"

       "{type => 'dom', }" - the DOM will be returned.

       "{type => 'file', path => $filepath, }" - the output string will be written to $filepath .

       "{type => 'implicit', }" - the output string will be calculated but implicitly discarded and undef()
       returned. (Added in version 2.00300 .)

       "{type => 'return', }" - the output string will be returned.

       $source can be:

       A string.

       "{type => 'file', path => $filepath, params => +{}, }" - the file will be parsed.

       "{type => 'string', string => $my_xml_string, params => +{}, }" - the string will be parsed.

   $obj->output_as_chars($dom)
   $obj->transform(...)
   $obj->transform_into_chars(...)
       Delegating from $obj->stylesheet() . See XML::LibXSLT .

SEE ALSO

       XML::LibXSLT::Easy by Yuval Kogman - requires some MooseX modules.

       XML::LibXSLT - used as the backend of this module.

COPYRIGHT & LICENSE

       NOTE!!! : this licence applies to this file alone. The blanket licence for the distribution is "same as
       Perl 5".

       (I am not a lawyer (= "IANAL") / etc. )

       For more information, consult:

       •   <https://www.shlomifish.org/philosophy/computers/open-source/foss-licences-wars/rev2/#which-licence-same-as-perl>

       •   <https://github.com/shlomif/perl-XML-LibXSLT/issues/5>

       •   <https://en.wikiquote.org/w/index.php?title=Rick_Cook&oldid=3060266>

           “Programming today is a race between software engineers striving to build bigger and better idiot-
           proof programs, and the Universe trying to produce bigger and better idiots. So far, the Universe is
           winning.”

       Copyright 2022 by Shlomi Fish

       This program is distributed under the MIT / Expat License:
       <http://www.opensource.org/licenses/mit-license.php>

       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
       associated documentation files (the "Software"), to deal in the Software without restriction, including
       without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
       following conditions:

       The above copyright notice and this permission notice shall be included in all copies or substantial
       portions of the Software.

       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
       LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
       EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
       IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
       THE USE OR OTHER DEALINGS IN THE SOFTWARE.