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_Column

PHPExcel_Worksheet_AutoFilter_Column

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/Column.php
Methods summary
public
# __construct( string $pColumn, PHPExcel_Worksheet_AutoFilter $pParent = NULL )

Create a new PHPExcel_Worksheet_AutoFilter_Column

Create a new PHPExcel_Worksheet_AutoFilter_Column

Parameters

$pColumn
Column (e.g. A)
$pParent
Autofilter for this column
public string
# getColumnIndex( )

Get AutoFilter Column Index

Get AutoFilter Column Index

Returns

string
public PHPExcel_Worksheet_AutoFilter_Column
# setColumnIndex( string $pColumn )

Set AutoFilter Column Index

Set AutoFilter Column Index

Parameters

$pColumn
Column (e.g. A)

Returns

PHPExcel_Worksheet_AutoFilter_Column

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter
# getParent( )

Get this Column's AutoFilter Parent

Get this Column's AutoFilter Parent

Returns

PHPExcel_Worksheet_AutoFilter
public PHPExcel_Worksheet_AutoFilter_Column
# setParent( PHPExcel_Worksheet_AutoFilter $pParent = NULL )

Set this Column's AutoFilter Parent

Set this Column's AutoFilter Parent

Parameters

$pParent

Returns

PHPExcel_Worksheet_AutoFilter_Column
public string
# getFilterType( )

Get AutoFilter Type

Get AutoFilter Type

Returns

string
public PHPExcel_Worksheet_AutoFilter_Column
# setFilterType( string $pFilterType = PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_FILTERTYPE_FILTER )

Set AutoFilter Type

Set AutoFilter Type

Parameters

$pFilterType

Returns

PHPExcel_Worksheet_AutoFilter_Column

Throws

PHPExcel_Exception
public string
# getJoin( )

Get AutoFilter Multiple Rules And/Or Join

Get AutoFilter Multiple Rules And/Or Join

Returns

string
public PHPExcel_Worksheet_AutoFilter_Column
# setJoin( string $pJoin = PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_COLUMN_JOIN_OR )

Set AutoFilter Multiple Rules And/Or

Set AutoFilter Multiple Rules And/Or

Parameters

$pJoin
And/Or

Returns

PHPExcel_Worksheet_AutoFilter_Column

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter_Column
# setAttributes( string[] $pAttributes = array() )

Set AutoFilter Attributes

Set AutoFilter Attributes

Parameters

$pAttributes

Returns

PHPExcel_Worksheet_AutoFilter_Column

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter_Column
# setAttribute( string $pName, string $pValue )

Set An AutoFilter Attribute

Set An AutoFilter Attribute

Parameters

$pName
Attribute Name
$pValue
Attribute Value

Returns

PHPExcel_Worksheet_AutoFilter_Column

Throws

PHPExcel_Exception
public string
# getAttributes( )

Get AutoFilter Column Attributes

Get AutoFilter Column Attributes

Returns

string
public string
# getAttribute( string $pName )

Get specific AutoFilter Column Attribute

Get specific AutoFilter Column Attribute

Parameters

$pName
Attribute Name

Returns

string
public array
# getRules( )

Get all AutoFilter Column Rules

Get all AutoFilter Column Rules

Returns

array
of PHPExcel_Worksheet_AutoFilter_Column_Rule

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_AutoFilter_Column_Rule
# getRule( integer $pIndex )

Get a specified AutoFilter Column Rule

Get a specified AutoFilter Column Rule

Parameters

$pIndex
Rule index in the ruleset array

Returns

PHPExcel_Worksheet_AutoFilter_Column_Rule
public PHPExcel_Worksheet_AutoFilter_Column_Rule
# createRule( )

Create a new AutoFilter Column Rule in the ruleset

Create a new AutoFilter Column Rule in the ruleset

Returns

PHPExcel_Worksheet_AutoFilter_Column_Rule
public PHPExcel_Worksheet_AutoFilter_Column|PHPExcel_Worksheet_AutoFilter_Column_Rule
# addRule( PHPExcel_Worksheet_AutoFilter_Column_Rule $pRule, boolean $returnRule = TRUE )

Add a new AutoFilter Column Rule to the ruleset

Add a new AutoFilter Column Rule to the ruleset

Parameters

$pRule
$returnRule
Flag indicating whether the rule object or the column object should be returned

Returns

PHPExcel_Worksheet_AutoFilter_Column|PHPExcel_Worksheet_AutoFilter_Column_Rule
public PHPExcel_Worksheet_AutoFilter_Column
# deleteRule( integer $pIndex )

Delete a specified AutoFilter Column Rule If the number of rules is reduced to 1, then we reset And/Or logic to Or

Delete a specified AutoFilter Column Rule If the number of rules is reduced to 1, then we reset And/Or logic to Or

Parameters

$pIndex
Rule index in the ruleset array

Returns

PHPExcel_Worksheet_AutoFilter_Column
public PHPExcel_Worksheet_AutoFilter_Column
# clearRules( )

Delete all AutoFilter Column Rules

Delete all AutoFilter Column Rules

Returns

PHPExcel_Worksheet_AutoFilter_Column
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.

Constants summary
string AUTOFILTER_FILTERTYPE_FILTER
# 'filters'
string AUTOFILTER_FILTERTYPE_CUSTOMFILTER
# 'customFilters'
string AUTOFILTER_FILTERTYPE_DYNAMICFILTER
# 'dynamicFilter'
string AUTOFILTER_FILTERTYPE_TOPTENFILTER
# 'top10'
string AUTOFILTER_COLUMN_JOIN_AND
# 'and'
string AUTOFILTER_COLUMN_JOIN_OR
# 'or'
Properties summary
private static string[] $_filterTypes

Types of autofilter rules

Types of autofilter rules

# array( // Currently we're not handling // colorFilter // extLst // iconFilter self::AUTOFILTER_FILTERTYPE_FILTER, self::AUTOFILTER_FILTERTYPE_CUSTOMFILTER, self::AUTOFILTER_FILTERTYPE_DYNAMICFILTER, self::AUTOFILTER_FILTERTYPE_TOPTENFILTER, )
private static string[] $_ruleJoins

Join options for autofilter rules

Join options for autofilter rules

# array( self::AUTOFILTER_COLUMN_JOIN_AND, self::AUTOFILTER_COLUMN_JOIN_OR, )
private PHPExcel_Worksheet_AutoFilter $_parent

Autofilter

Autofilter

# NULL
private string $_columnIndex

Autofilter Column Index

Autofilter Column Index

# ''
private string $_filterType

Autofilter Column Filter Type

Autofilter Column Filter Type

# PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_FILTERTYPE_FILTER
private string $_join

Autofilter Multiple Rules And/Or

Autofilter Multiple Rules And/Or

# PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_COLUMN_JOIN_OR
private array $_ruleset

Autofilter Column Rules

Autofilter Column Rules

# array()
private array $_attributes

Autofilter Column Dynamic Attributes

Autofilter Column Dynamic Attributes

# array()
Autene API documentation generated by ApiGen