\PHPExcel_Calculation_TextData

PHPExcel_Calculation_TextData

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
CHARACTER()
TRIMNONPRINTABLE()
TRIMSPACES()
ASCIICODE()
CONCATENATE()
DOLLAR()
SEARCHSENSITIVE()
SEARCHINSENSITIVE()
FIXEDFORMAT()
LEFT()
MID()
RIGHT()
STRINGLENGTH()
LOWERCASE()
UPPERCASE()
PROPERCASE()
REPLACE()
SUBSTITUTE()
RETURNSTRING()
TEXTFORMAT()
VALUE()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
unicodeToOrd()
$invalidChars
N/A

Properties

$invalidChars

$invalidChars : 

Type

Methods

CHARACTER()

CHARACTER(string  $character) : integer

CHARACTER

Parameters

string $character

Value

Returns

integer

TRIMNONPRINTABLE()

TRIMNONPRINTABLE(mixed  $stringValue = '') : string

TRIMNONPRINTABLE

Parameters

mixed $stringValue

Value to check

Returns

string

TRIMSPACES()

TRIMSPACES(mixed  $stringValue = '') : string

TRIMSPACES

Parameters

mixed $stringValue

Value to check

Returns

string

ASCIICODE()

ASCIICODE(string  $characters) : integer

ASCIICODE

Parameters

string $characters

Value

Returns

integer

CONCATENATE()

CONCATENATE() : string

CONCATENATE

Returns

string

DOLLAR()

DOLLAR(float  $value, integer  $decimals = 2) : string

DOLLAR

This function converts a number to text using currency format, with the decimals rounded to the specified place. The format used is $#,##0.00_);($#,##0.00)..

Parameters

float $value

The value to format

integer $decimals

The number of digits to display to the right of the decimal point. If decimals is negative, number is rounded to the left of the decimal point. If you omit decimals, it is assumed to be 2

Returns

string

SEARCHSENSITIVE()

SEARCHSENSITIVE(string  $needle, string  $haystack, integer  $offset = 1) : string

SEARCHSENSITIVE

Parameters

string $needle

The string to look for

string $haystack

The string in which to look

integer $offset

Offset within $haystack

Returns

string

SEARCHINSENSITIVE()

SEARCHINSENSITIVE(string  $needle, string  $haystack, integer  $offset = 1) : string

SEARCHINSENSITIVE

Parameters

string $needle

The string to look for

string $haystack

The string in which to look

integer $offset

Offset within $haystack

Returns

string

FIXEDFORMAT()

FIXEDFORMAT(mixed  $value, integer  $decimals = 2, boolean  $no_commas = false) : boolean

FIXEDFORMAT

Parameters

mixed $value

Value to check

integer $decimals
boolean $no_commas

Returns

boolean

LEFT()

LEFT(string  $value = '', integer  $chars = 1) : string

LEFT

Parameters

string $value

Value

integer $chars

Number of characters

Returns

string

MID()

MID(string  $value = '', integer  $start = 1, integer  $chars = null) : string

MID

Parameters

string $value

Value

integer $start

Start character

integer $chars

Number of characters

Returns

string

RIGHT()

RIGHT(string  $value = '', integer  $chars = 1) : string

RIGHT

Parameters

string $value

Value

integer $chars

Number of characters

Returns

string

STRINGLENGTH()

STRINGLENGTH(string  $value = '') : string

STRINGLENGTH

Parameters

string $value

Value

Returns

string

LOWERCASE()

LOWERCASE(string  $mixedCaseString) : string

LOWERCASE

Converts a string value to upper case.

Parameters

string $mixedCaseString

Returns

string

UPPERCASE()

UPPERCASE(string  $mixedCaseString) : string

UPPERCASE

Converts a string value to upper case.

Parameters

string $mixedCaseString

Returns

string

PROPERCASE()

PROPERCASE(string  $mixedCaseString) : string

PROPERCASE

Converts a string value to upper case.

Parameters

string $mixedCaseString

Returns

string

REPLACE()

REPLACE(string  $oldText = '', integer  $start = 1, integer  $chars = null, string  $newText) : string

REPLACE

Parameters

string $oldText

String to modify

integer $start

Start character

integer $chars

Number of characters

string $newText

String to replace in defined position

Returns

string

SUBSTITUTE()

SUBSTITUTE(string  $text = '', string  $fromText = '', string  $toText = '', integer  $instance) : string

SUBSTITUTE

Parameters

string $text

Value

string $fromText

From Value

string $toText

To Value

integer $instance

Instance Number

Returns

string

RETURNSTRING()

RETURNSTRING(mixed  $testValue = '') : boolean

RETURNSTRING

Parameters

mixed $testValue

Value to check

Returns

boolean

TEXTFORMAT()

TEXTFORMAT(mixed  $value, string  $format) : boolean

TEXTFORMAT

Parameters

mixed $value

Value to check

string $format

Format mask to use

Returns

boolean

VALUE()

VALUE(mixed  $value = '') : boolean

VALUE

Parameters

mixed $value

Value to check

Returns

boolean

unicodeToOrd()

unicodeToOrd(  $c) 

Parameters

$c