Documentation

Database

Tags
deprecated
1.17.0
codeCoverageIgnore

Table of Contents

DAVERAGE()  : float|string
DAVERAGE.
DCOUNT()  : int|string
DCOUNT.
DCOUNTA()  : int|string
DCOUNTA.
DGET()  : mixed
DGET.
DMAX()  : null|float|string
DMAX.
DMIN()  : null|float|string
DMIN.
DPRODUCT()  : float|string
DPRODUCT.
DSTDEV()  : float|string
DSTDEV.
DSTDEVP()  : float|string
DSTDEVP.
DSUM()  : null|float|string
DSUM.
DVAR()  : float|string
DVAR.
DVARP()  : float|string
DVARP.

Methods

DAVERAGE()

DAVERAGE.

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

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

Excel Function: DAVERAGE(database,field,criteria)

Parameters
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DAverage class instead

see
DAverage::evaluate()
Return values
float|string —

DCOUNT()

DCOUNT.

public static DCOUNT(array<string|int, mixed> $database, null|int|string $field, array<string|int, mixed> $criteria) : int|string

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)

Parameters
$database : array<string|int, mixed>

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.

$field : null|int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DCount class instead

see
DCount::evaluate()
TODO

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

Return values
int|string —

DCOUNTA()

DCOUNTA.

public static DCOUNTA(array<string|int, mixed> $database, int|string $field, array<string|int, mixed> $criteria) : int|string

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

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

Parameters
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DCountA class instead

see
DCountA::evaluate()
Return values
int|string —

DGET()

DGET.

public static DGET(array<string|int, mixed> $database, int|string $field, array<string|int, mixed> $criteria) : mixed

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
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DGet class instead

see
DGet::evaluate()
Return values
mixed —

DMAX()

DMAX.

public static DMAX(array<string|int, mixed> $database, int|string $field, array<string|int, mixed> $criteria) : null|float|string

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
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DMax class instead

see
DMax::evaluate()
Return values
null|float|string —

DMIN()

DMIN.

public static DMIN(array<string|int, mixed> $database, int|string $field, array<string|int, mixed> $criteria) : null|float|string

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
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DMin class instead

see
DMin::evaluate()
Return values
null|float|string —

DPRODUCT()

DPRODUCT.

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

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

Excel Function: DPRODUCT(database,field,criteria)

Parameters
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DProduct class instead

see
DProduct::evaluate()
Return values
float|string —

DSTDEV()

DSTDEV.

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

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
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DStDev class instead

see
DStDev::evaluate()
Return values
float|string —

DSTDEVP()

DSTDEVP.

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

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
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DStDevP class instead

see
DStDevP::evaluate()
Return values
float|string —

DSUM()

DSUM.

public static DSUM(array<string|int, mixed> $database, int|string $field, array<string|int, mixed> $criteria) : null|float|string

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

Excel Function: DSUM(database,field,criteria)

Parameters
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DSum class instead

see
DSum::evaluate()
Return values
null|float|string —

DVAR()

DVAR.

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

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
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DVar class instead

see
DVar::evaluate()
Return values
float|string —

(string if result is an error)

DVARP()

DVARP.

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

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
$database : array<string|int, mixed>

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.

$field : int|string

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.

$criteria : array<string|int, mixed>

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.

Tags
deprecated
1.17.0

Use the evaluate() method in the Database\DVarP class instead

see
DVarP::evaluate()
Return values
float|string —

(string if result is an error)

Search results