/usr/share/perl5/HTML/Mason/Resolver.pm is in libhtml-mason-perl 1:1.56-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 | # Copyright (c) 1998-2005 by Jonathan Swartz. All rights reserved.
# This program is free software; you can redistribute it and/or modify it
# under the same terms as Perl itself.
package HTML::Mason::Resolver;
$HTML::Mason::Resolver::VERSION = '1.56';
use strict;
use warnings;
use HTML::Mason::Exceptions( abbr => ['param_error', 'virtual_error'] );
use Params::Validate qw(:all);
Params::Validate::validation_options( on_fail => sub { param_error join '', @_ } );
use HTML::Mason::ComponentSource;
use Class::Container;
use base qw(Class::Container);
# Returns HTML::Mason::ComponentSource object
sub get_info {
shift->_virtual;
}
sub glob_path {
shift->_virtual;
}
sub _virtual
{
my $self = shift;
my $sub = (caller(1))[3];
$sub =~ s/.*::(.*?)$/$1/;
virtual_error "$sub is a virtual method and must be overridden in " . ref($self);
}
1;
__END__
=head1 NAME
HTML::Mason::Resolver - Component path resolver base class
=head1 SYNOPSIS
# make a subclass and use it
=head1 DESCRIPTION
The resolver is responsible for translating a component path like
/foo/index.html into a component. By default, Mason expects
components to be stored on the filesystem, and uses the
HTML::Mason::Resolver::File class to get information on these
components.
The HTML::Mason::Resolver provides a virtual parent class from which
all resolver implementations should inherit.
=head1 Class::Container
This class is used by most of the Mason object's to manage constructor
parameters and has-a relationships with other objects.
See the documentation on this class for details on how to declare what
parameters are valid for your subclass's constructor.
HTML::Mason::Resolver is a subclass of Class::Container so you
do not need to subclass it yourself.
=head1 METHODS
If you are interested in creating a resolver subclass, you must
implement the following methods.
=over 4
=item new
This method is optional. The new method included in this class is
simply inherited from C<Class::Container>.
If you need something more complicated done in your new method you
will need to override it in your subclass.
=item get_info
Takes three arguments: an absolute component path, a component root key,
and a component root path. Returns a new
L<HTML::Mason::ComponentSource|HTML::Mason::ComponentSource> object.
=item glob_path
Takes two arguments: a path glob pattern, something
like "/foo/*" or "/foo/*/bar", and a component root path. Returns
a list of component paths for components which match this glob pattern.
For example, the filesystem resolver simply appends this pattern to
the component root path and calls the Perl C<glob()> function to
find matching files on the filesystem.
=back
=head2 Using a Resolver with HTML::Mason::ApacheHandler
If you are creating a new resolver that you intend to use with the
L<HTML::Mason::ApacheHandler|HTML::Mason::ApacheHandler> module, then
you must implement the following method as well.
=over 4
=item apache_request_to_comp_path ($r, @comp_root_array)
This method, given an Apache object and a list of component root pairs,
should return a component path or undef if none exists.
This method is used by the
L<HTML::Mason::ApacheHandler|HTML::Mason::ApacheHandler> class to
translate web requests into component paths. You can omit this method
if your resolver subclass will never be used in conjunction with
L<HTML::Mason::ApacheHandler|HTML::Mason::ApacheHandler>.
=back
=cut
|