Shlomi Fish > XML-GrammarBase-v0.0.3 > XML::GrammarBase::Role::RelaxNG

Download:
XML-GrammarBase-v0.0.3.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: v0.0.3   Source   Latest Release: XML-GrammarBase-v0.2.3

NAME ^

XML::GrammarBase::Role::RelaxNG - base class for a RelaxNG validator

VERSION ^

Version 0.0.3

SYNOPSIS ^

    package XML::Grammar::MyGrammar::RelaxNG::Validate;

    use MooX 'late';

    with ('XML::GrammarBase::Role::RelaxNG');

    has '+module_base' => (default => 'XML::Grammar::MyGrammar');
    has '+rng_schema_basename' => (default => 'my-grammar.rng');

    package main;

    my $rnger = XML::Grammar::MyGrammar::RelaxNG::Validate->new(
        data_dir => "/path/to/data-dir",
    );

    # Throws an exception on failure.
    $rnger->rng_validate_file("/different-path-to-xml-file.xml");

SLOTS ^

module_base

The basename of the module - used for dist dir.

data_dir

The data directory where the XML assets can be found (the RELAX NG schema, etc.)

rng_schema_basename

The Relax NG Schema basename.

METHODS ^

$self->rng_validate_dom($source_dom)

Validates the DOM ( $source_dom ) using the RELAX-NG schema.

$self->rng_validate_file($file_path)

Validates the file in $file_path using the RELAX-NG schema.

$self->rng_validate_string($xml_string)

Validates the XML in the $xml_string using the RELAX-NG schema.

$self->dist_path($basename)

Returns the $basename relative to data_dir().

Utility method.

$self->dist_path_slot($slot)

Returns the basename of $self->$slot() relative to data_dir().

Utility method.

BUILD

Any::Moose constructor. For internal use.

AUTHOR ^

Shlomi Fish, <shlomif at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-xml-grammarbase at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=XML-GrammarBase. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc XML::GrammarBase

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2009 Shlomi Fish.

This program is distributed under the MIT (X11) 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.

syntax highlighting: