NAME

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

SYNOPSIS

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

sub calculate { ... }

DESCRIPTION

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

INSTANCE METHODS

calculate

Subclasses should provide this as the workhorse. It should either return the result, or die with an error message (that will be trapped and turned into a spreadsheet error).

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, 2008 Tony Bowden

LICENCE

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