From 4347e0635a2b05559cd181d3f8e991a6a649ddba Mon Sep 17 00:00:00 2001 From: Mark Baker Date: Sun, 25 Mar 2012 23:58:02 +0000 Subject: [PATCH] Doc Block changes git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@88405 2327b42d-5241-43d6-9e2a-de5ac946f064 --- Classes/PHPExcel/Calculation/Database.php | 78 +++++++++-------------- 1 file changed, 30 insertions(+), 48 deletions(-) diff --git a/Classes/PHPExcel/Calculation/Database.php b/Classes/PHPExcel/Calculation/Database.php index d46c098..02f2700 100644 --- a/Classes/PHPExcel/Calculation/Database.php +++ b/Classes/PHPExcel/Calculation/Database.php @@ -258,16 +258,16 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the @@ -308,24 +308,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return mixed * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DGET($database,$field,$criteria) { $field = self::__fieldExtract($database,$field); @@ -361,24 +359,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return float * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DMAX($database,$field,$criteria) { $field = self::__fieldExtract($database,$field); @@ -410,24 +406,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return float * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DMIN($database,$field,$criteria) { $field = self::__fieldExtract($database,$field); @@ -458,24 +452,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return float * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DPRODUCT($database,$field,$criteria) { $field = self::__fieldExtract($database,$field); @@ -507,24 +499,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return float * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DSTDEV($database,$field,$criteria) { $field = self::__fieldExtract($database,$field); @@ -556,24 +546,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return float * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DSTDEVP($database,$field,$criteria) { $field = self::__fieldExtract($database,$field); @@ -604,24 +592,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return float * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DSUM($database,$field,$criteria) { $field = self::__fieldExtract($database,$field); @@ -653,24 +639,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return float * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DVAR($database,$field,$criteria) { $field = self::__fieldExtract($database,$field); @@ -702,24 +686,22 @@ class PHPExcel_Calculation_Database { * * @access public * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * @return float * - * @TODO Numeric value in $field to reference a column position rather than a name. - * */ public static function DVARP($database,$field,$criteria) { $field = self::__fieldExtract($database,$field);