Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_Worksheet
  • PHPExcel_Worksheet_AutoFilter
  • PHPExcel_Worksheet_AutoFilter_Column
  • PHPExcel_Worksheet_AutoFilter_Column_Rule
  • PHPExcel_Worksheet_BaseDrawing
  • PHPExcel_Worksheet_CellIterator
  • PHPExcel_Worksheet_ColumnDimension
  • PHPExcel_Worksheet_HeaderFooter
  • PHPExcel_Worksheet_HeaderFooterDrawing
  • PHPExcel_Worksheet_MemoryDrawing
  • PHPExcel_Worksheet_PageMargins
  • PHPExcel_Worksheet_PageSetup
  • PHPExcel_Worksheet_Protection
  • PHPExcel_Worksheet_Row
  • PHPExcel_Worksheet_RowDimension
  • PHPExcel_Worksheet_RowIterator
  • PHPExcel_Worksheet_SheetView
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_Worksheet_AutoFilter

PHPExcel_Worksheet_AutoFilter

Package: PHPExcel\Worksheet
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Worksheet/AutoFilter.php
Methods summary
public
# __construct( string $pRange = '', PHPExcel_Worksheet $pSheet = NULL )

Create a new PHPExcel_Worksheet_AutoFilter

Create a new PHPExcel_Worksheet_AutoFilter

Parameters

$pRange
Cell range (i.e. A1:E10)
$pSheet
public PHPExcel_Worksheet
# getParent( )

Get AutoFilter Parent Worksheet

Get AutoFilter Parent Worksheet

Returns

PHPExcel_Worksheet
public PHPExcel_Worksheet_AutoFilter
# setParent( PHPExcel_Worksheet $pSheet = NULL )

Set AutoFilter Parent Worksheet

Set AutoFilter Parent Worksheet

Parameters

$pSheet

Returns

PHPExcel_Worksheet_AutoFilter
public string
# getRange( )

Get AutoFilter Range

Get AutoFilter Range

Returns

string
public PHPExcel_Worksheet_AutoFilter
# setRange( string $pRange = '' )

Set AutoFilter Range

Set AutoFilter Range

Parameters

$pRange
Cell range (i.e. A1:E10)

Returns

PHPExcel_Worksheet_AutoFilter

Throws

PHPExcel_Exception
public array
# getColumns( )

Get all AutoFilter Columns

Get all AutoFilter Columns

Returns

array
of PHPExcel_Worksheet_AutoFilter_Column

Throws

PHPExcel_Exception
public integer
# testColumnInRange( string $column )

Validate that the specified column is in the AutoFilter range

Validate that the specified column is in the AutoFilter range

Parameters

$column
Column name (e.g. A)

Returns

integer
The column offset within the autofilter range

Throws

PHPExcel_Exception
public integer
# getColumnOffset( string $pColumn )

Get a specified AutoFilter Column Offset within the defined AutoFilter range

Get a specified AutoFilter Column Offset within the defined AutoFilter range

Parameters

$pColumn
Column name (e.g. A)

Returns

integer
The offset of the specified column within the autofilter range

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter_Column
# getColumn( string $pColumn )

Get a specified AutoFilter Column

Get a specified AutoFilter Column

Parameters

$pColumn
Column name (e.g. A)

Returns

PHPExcel_Worksheet_AutoFilter_Column

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter_Column
# getColumnByOffset( integer $pColumnOffset = 0 )

Get a specified AutoFilter Column by it's offset

Get a specified AutoFilter Column by it's offset

Parameters

$pColumnOffset
Column offset within range (starting from 0)

Returns

PHPExcel_Worksheet_AutoFilter_Column

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter
# setColumn( PHPExcel_Worksheet_AutoFilter_Column|string $pColumn )

Set AutoFilter

Set AutoFilter

Parameters

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

Returns

PHPExcel_Worksheet_AutoFilter

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter
# clearColumn( string $pColumn )

Clear a specified AutoFilter Column

Clear a specified AutoFilter Column

Parameters

$pColumn
Column name (e.g. A)

Returns

PHPExcel_Worksheet_AutoFilter

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter
# shiftColumn( string $fromColumn = NULL, string $toColumn = NULL )

Shift an AutoFilter Column Rule to a different column

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

$fromColumn
Column name (e.g. A)
$toColumn
Column name (e.g. B)

Returns

PHPExcel_Worksheet_AutoFilter
private static boolean
# _filterTestInSimpleDataSet( mixed $cellValue, mixed[] $dataSet )

Test if cell value is in the defined set of values

Test if cell value is in the defined set of values

Parameters

$cellValue
$dataSet

Returns

boolean
private static boolean
# _filterTestInDateGroupSet( mixed $cellValue, mixed[] $dataSet )

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

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

Parameters

$cellValue
$dataSet

Returns

boolean
private static boolean
# _filterTestInCustomDataSet( mixed $cellValue, mixed[] $ruleSet )

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

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

Parameters

$cellValue
$ruleSet

Returns

boolean
private static boolean
# _filterTestInPeriodDateSet( mixed $cellValue, mixed[] $monthSet )

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

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

Parameters

$cellValue
$monthSet

Returns

boolean
private mixed[]
# _dynamicFilterDateRange( string $dynamicRuleType, PHPExcel_Worksheet_AutoFilter_Column & $filterColumn )

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

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

Parameters

$dynamicRuleType
$filterColumn
$filterColumn

Returns

mixed[]
private
# _calculateTopTenValue( $columnID, $startRow, $endRow, $ruleType, $ruleValue )
public PHPExcel_Worksheet_AutoFilter
# showHideRows( )

Apply the AutoFilter rules to the AutoFilter Range

Apply the AutoFilter rules to the AutoFilter Range

Returns

PHPExcel_Worksheet_AutoFilter

Throws

PHPExcel_Exception
public
# __clone( )

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

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

public
# __toString( )

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

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

Properties summary
private PHPExcel_Worksheet $_workSheet

Autofilter Worksheet

Autofilter Worksheet

# NULL
private string $_range

Autofilter Range

Autofilter Range

# ''
private array $_columns

Autofilter Column Ruleset

Autofilter Column Ruleset

# array()
private static array $_fromReplace

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

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

# array('\*', '\?', '~~', '~.*', '~.?')
private static array $_toReplace
# array('.*', '.', '~', '\*', '\?')
Autene API documentation generated by ApiGen