Merge pull request #177 from johmue/php_excel370

beta for libxl 3.7.x

docs/ExcelAutoFilter.php

@@ -0,0 +1,107 @@
+<?php
+/*
+  +---------------------------------------------------------------------------+
+  | ExcelAutoFilter                                                           |
+  |                                                                           |
+  | Reference file for NuSphere PHPEd (and possibly other IDE's) for use with |
+  | php_excel interface to libxl by Ilia Alshanetsky <[email protected]>           |
+  |                                                                           |
+  | php_excel "PECL" style module (http://github.com/iliaal/php_excel)        |
+  | libxl library (http://www.libxl.com)                                      |
+  |                                                                           |
+  +---------------------------------------------------------------------------+
+*/
+class ExcelAutoFilter
+{
+	/**
+	* Create a AutoFilter within an Excel sheet
+	*
+	* @see ExcelSheet::autofilter()
+	* @param ExcelSheet $sheet
+	* @return ExcelAutoFilter
+	*/
+	public function __construct($sheet)
+	{
+	} // __construct
+
+	/**
+	* Gets the cell range of AutoFilter with header.
+	*
+	* @return array with keys "row_first"(int), "col_first"(int), "row_last"(int), "col_last"(int)
+	*/
+	public function getRef()
+	{
+	} // getRef
+
+	/**
+	* Sets the cell range of AutoFilter with header.
+	*
+	* @param int $row_first 0-based (optional, default = 0)
+	* @param int $col_first 0-based (optional, default = 0)
+	* @param int $row_last 0-based (optional, default = 0)
+	* @param int $col_last 0-based (optional, default = 0)
+	* @return void
+	*/
+	public function setRef($row_first=0, $col_first=0, $row_last=0, $col_last=0)
+	{
+	} // setRef
+
+	/**
+	* Returns the AutoFilter column by zero-based index. Creates it if it doesn't exist.
+	*
+	* @param int $colId 0-based
+	* @return ExcelFilterColumn
+	*/
+	public function column($colId)
+	{
+	} // column
+
+	/**
+	* Returns the number of specified AutoFilter columns which have a filter information.
+	*
+	* @return int
+	*/
+	public function columnSize()
+	{
+	} // columnSize
+
+	/**
+	* Returns the specified AutoFilter column which have a filter information by index.
+	*
+	* @param int $index 0-based
+	* @return ExcelFilterColumn
+	*/
+	public function columnByIndex($index)
+	{
+	} // columnByIndex
+
+	/**
+	* Gets the whole range of data to sort.
+	*
+	* @return array with keys "row_first"(int), "col_first"(int), "row_last"(int), "col_last"(int)
+	*/
+	public function getSortRange()
+	{
+	} // getSortRange
+
+	/**
+	* Gets the zero-based index of sorted column in AutoFilter and its sort order.
+	*
+	* @return array with keys "column_index"(int), "descending"(bool),
+	*/
+	public function getSort()
+	{
+	} // getSort
+
+	/**
+	* Sets the sorted column in AutoFilter by zero-based index and its sort order.
+	*
+	* @param int $columnIndex 0-based
+	* @param bool $descending
+	* @return bool
+	*/
+	public function setSort($columnIndex, $descending)
+	{
+	} // setSort
+
+} // end ExcelAutoFilter

docs/ExcelFilterColumn.php

@@ -0,0 +1,143 @@
+<?php
+/*
+  +---------------------------------------------------------------------------+
+  | ExcelFilterColumn                                                         |
+  |                                                                           |
+  | Reference file for NuSphere PHPEd (and possibly other IDE's) for use with |
+  | php_excel interface to libxl by Ilia Alshanetsky <[email protected]>           |
+  |                                                                           |
+  | php_excel "PECL" style module (http://github.com/iliaal/php_excel)        |
+  | libxl library (http://www.libxl.com)                                      |
+  |                                                                           |
+  +---------------------------------------------------------------------------+
+*/
+class ExcelFilterColumn
+{
+	const FILTER_VALUE = 0;
+	const FILTER_TOP10 = 1;
+	const FILTER_CUSTOM = 2;
+	const FILTER_DYNAMIC = 3;
+	const FILTER_COLOR = 4;
+	const FILTER_ICON = 5;
+	const FILTER_EXT = 6;
+	const FILTER_NOT_SET = 7;
+
+	const OPERATOR_EQUAL = 0;
+	const OPERATOR_GREATER_THAN = 1;
+	const OPERATOR_GREATER_THAN_OR_EQUAL = 2;
+	const OPERATOR_LESS_THAN = 3;
+	const OPERATOR_LESS_THAN_OR_EQUAL = 4;
+	const OPERATOR_NOT_EQUAL = 5;
+
+	/**
+	* Create a filter column within an Excel auto filter
+	*
+	* @see ExcelAutoFilter::column()
+	* @param ExcelAutoFilter $autoFilter
+	* @return ExcelFilterColumn
+	*/
+	public function __construct($autoFilter)
+	{
+	} // __construct
+
+	/**
+	* Returns the zero-based index of this AutoFilter column.
+	*
+	* @return int
+	*/
+	public function index()
+	{
+	} // index
+
+	/**
+	* Returns the filter type of this AutoFilter column.
+	*
+	* @return int One of ExcelFilterColumn::FILTER_* constants
+	*/
+	public function filterType()
+	{
+	} // filterType
+
+	/**
+	* Returns the number of filter values.
+	*
+	* @return int
+	*/
+	public function filterSize()
+	{
+	} // filterSize
+
+	/**
+	* Returns the filter value by index.
+	*
+	* @param int $index
+	* @return string filter value
+	*/
+	public function filter($index)
+	{
+	} // filter
+
+	/**
+	* Adds the filter value.
+	*
+	* @param string $filterValue
+	* @return void
+	*/
+	public function addFilter($filterValue)
+	{
+	} // addFilter
+
+	/**
+	* Gets the number of top or bottom items:
+	*
+	* @return array with keys "value"(float), "top"(bool) and "percent"(bool)
+	*/
+	public function getTop10()
+	{
+	} // getTop10
+
+	/**
+	* Sets the number of top or bottom items:
+	*
+	* @param float $value - number of items;
+	* @param bool $top - top items if true otherwise bottom items; (optional, default = true)
+	* @param bool $percent - using percent instead of number items. (optional, default = false)
+	* @return bool
+	*/
+	public function setTop10($value, $top=true, $percent=false)
+	{
+	} // setTop10
+
+	/**
+	* Gets the custom filter criteria:
+	*
+	* @return array with keys "operator_1"(int), "value_1"(string), "operator_2"(int), "value_2"(string) and "andOp"(bool)
+	*/
+	public function getCustomFilter()
+	{
+	} // getCustomFilter
+
+	/**
+	* Sets the custom filter criteria.
+	*
+	* @param int $op1 - one of ExcelFilterColumn::OPERATOR_* constants - operator used by the filter comparison in the first filter criteria;
+	* @param string $v1 - value used in the first filter criteria;
+	* @param int $op2 - one of ExcelFilterColumn::OPERATOR_* constants - operator used by the filter comparison in the second filter criteria; (optional, default = -1)
+	* @param string $v2 - value used in the second filter criteria; (optional, default = null)
+	* @param bool $andOp - flag indicating whether the two criterias have an "and" relationship. True indicates "and", false indicates "or". (optional, default = false)
+	* @return void
+	*/
+	public function setCustomFilter($op1, $v1, $op2=-1, $v2=null, $andOp=false)
+	{
+	} // setCustomFilter
+
+	/**
+	* Clear the filter criteria.
+	*
+	* @return bool
+	*/
+	public function clear()
+	{
+	} // clear
+
+} // end ExcelFilterColumn