class LookupRef (View source)

Methods

static string
cellAddress(mixed $row, mixed $column, int $relativity = 1, bool $referenceStyle = true, string $sheetText = '')

CELL_ADDRESS.

static int|int[]
COLUMN(null|array|string $cellAddress = null)

COLUMN.

static int
COLUMNS(null|array|string $cellAddress = null)

COLUMNS.

static int
ROW(null|array|string $cellAddress = null)

ROW.

static int
ROWS(null|array|string $cellAddress = null)

ROWS.

static mixed
HYPERLINK(string $linkURL = '', string $displayName = null, Cell $pCell = null)

HYPERLINK.

static mixed
INDIRECT(null|array|string $cellAddress = null, Cell $pCell = null)

INDIRECT.

static string
OFFSET(null|string $cellAddress = null, mixed $rows = 0, mixed $columns = 0, mixed $height = null, mixed $width = null, Cell $pCell = null)

OFFSET.

static mixed
CHOOSE(...$chooseArgs)

CHOOSE.

static int|string
MATCH(mixed $lookupValue, mixed $lookupArray, mixed $matchType = 1)

MATCH.

static mixed
INDEX(mixed $arrayValues, mixed $rowNum = 0, mixed $columnNum = 0)

INDEX.

static array
TRANSPOSE(array $matrixData)

TRANSPOSE.

static mixed
VLOOKUP(mixed $lookup_value, mixed $lookup_array, mixed $index_number, mixed $not_exact_match = true)

VLOOKUP The VLOOKUP function searches for value in the left-most column of lookup_array and returns the value in the same row based on the index_number.

static mixed
HLOOKUP(mixed $lookup_value, mixed $lookup_array, mixed $index_number, mixed $not_exact_match = true)

HLOOKUP The HLOOKUP function searches for value in the top-most row of lookup_array and returns the value in the same column based on the index_number.

static mixed
LOOKUP(mixed $lookup_value, mixed $lookup_vector, null|mixed $result_vector = null)

LOOKUP The LOOKUP function searches for value either from a one-row or one-column range or from an array.

static string
FORMULATEXT(mixed $cellReference = '', Cell $pCell = null)

FORMULATEXT.

Details

static string cellAddress(mixed $row, mixed $column, int $relativity = 1, bool $referenceStyle = true, string $sheetText = '')

CELL_ADDRESS.

Creates a cell address as text, given specified row and column numbers.

Excel Function: =ADDRESS(row, column, [relativity], [referenceStyle], [sheetText])

Parameters

mixed $row Row number to use in the cell reference
mixed $column Column number to use in the cell reference
int $relativity Flag indicating the type of reference to return 1 or omitted Absolute 2 Absolute row; relative column 3 Relative row; absolute column 4 Relative
bool $referenceStyle A logical value that specifies the A1 or R1C1 reference style. TRUE or omitted CELL_ADDRESS returns an A1-style reference FALSE CELL_ADDRESS returns an R1C1-style reference
string $sheetText Optional Name of worksheet to use

Return Value

string

static int|int[] COLUMN(null|array|string $cellAddress = null)

COLUMN.

Returns the column number of the given cell reference If the cell reference is a range of cells, COLUMN returns the column numbers of each column in the reference as a horizontal array. If cell reference is omitted, and the function is being called through the calculation engine, then it is assumed to be the reference of the cell in which the COLUMN function appears; otherwise this function returns 0.

Excel Function: =COLUMN([cellAddress])

Parameters

null|array|string $cellAddress A reference to a range of cells for which you want the column numbers

Return Value

int|int[]

static int COLUMNS(null|array|string $cellAddress = null)

COLUMNS.

Returns the number of columns in an array or reference.

Excel Function: =COLUMNS(cellAddress)

Parameters

null|array|string $cellAddress An array or array formula, or a reference to a range of cells for which you want the number of columns

Return Value

int The number of columns in cellAddress

static int ROW(null|array|string $cellAddress = null)

ROW.

Returns the row number of the given cell reference If the cell reference is a range of cells, ROW returns the row numbers of each row in the reference as a vertical array. If cell reference is omitted, and the function is being called through the calculation engine, then it is assumed to be the reference of the cell in which the ROW function appears; otherwise this function returns 0.

Excel Function: =ROW([cellAddress])

Parameters

null|array|string $cellAddress A reference to a range of cells for which you want the row numbers

Return Value

int or array of integer

static int ROWS(null|array|string $cellAddress = null)

ROWS.

Returns the number of rows in an array or reference.

Excel Function: =ROWS(cellAddress)

Parameters

null|array|string $cellAddress An array or array formula, or a reference to a range of cells for which you want the number of rows

Return Value

int The number of rows in cellAddress

HYPERLINK.

Excel Function: =HYPERLINK(linkURL,displayName)

Parameters

string $linkURL Value to check, is also the value returned when no error
string $displayName Value to return when testValue is an error condition
Cell $pCell The cell to set the hyperlink in

Return Value

mixed The value of $displayName (or $linkURL if $displayName was blank)

static mixed INDIRECT(null|array|string $cellAddress = null, Cell $pCell = null)

INDIRECT.

Returns the reference specified by a text string. References are immediately evaluated to display their contents.

Excel Function: =INDIRECT(cellAddress)

NOTE - INDIRECT() does not yet support the optional a1 parameter introduced in Excel 2010

Parameters

null|array|string $cellAddress $cellAddress The cell address of the current cell (containing this formula)
Cell $pCell The current cell (containing this formula)

Return Value

mixed The cells referenced by cellAddress

static string OFFSET(null|string $cellAddress = null, mixed $rows = 0, mixed $columns = 0, mixed $height = null, mixed $width = null, Cell $pCell = null)

OFFSET.

Returns a reference to a range that is a specified number of rows and columns from a cell or range of cells. The reference that is returned can be a single cell or a range of cells. You can specify the number of rows and the number of columns to be returned.

Excel Function: =OFFSET(cellAddress, rows, cols, [height], [width])

Parameters

null|string $cellAddress The reference from which you want to base the offset. Reference must refer to a cell or range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value.
mixed $rows The number of rows, up or down, that you want the upper-left cell to refer to. Using 5 as the rows argument specifies that the upper-left cell in the reference is five rows below reference. Rows can be positive (which means below the starting reference) or negative (which means above the starting reference).
mixed $columns The number of columns, to the left or right, that you want the upper-left cell of the result to refer to. Using 5 as the cols argument specifies that the upper-left cell in the reference is five columns to the right of reference. Cols can be positive (which means to the right of the starting reference) or negative (which means to the left of the starting reference).
mixed $height The height, in number of rows, that you want the returned reference to be. Height must be a positive number.
mixed $width The width, in number of columns, that you want the returned reference to be. Width must be a positive number.
Cell $pCell

Return Value

string A reference to a cell or range of cells

static mixed CHOOSE(...$chooseArgs)

CHOOSE.

Uses lookup_value to return a value from the list of value arguments. Use CHOOSE to select one of up to 254 values based on the lookup_value.

Excel Function: =CHOOSE(index_num, value1, [value2], ...)

Parameters

...$chooseArgs

Return Value

mixed The selected value

static int|string MATCH(mixed $lookupValue, mixed $lookupArray, mixed $matchType = 1)

MATCH.

The MATCH function searches for a specified item in a range of cells

Excel Function: =MATCH(lookup_value, lookup_array, [match_type])

Parameters

mixed $lookupValue The value that you want to match in lookup_array
mixed $lookupArray The range of cells being searched
mixed $matchType The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.

Return Value

int|string The relative position of the found item

static mixed INDEX(mixed $arrayValues, mixed $rowNum = 0, mixed $columnNum = 0)

INDEX.

Uses an index to choose a value from a reference or array

Excel Function: =INDEX(range_array, row_num, [column_num])

Parameters

mixed $arrayValues A range of cells or an array constant
mixed $rowNum The row in array from which to return a value. If row_num is omitted, column_num is required.
mixed $columnNum The column in array from which to return a value. If column_num is omitted, row_num is required.

Return Value

mixed the value of a specified cell or array of cells

static array TRANSPOSE(array $matrixData)

TRANSPOSE.

Parameters

array $matrixData A matrix of values

Return Value

array Unlike the Excel TRANSPOSE function, which will only work on a single row or column, this function will transpose a full matrix

static mixed VLOOKUP(mixed $lookup_value, mixed $lookup_array, mixed $index_number, mixed $not_exact_match = true)

VLOOKUP The VLOOKUP function searches for value in the left-most column of lookup_array and returns the value in the same row based on the index_number.

Parameters

mixed $lookup_value The value that you want to match in lookup_array
mixed $lookup_array The range of cells being searched
mixed $index_number The column number in table_array from which the matching value must be returned. The first column is 1.
mixed $not_exact_match determines if you are looking for an exact match based on lookup_value

Return Value

mixed The value of the found cell

static mixed HLOOKUP(mixed $lookup_value, mixed $lookup_array, mixed $index_number, mixed $not_exact_match = true)

HLOOKUP The HLOOKUP function searches for value in the top-most row of lookup_array and returns the value in the same column based on the index_number.

Parameters

mixed $lookup_value The value that you want to match in lookup_array
mixed $lookup_array The range of cells being searched
mixed $index_number The row number in table_array from which the matching value must be returned. The first row is 1.
mixed $not_exact_match determines if you are looking for an exact match based on lookup_value

Return Value

mixed The value of the found cell

static mixed LOOKUP(mixed $lookup_value, mixed $lookup_vector, null|mixed $result_vector = null)

LOOKUP The LOOKUP function searches for value either from a one-row or one-column range or from an array.

Parameters

mixed $lookup_value The value that you want to match in lookup_array
mixed $lookup_vector The range of cells being searched
null|mixed $result_vector The column from which the matching value must be returned

Return Value

mixed The value of the found cell

static string FORMULATEXT(mixed $cellReference = '', Cell $pCell = null)

FORMULATEXT.

Parameters

mixed $cellReference The cell to check
Cell $pCell The current cell (containing this formula)

Return Value

string