| 1 |
<?php |
| 2 |
|
| 3 |
namespace TablePress\PhpOffice\PhpSpreadsheet\Calculation\Database; |
| 4 |
|
| 5 |
use TablePress\PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError; |
| 6 |
use TablePress\PhpOffice\PhpSpreadsheet\Calculation\Statistical\Maximum; |
| 7 |
|
| 8 |
class DMax extends DatabaseAbstract |
| 9 |
{ |
| 10 |
/** |
| 11 |
* DMAX. |
| 12 |
* |
| 13 |
* Returns the largest number in a column of a list or database that matches conditions you that |
| 14 |
* specify. |
| 15 |
* |
| 16 |
* Excel Function: |
| 17 |
* DMAX(database,field,criteria) |
| 18 |
* |
| 19 |
* @param mixed[] $database The range of cells that makes up the list or database. |
| 20 |
* A database is a list of related data in which rows of related |
| 21 |
* information are records, and columns of data are fields. The |
| 22 |
* first row of the list contains labels for each column. |
| 23 |
* @param null|array<mixed>|int|string $field Indicates which column is used in the function. Enter the |
| 24 |
* column label enclosed between double quotation marks, such as |
| 25 |
* "Age" or "Yield," or a number (without quotation marks) that |
| 26 |
* represents the position of the column within the list: 1 for |
| 27 |
* the first column, 2 for the second column, and so on. |
| 28 |
* @param mixed[][] $criteria The range of cells that contains the conditions you specify. |
| 29 |
* You can use any range for the criteria argument, as long as it |
| 30 |
* includes at least one column label and at least one cell below |
| 31 |
* the column label in which you specify a condition for the |
| 32 |
* column. |
| 33 |
* @return null|float|string |
| 34 |
*/ |
| 35 |
public static function evaluate(array $database, $field, array $criteria, bool $returnError = true) |
| 36 |
{ |
| 37 |
$field = self::fieldExtract($database, $field); |
| 38 |
if ($field === null) { |
| 39 |
return $returnError ? ExcelError::VALUE() : null; |
| 40 |
} |
| 41 |
|
| 42 |
return Maximum::max( |
| 43 |
self::getFilteredColumn($database, $field, $criteria) |
| 44 |
); |
| 45 |
} |
| 46 |
} |
| 47 |
|