NAME

Spreadsheet::Engine::Function::text - base class for text functions

SYNOPSIS

  use base 'Spreadsheet::Engine::Function::text';

  sub arguments { [ 1 ] }

  sub calculate { ... }

DESCRIPTION

This provides a base class for spreadsheet functions that operate on text, such as UPPER(), LOWER(), REPLACE() etc.

Subclasses should provide an 'arguments' method detailing the number and type of arguments they should receive, and a 'calculate' function that will be called with those arguments.

INSTANCE METHODS

execute

This checks that the parameters passed to the function are correct, and if so delegates to the subclass to calculate().

result_type

Most text functions return a text string, so we provide that as the default value. Functions that return something different (e.g. LENGTH) should override this.

HISTORY

This is a Modified Version of code extracted from SocialCalc::Functions in SocialCalc 1.1.0

COPYRIGHT

Portions (c) Copyright 2005, 2006, 2007 Software Garden, Inc. All Rights Reserved.

Portions (c) Copyright 2007 Socialtext, Inc. All Rights Reserved.

Portions (c) Copyright 2007 Tony Bowden

LICENSE

The contents of this file are subject to the Artistic License 2.0; you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.perlfoundation.org/artistic_license_2_0