lib/SGN/View/Mason.pm

   1 =head1 NAME
   2
   3 SGN::View::Mason - Mason View Component for SGN
   4
   5 =head1 DESCRIPTION
   6
   7 Mason View Component for SGN. This extends Catalyst::View::HTML::Mason.
   8
   9 =cut
  10
  11 package SGN::View::Mason;
  12 use Moose;
  13 use Moose::Util::TypeConstraints;
  14 use namespace::autoclean;
  15
  16 extends 'Catalyst::View::HTML::Mason';
  17 with 'Catalyst::Component::ApplicationAttribute';
  18
  19 __PACKAGE__->config(
  20     globals => ['$c'],
  21     template_extension => '.mas',
  22     interp_args => {
  23         data_dir => SGN->tempfiles_base->subdir('mason'),
  24         comp_root => [
  25             [ main => SGN->path_to('mason') ],
  26         ],
  27     },
  28 );
  29
  30 =head1 CONFIGURATION SETTINGS (which are also accessors)
  31
  32 =head2 add_comp_root
  33
  34 Configurable arrayref of additional Mason component roots.  These will
  35 be searched before the default ones.  Must be absolute paths.
  36
  37 =cut
  38
  39 # munges the interp_args comp_root to include the add_comp_root
  40 # configuration, plus the comp roots for SiteFeatures
  41 sub COMPONENT {
  42     my ( $class, $c, $args ) = @_;
  43
  44     $args = $class->merge_config_hashes( $class->config, $args );
  45
  46     # coerce add_comp_root to arrayref
  47     if( $args->{add_comp_root} && ! ref $args->{add_comp_root} ) {
  48         $args->{add_comp_root} = [ $args->{add_comp_root} ];
  49     }
  50
  51     # add comp roots for features and add_comp_root
  52     unshift @{ $args->{interp_args}->{comp_root} }, (
  53             # add_comp_root
  54             ( map [ additional => $_ ], @{ $args->{add_comp_root} || [] } ),
  55             # SiteFeatures
  56             ( map [ $_->feature_name, $_->path_to('mason')], $c->features ),
  57     );
  58
  59     return $class->new($c, $args);
  60 }
  61
  62 =head1 FUNCTIONS
  63
  64 =head2 $self->component_exists($component)
  65
  66 Check if a Mason component exists. Returns 1 if the component exists, otherwise 0.
  67
  68
  69 =cut
  70
  71 sub component_exists {
  72     my ( $self, $component ) = @_;
  73
  74     return $self->interp->comp_exists( $component ) ? 1 : 0;
  75 }
  76
  77 =head1 SEE ALSO
  78
  79 L<SGN>, L<HTML::Mason>, L<Catalyst::View::HTML::Mason>
  80
  81 =head1 AUTHORS
  82
  83 Robert Buels, Jonathan "Duke" Leto
  84
  85 =head1 LICENSE
  86
  87 This library is free software . You can redistribute it and/or modify it under
  88 the same terms as perl itself.
  89
  90 =cut
  91
  92 __PACKAGE__->meta->make_immutable;
  93 1;