| Current File : //proc/self/root/usr/share/doc/perl-Template-Toolkit-2.24/modules/Template/Plugin/Directory.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html>
<head>
<title>Template::Plugin::Directory</title>
<link rel="stylesheet" type="text/css" href="../../../css/blue.css" title="Clear Blue">
<link rel="alternate stylesheet" type="text/css" href="../../../css/orange.css" title="Clear Orange">
<link rel="alternate stylesheet" type="text/css" href="../../../css/green.css" title="Clear Green">
<link rel="alternate stylesheet" type="text/css" href="../../../css/purple.css" title="Clear Purple">
<link rel="alternate stylesheet" type="text/css" href="../../../css/grey.css" title="Clear Grey">
<link rel="alternate stylesheet" type="text/css" href="../../../css/print.css" title="Print">
<!--[if IE 6]>
<link rel="stylesheet" type="text/css" href="../../../css/ie6.css" />
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="../../../css/ie7.css" />
<![endif]-->
<link rel="stylesheet" type="text/css" href="../../../css/print.css" media="print">
<script type="text/javascript" src="../../../js/tt2.js"></script>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="author" content="Andy Wardley">
</head>
<body id="body">
<div id="layout">
<div id="header">
<a href="../../../index.html" id="logo" alt="" title="Click for the Home Page"><span class="alt">TT2 Home Page</span></a>
<ul id="trail">
<li><a href="../../../modules/index.html">Modules</a></li>
<li><a href="../../../modules/Template/index.html">Template::*</a></li>
<li><a href="../../../modules/Template/Plugin/index.html">Plugin::*</a></li>
<li class="last"><a href="../../../modules/Template/Plugin/Directory.html">Directory.pm</a></li>
</ul>
<div class="controls">
<a href="#" class="menu show" onclick="widescreen_off(); return false" title="Show Menu">
<span class="about">Click to view the menu. It's very nice.</span>
</a>
<a href="#" class="menu hide" onclick="widescreen_on(); return false" title="Hide Menu">
<span class="about">Click to hide the menu and go all widescreen!</span>
</a>
<div class="pager">
<a href="../../../modules/Template/Plugin/Date.html" title="Template::Plugin::Date" class="go back">Back<span class="about"><h4>Template::Plugin::Date</h4>Plugin to generate formatted date strings</span></a>
<a href="../../../modules/Template/Plugin/index.html" title="Template::Plugin::* Modules" class="go up">Up<span class="about"><h4>Template::Plugin::* Modules</h4></span></a>
<a href="../../../modules/Template/Plugin/Dumper.html" title="Template::Plugin::Dumper" class="go next">Next<span class="about"><h4>Template::Plugin::Dumper</h4>Plugin interface to Data::Dumper</span></a>
</div>
</div>
<h1 class="headline">Template::Plugin::Directory</h1>
<h2 class="subhead">Plugin for generating directory listings</h1>
</div>
<div id="page">
<div id="sidebar">
<a href="../../../index.html" id="logo"></a>
<div id="menu">
<ul class="menu">
<li class="l0 first"><a href="../../../manual/index.html">Manual</a></li>
<li class="l0"><a href="../../../modules/index.html" class="warm">Modules</a></li>
<li class="l1"><a href="../../../modules/Template.html">Template.pm</a></li>
<li class="l1"><a href="../../../modules/Template/index.html" class="warm">Template::*</a></li>
<li class="l2"><a href="../../../modules/Template/Base.html">Base.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Config.html">Config.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Constants.html">Constants.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Context.html">Context.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Directive.html">Directive.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Document.html">Document.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Exception.html">Exception.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Filters.html">Filters.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Grammar.html">Grammar.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Iterator.html">Iterator.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Namespace/index.html">Namespace::*</a></li>
<li class="l2"><a href="../../../modules/Template/Parser.html">Parser.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Plugin.html">Plugin.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Plugin/index.html" class="warm">Plugin::*</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Assert.html">Assert.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/CGI.html">CGI.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Datafile.html">Datafile.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Date.html">Date.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Directory.html" class="warm">Directory.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Dumper.html">Dumper.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/File.html">File.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Filter.html">Filter.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Format.html">Format.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/HTML.html">HTML.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Image.html">Image.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Iterator.html">Iterator.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Math.html">Math.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Pod.html">Pod.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Procedural.html">Procedural.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Scalar.html">Scalar.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/String.html">String.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Table.html">Table.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/URL.html">URL.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/View.html">View.pm</a></li>
<li class="l3"><a href="../../../modules/Template/Plugin/Wrap.html">Wrap.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Plugins.html">Plugins.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Provider.html">Provider.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Service.html">Service.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Stash.html">Stash.pm</a></li>
<li class="l2"><a href="../../../modules/Template/Stash/index.html">Stash::*</a></li>
<li class="l2"><a href="../../../modules/Template/Test.html">Test.pm</a></li>
<li class="l2"><a href="../../../modules/Template/VMethods.html">VMethods.pm</a></li>
<li class="l2"><a href="../../../modules/Template/View.html">View.pm</a></li>
<li class="l0"><a href="../../../tools/index.html">Tools</a></li>
<li class="l0"><a href="../../../tutorial/index.html">Tutorial</a></li>
<li class="l0 last"><a href="../../../faq/index.html">FAQ</a></li>
</ul>
<div class="foot"></div>
</div>
</div>
<div id="content">
<div class="section">
<div class="head">
<h1 id="contents" onclick="switch_section(this)" title="Click title to show/hide section content.">Contents</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<ul class="toc">
<li class=""><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li class=""><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li class=""><a href="#AUTHORS">AUTHORS</a></li>
<li class=""><a href="#COPYRIGHT">COPYRIGHT</a></li>
<li class=""><a href="#SEE_ALSO">SEE ALSO</a></li>
</ul>
</div>
</div>
<div class="pod">
<div class="section">
<div class="head">
<h1 id="SYNOPSIS" onclick="switch_section(this)" title="Click title to show/hide section content.">SYNOPSIS</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<pre><span class="tt">[% USE dir = Directory(dirpath) %]</span>
# files returns list of regular files
<span class="tt">[% FOREACH file = dir.files %]</span>
<span class="tt">[% file.name %]</span> <span class="tt">[% file.path %]</span> ...
<span class="tt">[% END %]</span>
# dirs returns list of sub-directories
<span class="tt">[% FOREACH subdir = dir.dirs %]</span>
<span class="tt">[% subdir.name %]</span> <span class="tt">[% subdir.path %]</span> ...
<span class="tt">[% END %]</span>
# list returns both interleaved in order
<span class="tt">[% FOREACH item = dir.list %]</span>
<span class="tt">[% IF item.isdir %]</span>
Directory: <span class="tt">[% item.name %]</span>
<span class="tt">[% ELSE %]</span>
File: <span class="tt">[% item.name %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% END %]</span>
# define a VIEW to display dirs/files
<span class="tt">[% VIEW myview %]</span>
<span class="tt">[% BLOCK file %]</span>
File: <span class="tt">[% item.name %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% BLOCK directory %]</span>
Directory: <span class="tt">[% item.name %]</span>
<span class="tt">[% item.content(myview) | indent -%]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% END %]</span>
# display directory content using view
<span class="tt">[% myview.print(dir) %]</span></pre>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="DESCRIPTION" onclick="switch_section(this)" title="Click title to show/hide section content.">DESCRIPTION</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
This Template Toolkit plugin provides a simple interface to directory
listings. It is derived from the <a href="../../../modules/Template/Plugin/File.html">Template::Plugin::File</a>
module and uses <a href="../../../modules/Template/Plugin/File.html">Template::Plugin::File</a> object instances to represent files
within a directory. Sub-directories within a directory are represented by
further <code>Template::Plugin::Directory</code> instances.
</p>
<p>
The constructor expects a directory name as an argument.
</p>
<pre><span class="tt">[% USE dir = Directory('/tmp') %]</span></pre>
<p>
It then provides access to the files and sub-directories contained within
the directory.
</p>
<pre># regular files (not directories)
<span class="tt">[% FOREACH file IN dir.files %]</span>
<span class="tt">[% file.name %]</span>
<span class="tt">[% END %]</span>
# directories only
<span class="tt">[% FOREACH file IN dir.dirs %]</span>
<span class="tt">[% file.name %]</span>
<span class="tt">[% END %]</span>
# files and/or directories
<span class="tt">[% FOREACH file IN dir.list %]</span>
<span class="tt">[% file.name %]</span> (<span class="tt">[% file.isdir ? 'directory' : 'file' %]</span>)
<span class="tt">[% END %]</span></pre>
<p>
The plugin constructor will throw a <code>Directory</code> error if the
specified path does not exist, is not a directory or fails to
<code>stat()</code> (see <a href="../../../modules/Template/Plugin/File.html">Template::Plugin::File</a>). Otherwise, it will scan the directory
and create lists named '<code>files</code>' containing files,
'<code>dirs</code>' containing directories and '<code>list</code>'
containing both files and directories combined. The <code>nostat</code>
option can be set to disable all file/directory checks and directory
scanning.
</p>
<p>
Each file in the directory will be represented by a <a href="../../../modules/Template/Plugin/File.html">Template::Plugin::File</a>
object instance, and each directory by another
<code>Template::Plugin::Directory</code>. If the <code>recurse</code>
flag is set, then those directories will contain further nested entries,
and so on. With the <code>recurse</code> flag unset, as it is by default,
then each is just a place marker for the directory and does not contain
any further content unless its <code>scan()</code> method is explicitly
called. The <code>isdir</code> flag can be tested against files and/or
directories, returning true if the item is a directory or false if it is
a regular file.
</p>
<pre><span class="tt">[% FOREACH file = dir.list %]</span>
<span class="tt">[% IF file.isdir %]</span>
* Directory: <span class="tt">[% file.name %]</span>
<span class="tt">[% ELSE %]</span>
* File: <span class="tt">[% file.name %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% END %]</span></pre>
<p>
This example shows how you might walk down a directory tree, displaying
content as you go. With the recurse flag disabled, as is the default, we
need to explicitly call the <code>scan()</code> method on each directory,
to force it to lookup files and further sub-directories contained within.
</p>
<pre><span class="tt">[% USE dir = Directory(dirpath) %]</span>
* <span class="tt">[% dir.path %]</span>
<span class="tt">[% INCLUDE showdir %]</span>
<span class="tt">[% BLOCK showdir -%]</span>
<span class="tt">[% FOREACH file = dir.list -%]</span>
<span class="tt">[% IF file.isdir -%]</span>
* <span class="tt">[% file.name %]</span>
<span class="tt">[% file.scan -%]</span>
<span class="tt">[% INCLUDE showdir dir=file FILTER indent(4) -%]</span>
<span class="tt">[% ELSE -%]</span>
- <span class="tt">[% f.name %]</span>
<span class="tt">[% END -%]</span>
<span class="tt">[% END -%]</span>
<span class="tt">[% END %]</span></pre>
<p>
This example is adapted (with some re-formatting for clarity) from a test
in <i>t/directry.t</i> which produces the following output:
</p>
<pre>* test/dir
- file1
- file2
* sub_one
- bar
- foo
* sub_two
- waz.html
- wiz.html
- xyzfile</pre>
<p>
The <code>recurse</code> flag can be set (disabled by default) to cause
the constructor to automatically recurse down into all sub-directories,
creating a new <code>Template::Plugin::Directory</code> object for each
one and filling it with any further content. In this case there is no
need to explicitly call the <code>scan()</code> method.
</p>
<pre><span class="tt">[% USE dir = Directory(dirpath, recurse=1) %]</span>
...
<span class="tt">[% IF file.isdir -%]</span>
* <span class="tt">[% file.name %]</span>
<span class="tt">[% INCLUDE showdir dir=file FILTER indent(4) -%]</span>
<span class="tt">[% ELSE -%]</span>
...</pre>
<p>
The directory plugin also provides support for views. A view can be
defined as a <code>VIEW ... END</code> block and should contain
<code>BLOCK</code> definitions for files ('<code>file</code>') and
directories ('<code>directory</code>').
</p>
<pre><span class="tt">[% VIEW myview %]</span>
<span class="tt">[% BLOCK file %]</span>
- <span class="tt">[% item.name %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% BLOCK directory %]</span>
* <span class="tt">[% item.name %]</span>
<span class="tt">[% item.content(myview) FILTER indent %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% END %]</span></pre>
<p>
The view <code>print()</code> method can then be called, passing the
<code>Directory</code> object as an argument.
</p>
<pre><span class="tt">[% USE dir = Directory(dirpath, recurse=1) %]</span>
<span class="tt">[% myview.print(dir) %]</span></pre>
<p>
When a directory is presented to a view, either as <code>[%
myview.print(dir) %]</code> or <code>[% dir.present(view) %]</code>, then
the <code>directory</code> <code>BLOCK</code> within the
<code>myview</code> <code>VIEW</code> is processed. The <code>item</code>
variable will be set to alias the <code>Directory</code> object.
</p>
<pre><span class="tt">[% BLOCK directory %]</span>
* <span class="tt">[% item.name %]</span>
<span class="tt">[% item.content(myview) FILTER indent %]</span>
<span class="tt">[% END %]</span></pre>
<p>
In this example, the directory name is first printed and the
content(view) method is then called to present each item within the
directory to the view. Further directories will be mapped to the
<code>directory</code> block, and files will be mapped to the
<code>file</code> block.
</p>
<p>
With the recurse option disabled, as it is by default, the
<code>directory</code> block should explicitly call a <code>scan()</code>
on each directory.
</p>
<pre><span class="tt">[% VIEW myview %]</span>
<span class="tt">[% BLOCK file %]</span>
- <span class="tt">[% item.name %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% BLOCK directory %]</span>
* <span class="tt">[% item.name %]</span>
<span class="tt">[% item.scan %]</span>
<span class="tt">[% item.content(myview) FILTER indent %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% USE dir = Directory(dirpath) %]</span>
<span class="tt">[% myview.print(dir) %]</span></pre>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="AUTHORS" onclick="switch_section(this)" title="Click title to show/hide section content.">AUTHORS</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Michael Stevens wrote the original Directory plugin on which this is
based. Andy Wardley split it into separate <a href="../../../modules/Template/Plugin/File.html">File</a> and <a href="../../../modules/Template/Plugin/Directory.html">Directory</a> plugins,
added some extra code and documentation for <code>VIEW</code> support,
and made a few other minor tweaks.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="COPYRIGHT" onclick="switch_section(this)" title="Click title to show/hide section content.">COPYRIGHT</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Copyright (C) 2000-2007 Michael Stevens, Andy Wardley.
</p>
<p>
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="SEE_ALSO" onclick="switch_section(this)" title="Click title to show/hide section content.">SEE ALSO</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
<a href="../../../modules/Template/Plugin.html">Template::Plugin</a>, <a
href="../../../modules/Template/Plugin/File.html">Template::Plugin::File</a>, <a href="../../../modules/Template/View.html">Template::View</a>
</p>
</div>
</div>
</div></div>
<br class="clear" />
<div class="pageinfo">
<a href="http://template-toolkit.org/docs/modules/Template/Plugin/Directory.html">http://template-toolkit.org/docs/modules/Template/Plugin/Directory.html</a>
</div>
</div>
<div id="footer">
<a href="http://opensource.org/" class="osi"></a>
<div class="controls">
<div class="pager">
<a href="../../../modules/Template/Plugin/Date.html" title="Template::Plugin::Date" class="go back">Back<span class="about"><h4>Template::Plugin::Date</h4></span></a>
<a href="../../../modules/Template/Plugin/index.html" title="Template::Plugin::* Modules" class="go up">Up<span class="about"><h4>Template::Plugin::* Modules</h4></span></a>
<a href="../../../modules/Template/Plugin/Dumper.html" title="Template::Plugin::Dumper" class="go next">Next<span class="about"><h4>Template::Plugin::Dumper</h4></span></a>
</div>
</div>
<div class="copyright">
Copyright © 1996-2012 <a href="http://wardley.org/">Andy Wardley</a>. All Rights Reserved.
</div>
<div class="licence">
The <a href="http://template-toolkit.org/">Template Toolkit</a> is <a href="http://opensource.org/">Open Source</a> software.
You can redistribute and/or modify it under the terms of the <a href="http://www.opensource.org/licenses/gpl-license.php">GNU Public Licence</a>
or the <a href="http://www.opensource.org/licenses/artistic-license.php">Perl Artistic Licence</a>.
</div>
</div>
<div id="palette">
<ul>
<li class="first"><a href="#" class="blue" onclick="set_style('Clear Blue')"></a></li>
<li><a href="#" class="orange" onclick="set_style('Clear Orange')"></a></li>
<li><a href="#" class="green" onclick="set_style('Clear Green')"></a></li>
<li><a href="#" class="purple" onclick="set_style('Clear Purple')"></a></li>
<li><a href="#" class="grey" onclick="set_style('Clear Grey')"></a></li>
</ul>
</div>
</div> </body>
</html>