alex/PhpSpreadsheet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Doc Block changes

Browse Source 
git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@88405 2327b42d-5241-43d6-9e2a-de5ac946f064
This commit is contained in:
Mark Baker 2012-03-25 23:58:02 +00:00
parent a2560b45f7
commit 4347e0635a
1 changed files with 30 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
Classes/PHPExcel/Calculation/Database.php
View File

@ -258,16 +258,16 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
@ -308,24 +308,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return mixed * @return mixed
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DGET($database,$field,$criteria) { public static function DGET($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);
@ -361,24 +359,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return float * @return float
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DMAX($database,$field,$criteria) { public static function DMAX($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);
@ -410,24 +406,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return float * @return float
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DMIN($database,$field,$criteria) { public static function DMIN($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);
@ -458,24 +452,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return float * @return float
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DPRODUCT($database,$field,$criteria) { public static function DPRODUCT($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);
@ -507,24 +499,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return float * @return float
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DSTDEV($database,$field,$criteria) { public static function DSTDEV($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);
@ -556,24 +546,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return float * @return float
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DSTDEVP($database,$field,$criteria) { public static function DSTDEVP($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);
@ -604,24 +592,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return float * @return float
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DSUM($database,$field,$criteria) { public static function DSUM($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);
@ -653,24 +639,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return float * @return float
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DVAR($database,$field,$criteria) { public static function DVAR($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);
@ -702,24 +686,22 @@ class PHPExcel_Calculation_Database {
* *
* @access public * @access public
* @category Database Functions * @category Database Functions
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $field Indicates which column is used in the function. Enter the * @param string|integer $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* @return float * @return float
* *
* @TODO Numeric value in $field to reference a column position rather than a name.
*
*/ */
public static function DVARP($database,$field,$criteria) { public static function DVARP($database,$field,$criteria) {
$field = self::__fieldExtract($database,$field); $field = self::__fieldExtract($database,$field);