NAME

Orze::Drivers - Superclass of all Orze::Drivers::

SYNOPSIS

package Orze::Drivers::Foo;

use strict;
use warnings;
use base qw( Orze::Drivers );
use Text::Foo;

sub process {
    # do some cool stuff
}

new

Create the driver object, using the $page tree and the $variables hash.

process

You need to overload this method in order to do the real processing of the page data.

sub process { croak "You really should subclass this package !!!!"; }

input

Get the full path of a file in the data/ folder, according the current outputdir value.

output

Get the full path of a file in the www/ folder, according the current outputdir value.

paths

Give the tuple (input($file), output($file)).

cache

Build the name of a file in the cache directory. The path depends on the current driver and on the page's name.

cleanpath($base, $file, $extension)

Given a base name and a filename, returns a cleaned path by removing ".." and leading "/". Take care of the outputir.

warning

Display a warning message during the processing, giving information on the current page and the current driver.

root

Give the relative path needed to reach the root of the website from the current page.