Gitee
\
app
admin
controller
model
validate
chengji
controller
model
validate
common
controller
model
validate
home
controller
http
middleware
index
controller
kaoshi
controller
model
validate
Keti
model
keti
controller
model
validate
login
controller
validate
member
controller
renshi
controller
model
validate
rongyu
controller
model
validate
system
controller
model
validate
teach
controller
model
validate
BaconQrCode
Common
Encoder
Exception
Renderer
Color
Image
Decorator
Text
Common
Tests
Adapter
Zip
Complex
Composer
Autoload
Endroid
Installer
Tests
QrCode
Exception
Factory
Response
Tests
Writer
Khanamiryan
QrCodeTests
MyCLabs
Enum
Phinx
Db
Adapter
Table
Migration
Seed
Util
php4world
PhpOffice
Common
Adapter
Zip
Microsoft
Tests
Microsoft
PhpPowerpoint
Tests
PhpSpreadsheet
Calculation
Engine
Token
Cell
Chart
Renderer
Collection
Document
Helper
Reader
Xls
Color
Style
Xlsx
RichText
Shared
Escher
DgContainer
SpgrContainer
DggContainer
BstoreContainer
BSE
JAMA
OLE
PPS
Trend
Style
Worksheet
AutoFilter
Column
Drawing
Writer
Ods
Cell
Pdf
Xls
Xlsx
PhpWord
Collection
ComplexType
Element
Escaper
Exception
Metadata
Reader
ODText
RTF
Word2007
Shared
SimpleType
Style
Writer
HTML
Element
Part
Style
ODText
Element
Part
Style
PDF
RTF
Element
Part
Style
Word2007
Element
Part
Style
Psr
SimpleCache
Samples
Sample09
Sample10
Sample12
Sample14
Symfony
Component
Inflector
Tests
OptionsResolver
Debug
Exception
Tests
Debug
PropertyAccess
Exception
Tests
Fixtures
Polyfill
Ctype
think
cache
driver
captcha
composer
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
db
builder
connector
exception
debug
exception
facade
helper
hash
log
driver
migration
command
migrate
seed
db
model
concern
relation
paginator
driver
process
exception
pipes
response
route
dispatch
session
driver
template
driver
taglib
validate
view
driver
traits
controller
WhiteHat101
Crypt
Zend
Escaper
Exception
Zxing
Common
CharacterSetEci
AbstractEnum
Detector
Reedsolomon
Qrcode
Decoder
Detector

\PhpOffice\PhpSpreadsheet\WorksheetAutoFilter

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

$range

$range : string

Autofilter Range.

Type

string

$fromReplace

$fromReplace : array

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

Type

array

$toReplace

$toReplace :

Type

Methods

__construct()

__construct(string  $pRange = '', \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet = null)

Create a new AutoFilter.

Parameters

string $pRange

Cell range (i.e. A1:E10)
\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

getRange()

getRange() : string

Get AutoFilter Range.

Returns

string

setRange()

setRange(string  $pRange) : \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter

Set AutoFilter Range.

Parameters

string $pRange

Cell range (i.e. A1:E10)

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter

testColumnInRange()

testColumnInRange(string  $column) : integer

Validate that the specified column is in the AutoFilter range.

Parameters

string $column

Column name (e.g. A)

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

integer —

The column offset within the autofilter range

getColumnOffset()

getColumnOffset(string  $pColumn) : integer

Get a specified AutoFilter Column Offset within the defined AutoFilter range.

Parameters

string $pColumn

Column name (e.g. A)

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

integer —

The offset of the specified column within the autofilter range

getColumn()

getColumn(string  $pColumn) : \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

Get a specified AutoFilter Column.

Parameters

string $pColumn

Column name (e.g. A)

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

getColumnByOffset()

getColumnByOffset(integer  $pColumnOffset) : \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

Get a specified AutoFilter Column by it's offset.

Parameters

integer $pColumnOffset

Column offset within range (starting from 0)

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

clearColumn()

clearColumn(string  $pColumn) : \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter

Clear a specified AutoFilter Column.

Parameters

string $pColumn

Column name (e.g. A)

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter

shiftColumn()

shiftColumn(string  $fromColumn, string  $toColumn) : \PhpOffice\PhpSpreadsheet\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 override any existing value. Use with caution.

Parameters

string $fromColumn

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

Column name (e.g. B)

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter

showHideRows()

showHideRows() : \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter

Apply the AutoFilter rules to the AutoFilter Range.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter

__clone()

__clone()

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

__toString()

__toString()

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

filterTestInSimpleDataSet()

filterTestInSimpleDataSet(mixed  $cellValue, array<mixed,mixed>  $dataSet) : boolean

Test if cell value is in the defined set of values.

Parameters

mixed $cellValue
array<mixed,mixed> $dataSet

Returns

boolean

filterTestInDateGroupSet()

filterTestInDateGroupSet(mixed  $cellValue, array<mixed,mixed>  $dataSet) : boolean

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

Parameters

mixed $cellValue
array<mixed,mixed> $dataSet

Returns

boolean

filterTestInCustomDataSet()

filterTestInCustomDataSet(mixed  $cellValue, array<mixed,mixed>  $ruleSet) : boolean

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

Parameters

mixed $cellValue
array<mixed,mixed> $ruleSet

Returns

boolean

filterTestInPeriodDateSet()

filterTestInPeriodDateSet(mixed  $cellValue, array<mixed,mixed>  $monthSet) : boolean

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

Parameters

mixed $cellValue
array<mixed,mixed> $monthSet

Returns

boolean

dynamicFilterDateRange()

dynamicFilterDateRange(string  $dynamicRuleType, \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column  $filterColumn) : array<mixed,mixed>

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

Parameters

string $dynamicRuleType
\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column $filterColumn

Returns

array<mixed,mixed>

calculateTopTenValue()

calculateTopTenValue(  $columnID,   $startRow,   $endRow,   $ruleType,   $ruleValue)

Parameters

$columnID
$startRow
$endRow
$ruleType
$ruleValue