Padre::Transform(3pm)

Padre::Transform3pm

Padre document transform api

Overview

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.

Releases

3 releases since Debian 6.0 (Squeeze); the text changed 2 times.

  1. 6.0
  2. 7
  3. 8

From padre 1.00+dfsg-3 in Debian 8 (Jessie). Parsed by carta from the page's man source.