Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Toader::Page::Helper(3User Contributed Perl DocumentatiToader::Page::Helper(3)

NAME
       Toader::Page::Helper - Misc helper methods for pages.

VERSION
       Version 1.0.0

METHODS
   new
       This initializes	this object.

       This method will	not error.

	   my $foo = Toader::Page::FileHelper->new();

   pageDirectory
       This returns the	page directory.

       This requires setDir to be called previously.

       If setDir has been successfully called, this will not error.

	   my $pageDirectory=$foo->pageDirectory;
	   if($foo->error){
	       warn('error: '.$foo->error.":".$foo->errorString);
	   }

   pageExists
       This checks if the specified page exists.

       One argument is accepted	and it is the page in question.

       This requires setDir to be called previously.

	   my $retruned=$foo->pageExists($page);
	   if($foo->error){
	       warn('error: '.$foo->error.":".$foo->errorString);
	   }
	   if($returned){
	       print "It exists.\n";
	   }

   setDir
       This sets the directory to operate on.

       One argument is required. It is the directory to	use.

	   $foo->setDir($directory);
	   if($foo->error){
	       warn('error: '.$foo->error.":".$foo->errorString);
	   }

   summary
       This builds a summary of	of the the pages.

   validPageName
       This verifies that the name is a	valid file name.

       One arguemnet is	taken and that is the name of the page name to check.

       This will not error. If the name	is not defined,	false, '0', will be
       returned	as undefined is	not a valid name.

	   my $valid=$foo->validPageName($name);
	   if($valid){
	       print '"'.$name.'" is a valid name.';
	   }

ERROR CODES
   1, notAtoaderDir
       Not a Toader directory.

   2, noDirSpecified
       No directory specified.

   3, noPageSpecified
       No page specified.

   4, noDirSet
       No directory has	been set yet.

   5, invalidPageName
       The page	name is	not valid.

   6, pageManageErrored
       Failed to initialize Toader::Page::Manage.

   7, noToaderObj
       No Toader object	specified.

   8, notAtoaderObj
       The object specified is not a Toader object.

AUTHOR
       Zane C. Bowers, "<vvelox	at vvelox.net>"

BUGS
       Please report any bugs or feature requests to "bug-toader at
       rt.cpan.org", or	through	the web	interface at
       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader>.	 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 Toader::Page::Helper

       You can also look for information at:

       o   RT: CPAN's request tracker

	   <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Toader>

       o   CPAN	Ratings

	   <http://cpanratings.perl.org/d/Toader>

       o   Search CPAN

	   <http://search.cpan.org/dist/Toader/>

ACKNOWLEDGEMENTS
LICENSE	AND COPYRIGHT
       Copyright 2011 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.

perl v5.24.1			  2013-04-13	       Toader::Page::Helper(3)

NAME | VERSION | METHODS | ERROR CODES | AUTHOR | BUGS | SUPPORT | ACKNOWLEDGEMENTS | LICENSE AND COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Toader::Page::Helper&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help