[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/phpexcel/PHPExcel/Worksheet/ -> AutoFilter.php (summary)

[Source view] [Print] [Project Stats]

(no description)

File Size: 846 lines (39 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PHPExcel_Worksheet_AutoFilter:: (22 methods):
  __construct()
  getParent()
  setParent()
  getRange()
  setRange()
  getColumns()
  testColumnInRange()
  getColumnOffset()
  getColumn()
  getColumnByOffset()
  setColumn()
  clearColumn()
  shiftColumn()
  filterTestInSimpleDataSet()
  filterTestInDateGroupSet()
  filterTestInCustomDataSet()
  filterTestInPeriodDateSet()
  dynamicFilterDateRange()
  calculateTopTenValue()
  showHideRows()
  __clone()
  __toString()


Class: PHPExcel_Worksheet_AutoFilter  - X-Ref

PHPExcel_Worksheet_AutoFilter

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

__construct($pRange = '', PHPExcel_Worksheet $pSheet = null)   X-Ref
Create a new PHPExcel_Worksheet_AutoFilter

param: string        $pRange        Cell range (i.e. A1:E10)
param: PHPExcel_Worksheet $pSheet

getParent()   X-Ref
Get AutoFilter Parent Worksheet

return: PHPExcel_Worksheet

setParent(PHPExcel_Worksheet $pSheet = null)   X-Ref
Set AutoFilter Parent Worksheet

param: PHPExcel_Worksheet $pSheet
return: PHPExcel_Worksheet_AutoFilter

getRange()   X-Ref
Get AutoFilter Range

return: string

setRange($pRange = '')   X-Ref
Set AutoFilter Range

param: string        $pRange        Cell range (i.e. A1:E10)
return: PHPExcel_Worksheet_AutoFilter

getColumns()   X-Ref
Get all AutoFilter Columns

return: array of PHPExcel_Worksheet_AutoFilter_Column

testColumnInRange($column)   X-Ref
Validate that the specified column is in the AutoFilter range

param: string    $column            Column name (e.g. A)
return: integer    The column offset within the autofilter range

getColumnOffset($pColumn)   X-Ref
Get a specified AutoFilter Column Offset within the defined AutoFilter range

param: string    $pColumn        Column name (e.g. A)
return: integer    The offset of the specified column within the autofilter range

getColumn($pColumn)   X-Ref
Get a specified AutoFilter Column

param: string    $pColumn        Column name (e.g. A)
return: PHPExcel_Worksheet_AutoFilter_Column

getColumnByOffset($pColumnOffset = 0)   X-Ref
Get a specified AutoFilter Column by it's offset

param: integer    $pColumnOffset        Column offset within range (starting from 0)
return: PHPExcel_Worksheet_AutoFilter_Column

setColumn($pColumn)   X-Ref
Set AutoFilter

param: PHPExcel_Worksheet_AutoFilter_Column|string        $pColumn
return: PHPExcel_Worksheet_AutoFilter

clearColumn($pColumn)   X-Ref
Clear a specified AutoFilter Column

param: string  $pColumn    Column name (e.g. A)
return: PHPExcel_Worksheet_AutoFilter

shiftColumn($fromColumn = null, $toColumn = null)   X-Ref
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.

param: string    $fromColumn        Column name (e.g. A)
param: string    $toColumn        Column name (e.g. B)
return: PHPExcel_Worksheet_AutoFilter

filterTestInSimpleDataSet($cellValue, $dataSet)   X-Ref
Test if cell value is in the defined set of values

param: mixed        $cellValue
param: mixed[]        $dataSet
return: boolean

filterTestInDateGroupSet($cellValue, $dataSet)   X-Ref
Test if cell value is in the defined set of Excel date values

param: mixed        $cellValue
param: mixed[]        $dataSet
return: boolean

filterTestInCustomDataSet($cellValue, $ruleSet)   X-Ref
Test if cell value is within a set of values defined by a ruleset

param: mixed        $cellValue
param: mixed[]        $ruleSet
return: boolean

filterTestInPeriodDateSet($cellValue, $monthSet)   X-Ref
Test if cell date value is matches a set of values defined by a set of months

param: mixed        $cellValue
param: mixed[]        $monthSet
return: boolean

dynamicFilterDateRange($dynamicRuleType, &$filterColumn)   X-Ref
Convert a dynamic rule daterange to a custom filter range expression for ease of calculation

param: string                                        $dynamicRuleType
param: PHPExcel_Worksheet_AutoFilter_Column        &$filterColumn
return: mixed[]

calculateTopTenValue($columnID, $startRow, $endRow, $ruleType, $ruleValue)   X-Ref
No description

showHideRows()   X-Ref
Apply the AutoFilter rules to the AutoFilter Range

return: PHPExcel_Worksheet_AutoFilter

__clone()   X-Ref
Implement PHP __clone to create a deep clone, not just a shallow copy.


__toString()   X-Ref
toString method replicates previous behavior by returning the range if object is
referenced as a property of its parent.



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1