Peter Lavender > Padre-0.98 > Padre::Transform

Download:
Padre-0.98.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.98   Source   Latest Release: Padre-1.00

NAME ^

Padre::Transform - Padre Document Transform API

DESCRIPTION ^

This is the base class for the Padre transform API.

I'll document this more later...

-- Adam K

METHODS ^

new

A default constructor for transform objects.

Takes arbitrary key/value pair parameters and returns a new object.

scalar_delta

  my $delta = $transform->scalar_delta($input_ref);

The scalar_delta method takes a reference to a SCALAR as the only parameter and changes the document.

If the transform class does not implement a scalar_delta itself the default implementation will pass the call through to scalar_scalar and then convert the result to a Padre::Delta object itself.

Returns a new Padre::Delta as output, or throws an exception on error.

scalar_scalar

  my $output_ref = $transform->scalar_scalar($input_ref);

The scalar_scalar method takes a reference to a SCALAR as the only parameter and changes the document.

Returns a new reference to a SCALAR as output, false if there is no change to the document, or throws an exception on error.

COPYRIGHT & LICENSE ^

Copyright 2008-2013 The Padre development team as listed in Padre.pm.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: