File Coverage

blib/lib/Toader/Templates/Defaults.pm

Criterion	Covered	Total	%
statement	9	129	6.9
branch	0	14	0.0
condition			n/a
subroutine	3	7	42.8
pod	4	4	100.0
total	16	154	10.3

package Toader::Templates::Defaults;

use warnings;
use strict;
use base 'Error::Helper';

=head1 NAME

Toader::Templates::Defaults - This provides the default templates for Toader.

=head1 VERSION

Version 0.3.0

=cut

our $VERSION = '0.3.0';

=head1 SYNOPSIS

    use Toader::Templates::Defaults;

    #initiates the object
    my $foo = Toader::Templates::Defaults->new;

    #fetches the css template
    my $template=$foo->getPage('css');
    if ( $foo->error ){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

=head1 METHODS

=head2 new

This initiates the object.

This method does not error.

    my $foo=Toader::Template::Defaults->new;

=cut

sub new{
	my %args;
	if(defined($_[1])){
		%args= %{$_[1]};
	};

	my $self={
		error=>undef,
		errorString=>'',
		templates=>{},
			  errorExtra=>{
				  flags=>{
					  1=>'noTemplateNameSpecified',
					  2=>'noSuchTemplate',
				  },
			  },
	};
	bless $self;

	$self->{templates}{'link'}='[== $text ==]';
	$self->{templates}{'linkDirectory'}='[== $text ==]';
	$self->{templates}{'linkEntry'}='[== $text ==]';
	$self->{templates}{'linkPage'}='[== $text ==]';
	$self->{templates}{'linkFile'}='[== $text ==]';
	$self->{templates}{'linkDirectoryFile'}='[== $text ==]';
	$self->{templates}{'linkEntryFile'}='[== $text ==]';
	$self->{templates}{'linkPageFile'}='[== $text ==]';
	$self->{templates}{'entriesLink'}='[== $text ==]';
	$self->{templates}{'entriesArchiveLink'}='[== $text ==]';
	$self->{templates}{'upOneDirLink'}='[== $text ==]';
	$self->{templates}{'dirListLink'}='[== $text ==]';
	$self->{templates}{'pageListLink'}='[== $text ==]';
	$self->{templates}{'authorLink'}='[== $name ==]';
	$self->{templates}{'pageSummaryLink'}='[== $text ==]';
	$self->{templates}{'toRootLink'}='[== $text ==]';
	$self->{templates}{'autodocLink'}='[== $text ==]';
	$self->{templates}{'linkAutoDocList'}='[== $text ==]';
	$self->{templates}{'linkGallery'}='[== $text ==]';

	$self->{templates}{'dirListBegin'}='';
	$self->{templates}{'dirListEnd'}='';
	$self->{templates}{'dirListJoin'}=''."\n";
	$self->{templates}{'dirListEnd'}=''."\n";

	$self->{templates}{'pageListBegin'}='';
	$self->{templates}{'pageListJoin'}=''."\n";
	$self->{templates}{'pageListEnd'}=''."\n";

	$self->{templates}{'entryListBegin'}='';
	$self->{templates}{'entryListJoin'}=''."\n";
	$self->{templates}{'entryListEnd'}=''."\n";

	$self->{templates}{'authorBegin'}='';
	$self->{templates}{'authorEnd'}='';
	$self->{templates}{'authorJoin'}=", \n";
	$self->{templates}{'authorEnd'}="\n";

	$self->{templates}{'cssInclude'}='';
	$self->{templates}{'css'}='div{
  border: 0px solid;
  padding: 2px;
  width: 100%;
 }
div#sidebar{
  width: auto;
  float: left;
  border: 1px solid;
 }
div#content{
  width: auto;
  float: none;
 }
div#location{
  width: 100%;
  border: 1px solid;
 }
div#header{
  width: 100%;
  border: 1px solid;
 }
div#content{
  width: 100%;
  border: 1px solid;
 }
div#imageDiv{
  border: 1px solid;
  float: left;
 }
div#copyright{
  width: auto;
  text-align: center;
 clear: left;
 }
body{
  background: black;
  color: white;
 }
a:link{
  color: grey;
 }
a:visited{
  color: lightgreen;
 }
a:hover{
  color: green;
 }
table#entryArchive{
  border: 1px solid;
 }
td#entryArchive{
  border: 1px solid;
 }
table#pageSummary{
  border: 1px solid;
 }
td#pageSummary{
  border: 1px solid;
 }
table#hashToTable{
  border: 1px solid;
 }
td#hashToTable{
  border: 1px solid;
 }
tr#hashToTable{
  border: 1px solid;
 }
';

	$self->{templates}{'page'}='



	 [== $c->{_}->{siteTitle} ==]






	  [== $g->top ==]



	  [== $g->locationbar( $locationID ) ==]
      [== $g->locationSub ==]





        [== $g->sidebar; ==]



		[== $content ==]






    [== $g->copyright ==]




';

	$self->{templates}{'copyright'}='
 [==
   my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)=localtime(time);
   $year=$year+1900;
   return "Copyright ".$year." ".$c->{_}->{owner};
  ==]

';

	$self->{templates}{'sidebar'}='[==
  if ( ! $g->hasEntries ){
    return "";
  }
  return "Entries\n".
    "		".$g->entriesLink." \n".
    "		".$g->entriesArchiveLink." \n";
==]
[==
  my $pages=$g->listPages;
  if ( ( ! defined( $pages ) ) || ( $pages eq "" ) ){
    return "";
  }
  return "		".$g->pageSummaryLink."\n".$pages."\n		\n";
==]
[==
  if( $g->hasGallery ){
    return "\n".$g->galleryLink."";
  }else{
    return "";
  }
==]
[==
  if( $g->hasAnyDirs ){
      return "\nDirectories";
  }else{
    return "";
  }
==]
[==
  if ( $g->atRoot ){
    return "";
  }
  return $g->rlink("Go To The Root")."		\n		".
    $g->upOneDirLink."		\n		";
==]

[==
  if ( $g->hasSubDirs ){
    return $g->listDirs;
  }
  return "";
==]
[==
  if ( $g->hasDocs ){
    return "".$g->adListLink;
  }
  return "";
==]
';

	$self->{templates}{'pageGallery'}='



     [== $c->{_}->{siteTitle} ==]






      [== $g->top ==]



      [== $g->locationbar( $locationID ) ==]
      [== $g->locationSub ==]





      [== $content ==]





      [==
        my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)=localtime(time);
        $year=$year+1900;
        return "Copyright ".$year." ".$c->{_}->{owner};
       ==]





';

	$self->{templates}{'dirContent'}='[== $body ==]';


	$self->{templates}{'pageContent'}='[== $body ==]';

	$self->{templates}{'entryContent'}='
  [== $g->elink( $g->or2r, $date, $title ) ==]
  Date: [== $year.$month.$day."-".$hour.":".$min ==]
  Author: [== $g->authorsLink( $from ) ==]

    [== $body ==]


';

	$self->{templates}{'entryIndex'}='[== $g->lastEntries( $c->{_}->{last} ) ==]';

	$self->{templates}{'entryArchive'}='[== $g->entryArchive ==]';
	$self->{templates}{'entryArchiveBegin'}=' 




332




 





 





 





 





 





 



    Date Title Summary  




333




 





 





 





 





 





 



 '; 




334



  
0
  




 





 





 





 





 



 	$self->{templates}{'entryArchiveRow'}='   




335




 





 





 





 





 





 



     [== $g->elink( "./", $date, $date ) ==] 




336




 





 





 





 





 





 



     [== $title ==] 




337




 





 





 





 





 





 



     [== $summary ==] 




338




 





 





 





 





 





 



    




339




 





 





 





 





 





 



 '; 




340



  
0
  




 





 





 





 





 



 	$self->{templates}{'entryArchiveJoin'}=''; 




341



  
0
  




 





 





 





 





 



 	$self->{templates}{'entryArchiveEnd'}='';

';
	$self->{templates}{'entryArchiveRow'}='




';
	$self->{templates}{'entryArchiveJoin'}='';
	$self->{templates}{'entryArchiveEnd'}='

	$self->{templates}{'pageSummary'}='[== $g->pageSummary ==]';

	$self->{templates}{'pageSummaryBegin'}=' 




346




 





 





 





 





 





 



    Name Summary  




347




 





 





 





 





 





 



 '; 




348



  
0
  




 





 





 





 





 



 	$self->{templates}{'pageSummaryRow'}='   




349




 





 





 





 





 





 



     [== $name ==] 




350




 





 





 





 





 





 



     [== $summary ==] 




351




 





 





 





 





 





 



    




352




 





 





 





 





 





 



 '; 




353



  
0
  




 





 





 





 





 



 	$self->{templates}{'pageSummaryJoin'}=''; 




354



  
0
  




 





 





 





 





 



 	$self->{templates}{'pageSummaryEnd'}='';

';
	$self->{templates}{'pageSummaryRow'}='



';
	$self->{templates}{'pageSummaryJoin'}='';
	$self->{templates}{'pageSummaryEnd'}='

	$self->{templates}{'locationStart'}='Location: ';
	$self->{templates}{'locationPart'}='[== $text ==] / ';
	$self->{templates}{'locationEnd'}='[== $locationID ==]
';

	$self->{templates}{'top'}='[== $c->{_}->{site} ==]';

    $self->{templates}{'autodocContent'}='[== $g->autodocList ==]';
    $self->{templates}{'autodocListBegin'}=' 




365




 





 





 





 





 





 



    File  




366




 





 





 





 





 





 



 '; 




367



  
0
  




 





 





 





 





 



     $self->{templates}{'autodocListRow'}='   




368




 





 





 





 





 





 



     [== $g->adlink( $dir, $file ) ==] 




369




 





 





 





 





 





 



    




370




 





 





 





 





 





 



 '; 




371



  
0
  




 





 





 





 





 



     $self->{templates}{'autodocListJoin'}=''; 




372



  
0
  




 





 





 





 





 



     $self->{templates}{'autodocListEnd'}='';

';
    $self->{templates}{'autodocListRow'}='


';
    $self->{templates}{'autodocListJoin'}='';
    $self->{templates}{'autodocListEnd'}='

    $self->{templates}{'hashToTableBegin'}=' 




375




 





 





 





 





 





 



 '; 




376



  
0
  




 





 





 





 





 



     $self->{templates}{'hashToTableTitle'}='   




377




 





 





 





 





 





 



     [== $keyTitle ==] 




378




 





 





 





 





 





 



     [== $valueTitle ==] 




379




 





 





 





 





 





 



    




380




 





 





 





 





 





 



 '; 




381



  
0
  




 





 





 





 





 



     $self->{templates}{'hashToTableRow'}='   




382




 





 





 





 





 





 



     [== $key ==] 




383




 





 





 





 





 





 



     [== $value ==] 




384




 





 





 





 





 





 



    




385




 





 





 





 





 





 



 '; 




386




 





 





 





 





 





 



   




387



  
0
  




 





 





 





 





 



     $self->{templates}{'hashToTableJoin'}=''; 




388



  
0
  




 





 





 





 





 



     $self->{templates}{'hashToTableEnd'}='';
';
    $self->{templates}{'hashToTableTitle'}='



';
    $self->{templates}{'hashToTableRow'}='



';

    $self->{templates}{'hashToTableJoin'}='';
    $self->{templates}{'hashToTableEnd'}='

	$self->{templates}{'imageDiv'}='
  [== $above ==]
  [== if ( defined( $link ) ){ return \'\' }else{ return \'\' } ==]

  [== if ( defined( $link ) ){ return \'\' }else{ return \'\' } ==]
  [== $below ==]

';

	$self->{templates}{'gallerySmallImageBegin'}='';
	$self->{templates}{'gallerySmallImage'}='[== $g->galleryImageSmall( $dir, $gdir, $image ); ==]';
	$self->{templates}{'galleryDir'}=' [== $link ==] ';
	$self->{templates}{'gallerySmallImageJoin'}="\n";
	$self->{templates}{'gallerySmallImageEnd'}='';

    $self->{templates}{'galleryLocationStart'}='Gallery Location: ';
    $self->{templates}{'galleryLocationPart'}='[== $text ==]';
	$self->{templates}{'galleryLocationJoin'}=' / ';
    $self->{templates}{'galleryLocationEnd'}='
';
	$self->{templates}{'galleryLocationImage'}='Image: [== $image ==]
';


	$self->{templates}{'imageExifTablesGroup'}='
EXIF Tag Group: [== $group ==]
[== $table ==]

';
	$self->{templates}{'imageExifTablesJoin'}='';
	$self->{templates}{'imageExifTablesBegin'}='';
	$self->{templates}{'imageExifTablesEnd'}='';
	$self->{templates}{'imageExifTables'}='Image:  [== $filename ==]
[== $tables ==]
';

	return $self;
}

=head2 exists

This checks if the specified template exists as a default template.

One argument is required and that is the template name to check for.
This method will only throw a error if it is left undefined.

The return value is a Perl boolean value.

    my $exists=$foo->exists($template);

=cut

sub exists{
    my $self=$_[0];
    my $name=$_[1];

    if ( ! $self->errorblank ){
        $self->{error}=1;
        $self->{errorString}='No template specified';
        $self->warn;
        return undef;
    }

    if ( defined( $self->{templates}{$name}  ) ){
        return 1;
    }

	return 0;
}

=head2 getTemplate

This returns a default template.

One argument is required and it is the template name.

There is no need to do error checking, if one is certian
the template exists.

    my $template=$foo->getTemplate( $name );
    if ( $foo->error ){
        warn( 'Error:'.$foo->error.': '.$foo->errorString );
    }

=cut

sub getTemplate{
	my $self=$_[0];
	my $name=$_[1];

	if ( ! $self->errorblank ){
		return undef;
	}

	if ( ! defined( $name ) ){
		$self->{error}=1;
		$self->{errorString}='No template specified';
		$self->warn;
		return undef;
	}

	if ( ! defined( $self->{templates}{$name}  ) ){
		$self->{error}=2;
		$self->{errorString}='"'.$name.'" is not a default template';
		$self->warn;
		return undef;
	}

	return $self->{templates}{$name};
}

=head2 listTemplates

This returns a list of default templates.

No arguments are taken.

    my @defTemplates=$foo->listTemplates;

=cut

sub listTemplates{
    my $self=$_[0];

    if ( ! $self->errorblank ){
        return undef;
    }

	return keys( %{ $self->{templates} } );
}

=head1 ERROR CODES/FLAGS

=head2 1, noTemplateNameSpecified

No template name specified.

=head2 2, noSuchTemplate

No such template.

=head1 AUTHOR

Zane C. Bowers-Hadley, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

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

    perldoc Toader::Templates::Defaults


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2013 Zane C. Bowers-Hadley.

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.


=cut

1; # End of Toader