\PhpOffice\PhpSpreadsheet\CalculationDatabase

Summary

Methods

Properties

Constants

DAVERAGE()
DCOUNT()
DCOUNTA()
DGET()
DMAX()
DMIN()
DPRODUCT()
DSTDEV()
DSTDEVP()
DSUM()
DVAR()
DVARP()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

fieldExtract()
filter()
getFilteredColumn()

No private properties found

N/A

File: vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Calculation/Database.php
Package: Default
Class hierarchy: \PhpOffice\PhpSpreadsheet\Calculation\Database

Methods

DAVERAGE()

DAVERAGE(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float|string

DAVERAGE.

Averages the values in a column of a list or database that match conditions you specify.

Excel Function: DAVERAGE(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float|string

DCOUNT()

DCOUNT(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : integer

DCOUNT.

Counts the cells that contain numbers in a column of a list or database that match conditions that you specify.

Excel Function: DCOUNT(database,[field],criteria)

Excel Function: DAVERAGE(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

integer

static

Inherited from: \PhpOffice\PhpSpreadsheet\Calculation\Database

Tags

TODO	The field argument is optional. If field is omitted, DCOUNTA counts all records in the database that match the criteria.

DGET()

DGET(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : mixed

DGET.

Extracts a single value from a column of a list or database that matches conditions that you specify.

Excel Function: DGET(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

mixed

DMAX()

DMAX(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float

DMAX.

Returns the largest number in a column of a list or database that matches conditions you that specify.

Excel Function: DMAX(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float

DMIN()

DMIN(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float

DMIN.

Returns the smallest number in a column of a list or database that matches conditions you that specify.

Excel Function: DMIN(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float

DPRODUCT()

DPRODUCT(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float

DPRODUCT.

Multiplies the values in a column of a list or database that match conditions that you specify.

Excel Function: DPRODUCT(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float

DSTDEV()

DSTDEV(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float|string

DSTDEV.

Estimates the standard deviation of a population based on a sample by using the numbers in a column of a list or database that match conditions that you specify.

Excel Function: DSTDEV(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float|string

DSTDEVP()

DSTDEVP(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float|string

DSTDEVP.

Calculates the standard deviation of a population based on the entire population by using the numbers in a column of a list or database that match conditions that you specify.

Excel Function: DSTDEVP(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float|string

DSUM()

DSUM(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float

DSUM.

Adds the numbers in a column of a list or database that match conditions that you specify.

Excel Function: DSUM(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float

DVAR()

DVAR(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float

DVAR.

Estimates the variance of a population based on a sample by using the numbers in a column of a list or database that match conditions that you specify.

Excel Function: DVAR(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float

DVARP()

DVARP(array<mixed,mixed>  $database, integer|string  $field, array<mixed,mixed>  $criteria) : float

DVARP.

Calculates the variance of a population based on the entire population by using the numbers in a column of a list or database that match conditions that you specify.

Excel Function: DVARP(database,field,criteria)

Parameters

array<mixed,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.
integer\|string	$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.
array<mixed,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.

Returns

float

fieldExtract()

fieldExtract(array<mixed,mixed>  $database, mixed  $field) : null|string

fieldExtract.

Extracts the column ID to use for the data field.

Parameters

array<mixed,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.
mixed	$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.

Returns

null|string

filter()

filter(array<mixed,mixed>  $database, array<mixed,mixed>  $criteria) : array

filter.

Parses the selection criteria, extracts the database rows that match those criteria, and returns that subset of rows.

Parameters

array<mixed,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.
array<mixed,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.

Returns

array —

of mixed

getFilteredColumn()

getFilteredColumn(  $database,   $field,   $criteria)

Parameters

	$database
	$field
	$criteria