Gitee
\
admin
login
classes
systemlog
classes
Composer
Autoload
core
dzz
Guzzle
Tests
Service
Description
GuzzleHttp
Command
Exception
Guzzle
Handler
QuerySerializer
RequestLocation
ResponseLocation
Cookie
Exception
Handler
Promise
Psr7
Tests
Command
Guzzle
Asset
Exception
Handler
QuerySerializer
RequestLocation
ResponseLocation
misc
classes
Psr
Http
Message
Qcloud
Cos
Exception
Request
Tests
user
classes
login
classes
profile
classes
register
classes
sso
classes

\PHPExcel_Worksheet_AutoFilter

PHPExcel_Worksheet_AutoFilter

Summary

Methods
Properties
Constants
__construct()
getParent()
setParent()
getRange()
setRange()
getColumns()
testColumnInRange()
getColumnOffset()
getColumn()
getColumnByOffset()
setColumn()
clearColumn()
shiftColumn()
showHideRows()
__clone()
__toString()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
_filterTestInSimpleDataSet()
_filterTestInDateGroupSet()
_filterTestInCustomDataSet()
_filterTestInPeriodDateSet()
_dynamicFilterDateRange()
_calculateTopTenValue()
$_workSheet
$_range
$_columns
$_fromReplace
$_toReplace
N/A

Properties

$_workSheet

$_workSheet : \PHPExcel_Worksheet

Autofilter Worksheet

Type

PHPExcel_Worksheet —

$_range

$_range : string

Autofilter Range

Type

string —

$_columns

$_columns : array

Autofilter Column Ruleset

Type

array — of PHPExcel_Worksheet_AutoFilter_Column

$_fromReplace

$_fromReplace : array

Search/Replace arrays to convert Excel wildcard syntax to a regexp syntax for preg_matching

Type

array —

$_toReplace

$_toReplace

Methods

__construct()

__construct(string  $pRange = '', \PHPExcel_Worksheet  $pSheet = NULL) : mixed

Create a new PHPExcel_Worksheet_AutoFilter

Parameters

string $pRange

Cell range (i.e. A1:E10)
\PHPExcel_Worksheet $pSheet

Returns

mixed —

getParent()

getParent() : \PHPExcel_Worksheet

Get AutoFilter Parent Worksheet

Returns

\PHPExcel_Worksheet —

setParent()

setParent(\PHPExcel_Worksheet  $pSheet = NULL) : \PHPExcel_Worksheet_AutoFilter

Set AutoFilter Parent Worksheet

Parameters

\PHPExcel_Worksheet $pSheet

Returns

\PHPExcel_Worksheet_AutoFilter —

getRange()

getRange() : string

Get AutoFilter Range

Returns

string —

setRange()

setRange(string  $pRange = '') : \PHPExcel_Worksheet_AutoFilter

Set AutoFilter Range

Parameters

string $pRange

Cell range (i.e. A1:E10)

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter —

getColumns()

getColumns() : array

Get all AutoFilter Columns

Throws

\PHPExcel_Exception

Returns

array —

of PHPExcel_Worksheet_AutoFilter_Column

testColumnInRange()

testColumnInRange(string  $column) : int

Validate that the specified column is in the AutoFilter range

Parameters

string $column

Column name (e.g. A)

Throws

\PHPExcel_Exception

Returns

int —

The column offset within the autofilter range

getColumnOffset()

getColumnOffset(string  $pColumn) : int

Get a specified AutoFilter Column Offset within the defined AutoFilter range

Parameters

string $pColumn

Column name (e.g. A)

Throws

\PHPExcel_Exception

Returns

int —

The offset of the specified column within the autofilter range

getColumn()

getColumn(string  $pColumn) : \PHPExcel_Worksheet_AutoFilter_Column

Get a specified AutoFilter Column

Parameters

string $pColumn

Column name (e.g. A)

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

getColumnByOffset()

getColumnByOffset(int  $pColumnOffset) : \PHPExcel_Worksheet_AutoFilter_Column

Get a specified AutoFilter Column by it's offset

Parameters

int $pColumnOffset

Column offset within range (starting from 0)

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

setColumn()

setColumn(\PHPExcel_Worksheet_AutoFilter_Column|string  $pColumn) : \PHPExcel_Worksheet_AutoFilter

Set AutoFilter

Parameters

\PHPExcel_Worksheet_AutoFilter_Column|string $pColumn

A simple string containing a Column ID like 'A' is permitted

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter —

clearColumn()

clearColumn(string  $pColumn) : \PHPExcel_Worksheet_AutoFilter

Clear a specified AutoFilter Column

Parameters

string $pColumn

Column name (e.g. A)

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter —

shiftColumn()

shiftColumn(string  $fromColumn = NULL, string  $toColumn = NULL) : \PHPExcel_Worksheet_AutoFilter

Shift an AutoFilter Column Rule to a different column

Note: This method bypasses validation of the destination column to ensure it is within this AutoFilter range. Nor does it verify whether any column rule already exists at $toColumn, but will simply overrideany existing value. Use with caution.

Parameters

string $fromColumn

Column name (e.g. A)
string $toColumn

Column name (e.g. B)

Returns

\PHPExcel_Worksheet_AutoFilter —

showHideRows()

showHideRows() : \PHPExcel_Worksheet_AutoFilter

Apply the AutoFilter rules to the AutoFilter Range

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter —

__clone()

__clone() : mixed

Implement PHP __clone to create a deep clone, not just a shallow copy.

Returns

mixed —

__toString()

__toString() : mixed

toString method replicates previous behavior by returning the range if object is referenced as a property of its parent.

Returns

mixed —

_filterTestInSimpleDataSet()

_filterTestInSimpleDataSet(mixed  $cellValue, array  $dataSet) : bool

Test if cell value is in the defined set of values

Parameters

mixed $cellValue
array $dataSet

Returns

bool —

_filterTestInDateGroupSet()

_filterTestInDateGroupSet(mixed  $cellValue, array  $dataSet) : bool

Test if cell value is in the defined set of Excel date values

Parameters

mixed $cellValue
array $dataSet

Returns

bool —

_filterTestInCustomDataSet()

_filterTestInCustomDataSet(mixed  $cellValue, array  $ruleSet) : bool

Test if cell value is within a set of values defined by a ruleset

Parameters

mixed $cellValue
array $ruleSet

Returns

bool —

_filterTestInPeriodDateSet()

_filterTestInPeriodDateSet(mixed  $cellValue, array  $monthSet) : bool

Test if cell date value is matches a set of values defined by a set of months

Parameters

mixed $cellValue
array $monthSet

Returns

bool —

_dynamicFilterDateRange()

_dynamicFilterDateRange(string  $dynamicRuleType, \PHPExcel_Worksheet_AutoFilter_Column  $filterColumn) : array

Convert a dynamic rule daterange to a custom filter range expression for ease of calculation

Parameters

string $dynamicRuleType
\PHPExcel_Worksheet_AutoFilter_Column $filterColumn

Returns

array —

_calculateTopTenValue()

_calculateTopTenValue(mixed  $columnID, mixed  $startRow, mixed  $endRow, mixed  $ruleType, mixed  $ruleValue) : mixed

Parameters

mixed $columnID
mixed $startRow
mixed $endRow
mixed $ruleType
mixed $ruleValue

Returns

mixed —