repo stringlengths 7 63 | file_url stringlengths 81 284 | file_path stringlengths 5 200 | content stringlengths 0 32.8k | language stringclasses 1
value | license stringclasses 7
values | commit_sha stringlengths 40 40 | retrieved_at stringdate 2026-01-04 15:02:33 2026-01-05 05:24:06 | truncated bool 2
classes |
|---|---|---|---|---|---|---|---|---|
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/ComplexNumbers2/IMLN.php | samples/ComplexNumbers2/IMLN.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'IMLN';
$description = 'Returns the natural logarithm of a complex number in x + yi or x + yj text format';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
['3+4i'],
['5-12i'],
['3.25+7.5i'],
['3.25-12.5i'],
['-3.25+7.5i'],
['-3.25-7.5i'],
['0-j'],
['0-2.5j'],
['0+j'],
['0+1.25j'],
[4],
[-2.5],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=IMLN(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(E$row): The Natural Logarithm of "
. $worksheet->getCell('A' . $row)->getValueString()
. ' is '
. $worksheet->getCell('B' . $row)->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/ComplexNumbers2/IMDIV.php | samples/ComplexNumbers2/IMDIV.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'IMDIV';
$description = 'Returns the quotient of two complex numbers in x + yi or x + yj text format';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
['3+4i', '5-3i'],
['3+4i', '5+3i'],
['-238+240i', '10+24i'],
['1+2i', 30],
['1+2i', '2i'],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('C' . $row, '=IMDIV(A' . $row . ', B' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(E$row): The Quotient of "
. $worksheet->getCell('A' . $row)->getValueString()
. ' and '
. $worksheet->getCell('B' . $row)->getValueString()
. ' is '
. $worksheet->getCell('C' . $row)->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/ComplexNumbers2/IMCOS.php | samples/ComplexNumbers2/IMCOS.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'IMCOS';
$description = 'Returns the cosine of a complex number in x + yi or x + yj text format';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
['3+4i'],
['5-12i'],
['3.25+7.5i'],
['3.25-12.5i'],
['-3.25+7.5i'],
['-3.25-7.5i'],
['0-j'],
['0-2.5j'],
['0+j'],
['0+1.25j'],
[4],
[-2.5],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=IMCOS(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(E$row): The Cosine of "
. $worksheet->getCell('A' . $row)->getValueString()
. ' is '
. $worksheet->getCell('B' . $row)->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Autofilter/10_Autofilter_selection_display.php | samples/Autofilter/10_Autofilter_selection_display.php | <?php
use PhpOffice\PhpSpreadsheet\Shared\Date;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column;
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column\Rule;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
// Create new Spreadsheet object
$helper->log('Create new Spreadsheet object');
$spreadsheet = new Spreadsheet();
// Set document properties
$helper->log('Set document properties');
$spreadsheet->getProperties()->setCreator('Maarten Balliauw')
->setLastModifiedBy('Maarten Balliauw')
->setTitle('PhpSpreadsheet Test Document')
->setSubject('PhpSpreadsheet Test Document')
->setDescription('Test document for PhpSpreadsheet, generated using PHP classes.')
->setKeywords('office PhpSpreadsheet php')
->setCategory('Test result file');
// Create the worksheet
$helper->log('Add data');
$spreadsheet->setActiveSheetIndex(0);
$spreadsheet->getActiveSheet()->setCellValue('A1', 'Year')
->setCellValue('B1', 'Period')
->setCellValue('C1', 'Country')
->setCellValue('D1', 'Date')
->setCellValue('E1', 'Sales')
->setCellValue('F1', 'Expenditure');
$dateTime = new DateTime();
$startYear = $endYear = $currentYear = (int) $dateTime->format('Y');
--$startYear;
++$endYear;
$years = range($startYear, $endYear);
$periods = range(1, 12);
$countries = [
'United States',
'UK',
'France',
'Germany',
'Italy',
'Spain',
'Portugal',
'Japan',
];
$row = 2;
foreach ($years as $year) {
foreach ($periods as $period) {
foreach ($countries as $country) {
$dateString = sprintf('%04d-%02d-01T00:00:00', $year, $period);
$dateTime = new DateTime($dateString);
$endDays = (int) $dateTime->format('t');
for ($i = 1; $i <= $endDays; ++$i) {
$eDate = Date::formattedPHPToExcel(
$year,
$period,
$i
);
$value = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
$salesValue = $invoiceValue = null;
$incomeOrExpenditure = mt_rand(-1, 1);
if ($incomeOrExpenditure == -1) {
$expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = null;
} elseif ($incomeOrExpenditure == 1) {
$expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} else {
$expenditure = null;
$income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
}
$dataArray = [$year,
$period,
$country,
$eDate,
$income,
$expenditure,
];
$spreadsheet->getActiveSheet()->fromArray($dataArray, null, 'A' . $row++);
}
}
}
}
--$row;
// Set styling
$helper->log('Set styling');
$spreadsheet->getActiveSheet()->getStyle('A1:F1')->getFont()->setBold(true);
$spreadsheet->getActiveSheet()->getStyle('A1:F1')->getAlignment()->setWrapText(true);
$spreadsheet->getActiveSheet()->getColumnDimension('C')->setWidth(12.5);
$spreadsheet->getActiveSheet()->getColumnDimension('D')->setWidth(10.5);
$spreadsheet->getActiveSheet()->getStyle('D2:D' . $row)->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_YYYYMMDD);
$spreadsheet->getActiveSheet()->getStyle('E2:F' . $row)->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_CURRENCY_USD_INTEGER);
$spreadsheet->getActiveSheet()->getColumnDimension('F')->setWidth(14);
$spreadsheet->getActiveSheet()->freezePane('A2');
$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, false, true, true));
// Set autofilter range
$filterRange = $spreadsheet->getActiveSheet()->calculateWorksheetDimension();
$helper->log("Set autofilter for cells {$filterRange}");
// Always include the complete filter range if you can!
// Excel does support setting only the caption row, but that's not a best practise...
$spreadsheet->getActiveSheet()->setAutoFilter($filterRange);
// Set active filters
$autoFilter = $spreadsheet->getActiveSheet()->getAutoFilter();
$helper->log('Set active filters');
// Filter the Country column on a filter value of countries beginning with the letter U (or Japan)
// We use * as a wildcard, so specify as U* and using a wildcard requires customFilter
$autoFilter->getColumn('C')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_CUSTOMFILTER)
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, 'u*')
->setRuleType(Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER);
$helper->log('Set country code filter (Column C) to countries beginning with "U" ("United States" and "UK")');
$autoFilter->getColumn('C')
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, 'japan')
->setRuleType(Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER);
$helper->log('Add "Japan" to the country code filter (Column C)');
// Filter the Date column on a filter value of the last day of every period of the current year
// We us a dateGroup ruletype for this, although it is still a standard filter
foreach ($periods as $period) {
$dateString = sprintf('%04d-%02d-01T00:00:00', $currentYear, $period);
$dateTime = new DateTime($dateString);
$endDate = (int) $dateTime->format('t');
$autoFilter->getColumn('D')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_FILTER)
->createRule()
->setRule(
Rule::AUTOFILTER_COLUMN_RULE_EQUAL,
[
'year' => $currentYear,
'month' => $period,
'day' => $endDate,
]
)
->setRuleType(Rule::AUTOFILTER_RULETYPE_DATEGROUP);
}
$helper->log('Add filter on the Date (Column D) to display only rows for the last day of each month');
// Display only sales values that are blank
// Standard filter, operator equals, and value of NULL
$autoFilter->getColumn('E')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_FILTER)
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, '');
$helper->log('Add filter on Sales Values (Column E) to display only blank values');
// Execute filtering
$helper->log('Execute filtering (apply the filter rules)');
$autoFilter->showHideRows();
// Set active sheet index to the first sheet, so Excel opens this as the first sheet
$spreadsheet->setActiveSheetIndex(0);
// Display Results of filtering
$helper->log('Display filtered rows');
$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, false, true, true, true));
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Autofilter/10_Autofilter_selection_1.php | samples/Autofilter/10_Autofilter_selection_1.php | <?php
use PhpOffice\PhpSpreadsheet\Shared\Date;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column;
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column\Rule;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
// Create new Spreadsheet object
$helper->log('Create new Spreadsheet object');
$spreadsheet = new Spreadsheet();
// Set document properties
$helper->log('Set document properties');
$spreadsheet->getProperties()->setCreator('Maarten Balliauw')
->setLastModifiedBy('Maarten Balliauw')
->setTitle('PhpSpreadsheet Test Document')
->setSubject('PhpSpreadsheet Test Document')
->setDescription('Test document for PhpSpreadsheet, generated using PHP classes.')
->setKeywords('office PhpSpreadsheet php')
->setCategory('Test result file');
// Create the worksheet
$helper->log('Add data');
$spreadsheet->setActiveSheetIndex(0);
$spreadsheet->getActiveSheet()->setCellValue('A1', 'Year')
->setCellValue('B1', 'Period')
->setCellValue('C1', 'Country')
->setCellValue('D1', 'Date')
->setCellValue('E1', 'Sales')
->setCellValue('F1', 'Expenditure');
$dateTime = new DateTime();
$startYear = $endYear = $currentYear = (int) $dateTime->format('Y');
--$startYear;
++$endYear;
$years = range($startYear, $endYear);
$periods = range(1, 12);
$countries = [
'United States',
'UK',
'France',
'Germany',
'Italy',
'Spain',
'Portugal',
'Japan',
];
$row = 2;
foreach ($years as $year) {
foreach ($periods as $period) {
foreach ($countries as $country) {
$dateString = sprintf('%04d-%02d-01T00:00:00', $year, $period);
$dateTime = new DateTime($dateString);
$endDays = (int) $dateTime->format('t');
for ($i = 1; $i <= $endDays; ++$i) {
$eDate = Date::formattedPHPToExcel(
$year,
$period,
$i
);
$value = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
$salesValue = $invoiceValue = null;
$incomeOrExpenditure = mt_rand(-1, 1);
if ($incomeOrExpenditure == -1) {
$expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = null;
} elseif ($incomeOrExpenditure == 1) {
$expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} else {
$expenditure = null;
$income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
}
$dataArray = [$year,
$period,
$country,
$eDate,
$income,
$expenditure,
];
$spreadsheet->getActiveSheet()->fromArray($dataArray, null, 'A' . $row++);
}
}
}
}
--$row;
// Set styling
$helper->log('Set styling');
$spreadsheet->getActiveSheet()->getStyle('A1:F1')->getFont()->setBold(true);
$spreadsheet->getActiveSheet()->getStyle('A1:F1')->getAlignment()->setWrapText(true);
$spreadsheet->getActiveSheet()->getColumnDimension('C')->setWidth(12.5);
$spreadsheet->getActiveSheet()->getColumnDimension('D')->setWidth(10.5);
$spreadsheet->getActiveSheet()->getStyle('D2:D' . $row)->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_YYYYMMDD);
$spreadsheet->getActiveSheet()->getStyle('E2:F' . $row)->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_CURRENCY_USD_INTEGER);
$spreadsheet->getActiveSheet()->getColumnDimension('F')->setWidth(14);
$spreadsheet->getActiveSheet()->freezePane('A2');
$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, false, true, true));
// Set autofilter range
$filterRange = $spreadsheet->getActiveSheet()->calculateWorksheetDimension();
$helper->log("Set autofilter for cells {$filterRange}");
// Always include the complete filter range if you can!
// Excel does support setting only the caption row, but that's not a best practise...
$spreadsheet->getActiveSheet()->setAutoFilter($filterRange);
// Set active filters
$autoFilter = $spreadsheet->getActiveSheet()->getAutoFilter();
$helper->log('Set active filters');
// Filter the Country column on a filter value of countries beginning with the letter U (or Japan)
// We use * as a wildcard, so specify as U* and using a wildcard requires customFilter
$autoFilter->getColumn('C')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_CUSTOMFILTER)
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, 'u*')
->setRuleType(Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER);
$helper->log('Set country code filter (Column C) to countries beginning with "U" ("United States" and "UK")');
$autoFilter->getColumn('C')
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, 'japan')
->setRuleType(Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER);
$helper->log('Add "Japan" to the country code filter (Column C)');
// Filter the Date column on a filter value of the last day of every period of the current year
// We use a dateGroup ruletype for this, although it is still a standard filter
foreach ($periods as $period) {
$dateString = sprintf('%04d-%02d-01T00:00:00', $currentYear, $period);
$dateTime = new DateTime($dateString);
$endDate = (int) $dateTime->format('t');
$autoFilter->getColumn('D')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_FILTER)
->createRule()
->setRule(
Rule::AUTOFILTER_COLUMN_RULE_EQUAL,
[
'year' => $currentYear,
'month' => $period,
'day' => $endDate,
]
)
->setRuleType(Rule::AUTOFILTER_RULETYPE_DATEGROUP);
}
$helper->log('Add filter on the Date (Column D) to display only rows for the last day of each month');
// Display only sales values that are blank
// Standard filter, operator equals, and value of NULL or empty space
$autoFilter->getColumn('E')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_FILTER)
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, '');
$helper->log('Add filter on Sales Values (Column E) to display only blank values');
$helper->log('NOTE: We don\'t apply the filter rules in this example, so we can\'t see the result here; although Excel will apply the rules when the file is loaded');
$helper->log('See 10_Autofilter_selection_display.php for an example that actually executes the filter rules');
// Save
$helper->write($spreadsheet, __FILE__);
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Autofilter/10_Autofilter.php | samples/Autofilter/10_Autofilter.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
// Create new Spreadsheet object
$helper->log('Create new Spreadsheet object');
$spreadsheet = new Spreadsheet();
// Set document properties
$helper->log('Set document properties');
$spreadsheet->getProperties()->setCreator('Maarten Balliauw')
->setLastModifiedBy('Maarten Balliauw')
->setTitle('PhpSpreadsheet Test Document')
->setSubject('PhpSpreadsheet Test Document')
->setDescription('Test document for PhpSpreadsheet, generated using PHP classes.')
->setKeywords('office PhpSpreadsheet php')
->setCategory('Test result file');
// Create the worksheet
$helper->log('Add data');
$spreadsheet->setActiveSheetIndex(0);
$spreadsheet->getActiveSheet()->setCellValue('A1', 'Year')
->setCellValue('B1', 'Quarter')
->setCellValue('C1', 'Country')
->setCellValue('D1', 'Sales');
$dataArray = [
['2010', 'Q1', 'United States', 790],
['2010', 'Q2', 'United States', 730],
['2010', 'Q3', 'United States', 860],
['2010', 'Q4', 'United States', 850],
['2011', 'Q1', 'United States', 800],
['2011', 'Q2', 'United States', 700],
['2011', 'Q3', 'United States', 900],
['2011', 'Q4', 'United States', 950],
['2010', 'Q1', 'Belgium', 380],
['2010', 'Q2', 'Belgium', 390],
['2010', 'Q3', 'Belgium', 420],
['2010', 'Q4', 'Belgium', 460],
['2011', 'Q1', 'Belgium', 400],
['2011', 'Q2', 'Belgium', 350],
['2011', 'Q3', 'Belgium', 450],
['2011', 'Q4', 'Belgium', 500],
['2010', 'Q1', 'UK', 690],
['2010', 'Q2', 'UK', 610],
['2010', 'Q3', 'UK', 620],
['2010', 'Q4', 'UK', 600],
['2011', 'Q1', 'UK', 720],
['2011', 'Q2', 'UK', 650],
['2011', 'Q3', 'UK', 580],
['2011', 'Q4', 'UK', 510],
['2010', 'Q1', 'France', 510],
['2010', 'Q2', 'France', 490],
['2010', 'Q3', 'France', 460],
['2010', 'Q4', 'France', 590],
['2011', 'Q1', 'France', 620],
['2011', 'Q2', 'France', 650],
['2011', 'Q3', 'France', 415],
['2011', 'Q4', 'France', 570],
['2010', 'Q1', 'Germany', 720],
['2010', 'Q2', 'Germany', 680],
['2010', 'Q3', 'Germany', 640],
['2010', 'Q4', 'Germany', 660],
['2011', 'Q1', 'Germany', 680],
['2011', 'Q2', 'Germany', 620],
['2011', 'Q3', 'Germany', 710],
['2011', 'Q4', 'Germany', 690],
['2010', 'Q1', 'Spain', 510],
['2010', 'Q2', 'Spain', 490],
['2010', 'Q3', 'Spain', 470],
['2010', 'Q4', 'Spain', 420],
['2011', 'Q1', 'Spain', 460],
['2011', 'Q2', 'Spain', 390],
['2011', 'Q3', 'Spain', 430],
['2011', 'Q4', 'Spain', 415],
['2010', 'Q1', 'Italy', 440],
['2010', 'Q2', 'Italy', 410],
['2010', 'Q3', 'Italy', 420],
['2010', 'Q4', 'Italy', 450],
['2011', 'Q1', 'Italy', 430],
['2011', 'Q2', 'Italy', 370],
['2011', 'Q3', 'Italy', 350],
['2011', 'Q4', 'Italy', 335],
];
$spreadsheet->getActiveSheet()->fromArray($dataArray, null, 'A2');
$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, false, false, true), true);
// Set title row bold
$helper->log('Set title row bold');
$spreadsheet->getActiveSheet()->getStyle('A1:D1')->getFont()->setBold(true);
// Set autofilter
$filterRange = $spreadsheet->getActiveSheet()->calculateWorksheetDimension();
$helper->log("Set autofilter for cells {$filterRange}");
// Always include the complete filter range if you can!
// Excel does support setting only the caption
// row, but that's not a best practise...
$spreadsheet->getActiveSheet()->setAutoFilter($filterRange);
// Save
$helper->write($spreadsheet, __FILE__, ['Xlsx']);
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Autofilter/10_Autofilter_dynamic_dates.php | samples/Autofilter/10_Autofilter_dynamic_dates.php | <?php
use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column;
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column\Rule;
require __DIR__ . '/../Header.php';
// Sample can be slightly off if processing begins just before midnight
// and does not complete till after midnight.
// This possibility is accounted for in unit tests,
// but seems unneccesarily complicated for the sample.
function createSheet(Sample $helper, Spreadsheet $spreadsheet, string $rule, bool $displayInitialWorksheet): void
{
$helper->log('Add data');
$sheet = $spreadsheet->createSheet();
$sheet->setTitle($rule);
$sheet->getCell('A1')->setValue('Date');
$row = 1;
$date = new DateTime();
$year = (int) $date->format('Y');
$month = (int) $date->format('m');
$day = (int) $date->format('d');
$yearMinus2 = $year - 2;
$sheet->getCell('B1')->setValue("=DATE($year, $month, $day)");
// Each day for two weeks before today through 2 weeks after
for ($dayOffset = -14; $dayOffset < 14; ++$dayOffset) {
++$row;
$sheet->getCell("A$row")->setValue("=B1+($dayOffset)");
}
// First and last day of each month, starting with January 2 years before,
// through December 2 years after.
for ($monthOffset = 0; $monthOffset < 48; ++$monthOffset) {
++$row;
$sheet->getCell("A$row")->setValue("=DATE($yearMinus2, $monthOffset, 1)");
++$row;
$sheet->getCell("A$row")->setValue("=DATE($yearMinus2, $monthOffset + 1, 0)");
}
$sheet->getStyle("A2:A$row")->getNumberFormat()->setFormatCode('yyyy-mm-dd');
$sheet->getStyle('B1')->getNumberFormat()->setFormatCode('yyyy-mm-dd');
$sheet->getColumnDimension('A')->setAutoSize(true);
$sheet->getColumnDimension('B')->setAutoSize(true);
if ($displayInitialWorksheet) {
$helper->log('Unfiltered Dates');
$helper->displayGrid($sheet->toArray(null, true, true, true));
}
$helper->log("Filter for $rule");
$autoFilter = $spreadsheet->getActiveSheet()->getAutoFilter();
$autoFilter->setRange("A1:A{$row}");
$columnFilter = $autoFilter->getColumn('A');
$columnFilter->setFilterType(Column::AUTOFILTER_FILTERTYPE_DYNAMICFILTER);
$columnFilter->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, '', $rule)
->setRuleType(Rule::AUTOFILTER_RULETYPE_DYNAMICFILTER);
$sheet->setSelectedCell('B1');
$helper->log('Execute filtering (apply the filter rules)');
$autoFilter->showHideRows();
$helper->log('Filtered Dates');
$helper->displayGrid($sheet->toArray(null, true, true, true, true));
}
// Create new Spreadsheet object
/** @var Sample $helper */
$helper->log('Create new Spreadsheet object');
$spreadsheet = new Spreadsheet();
// Set document properties
$helper->log('Set document properties');
$spreadsheet->getProperties()->setCreator('Owen Leibman')
->setLastModifiedBy('Owen Leibman')
->setTitle('PhpSpreadsheet Test Document')
->setSubject('PhpSpreadsheet Test Document')
->setDescription('Test document for PhpSpreadsheet, generated using PHP classes.')
->setKeywords('office PhpSpreadsheet php')
->setCategory('Test result file');
$ruleNames = [
Rule::AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_TODAY,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2,
Rule::AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3,
];
// Create the worksheets
foreach ($ruleNames as $index => $ruleName) {
createSheet($helper, $spreadsheet, $ruleName, $index === 0);
}
$spreadsheet->removeSheetByIndex(0);
$spreadsheet->setActiveSheetIndex(0);
// Save
$helper->write($spreadsheet, __FILE__);
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Autofilter/10_Autofilter_selection_2.php | samples/Autofilter/10_Autofilter_selection_2.php | <?php
use PhpOffice\PhpSpreadsheet\Shared\Date;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column;
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column\Rule;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
// Create new Spreadsheet object
$helper->log('Create new Spreadsheet object');
$spreadsheet = new Spreadsheet();
// Set document properties
$helper->log('Set document properties');
$spreadsheet->getProperties()->setCreator('Maarten Balliauw')
->setLastModifiedBy('Maarten Balliauw')
->setTitle('PhpSpreadsheet Test Document')
->setSubject('PhpSpreadsheet Test Document')
->setDescription('Test document for PhpSpreadsheet, generated using PHP classes.')
->setKeywords('office PhpSpreadsheet php')
->setCategory('Test result file');
// Create the worksheet
$helper->log('Add data');
$spreadsheet->setActiveSheetIndex(0);
$spreadsheet->getActiveSheet()->setCellValue('A1', 'Year')
->setCellValue('B1', 'Period')
->setCellValue('C1', 'Country')
->setCellValue('D1', 'Date')
->setCellValue('E1', 'Sales')
->setCellValue('F1', 'Expenditure');
$dateTime = new DateTime();
$startYear = $endYear = $currentYear = (int) $dateTime->format('Y');
--$startYear;
++$endYear;
$years = range($startYear, $endYear);
$periods = range(1, 12);
$countries = [
'United States',
'UK',
'France',
'Germany',
'Italy',
'Spain',
'Portugal',
'Japan',
];
$row = 2;
foreach ($years as $year) {
foreach ($periods as $period) {
foreach ($countries as $country) {
$dateString = sprintf('%04d-%02d-01T00:00:00', $year, $period);
$dateTime = new DateTime($dateString);
$endDays = (int) $dateTime->format('t');
for ($i = 1; $i <= $endDays; ++$i) {
$eDate = Date::formattedPHPToExcel(
$year,
$period,
$i
);
$value = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
$salesValue = $invoiceValue = null;
$incomeOrExpenditure = mt_rand(-1, 1);
if ($incomeOrExpenditure == -1) {
$expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = null;
} elseif ($incomeOrExpenditure == 1) {
$expenditure = mt_rand(-1000, -500) * (1 + (mt_rand(-1, 1) / 4));
$income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
} else {
$expenditure = null;
$income = mt_rand(500, 1000) * (1 + (mt_rand(-1, 1) / 4));
}
$dataArray = [$year,
$period,
$country,
$eDate,
$income,
$expenditure,
];
$spreadsheet->getActiveSheet()->fromArray($dataArray, null, 'A' . $row++);
}
}
}
}
--$row;
// Set styling
$helper->log('Set styling');
$spreadsheet->getActiveSheet()->getStyle('A1:F1')->getFont()->setBold(true);
$spreadsheet->getActiveSheet()->getStyle('A1:F1')->getAlignment()->setWrapText(true);
$spreadsheet->getActiveSheet()->getColumnDimension('C')->setWidth(12.5);
$spreadsheet->getActiveSheet()->getColumnDimension('D')->setWidth(10.5);
$spreadsheet->getActiveSheet()->getStyle('D2:D' . $row)->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_YYYYMMDD);
$spreadsheet->getActiveSheet()->getStyle('E2:F' . $row)->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_CURRENCY_USD_INTEGER);
$spreadsheet->getActiveSheet()->getColumnDimension('F')->setWidth(14);
$spreadsheet->getActiveSheet()->freezePane('A2');
$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, false, true, true));
// Set autofilter range
$filterRange = $spreadsheet->getActiveSheet()->calculateWorksheetDimension();
$helper->log("Set autofilter for cells {$filterRange}");
// Always include the complete filter range if you can!
// Excel does support setting only the caption row, but that's not a best practise...
$spreadsheet->getActiveSheet()->setAutoFilter($filterRange);
// Set active filters
$autoFilter = $spreadsheet->getActiveSheet()->getAutoFilter();
$helper->log('Set active filters');
// Filter the Country column on a filter value of Germany
// As it's just a simple value filter, we can use FILTERTYPE_FILTER
$autoFilter->getColumn('C')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_FILTER)
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, 'Germany');
$helper->log('Set country code filter (Column C) to "Germany"');
// Filter the Date column on a filter value of the year to date
$autoFilter->getColumn('D')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_DYNAMICFILTER)
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_EQUAL, '', Rule::AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE)
->setRuleType(Rule::AUTOFILTER_RULETYPE_DYNAMICFILTER);
$helper->log('Add filter on the Date (Column D) to display year to date');
// Display only sales values that are between 400 and 600
$autoFilter->getColumn('E')
->setFilterType(Column::AUTOFILTER_FILTERTYPE_CUSTOMFILTER)
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL, 400)
->setRuleType(Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER);
$autoFilter->getColumn('E')
->setJoin(Column::AUTOFILTER_COLUMN_JOIN_AND)
->createRule()
->setRule(Rule::AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL, 600)
->setRuleType(Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER);
$helper->log('Add filter on Sales Values (Column E) between 400 and 600');
$helper->log('NOTE: We don\'t apply the filter rules in this example, so we can\'t see the result here; although Excel will apply the rules when the file is loaded');
$helper->log('See 10_Autofilter_selection_display.php for an example that actually executes the filter rules inside PhpSpreadsheet');
// Save
$helper->write($spreadsheet, __FILE__);
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/AMORDEGRC.php | samples/Financial1/AMORDEGRC.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Calculation\Financial\Constants as FinancialConstants;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the prorated linear depreciation of an asset for a specified accounting period.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Cost', 150.00],
['Date Purchased', DateHelper::getDateValue('01-Jan-2015')],
['First Period Date', DateHelper::getDateValue('30-Sep-2015')],
['Salvage Value', 20.00],
['Number of Periods', 1],
['Depreciation Rate', 0.20],
['Basis', FinancialConstants::BASIS_DAYS_PER_YEAR_360_EUROPEAN],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1')->getNumberFormat()->setFormatCode('$#,##0.00');
$worksheet->getStyle('B2:B3')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
$worksheet->getStyle('B4')->getNumberFormat()->setFormatCode('$#,##0.00');
$worksheet->getStyle('B6')->getNumberFormat()->setFormatCode('0.00%');
// Now the formula
$worksheet->setCellValue('B10', '=AMORDEGRC(B1, B2, B3, B4, B5, B6, B7)');
$worksheet->getStyle('B10')->getNumberFormat()->setFormatCode('$#,##0.00');
$helper->log($worksheet->getCell('B10')->getValue());
$helper->log('AMORDEGRC() Result is ' . $worksheet->getCell('B10')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/CUMPRINC.php | samples/Financial1/CUMPRINC.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the cumulative payment on the principal of a loan or investment, between two specified periods.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Interest Rate (per period)', 0.05 / 12],
['Number of Periods', 5 * 12],
['Present Value', 50000],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1')->getNumberFormat()->setFormatCode('0.00%');
$worksheet->getStyle('B3')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
$baseRow = 5;
for ($year = 1; $year <= 5; ++$year) {
$row = (string) ($baseRow + $year);
$yearStartPeriod = (int) $year * 12 - 11;
$yearEndPeriod = (int) $year * 12;
$worksheet->setCellValue("A{$row}", "Yr {$year}");
$worksheet->setCellValue("B{$row}", "=CUMPRINC(\$B\$1, \$B\$2, \$B\$3, {$yearStartPeriod}, {$yearEndPeriod}, 0)");
$worksheet->getStyle("B{$row}")->getNumberFormat()->setFormatCode('$#,##0.00;-$#,##0.00');
$helper->log($worksheet->getCell("B{$row}")->getValue());
$helper->log("CUMPRINC() Year {$year} Result is " . $worksheet->getCell("B{$row}")->getFormattedValue());
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/COUPNUM.php | samples/Financial1/COUPNUM.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the number of coupons payable, between a security\'s settlement date and maturity date,');
$helper->log('rounded up to the nearest whole coupon.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Settlement Date', DateHelper::getDateValue('01-Jan-2011')],
['Maturity Date', DateHelper::getDateValue('25-Oct-2012')],
['Frequency', 4],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B2')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
// Now the formula
$worksheet->setCellValue('B6', '=COUPNUM(B1, B2, B3)');
$helper->log($worksheet->getCell('B6')->getValue());
$helper->log('COUPNUM() Result is ' . $worksheet->getCell('B6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/COUPPCD.php | samples/Financial1/COUPPCD.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the previous coupon date, before the settlement date for a security.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Settlement Date', DateHelper::getDateValue('01-Jan-2011')],
['Maturity Date', DateHelper::getDateValue('25-Oct-2012')],
['Frequency', 4],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B2')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
// Now the formula
$worksheet->setCellValue('B6', '=COUPPCD(B1, B2, B3)');
$worksheet->getStyle('B6')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
$helper->log($worksheet->getCell('B6')->getValue());
$helper->log('COUPPCD() Result is ' . $worksheet->getCell('B6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/CUMIPMT.php | samples/Financial1/CUMIPMT.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the cumulative interest paid on a loan or investment, between two specified periods.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Interest Rate (per period)', 0.05 / 12],
['Number of Periods', 5 * 12],
['Present Value', 50000],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1')->getNumberFormat()->setFormatCode('0.00%');
$worksheet->getStyle('B3')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
$baseRow = 5;
for ($year = 1; $year <= 5; ++$year) {
$row = (string) ($baseRow + $year);
$yearStartPeriod = (int) $year * 12 - 11;
$yearEndPeriod = (int) $year * 12;
$worksheet->setCellValue("A{$row}", "Yr {$year}");
$worksheet->setCellValue("B{$row}", "=CUMIPMT(\$B\$1, \$B\$2, \$B\$3, {$yearStartPeriod}, {$yearEndPeriod}, 0)");
$worksheet->getStyle("B{$row}")->getNumberFormat()->setFormatCode('$#,##0.00;-$#,##0.00');
$helper->log($worksheet->getCell("B{$row}")->getValue());
$helper->log("CUMIPMT() Year {$year} Result is " . $worksheet->getCell("B{$row}")->getFormattedValue());
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/AMORLINC.php | samples/Financial1/AMORLINC.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Calculation\Financial\Constants as FinancialConstants;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the prorated linear depreciation of an asset for a specified accounting period.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Cost', 150.00],
['Date Purchased', DateHelper::getDateValue('01-Jan-2015')],
['First Period Date', DateHelper::getDateValue('30-Sep-2015')],
['Salvage Value', 20.00],
['Period', 1],
['Depreciation Rate', 0.20],
['Basis', FinancialConstants::BASIS_DAYS_PER_YEAR_360_EUROPEAN],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1')->getNumberFormat()->setFormatCode('$#,##0.00');
$worksheet->getStyle('B2:B3')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
$worksheet->getStyle('B4')->getNumberFormat()->setFormatCode('$#,##0.00');
$worksheet->getStyle('B6')->getNumberFormat()->setFormatCode('0.00%');
// Now the formula
$worksheet->setCellValue('B10', '=AMORLINC(B1, B2, B3, B4, B5, B6, B7)');
$worksheet->getStyle('B10')->getNumberFormat()->setFormatCode('$#,##0.00');
$helper->log($worksheet->getCell('B10')->getValue());
$helper->log('AMORLINC() Result is ' . $worksheet->getCell('B10')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/ACCRINT.php | samples/Financial1/ACCRINT.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the accrued interest for a security that pays periodic interest.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Issue Date', DateHelper::getDateValue('01-Jan-2012')],
['First Interest Date', DateHelper::getDateValue('01-Apr-2012')],
['Settlement Date', DateHelper::getDateValue('31-Dec-2013')],
['Annual Coupon Rate', 0.08],
['Par Value', 10000],
['Frequency', 4],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B3')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
$worksheet->getStyle('B4')->getNumberFormat()->setFormatCode('0.00%');
$worksheet->getStyle('B5')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
$worksheet->setCellValue('B10', '=ACCRINT(B1, B2, B3, B4, B5, B6)');
$worksheet->getStyle('B10')->getNumberFormat()->setFormatCode('$#,##0.00');
$helper->log($worksheet->getCell('B10')->getValue());
$helper->log('ACCRINT() Result is ' . $worksheet->getCell('B10')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/COUPDAYBS.php | samples/Financial1/COUPDAYBS.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the number of days from the beginning of a coupon\'s period to the settlement date.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Settlement Date', DateHelper::getDateValue('01-Jan-2011')],
['Maturity Date', DateHelper::getDateValue('25-Oct-2012')],
['Frequency', 4],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B2')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
// Now the formula
$worksheet->setCellValue('B6', '=COUPDAYBS(B1, B2, B3)');
$helper->log($worksheet->getCell('B6')->getValue());
$helper->log('COUPDAYBS() Result is ' . $worksheet->getCell('B6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/COUPDAYSNC.php | samples/Financial1/COUPDAYSNC.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the number of days from the settlement date to the next coupon date.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Settlement Date', DateHelper::getDateValue('01-Jan-2011')],
['Maturity Date', DateHelper::getDateValue('25-Oct-2012')],
['Frequency', 4],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B2')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
// Now the formula
$worksheet->setCellValue('B6', '=COUPDAYSNC(B1, B2, B3)');
$helper->log($worksheet->getCell('B6')->getValue());
$helper->log('COUPDAYSNC() Result is ' . $worksheet->getCell('B6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/COUPNCD.php | samples/Financial1/COUPNCD.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the next coupon date, after the settlement date.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Settlement Date', DateHelper::getDateValue('01-Jan-2011')],
['Maturity Date', DateHelper::getDateValue('25-Oct-2012')],
['Frequency', 4],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B2')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
// Now the formula
$worksheet->setCellValue('B6', '=COUPNCD(B1, B2, B3)');
$worksheet->getStyle('B6')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
$helper->log($worksheet->getCell('B6')->getValue());
$helper->log('COUPNCD() Result is ' . $worksheet->getCell('B6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/ACCRINTM.php | samples/Financial1/ACCRINTM.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the accrued interest for a security that pays interest at maturity.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Issue Date', DateHelper::getDateValue('01-Jan-2012')],
['Settlement Date', DateHelper::getDateValue('31-Dec-2012')],
['Annual Coupon Rate', 0.08],
['Par Value', 10000],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B2')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
$worksheet->getStyle('B3')->getNumberFormat()->setFormatCode('0.00%');
$worksheet->getStyle('B4')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
$worksheet->setCellValue('B6', '=ACCRINTM(B1, B2, B3, B4)');
$worksheet->getStyle('B6')->getNumberFormat()->setFormatCode('$#,##0.00');
$helper->log($worksheet->getCell('B6')->getValue());
$helper->log('ACCRINTM() Result is ' . $worksheet->getCell('B6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial1/COUPDAYS.php | samples/Financial1/COUPDAYS.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the number of days in the coupon period that contains the settlement date.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Settlement Date', DateHelper::getDateValue('01-Jan-2011')],
['Maturity Date', DateHelper::getDateValue('25-Oct-2012')],
['Frequency', 4],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B2')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
// Now the formula
$worksheet->setCellValue('B6', '=COUPDAYS(B1, B2, B3)');
$helper->log($worksheet->getCell('B6')->getValue());
$helper->log('COUPDAYS() Result is ' . $worksheet->getCell('B6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/HEX2BIN.php | samples/HexEtcConversions/HEX2BIN.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'HEX2BIN';
$description = 'Converts a hexadecimal number to binary';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[3],
[8],
[42],
[99],
['A2'],
['F0'],
['100'],
['128'],
['1AB'],
['1FF'],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=HEX2BIN(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Hexadecimal ' . $worksheet->getCell("A$row")->getValueString()
. ' is binary ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/OCT2BIN.php | samples/HexEtcConversions/OCT2BIN.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'OCT2BIN';
$description = 'Converts an octal number to binary';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[3],
[7],
[42],
[70],
[72],
[77],
[100],
[127],
[177],
[456],
[567],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=OCT2BIN(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Octal ' . $worksheet->getCell("A$row")->getValueString()
. ' is binary ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/BIN2DEC.php | samples/HexEtcConversions/BIN2DEC.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'BIN2DEC';
$description = 'Converts a binary number to decimal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[101],
[110110],
[1000000],
[11111111],
[100010101],
[110001100],
[111111111],
[1111111111],
[1100110011],
[1000000000],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=BIN2DEC(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Binary ' . $worksheet->getCell("A$row")->getValueString()
. ' is decimal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/BIN2HEX.php | samples/HexEtcConversions/BIN2HEX.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'BIN2HEX';
$description = 'Converts a binary number to hexadecimal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[101],
[110110],
[1000000],
[11111111],
[100010101],
[110001100],
[111111111],
[1111111111],
[1100110011],
[1000000000],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=BIN2HEX(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Binary ' . $worksheet->getCell("A$row")->getValueString()
. ' is hexadecimal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/HEX2DEC.php | samples/HexEtcConversions/HEX2DEC.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'HEX2DEC';
$description = 'Converts a hexadecimal number to decimal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
['08'],
['42'],
['A2'],
['400'],
['1000'],
['1234'],
['ABCD'],
['C3B0'],
['FFFFFFFFF'],
['FFFFFFFFFF'],
['FFFFFFF800'],
['FEDCBA9876'],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=HEX2DEC(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Hexadecimal ' . $worksheet->getCell("A$row")->getValueString()
. ' is decimal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/HEX2OCT.php | samples/HexEtcConversions/HEX2OCT.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'HEX2OCT';
$description = 'Converts a hexadecimal number to octal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
['08'],
['42'],
['A2'],
['400'],
['100'],
['1234'],
['ABCD'],
['C3B0'],
['FFFFFFFFFF'],
['FFFFFFF800'],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=HEX2OCT(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Hexadecimal ' . $worksheet->getCell("A$row")->getValueString()
. ' is octal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/DEC2BIN.php | samples/HexEtcConversions/DEC2BIN.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'DEC2BIN';
$description = 'Converts a decimal number to binary';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[-255],
[-123],
[-15],
[-1],
[5],
[7],
[19],
[51],
[121],
[256],
[511],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=DEC2BIN(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Decimal ' . $worksheet->getCell("A$row")->getValueString()
. ' is binary ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/OCT2DEC.php | samples/HexEtcConversions/OCT2DEC.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'OCT2DEC';
$description = 'Converts an octal number to decimal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[3],
[7],
[42],
[70],
[72],
[77],
[100],
[127],
[177],
[456],
[4567],
[7777700001],
[7777776543],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=OCT2DEC(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Octal ' . $worksheet->getCell("A$row")->getValueString()
. ' is decimal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/OCT2HEX.php | samples/HexEtcConversions/OCT2HEX.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'OCT2HEX';
$description = 'Converts an octal number to hexadecimal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[3],
[12],
[42],
[70],
[72],
[77],
[100],
[127],
[177],
[456],
[4567],
[7777700001],
[7777776543],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=OCT2HEX(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Octal ' . $worksheet->getCell("A$row")->getValueString()
. ' is hexadecimal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/DEC2OCT.php | samples/HexEtcConversions/DEC2OCT.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'DEC2OCT';
$description = 'Converts a decimal number to octal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[-255],
[-123],
[-15],
[-1],
[5],
[7],
[19],
[51],
[121],
[256],
[511],
[12345678],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=DEC2OCT(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Decimal ' . $worksheet->getCell("A$row")->getValueString()
. ' is octal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/BIN2OCT.php | samples/HexEtcConversions/BIN2OCT.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'BIN2OCT';
$description = 'Converts a binary number to octal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[101],
[110110],
[1000000],
[11111111],
[100010101],
[110001100],
[111111111],
[1111111111],
[1100110011],
[1000000000],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=BIN2OCT(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Binary ' . $worksheet->getCell("A$row")->getValueString()
. ' is octal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/HexEtcConversions/DEC2HEX.php | samples/HexEtcConversions/DEC2HEX.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Engineering';
$functionName = 'DEC2HEX';
$description = 'Converts a decimal number to hexadecimal';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testData = [
[-255],
[-123],
[-15],
[-1],
[5],
[7],
[19],
[51],
[121],
[256],
[511],
[12345678],
];
$testDataCount = count($testData);
$worksheet->fromArray($testData, null, 'A1', true);
for ($row = 1; $row <= $testDataCount; ++$row) {
$worksheet->setCellValue('B' . $row, '=DEC2HEX(A' . $row . ')');
}
// Test the formulae
for ($row = 1; $row <= $testDataCount; ++$row) {
$helper->log(
"(B$row): "
. 'Decimal ' . $worksheet->getCell("A$row")->getValueString()
. ' is hexadecimal ' . $worksheet->getCell("B$row")->getCalculatedValueString()
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Chart/32_Chart_read_write_PDF.php | samples/Chart/32_Chart_read_write_PDF.php | <?php
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Settings;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
IOFactory::registerWriter('Pdf', PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class);
// Change these values to select the Rendering library that you wish to use
//Settings::setChartRenderer(\PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph::class);
Settings::setChartRenderer(PhpOffice\PhpSpreadsheet\Chart\Renderer\MtJpGraphRenderer::class);
$inputFileType = 'Xlsx';
$inputFileNames = __DIR__ . '/../templates/36write*.xlsx';
if ((isset($argc)) && ($argc > 1)) {
$inputFileNames = [];
for ($i = 1; $i < $argc; ++$i) {
$inputFileNames[] = __DIR__ . '/../templates/' . $argv[$i];
}
} else {
$inputFileNames = glob($inputFileNames) ?: [];
}
foreach ($inputFileNames as $inputFileName) {
$inputFileNameShort = basename($inputFileName);
if (!file_exists($inputFileName)) {
$helper->log('File ' . $inputFileNameShort . ' does not exist');
continue;
}
$helper->log("Load Test from $inputFileType file " . $inputFileNameShort);
$reader = IOFactory::createReader($inputFileType);
$reader->setIncludeCharts(true);
$spreadsheet = $reader->load($inputFileName);
$helper->log('Merge chart cells (needed only for Pdf)');
$spreadsheet->mergeChartCellsForPdf();
$helper->log('Iterate worksheets looking at the charts');
foreach ($spreadsheet->getWorksheetIterator() as $worksheet) {
$sheetName = $worksheet->getTitle();
$helper->log('Worksheet: ' . $sheetName);
$chartNames = $worksheet->getChartNames();
if (empty($chartNames)) {
$helper->log(' There are no charts in this worksheet');
} else {
natsort($chartNames);
foreach ($chartNames as $i => $chartName) {
$chart = $worksheet->getChartByNameOrThrow($chartName);
if ($chart->getTitle() !== null) {
$caption = '"' . $chart->getTitle()->getCaptionText($spreadsheet) . '"';
} else {
$caption = 'Untitled';
}
$helper->log(' ' . $chartName . ' - ' . $caption);
$helper->log(str_repeat(' ', strlen($chartName) + 3));
$groupCount = $chart->getPlotAreaOrThrow()->getPlotGroupCount();
if ($groupCount == 1) {
$chartType = $chart->getPlotAreaOrThrow()->getPlotGroupByIndex(0)->getPlotType();
$helper->log(' ' . $chartType);
} else {
$chartTypes = [];
for ($i = 0; $i < $groupCount; ++$i) {
$chartTypes[] = $chart->getPlotAreaOrThrow()->getPlotGroupByIndex($i)->getPlotType();
}
$chartTypes = array_unique($chartTypes);
if (count($chartTypes) == 1) {
$chartType = 'Multiple Plot ' . array_pop($chartTypes);
$helper->log(' ' . $chartType);
} elseif (count($chartTypes) == 0) {
$helper->log(' *** Type not yet implemented');
} else {
$helper->log(' Combination Chart');
}
}
}
}
}
// Save
$filename = $helper->getFilename($inputFileName, 'pdf');
$helper->write($spreadsheet, $filename, ['Pdf'], true);
$spreadsheet->disconnectWorksheets();
unset($spreadsheet);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Chart/35_Chart_render.php | samples/Chart/35_Chart_render.php | <?php
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Settings;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
// Change these values to select the Rendering library that you wish to use
//Settings::setChartRenderer(\PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph::class);
Settings::setChartRenderer(PhpOffice\PhpSpreadsheet\Chart\Renderer\MtJpGraphRenderer::class);
$inputFileType = 'Xlsx';
$inputFileNames = __DIR__ . '/../templates/32readwrite*[0-9].xlsx';
//$inputFileNames = __DIR__ . '/../templates/32readwriteStockChart5.xlsx';
if ((isset($argc)) && ($argc > 1)) {
$inputFileNames = [];
for ($i = 1; $i < $argc; ++$i) {
$inputFileNames[] = __DIR__ . '/../templates/' . $argv[$i];
}
} else {
$inputFileNames = glob($inputFileNames) ?: [];
}
if (count($inputFileNames) === 1) {
/** @var string[] */
$unresolvedErrors = [];
} else {
/** @var string[] */
$unresolvedErrors = [
// The following spreadsheet was created by 3rd party software,
// and doesn't include the data that usually accompanies a chart.
// That is good enough for Excel, but not for JpGraph.
'32readwriteBubbleChart2.xlsx',
];
}
foreach ($inputFileNames as $inputFileName) {
$inputFileNameShort = basename($inputFileName);
if (!file_exists($inputFileName)) {
$helper->log('File ' . $inputFileNameShort . ' does not exist');
continue;
}
if (in_array($inputFileNameShort, $unresolvedErrors, true)) {
$helper->log('*****');
$helper->log('***** File ' . $inputFileNameShort . ' does not yet work with this script');
$helper->log('*****');
continue;
}
$helper->log("Load Test from $inputFileType file " . $inputFileNameShort);
$reader = IOFactory::createReader($inputFileType);
$reader->setIncludeCharts(true);
$spreadsheet = $reader->load($inputFileName);
$helper->log('Iterate worksheets looking at the charts');
$renderedCharts = 0;
foreach ($spreadsheet->getWorksheetIterator() as $worksheet) {
$sheetName = $worksheet->getTitle();
$helper->log('Worksheet: ' . $sheetName);
$chartNames = $worksheet->getChartNames();
if (empty($chartNames)) {
$helper->log(' There are no charts in this worksheet');
} else {
natsort($chartNames);
foreach ($chartNames as $j => $chartName) {
$i = $renderedCharts + $j;
$chart = $worksheet->getChartByNameOrThrow($chartName);
if ($chart->getTitle() !== null) {
$caption = '"' . $chart->getTitle()->getCaptionText($spreadsheet) . '"';
} else {
$caption = 'Untitled';
}
$helper->log(' ' . $chartName . ' - ' . $caption);
$pngFile = $helper->getFilename('35-' . $inputFileNameShort, 'png');
if ($i !== 0) {
$pngFile = substr($pngFile, 0, -3) . "$i.png";
}
if (file_exists($pngFile)) {
unlink($pngFile);
}
try {
$chart->render($pngFile);
$helper->log('Rendered image: ' . $pngFile);
} catch (Exception $e) {
$helper->log('Error rendering chart: ' . $e->getMessage());
}
++$renderedCharts;
}
}
}
$spreadsheet->disconnectWorksheets();
unset($spreadsheet);
gc_collect_cycles();
}
$helper->log('Done rendering charts as images');
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Chart/34_Chart_update.php | samples/Chart/34_Chart_update.php | <?php
use PhpOffice\PhpSpreadsheet\Reader\Xlsx as XlsxReader;
use PhpOffice\PhpSpreadsheet\Writer\Xlsx as XlsxWriter;
require __DIR__ . '/../Header.php';
// Create temporary file that will be read
/** @var PhpOffice\PhpSpreadsheet\Spreadsheet */
$sampleSpreadsheet = require __DIR__ . '/../templates/chartSpreadsheet.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$filename = $helper->getTemporaryFilename();
$writer = new XlsxWriter($sampleSpreadsheet);
$writer->setIncludeCharts(true);
$writer->save($filename);
$helper->log('Load from Xlsx file');
$reader = new XlsxReader();
$reader->setIncludeCharts(true);
$spreadsheet = $reader->load($filename);
unlink($filename);
$helper->log('Update cell data values that are displayed in the chart');
$worksheet = $spreadsheet->getActiveSheet();
$worksheet->fromArray(
[
[50 - 12, 50 - 15, 50 - 21],
[50 - 56, 50 - 73, 50 - 86],
[50 - 52, 50 - 61, 50 - 69],
[50 - 30, 50 - 32, 50],
],
null,
'B2'
);
// Save Excel 2007 file
$helper->write($spreadsheet, __FILE__, ['Xlsx'], true);
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Chart/32_Chart_read_write_HTML.php | samples/Chart/32_Chart_read_write_HTML.php | <?php
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Settings;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
// Change these values to select the Rendering library that you wish to use
//Settings::setChartRenderer(\PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph::class);
Settings::setChartRenderer(PhpOffice\PhpSpreadsheet\Chart\Renderer\MtJpGraphRenderer::class);
$inputFileType = 'Xlsx';
$inputFileNames = __DIR__ . '/../templates/36write*.xlsx';
if ((isset($argc)) && ($argc > 1)) {
$inputFileNames = [];
for ($i = 1; $i < $argc; ++$i) {
$inputFileNames[] = __DIR__ . '/../templates/' . $argv[$i];
}
} else {
$inputFileNames = glob($inputFileNames) ?: [];
}
foreach ($inputFileNames as $inputFileName) {
$inputFileNameShort = basename($inputFileName);
if (!file_exists($inputFileName)) {
$helper->log('File ' . $inputFileNameShort . ' does not exist');
continue;
}
$helper->log("Load Test from $inputFileType file " . $inputFileNameShort);
$reader = IOFactory::createReader($inputFileType);
$reader->setIncludeCharts(true);
$spreadsheet = $reader->load($inputFileName);
$helper->log('Iterate worksheets looking at the charts');
foreach ($spreadsheet->getWorksheetIterator() as $worksheet) {
$sheetName = $worksheet->getTitle();
$helper->log('Worksheet: ' . $sheetName);
$chartNames = $worksheet->getChartNames();
if (empty($chartNames)) {
$helper->log(' There are no charts in this worksheet');
} else {
natsort($chartNames);
foreach ($chartNames as $i => $chartName) {
$chart = $worksheet->getChartByNameOrThrow($chartName);
if ($chart->getTitle() !== null) {
$caption = '"' . $chart->getTitle()->getCaptionText($spreadsheet) . '"';
} else {
$caption = 'Untitled';
}
$helper->log(' ' . $chartName . ' - ' . $caption);
$helper->log(str_repeat(' ', strlen($chartName) + 3));
$groupCount = $chart->getPlotAreaOrThrow()->getPlotGroupCount();
if ($groupCount == 1) {
$chartType = $chart->getPlotAreaOrThrow()->getPlotGroupByIndex(0)->getPlotType();
$helper->log(' ' . $chartType);
} else {
$chartTypes = [];
for ($i = 0; $i < $groupCount; ++$i) {
$chartTypes[] = $chart->getPlotAreaOrThrow()->getPlotGroupByIndex($i)->getPlotType();
}
$chartTypes = array_unique($chartTypes);
if (count($chartTypes) == 1) {
$chartType = 'Multiple Plot ' . array_pop($chartTypes);
$helper->log(' ' . $chartType);
} elseif (count($chartTypes) == 0) {
$helper->log(' *** Type not yet implemented');
} else {
$helper->log(' Combination Chart');
}
}
}
}
}
// Save
$filename = $helper->getFilename($inputFileName, 'html');
$helper->write($spreadsheet, $filename, ['Html'], true);
$spreadsheet->disconnectWorksheets();
unset($spreadsheet);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Chart/37_Chart_dynamic_title.php | samples/Chart/37_Chart_dynamic_title.php | <?php
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Settings;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$inputFileType = 'Xlsx';
$inputFileName = __DIR__ . '/../templates/37dynamictitle.xlsx';
var_dump($inputFileName);
var_dump(realpath($inputFileName));
$inputFileNames = [$inputFileName];
foreach ($inputFileNames as $inputFileName) {
$inputFileNameShort = basename($inputFileName);
if (!file_exists($inputFileName)) {
$helper->log('File ' . $inputFileNameShort . ' does not exist');
continue;
}
$reader = IOFactory::createReader($inputFileType);
$reader->setIncludeCharts(true);
$callStartTime = microtime(true);
$spreadsheet = $reader->load($inputFileName);
$helper->logRead($inputFileType, $inputFileName, $callStartTime);
$helper->log('Iterate worksheets looking at the charts');
foreach ($spreadsheet->getWorksheetIterator() as $worksheet) {
$sheetName = $worksheet->getTitle();
$worksheet->getCell('A1')->setValue('Changed Title');
$helper->log('Worksheet: ' . $sheetName);
$chartNames = $worksheet->getChartNames();
if (empty($chartNames)) {
$helper->log(' There are no charts in this worksheet');
} else {
natsort($chartNames);
foreach ($chartNames as $i => $chartName) {
$chart = $worksheet->getChartByNameOrThrow($chartName);
if ($chart->getTitle() !== null) {
$caption = '"' . $chart->getTitle()->getCaptionText($spreadsheet) . '"';
} else {
$caption = 'Untitled';
}
$helper->log(' ' . $chartName . ' - ' . $caption);
$indentation = str_repeat(' ', strlen($chartName) + 3);
$groupCount = $chart->getPlotAreaOrThrow()->getPlotGroupCount();
if ($groupCount == 1) {
$chartType = $chart->getPlotAreaOrThrow()->getPlotGroupByIndex(0)->getPlotType();
$helper->log($indentation . ' ' . $chartType);
$helper->renderChart($chart, __FILE__, $spreadsheet);
} else {
$chartTypes = [];
for ($i = 0; $i < $groupCount; ++$i) {
$chartTypes[] = $chart->getPlotAreaOrThrow()->getPlotGroupByIndex($i)->getPlotType();
}
$chartTypes = array_unique($chartTypes);
if (count($chartTypes) == 1) {
$chartType = 'Multiple Plot ' . array_pop($chartTypes);
$helper->log($indentation . ' ' . $chartType);
$helper->renderChart($chart, __FILE__);
} elseif (count($chartTypes) == 0) {
$helper->log($indentation . ' *** Type not yet implemented');
} else {
$helper->log($indentation . ' Combination Chart');
$helper->renderChart($chart, __FILE__);
}
}
}
}
}
$callStartTime = microtime(true);
$helper->write($spreadsheet, $inputFileName, ['Xlsx'], true);
Settings::setChartRenderer(PhpOffice\PhpSpreadsheet\Chart\Renderer\MtJpGraphRenderer::class);
$callStartTime = microtime(true);
$helper->write($spreadsheet, $inputFileName, ['Html'], true);
$spreadsheet->disconnectWorksheets();
unset($spreadsheet);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Chart/35_Chart_render33.php | samples/Chart/35_Chart_render33.php | <?php
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Settings;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
// Change these values to select the Rendering library that you wish to use
//Settings::setChartRenderer(\PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph::class);
Settings::setChartRenderer(PhpOffice\PhpSpreadsheet\Chart\Renderer\MtJpGraphRenderer::class);
$inputFileType = 'Xlsx';
$inputFileNamesString = $helper->getTemporaryFolder() . '/33_Chart_create_*.xlsx';
if ((isset($argc)) && ($argc > 1)) {
$inputFileNames = [];
for ($i = 1; $i < $argc; ++$i) {
$inputFileNames[] = __DIR__ . '/../templates/' . $argv[$i];
}
} else {
$inputFileNames = glob($inputFileNamesString) ?: [];
}
if (count($inputFileNames) === 1) {
/** @var string[] */
$unresolvedErrors = [];
} else {
/** @var string[] */
$unresolvedErrors = [
//'33_Chart_create_bar_stacked.xlsx', // fixed with mitoteam/jpgraph 10.3
];
}
foreach ($inputFileNames as $inputFileName) {
$inputFileNameShort = basename($inputFileName);
if (!file_exists($inputFileName)) {
$helper->log('File ' . $inputFileNameShort . ' does not exist');
continue;
}
if (in_array($inputFileNameShort, $unresolvedErrors, true)) {
$helper->log('*****');
$helper->log('***** File ' . $inputFileNameShort . ' does not yet work with this script');
$helper->log('*****');
continue;
}
$helper->log("Load Test from $inputFileType file " . $inputFileNameShort);
$reader = IOFactory::createReader($inputFileType);
$reader->setIncludeCharts(true);
$spreadsheet = $reader->load($inputFileName);
$helper->log('Iterate worksheets looking at the charts');
$renderedCharts = 0;
foreach ($spreadsheet->getWorksheetIterator() as $worksheet) {
$sheetName = $worksheet->getTitle();
$helper->log('Worksheet: ' . $sheetName);
$chartNames = $worksheet->getChartNames();
if (empty($chartNames)) {
$helper->log(' There are no charts in this worksheet');
} else {
natsort($chartNames);
foreach ($chartNames as $j => $chartName) {
$i = $renderedCharts + $j;
$chart = $worksheet->getChartByNameOrThrow($chartName);
if ($chart->getTitle() !== null) {
$caption = '"' . $chart->getTitle()->getCaptionText($spreadsheet) . '"';
} else {
$caption = 'Untitled';
}
$helper->log(' ' . $chartName . ' - ' . $caption);
$pngFile = $helper->getFilename('35-' . $inputFileNameShort, 'png');
if ($i !== 0) {
$pngFile = substr($pngFile, 0, -3) . "$i.png";
}
if (file_exists($pngFile)) {
unlink($pngFile);
}
try {
$chart->render($pngFile);
$helper->log('Rendered image: ' . $pngFile);
} catch (Exception $e) {
$helper->log('Error rendering chart: ' . $e->getMessage());
}
++$renderedCharts;
}
}
}
$spreadsheet->disconnectWorksheets();
unset($spreadsheet);
gc_collect_cycles();
}
$helper->log('Done rendering charts as images');
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Chart/32_Chart_read_write.php | samples/Chart/32_Chart_read_write.php | <?php
use PhpOffice\PhpSpreadsheet\IOFactory;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$inputFileType = 'Xlsx';
$inputFileNames = __DIR__ . '/../templates/32readwrite*[0-9].xlsx';
if ((isset($argc)) && ($argc > 1)) {
$inputFileNames = [];
for ($i = 1; $i < $argc; ++$i) {
$inputFileNames[] = __DIR__ . '/../templates/' . $argv[$i];
}
} else {
$inputFileNames = glob($inputFileNames) ?: [];
}
foreach ($inputFileNames as $inputFileName) {
$inputFileNameShort = basename($inputFileName);
if (!file_exists($inputFileName)) {
$helper->log('File ' . $inputFileNameShort . ' does not exist');
continue;
}
$reader = IOFactory::createReader($inputFileType);
$reader->setIncludeCharts(true);
$callStartTime = microtime(true);
$spreadsheet = $reader->load($inputFileName);
$helper->logRead($inputFileType, $inputFileName, $callStartTime);
$helper->log('Iterate worksheets looking at the charts');
foreach ($spreadsheet->getWorksheetIterator() as $worksheet) {
$sheetName = $worksheet->getTitle();
$helper->log('Worksheet: ' . $sheetName);
$chartNames = $worksheet->getChartNames();
if (empty($chartNames)) {
$helper->log(' There are no charts in this worksheet');
} else {
natsort($chartNames);
foreach ($chartNames as $i => $chartName) {
$chart = $worksheet->getChartByNameOrThrow($chartName);
if ($chart->getTitle() !== null) {
$caption = '"' . $chart->getTitle()->getCaptionText($spreadsheet) . '"';
} else {
$caption = 'Untitled';
}
$helper->log(' ' . $chartName . ' - ' . $caption);
$indentation = str_repeat(' ', strlen($chartName) + 3);
$groupCount = $chart->getPlotAreaOrThrow()->getPlotGroupCount();
if ($groupCount == 1) {
$chartType = $chart->getPlotAreaOrThrow()->getPlotGroupByIndex(0)->getPlotType();
$helper->log($indentation . ' ' . $chartType);
$helper->renderChart($chart, __FILE__);
} else {
$chartTypes = [];
for ($i = 0; $i < $groupCount; ++$i) {
$chartTypes[] = $chart->getPlotAreaOrThrow()->getPlotGroupByIndex($i)->getPlotType();
}
$chartTypes = array_unique($chartTypes);
if (count($chartTypes) == 1) {
$chartType = 'Multiple Plot ' . array_pop($chartTypes);
$helper->log($indentation . ' ' . $chartType);
$helper->renderChart($chart, __FILE__);
} elseif (count($chartTypes) == 0) {
$helper->log($indentation . ' *** Type not yet implemented');
} else {
$helper->log($indentation . ' Combination Chart');
$helper->renderChart($chart, __FILE__);
}
}
}
}
}
$outputFileName = $helper->getFilename($inputFileName);
$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
$writer->setIncludeCharts(true);
$callStartTime = microtime(true);
$writer->save($outputFileName);
$helper->logWrite($writer, $outputFileName, $callStartTime);
$spreadsheet->disconnectWorksheets();
unset($spreadsheet);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial3/IRR.php | samples/Financial3/IRR.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the Internal Rate of Return for a supplied series of periodic cash flows.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Initial Investment', -100.00],
['Year 1 Income', 20.00],
['Year 2 Income', 24.00, 'IRR after 3 Years'],
['Year 3 Income', 28.80],
['Year 4 Income', 34.56, 'IRR after 5 Years'],
['Year 5 Income', 41.47],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B6')->getNumberFormat()->setFormatCode('$#,##0.00;-$#,##0.00');
// Now the formula
$worksheet->setCellValue('C4', '=IRR(B1:B4)');
$worksheet->getStyle('C4')->getNumberFormat()->setFormatCode('0.00%');
$helper->log($worksheet->getCell('C4')->getValue());
$helper->log('IRR() Result is ' . $worksheet->getCell('C4')->getFormattedValue());
$worksheet->setCellValue('C6', '=IRR(B1:B6)');
$worksheet->getStyle('C6')->getNumberFormat()->setFormatCode('0.00%');
$helper->log($worksheet->getCell('C6')->getValue());
$helper->log('IRR() Result is ' . $worksheet->getCell('C6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial3/NOMINAL.php | samples/Financial3/NOMINAL.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the nominal interest rate for a given effective interest rate and number of');
$helper->log('compounding periods per year.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
[0.10, 4],
[0.10, 2],
[0.025, 12],
];
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B3')->getNumberFormat()->setFormatCode('0.00%');
// Now the formula
for ($row = 1; $row <= 3; ++$row) {
$worksheet->setCellValue("C{$row}", "=NOMINAL(A{$row}, B{$row})");
$worksheet->getStyle("C{$row}")->getNumberFormat()->setFormatCode('0.00%');
$helper->log($worksheet->getCell("C{$row}")->getValue());
$helper->log('NOMINAL() Result is ' . $worksheet->getCell("C{$row}")->getFormattedValue());
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial3/NPER.php | samples/Financial3/NPER.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\Financial\Constants as FinancialConstants;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the number of periods required to pay off a loan, for a constant periodic payment');
$helper->log('and a constant interest rate.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Interest Rate', 0.04, 0.06],
['Payments per Year', 1, 4],
['Payment Amount', -6000.00, -2000],
['Present Value', 50000, 60000],
['Future Value', null, 30000],
['Payment Type', null, FinancialConstants::PAYMENT_BEGINNING_OF_PERIOD],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:C1')->getNumberFormat()->setFormatCode('0.00%');
$worksheet->getStyle('B3:C5')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
$worksheet->setCellValue('B8', '=NPER(B1/B2, B3, B4)');
$helper->log($worksheet->getCell('B8')->getValue());
$helper->log('NPER() Result is ' . $worksheet->getCell('B8')->getFormattedValue());
$worksheet->setCellValue('C8', '=NPER(C1/C2, C3, C4, C5, C6)');
$helper->log($worksheet->getCell('C8')->getValue());
$helper->log('NPER() Result is ' . $worksheet->getCell('C8')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial3/IPMT.php | samples/Financial3/IPMT.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the interest payment, during a specific period of a loan or investment that is paid in,');
$helper->log('constant periodic payments, with a constant interest rate.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Interest Rate', 0.05],
['Number of Years', 5],
['Present Value', 50000.00],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1')->getNumberFormat()->setFormatCode('0.00%');
$worksheet->getStyle('B3')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
$baseRow = 6;
for ($month = 1; $month <= 12; ++$month) {
$row = (string) ($baseRow + $month);
$worksheet->setCellValue("A{$row}", "Payment for Mth {$month}");
$worksheet->setCellValue("B{$row}", "=IPMT(\$B\$1/12, {$month}, \$B\$2*12, \$B\$3)");
$worksheet->getStyle("B{$row}")->getNumberFormat()->setFormatCode('$#,##0.00;-$#,##0.00');
$helper->log($worksheet->getCell("B{$row}")->getValue());
$helper->log("IPMT() Month {$month} Result is " . $worksheet->getCell("B{$row}")->getFormattedValue());
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial3/MIRR.php | samples/Financial3/MIRR.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the Modified Internal Rate of Return for a supplied series of periodic cash flows.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Initial Investment', -100.00],
['Year 1 Income', 18.00],
['Year 2 Income', 22.50, 'MIRR after 3 Years'],
['Year 3 Income', 28.00],
['Year 4 Income', 35.50, 'MIRR after 5 Years'],
['Year 5 Income', 45.00],
[null],
['Finance Rate', 0.055],
['Re-invest Rate', 0.05],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B6')->getNumberFormat()->setFormatCode('$#,##0.00;-$#,##0.00');
$worksheet->getStyle('B8:B9')->getNumberFormat()->setFormatCode('0.00%');
// Now the formula
$worksheet->setCellValue('C4', '=MIRR(B1:B4, B8, B9)');
$worksheet->getStyle('C4')->getNumberFormat()->setFormatCode('0.00%');
$helper->log($worksheet->getCell('C4')->getValue());
$helper->log('MIRR() Result is ' . $worksheet->getCell('C4')->getFormattedValue());
$worksheet->setCellValue('C6', '=MIRR(B1:B6, B8, B9)');
$worksheet->getStyle('C6')->getNumberFormat()->setFormatCode('0.00%');
$helper->log($worksheet->getCell('C6')->getValue());
$helper->log('MIRR() Result is ' . $worksheet->getCell('C6')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial3/ISPMT.php | samples/Financial3/ISPMT.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the interest paid during a specific period of a loan or investment.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Interest Rate', 0.05],
['Number of Years', 5],
['Present Value', 50000.00],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1')->getNumberFormat()->setFormatCode('0.00%');
$worksheet->getStyle('B3')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
$baseRow = 6;
for ($month = 1; $month <= 12; ++$month) {
$row = (string) ($baseRow + $month);
$worksheet->setCellValue("A{$row}", "Payment for Mth {$month}");
$worksheet->setCellValue("B{$row}", "=ISPMT(\$B\$1/12, {$month}, \$B\$2*12, \$B\$3)");
$worksheet->getStyle("B{$row}")->getNumberFormat()->setFormatCode('$#,##0.00;-$#,##0.00');
$helper->log($worksheet->getCell("B{$row}")->getValue());
$helper->log("ISPMT() Month {$month} Result is " . $worksheet->getCell("B{$row}")->getFormattedValue());
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial3/INTRATE.php | samples/Financial3/INTRATE.php | <?php
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers as DateHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the interest rate for a fully invested security.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Settlement Date', DateHelper::getDateValue('01-Apr-2005')],
['Maturity Date', DateHelper::getDateValue('31-Mar-2010')],
['Investment', 1000.00],
['Investment', 2125.00],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:B2')->getNumberFormat()->setFormatCode('dd-mmm-yyyy');
$worksheet->getStyle('B3:B4')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
$worksheet->setCellValue('B7', '=INTRATE(B1, B2, B3, B4)');
$worksheet->getStyle('B7')->getNumberFormat()->setFormatCode('0.00%');
$helper->log($worksheet->getCell('B7')->getValue());
$helper->log('INTRATE() Result is ' . $worksheet->getCell('B7')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/Financial3/NPV.php | samples/Financial3/NPV.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Returns the Net Present Value of an investment, based on a supplied discount rate,');
$helper->log('and a series of future payments and income.');
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$arguments = [
['Annual Discount Rate', 0.02, 0.05],
['Initial Investment Cost', -5000.00, -10000],
['Return from Year 1', 800.00, 2000.00],
['Return from Year 2', 950.00, 2400.00],
['Return from Year 3', 1080.00, 2900.00],
['Return from Year 4', 1220.00, 3500.00],
['Return from Year 5', 1500.00, 4100.00],
];
// Some basic formatting for the data
$worksheet->fromArray($arguments, null, 'A1');
$worksheet->getStyle('B1:C1')->getNumberFormat()->setFormatCode('0.00%');
$worksheet->getStyle('B2:C7')->getNumberFormat()->setFormatCode('$#,##0.00');
// Now the formula
// When initial investment is made at the end of the first period
$worksheet->setCellValue('B10', '=NPV(B1, B2:B7)');
$worksheet->getStyle('B10')->getNumberFormat()->setFormatCode('$#,##0.00');
$helper->log($worksheet->getCell('B10')->getValue());
$helper->log('NPV() Result is ' . $worksheet->getCell('B10')->getFormattedValue());
// When initial investment is made at the start of the first period
$worksheet->setCellValue('C10', '=NPV(C1, C3:C7) + C2');
$worksheet->getStyle('C10')->getNumberFormat()->setFormatCode('$#,##0.00');
$helper->log($worksheet->getCell('C10')->getValue());
$helper->log('NPV() Result is ' . $worksheet->getCell('C10')->getFormattedValue());
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/TIME.php | samples/DateTime2/TIME.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'TIME';
$description = 'Returns the Excel serial number of a particular time';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testDates = [[3, 15], [13, 15], [15, 15, 15], [3, 15, 30],
[15, 15, 15], [5], [9, 15, 0], [9, 15, -1],
[13, -14, -15], [0, 0, -1],
];
$testDateCount = count($testDates);
$worksheet->fromArray($testDates, null, 'A1', true);
for ($row = 1; $row <= $testDateCount; ++$row) {
$worksheet->setCellValue('D' . $row, '=TIME(A' . $row . ',B' . $row . ',C' . $row . ')');
$worksheet->setCellValue('E' . $row, '=D' . $row);
}
$worksheet->getStyle('E1:E' . $testDateCount)
->getNumberFormat()
->setFormatCode('hh:mm:ss');
// Test the formulae
for ($row = 1; $row <= $testDateCount; ++$row) {
$helper->log("(A{$row}) Hour: " . $worksheet->getCell('A' . $row)->getFormattedValue());
$helper->log("(B{$row}) Minute: " . $worksheet->getCell('B' . $row)->getFormattedValue());
$helper->log("(C{$row}) Second: " . $worksheet->getCell('C' . $row)->getFormattedValue());
$helper->log('Formula: ' . $worksheet->getCell('D' . $row)->getValueString());
$helper->log('Excel TimeStamp: ' . $worksheet->getCell('D' . $row)->getCalculatedValueString());
$helper->log('Formatted TimeStamp: ' . $worksheet->getCell('E' . $row)->getFormattedValue());
$helper->log('');
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/SECOND.php | samples/DateTime2/SECOND.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'SECOND';
$description = 'Returns the second of a time value. The second is given as an integer, ranging from 0 to 59';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testTimes = [
[0, 6, 0],
[1, 12, 15],
[3, 30, 12],
[5, 17, 31],
[8, 15, 45],
[12, 45, 11],
[14, 0, 30],
[17, 55, 50],
[19, 21, 8],
[21, 10, 10],
[23, 59, 59],
];
$testTimeCount = count($testTimes);
$worksheet->fromArray($testTimes, null, 'A1', true);
for ($row = 1; $row <= $testTimeCount; ++$row) {
$worksheet->setCellValue('D' . $row, '=TIME(A' . $row . ',B' . $row . ',C' . $row . ')');
$worksheet->setCellValue('E' . $row, '=D' . $row);
$worksheet->setCellValue('F' . $row, '=SECOND(D' . $row . ')');
}
$worksheet->getStyle('E1:E' . $testTimeCount)
->getNumberFormat()
->setFormatCode('hh:mm:ss');
// Test the formulae
for ($row = 1; $row <= $testTimeCount; ++$row) {
$helper->log(sprintf('(E%d): %s', $row, $worksheet->getCell('E' . $row)->getFormattedValue()));
$helper->log('Second is: ' . $worksheet->getCell('F' . $row)->getCalculatedValueString());
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/TODAY.php | samples/DateTime2/TODAY.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'TODAY';
$description = 'Returns the serial number of the current date';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
$worksheet->setCellValue('A1', '=TODAY()');
$worksheet->getStyle('A1')
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
// Test the formulae
$helper->log(
'Today is '
. $worksheet->getCell('A1')->getCalculatedValueString()
. ' ('
. $worksheet->getCell('A1')->getFormattedValue()
. ')'
);
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/TIMEVALUE.php | samples/DateTime2/TIMEVALUE.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'DATEVALUE';
$description = 'Converts a time in the form of text to an Excel serial number';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testDates = ['3:15', '13:15', '15:15:15', '3:15 AM', '3:15 PM', '5PM', '9:15AM', '13:15AM',
];
$testDateCount = count($testDates);
for ($row = 1; $row <= $testDateCount; ++$row) {
$worksheet->setCellValue('A' . $row, $testDates[$row - 1]);
$worksheet->setCellValue('B' . $row, '=TIMEVALUE(A' . $row . ')');
$worksheet->setCellValue('C' . $row, '=B' . $row);
}
$worksheet->getStyle('C1:C' . $testDateCount)
->getNumberFormat()
->setFormatCode('hh:mm:ss');
// Test the formulae
for ($row = 1; $row <= $testDateCount; ++$row) {
$helper->log("(A{$row}) Time String: " . $worksheet->getCell('A' . $row)->getFormattedValue());
$helper->log('Formula: ' . $worksheet->getCell('B' . $row)->getValueString());
$helper->log('Excel TimeStamp: ' . $worksheet->getCell('B' . $row)->getFormattedValue());
$helper->log('Formatted TimeStamp: ' . $worksheet->getCell('C' . $row)->getFormattedValue());
$helper->log('');
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/NOW.php | samples/DateTime2/NOW.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'NOW';
$description = 'Returns the serial number of the current date and time';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
$worksheet->setCellValue('A1', '=NOW()');
$worksheet->getStyle('A1')
->getNumberFormat()
->setFormatCode('yyyy-mm-dd hh:mm:ss');
// Test the formulae
$helper->log(
'Today is '
. $worksheet->getCell('A1')->getCalculatedValueString()
. ' ('
. $worksheet->getCell('A1')->getFormattedValue()
. ')'
);
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/NETWORKDAYS.php | samples/DateTime2/NETWORKDAYS.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'NETWORKDAYS';
$description = 'Returns the number of whole working days between start_date and end_date. Working days exclude weekends and any dates identified in holidays';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$publicHolidays = [
[2022, 1, 3, '=DATE(G1, H1, I1)', 'New Year'],
[2022, 4, 15, '=DATE(G2, H2, I2)', 'Good Friday'],
[2022, 4, 18, '=DATE(G3, H3, I3)', 'Easter Monday'],
[2022, 5, 2, '=DATE(G4, H4, I4)', 'Early May Bank Holiday'],
[2022, 6, 2, '=DATE(G5, H5, I5)', 'Spring Bank Holiday'],
[2022, 6, 3, '=DATE(G6, H6, I6)', 'Platinum Jubilee Bank Holiday'],
[2022, 8, 29, '=DATE(G7, H7, I7)', 'Summer Bank Holiday'],
[2022, 12, 26, '=DATE(G8, H8, I8)', 'Boxing Day'],
[2022, 12, 27, '=DATE(G9, H9, I9)', 'Christmas Day'],
];
$holidayCount = count($publicHolidays);
$worksheet->fromArray($publicHolidays, null, 'G1', true);
$worksheet->getStyle('J1:J' . $holidayCount)
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
$worksheet->setCellValue('A1', '=DATE(2022,1,1)');
for ($numberOfMonths = 0; $numberOfMonths < 12; ++$numberOfMonths) {
$worksheet->setCellValue('B' . ($numberOfMonths + 1), '=EOMONTH(A1, ' . $numberOfMonths . ')');
$worksheet->setCellValue('C' . ($numberOfMonths + 1), '=NETWORKDAYS(A1, B' . ($numberOfMonths + 1) . ')');
$worksheet->setCellValue('D' . ($numberOfMonths + 1), '=NETWORKDAYS(A1, B' . ($numberOfMonths + 1) . ', J1:J' . $holidayCount . ')');
}
$worksheet->getStyle('A1')
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
$worksheet->getStyle('B1:B12')
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
// Test the formulae
$helper->log('UK Public Holidays');
$holidayData = $worksheet->rangeToArray('J1:K' . $holidayCount, null, true, true, true);
$helper->displayGrid($holidayData);
for ($row = 1; $row <= 12; ++$row) {
$helper->log(
'Between '
. $worksheet->getCell('A1')->getFormattedValue()
. ' and '
. $worksheet->getCell('B' . $row)->getFormattedValue()
. ' is '
. $worksheet->getCell('C' . $row)->getCalculatedValueString()
. ' working days; '
. $worksheet->getCell('D' . $row)->getCalculatedValueString()
. ' excluding public holidays'
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/YEARFRAC.php | samples/DateTime2/YEARFRAC.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'DAYS360';
$description = 'Returns the number of days between two dates based on a 360-day year';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testDates = [
[1900, 1, 1],
[1904, 1, 1],
[1936, 3, 17],
[1960, 12, 19],
[1999, 12, 31],
[2000, 1, 1],
[2019, 2, 14],
[2020, 7, 4],
[2020, 2, 29],
[2029, 12, 31],
[2525, 1, 1],
];
$testDateCount = count($testDates);
$worksheet->fromArray($testDates, null, 'A1', true);
for ($row = 1; $row <= $testDateCount; ++$row) {
$worksheet->setCellValue('D' . $row, '=DATE(A' . $row . ',B' . $row . ',C' . $row . ')');
$worksheet->setCellValue('E' . $row, '=D' . $row);
$worksheet->setCellValue('F' . $row, '=DATE(2022,12,31)');
$worksheet->setCellValue('G' . $row, '=YEARFRAC(D' . $row . ', F' . $row . ')');
$worksheet->setCellValue('H' . $row, '=YEARFRAC(D' . $row . ', F' . $row . ', 1)');
$worksheet->setCellValue('I' . $row, '=YEARFRAC(D' . $row . ', F' . $row . ', 2)');
$worksheet->setCellValue('J' . $row, '=YEARFRAC(D' . $row . ', F' . $row . ', 3)');
$worksheet->setCellValue('K' . $row, '=YEARFRAC(D' . $row . ', F' . $row . ', 4)');
}
$worksheet->getStyle('E1:F' . $testDateCount)
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
// Test the formulae
for ($row = 1; $row <= $testDateCount; ++$row) {
$helper->log(sprintf(
'Between: %s and %s',
$worksheet->getCell('E' . $row)->getFormattedValue(),
$worksheet->getCell('F' . $row)->getFormattedValue()
));
$helper->log(
'Days: '
. $worksheet->getCell('G' . $row)->getCalculatedValueString()
. ' - US (NASD) 30/360'
);
$helper->log(
'Days: '
. $worksheet->getCell('H' . $row)->getCalculatedValueString()
. ' - Actual'
);
$helper->log(
'Days: '
. $worksheet->getCell('I' . $row)->getCalculatedValueString()
. ' - Actual/360'
);
$helper->log(
'Days: '
. $worksheet->getCell('J' . $row)->getCalculatedValueString()
. ' - Actual/365'
);
$helper->log(
'Days: '
. $worksheet->getCell('K' . $row)->getCalculatedValueString()
. ' - European 30/360'
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/WORKDAY.php | samples/DateTime2/WORKDAY.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'WORKDAY';
$description = 'Returns a number that represents a date that is the indicated number of working days before or after a starting date. Working days exclude weekends and any dates identified as holidays';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$publicHolidays = [
[2022, 1, 3, '=DATE(G1, H1, I1)', 'New Year'],
[2022, 4, 15, '=DATE(G2, H2, I2)', 'Good Friday'],
[2022, 4, 18, '=DATE(G3, H3, I3)', 'Easter Monday'],
[2022, 5, 2, '=DATE(G4, H4, I4)', 'Early May Bank Holiday'],
[2022, 6, 2, '=DATE(G5, H5, I5)', 'Spring Bank Holiday'],
[2022, 6, 3, '=DATE(G6, H6, I6)', 'Platinum Jubilee Bank Holiday'],
[2022, 8, 29, '=DATE(G7, H7, I7)', 'Summer Bank Holiday'],
[2022, 12, 26, '=DATE(G8, H8, I8)', 'Boxing Day'],
[2022, 12, 27, '=DATE(G9, H9, I9)', 'Christmas Day'],
];
$holidayCount = count($publicHolidays);
$worksheet->fromArray($publicHolidays, null, 'G1', true);
$worksheet->getStyle('J1:J' . $holidayCount)
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
$worksheet->setCellValue('A1', '=DATE(2022,1,1)');
$workdayStep = 10;
for ($days = $workdayStep; $days <= 366; $days += $workdayStep) {
$worksheet->setCellValue('B' . ((int) $days / $workdayStep + 1), $days);
$worksheet->setCellValue('C' . ((int) $days / $workdayStep + 1), '=WORKDAY(A1, B' . ((int) $days / $workdayStep + 1) . ')');
$worksheet->setCellValue('D' . ((int) $days / $workdayStep + 1), '=WORKDAY(A1, B' . ((int) $days / $workdayStep + 1) . ', J1:J' . $holidayCount . ')');
}
$worksheet->getStyle('A1')
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
$worksheet->getStyle('C1:D50')
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
// Test the formulae
$helper->log('UK Public Holidays');
$holidayData = $worksheet->rangeToArray('J1:K' . $holidayCount, null, true, true, true);
$helper->displayGrid($holidayData);
for ($days = $workdayStep; $days <= 366; $days += $workdayStep) {
$helper->log(sprintf(
'%d workdays from %s is %s; %s with public holidays',
$worksheet->getCell('B' . ((int) $days / $workdayStep + 1))->getFormattedValue(),
$worksheet->getCell('A1')->getFormattedValue(),
$worksheet->getCell('C' . ((int) $days / $workdayStep + 1))->getFormattedValue(),
$worksheet->getCell('D' . ((int) $days / $workdayStep + 1))->getFormattedValue()
));
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/WEEKDAY.php | samples/DateTime2/WEEKDAY.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'WEEKDAY';
$description = 'Returns the day of the week corresponding to a date';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testDates = [
[1900, 1, 1],
[1904, 2, 14],
[1936, 3, 17],
[1964, 4, 29],
[1999, 5, 18],
[2000, 6, 21],
[2019, 7, 4],
[2020, 8, 31],
[1956, 9, 10],
[2010, 10, 10],
[1982, 11, 30],
[1960, 12, 19],
['=YEAR(TODAY())', '=MONTH(TODAY())', '=DAY(TODAY())'],
];
$testDateCount = count($testDates);
$worksheet->fromArray($testDates, null, 'A1', true);
for ($row = 1; $row <= $testDateCount; ++$row) {
$worksheet->setCellValue('D' . $row, '=DATE(A' . $row . ',B' . $row . ',C' . $row . ')');
$worksheet->setCellValue('E' . $row, '=D' . $row);
$worksheet->setCellValue('F' . $row, '=WEEKDAY(D' . $row . ')');
$worksheet->setCellValue('G' . $row, '=WEEKDAY(D' . $row . ', 2)');
}
$worksheet->getStyle('E1:E' . $testDateCount)
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
// Test the formulae
for ($row = 1; $row <= $testDateCount; ++$row) {
$helper->log(sprintf('(E%d): %s', $row, $worksheet->getCell('E' . $row)->getFormattedValue()));
$helper->log(
'Weekday is: '
. $worksheet->getCell('F' . $row)->getCalculatedValueString()
. ' (1-7 = Sun-Sat)'
);
$helper->log(
'Weekday is: '
. $worksheet->getCell('G' . $row)->getCalculatedValueString()
. ' (1-7 = Mon-Sun)'
);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/YEAR.php | samples/DateTime2/YEAR.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'YEAR';
$description = 'Returns the year of a date, an integer ranging from 1900 to 9999';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testDates = [
[1900, 1, 1],
[1904, 2, 14],
[1936, 3, 17],
[1964, 4, 29],
[1999, 5, 18],
[2000, 6, 21],
[2019, 7, 4],
[2020, 8, 31],
[1956, 9, 10],
[2010, 10, 10],
[1982, 11, 30],
[1960, 12, 19],
['=YEAR(TODAY())', '=MONTH(TODAY())', '=DAY(TODAY())'],
];
$testDateCount = count($testDates);
$worksheet->fromArray($testDates, null, 'A1', true);
for ($row = 1; $row <= $testDateCount; ++$row) {
$worksheet->setCellValue('D' . $row, '=DATE(A' . $row . ',B' . $row . ',C' . $row . ')');
$worksheet->setCellValue('E' . $row, '=D' . $row);
$worksheet->setCellValue('F' . $row, '=YEAR(D' . $row . ')');
}
$worksheet->getStyle('E1:E' . $testDateCount)
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
// Test the formulae
for ($row = 1; $row <= $testDateCount; ++$row) {
$helper->log(sprintf('(E%d): %s', $row, $worksheet->getCell('E' . $row)->getFormattedValue()));
$helper->log('Year is: ' . $worksheet->getCell('F' . $row)->getCalculatedValueString());
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/samples/DateTime2/WEEKNUM.php | samples/DateTime2/WEEKNUM.php | <?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$category = 'Date/Time';
$functionName = 'WEEKNUM';
$description = 'Returns the week number of a specific date';
$helper->titles($category, $functionName, $description);
// Create new PhpSpreadsheet object
$spreadsheet = new Spreadsheet();
$worksheet = $spreadsheet->getActiveSheet();
// Add some data
$testDates = [
[1900, 1, 1],
[1904, 2, 14],
[1936, 3, 17],
[1964, 4, 29],
[1999, 5, 18],
[2000, 6, 21],
[2019, 7, 4],
[2020, 8, 31],
[1956, 9, 10],
[2010, 10, 10],
[1982, 11, 30],
[1960, 12, 19],
['=YEAR(TODAY())', '=MONTH(TODAY())', '=DAY(TODAY())'],
];
$testDateCount = count($testDates);
$worksheet->fromArray($testDates, null, 'A1', true);
for ($row = 1; $row <= $testDateCount; ++$row) {
$worksheet->setCellValue('D' . $row, '=DATE(A' . $row . ',B' . $row . ',C' . $row . ')');
$worksheet->setCellValue('E' . $row, '=D' . $row);
$worksheet->setCellValue('F' . $row, '=WEEKNUM(D' . $row . ')');
$worksheet->setCellValue('G' . $row, '=WEEKNUM(D' . $row . ', 21)');
}
$worksheet->getStyle('E1:E' . $testDateCount)
->getNumberFormat()
->setFormatCode('yyyy-mm-dd');
// Test the formulae
for ($row = 1; $row <= $testDateCount; ++$row) {
$helper->log(sprintf('(E%d): %s', $row, $worksheet->getCell('E' . $row)->getFormattedValue()));
$helper->log('System 1 Week number is: ' . $worksheet->getCell('F' . $row)->getCalculatedValueString());
$helper->log('System 2 (ISO-8601) Week number is: ' . $worksheet->getCell('G' . $row)->getCalculatedValueString());
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/infra/DocumentGenerator.php | infra/DocumentGenerator.php | <?php
namespace PhpOffice\PhpSpreadsheetInfra;
use PhpOffice\PhpSpreadsheet\Calculation\Category;
use PhpOffice\PhpSpreadsheet\Calculation\Functions;
use ReflectionClass;
use UnexpectedValueException;
class DocumentGenerator
{
private const EXCLUDED_FUNCTIONS = [
'CEILING.ODS',
'CEILING.XCL',
'FLOOR.ODS',
'FLOOR.XCL',
];
/**
* @param array<string, array{category: string, functionCall: string|string[], argumentCount: string, passCellReference?: bool, passByReference?: bool[], custom?: bool}> $phpSpreadsheetFunctions
*/
public static function generateFunctionListByCategory($phpSpreadsheetFunctions): string
{
$result = "# Function list by category\n";
foreach (self::getCategories() as $categoryConstant => $category) {
$result .= "\n";
$result .= "## {$categoryConstant}\n";
$result .= "\n";
$lengths = [25, 37];
$result .= self::tableRow($lengths, ['Excel Function', 'PhpSpreadsheet Function']) . "\n";
$result .= self::tableRow($lengths, null) . "\n";
foreach ($phpSpreadsheetFunctions as $excelFunction => $functionInfo) {
if (in_array($excelFunction, self::EXCLUDED_FUNCTIONS, true)) {
continue;
}
if ($category === $functionInfo['category']) {
$phpFunction = self::getPhpSpreadsheetFunctionText($functionInfo['functionCall']);
$result .= self::tableRow($lengths, [$excelFunction, $phpFunction]) . "\n";
}
}
}
return $result;
}
/** @return array<string, string> */
private static function getCategories(): array
{
/** @var array<string, string> */
$x = (new ReflectionClass(Category::class))->getConstants();
return $x;
}
/**
* @param int[] $lengths
* @param null|array<int, int|string> $values
*/
private static function tableRow(array $lengths, ?array $values = null): string
{
$result = '';
foreach (array_map(null, $lengths, $values ?? []) as $i => [$length, $value]) {
$pad = $value === null ? '-' : ' ';
if ($i > 0) {
$result .= '|' . $pad;
}
$result .= str_pad("$value", $length ?? 0, $pad);
}
return rtrim($result, ' ');
}
/** @param scalar|string|string[] $functionCall */
private static function getPhpSpreadsheetFunctionText(mixed $functionCall): string
{
if (is_string($functionCall)) {
return $functionCall;
}
if ($functionCall === [Functions::class, 'DUMMY']) {
return '**Not yet Implemented**';
}
if (is_array($functionCall)) {
return "\\{$functionCall[0]}::{$functionCall[1]}";
}
throw new UnexpectedValueException(
'$functionCall is of type ' . gettype($functionCall) . '. string or array expected'
);
}
/**
* @param array<string, array{category: string, functionCall: string|string[], argumentCount: string, passCellReference?: bool, passByReference?: bool[], custom?: bool}> $phpSpreadsheetFunctions
*/
public static function generateFunctionListByName(array $phpSpreadsheetFunctions, bool $compact = false): string
{
$categoryConstants = array_flip(self::getCategories());
if ($compact) {
$result = "# Function list by name compact\n";
$result .= "\n";
$result .= 'Category should be prefixed by `CATEGORY_` to match the values in \PhpOffice\PhpSpreadsheet\Calculation\Category';
$result .= "\n\n";
$result .= 'Function should be prefixed by `PhpOffice\PhpSpreadsheet\Calculation\`';
$result .= "\n\n";
$result .= 'A less compact list can be found [here](./function-list-by-name.md)';
$result .= "\n\n";
} else {
$result = "# Function list by name\n";
$result .= "\n";
$result .= 'A more compact list can be found [here](./function-list-by-name-compact.md)';
$result .= "\n\n";
}
$lastAlphabet = null;
$lengths = $compact ? [25, 22, 37] : [25, 31, 37];
foreach ($phpSpreadsheetFunctions as $excelFunction => $functionInfo) {
if (in_array($excelFunction, self::EXCLUDED_FUNCTIONS, true)) {
continue;
}
if ($lastAlphabet !== $excelFunction[0]) {
$lastAlphabet = $excelFunction[0];
$result .= "\n";
$result .= "## {$lastAlphabet}\n";
$result .= "\n";
$result .= self::tableRow($lengths, ['Excel Function', 'Category', 'PhpSpreadsheet Function']) . "\n";
$result .= self::tableRow($lengths, null) . "\n";
}
$category = $categoryConstants[$functionInfo['category']];
$phpFunction = self::getPhpSpreadsheetFunctionText($functionInfo['functionCall']);
if ($compact) {
$category = str_replace('CATEGORY_', '', $category);
$phpFunction = str_replace(
'\PhpOffice\PhpSpreadsheet\Calculation\\',
'',
$phpFunction
);
}
$result .= self::tableRow($lengths, [$excelFunction, $category, $phpFunction]) . "\n";
}
return $result;
}
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/infra/LocaleGenerator.php | infra/LocaleGenerator.php | <?php
namespace PhpOffice\PhpSpreadsheetInfra;
use Exception;
use PhpOffice\PhpSpreadsheet\Cell\Cell;
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
class LocaleGenerator
{
private const EXCEL_LOCALISATION_WORKSHEET = 'Excel Localisation';
private const EXCEL_FUNCTIONS_WORKSHEET = 'Excel Functions';
private const LOCALE_NAME_ROW = 1;
private const LOCALE_LANGUAGE_NAME_ROW = 2;
private const ENGLISH_LANGUAGE_NAME_ROW = 3;
private const ARGUMENT_SEPARATOR_ROW = 5;
private const ERROR_CODES_FIRST_ROW = 8;
private const CURRENCY_SYMBOL_ROW = 19;
private const FUNCTION_NAME_LIST_FIRST_ROW = 4;
private const ENGLISH_FUNCTION_CATEGORIES_COLUMN = 'A';
private const ENGLISH_REFERENCE_COLUMN = 'B';
private const EOL = "\n"; // not PHP_EOL
protected string $translationSpreadsheetName;
protected string $translationBaseFolder;
/** @var array<string, array{category: string, functionCall: string|string[], argumentCount: string, passCellReference?: bool, passByReference?: bool[], custom?: bool}> */
protected array $phpSpreadsheetFunctions;
protected Spreadsheet $translationSpreadsheet;
protected bool $verbose;
protected Worksheet $localeTranslations;
/** @var string[] */
protected array $localeLanguageMap = [];
/** @var int[] */
protected array $errorCodeMap = [];
private Worksheet $functionNameTranslations;
/** @var string[] */
protected array $functionNameLanguageMap = [];
/** @var array<int|string> */
protected array $functionNameMap = [];
/**
* @param array<string, array{category: string, functionCall: string|string[], argumentCount: string, passCellReference?: bool, passByReference?: bool[], custom?: bool}> $phpSpreadsheetFunctions
*/
public function __construct(
string $translationBaseFolder,
string $translationSpreadsheetName,
array $phpSpreadsheetFunctions,
bool $verbose = false
) {
$this->translationBaseFolder = $translationBaseFolder;
$this->translationSpreadsheetName = $translationSpreadsheetName;
$this->phpSpreadsheetFunctions = $phpSpreadsheetFunctions;
$this->verbose = $verbose;
}
public function generateLocales(): void
{
$this->openTranslationWorkbook();
$this->localeTranslations = $this->getTranslationSheet(self::EXCEL_LOCALISATION_WORKSHEET);
$this->localeLanguageMap = $this->mapLanguageColumns($this->localeTranslations);
$this->mapErrorCodeRows();
$this->functionNameTranslations = $this->getTranslationSheet(self::EXCEL_FUNCTIONS_WORKSHEET);
$this->functionNameLanguageMap = $this->mapLanguageColumns($this->functionNameTranslations);
$this->mapFunctionNameRows();
foreach ($this->localeLanguageMap as $column => $locale) {
$this->buildConfigFileForLocale($column, $locale);
}
foreach ($this->functionNameLanguageMap as $column => $locale) {
$this->buildFunctionsFileForLocale($column, $locale);
}
}
protected function buildConfigFileForLocale(string $column, string $locale): void
{
$language = $this->localeTranslations->getCell($column . self::ENGLISH_LANGUAGE_NAME_ROW)->getValue();
if (!is_string($language)) {
throw new Exception('Non-string language value at ' . $column . self::ENGLISH_LANGUAGE_NAME_ROW);
}
$localeLanguage = $this->localeTranslations->getCell($column . self::LOCALE_LANGUAGE_NAME_ROW)->getValue();
if (!is_string($localeLanguage)) {
throw new Exception('Non-string locale language value at ' . $column . self::LOCALE_LANGUAGE_NAME_ROW);
}
$configFile = $this->openConfigFile($locale, $language, $localeLanguage);
$this->writeConfigArgumentSeparator($configFile, $column);
$this->writeConfigCurrencySymbol($configFile, $column);
$this->writeFileSectionHeader($configFile, 'Error Codes');
foreach ($this->errorCodeMap as $errorCode => $row) {
$translationCell = $this->localeTranslations->getCell($column . $row);
$translationValue = $translationCell->getValue();
if ($translationValue !== null && !is_string($translationValue)) {
throw new Exception('Non-string translation value at ' . $column . $row);
}
if (!empty($translationValue)) {
$errorCodeTranslation = "{$errorCode} = {$translationValue}" . self::EOL;
fwrite($configFile, $errorCodeTranslation);
} else {
$errorCodeTranslation = "{$errorCode}" . self::EOL;
fwrite($configFile, $errorCodeTranslation);
$this->log("No {$language} translation available for error code {$errorCode}");
}
}
fclose($configFile);
}
/** @param resource $configFile resource to write to */
protected function writeConfigArgumentSeparator($configFile, string $column): void
{
$translationCell = $this->localeTranslations->getCell($column . self::ARGUMENT_SEPARATOR_ROW);
$localeValue = $translationCell->getValue();
if ($localeValue !== null && !is_string($localeValue)) {
throw new Exception('Non-string locale value at ' . $column . self::CURRENCY_SYMBOL_ROW);
}
if (!empty($localeValue)) {
$functionTranslation = "ArgumentSeparator = {$localeValue}" . self::EOL;
fwrite($configFile, $functionTranslation);
} else {
$this->log('No Argument Separator defined');
}
}
/** @param resource $configFile resource to write to */
protected function writeConfigCurrencySymbol($configFile, string $column): void
{
$translationCell = $this->localeTranslations->getCell($column . self::CURRENCY_SYMBOL_ROW);
$localeValue = $translationCell->getValue();
if ($localeValue !== null && !is_string($localeValue)) {
throw new Exception('Non-string locale value at ' . $column . self::CURRENCY_SYMBOL_ROW);
}
if (!empty($localeValue)) {
$functionTranslation = "currencySymbol = {$localeValue}" . self::EOL;
fwrite($configFile, '##' . self::EOL);
fwrite($configFile, '## (For future use)' . self::EOL);
fwrite($configFile, '##' . self::EOL);
fwrite($configFile, $functionTranslation);
} else {
$this->log('No Currency Symbol defined');
}
}
protected function buildFunctionsFileForLocale(string $column, string $locale): void
{
$language = $this->functionNameTranslations->getCell($column . self::ENGLISH_LANGUAGE_NAME_ROW)->getValue();
if (!is_string($language)) {
throw new Exception('Non-string language value at ' . $column . self::ENGLISH_LANGUAGE_NAME_ROW);
}
$localeLanguage = $this->functionNameTranslations->getCell($column . self::LOCALE_LANGUAGE_NAME_ROW)
->getValue();
if (!is_string($localeLanguage)) {
throw new Exception('Non-string locale language value at ' . $column . self::LOCALE_LANGUAGE_NAME_ROW);
}
$functionFile = $this->openFunctionNameFile($locale, $language, $localeLanguage);
foreach ($this->functionNameMap as $functionName => $row) {
$translationCell = $this->functionNameTranslations->getCell($column . $row);
$translationValue = $translationCell->getValue();
if ($translationValue !== null && !is_string($translationValue)) {
throw new Exception('Non-string translation value at ' . $column . $row);
}
if ($this->isFunctionCategoryEntry($translationCell)) {
$this->writeFileSectionHeader($functionFile, "{$translationValue} ({$functionName})");
} elseif (!array_key_exists($functionName, $this->phpSpreadsheetFunctions) && substr($functionName, 0, 1) !== '*') {
$this->log("Function {$functionName} is not defined in PhpSpreadsheet");
} elseif (!empty($translationValue)) {
$functionTranslation = "{$functionName} = {$translationValue}" . self::EOL;
fwrite($functionFile, $functionTranslation);
} else {
$this->log("No {$language} translation available for function {$functionName}");
}
}
fclose($functionFile);
}
/** @return resource used by other methods in this class */
protected function openConfigFile(string $locale, string $language, string $localeLanguage)
{
$this->log("Building locale {$locale} ($language) configuration");
$localeFolder = $this->getLocaleFolder($locale);
$configFileName = realpath($localeFolder) . DIRECTORY_SEPARATOR . 'config';
$this->log("Writing locale configuration to {$configFileName}");
$configFile = fopen($configFileName, 'wb');
if ($configFile === false) {
throw new Exception('Unable to open $configFileName for write');
}
$this->writeFileHeader($configFile, $localeLanguage, $language, 'locale settings');
return $configFile;
}
/** @return resource used by other methods in this class */
protected function openFunctionNameFile(string $locale, string $language, string $localeLanguage)
{
$this->log("Building locale {$locale} ($language) function names");
$localeFolder = $this->getLocaleFolder($locale);
$functionFileName = realpath($localeFolder) . DIRECTORY_SEPARATOR . 'functions';
$this->log("Writing local function names to {$functionFileName}");
$functionFile = fopen($functionFileName, 'wb');
if ($functionFile === false) {
throw new Exception('Unable to open $functionFileName for write');
}
$this->writeFileHeader($functionFile, $localeLanguage, $language, 'function name translations');
return $functionFile;
}
protected function getLocaleFolder(string $locale): string
{
$lastchar = substr($this->translationBaseFolder, -1);
$dirsep = ($lastchar === '/' || $lastchar === '\\') ? '' : DIRECTORY_SEPARATOR;
$localeFolder = $this->translationBaseFolder
. $dirsep
. str_replace('_', DIRECTORY_SEPARATOR, $locale);
if (!file_exists($localeFolder) || !is_dir($localeFolder)) {
mkdir($localeFolder, 7 * 64 + 7 * 8 + 7, true); // octal 777
}
return $localeFolder;
}
/** @param resource $localeFile file being written to */
protected function writeFileHeader($localeFile, string $localeLanguage, string $language, string $title): void
{
fwrite($localeFile, str_repeat('#', 60) . self::EOL);
fwrite($localeFile, '##' . self::EOL);
fwrite($localeFile, "## PhpSpreadsheet - {$title}" . self::EOL);
fwrite($localeFile, '##' . self::EOL);
fwrite($localeFile, "## {$localeLanguage} ({$language})" . self::EOL);
fwrite($localeFile, '##' . self::EOL);
fwrite($localeFile, str_repeat('#', 60) . self::EOL . self::EOL);
}
/** @param resource $localeFile file being written to */
protected function writeFileSectionHeader($localeFile, string $header): void
{
fwrite($localeFile, self::EOL . '##' . self::EOL);
fwrite($localeFile, "## {$header}" . self::EOL);
fwrite($localeFile, '##' . self::EOL);
}
protected function openTranslationWorkbook(): void
{
$filepathName = $this->translationBaseFolder . '/' . $this->translationSpreadsheetName;
$this->translationSpreadsheet = IOFactory::load($filepathName);
}
protected function getTranslationSheet(string $sheetName): Worksheet
{
$worksheet = $this->translationSpreadsheet->setActiveSheetIndexByName($sheetName);
return $worksheet;
}
/** @return string[] */
protected function mapLanguageColumns(Worksheet $translationWorksheet): array
{
$sheetName = $translationWorksheet->getTitle();
$this->log("Mapping Languages for {$sheetName}:");
$baseColumn = self::ENGLISH_REFERENCE_COLUMN;
$languagesList = $translationWorksheet->getColumnIterator(StringHelper::stringIncrement($baseColumn));
$languageNameMap = [];
foreach ($languagesList as $languageColumn) {
$cells = $languageColumn->getCellIterator(self::LOCALE_NAME_ROW, self::LOCALE_NAME_ROW);
$cells->setIterateOnlyExistingCells(true);
foreach ($cells as $cell) {
if ($this->localeCanBeSupported($translationWorksheet, $cell)) {
$languageNameMap[$cell->getColumn()] = $cell->getValueString();
$this->log($cell->getColumn() . ' -> ' . $cell->getValueString());
}
}
}
return $languageNameMap;
}
protected function localeCanBeSupported(Worksheet $worksheet, Cell $cell): bool
{
if ($worksheet->getTitle() === self::EXCEL_LOCALISATION_WORKSHEET) {
// Only provide support for languages that have a function argument separator defined
// in the localisation worksheet
return !empty(
$worksheet->getCell($cell->getColumn() . self::ARGUMENT_SEPARATOR_ROW)->getValue()
);
}
// If we're processing other worksheets, then language support is determined by whether we included the
// language in the map when we were processing the localisation worksheet (which is always processed first)
return in_array($cell->getValue(), $this->localeLanguageMap, true);
}
protected function mapErrorCodeRows(): void
{
$this->log('Mapping Error Codes:');
$errorList = $this->localeTranslations->getRowIterator(self::ERROR_CODES_FIRST_ROW);
foreach ($errorList as $errorRow) {
$cells = $errorRow->getCellIterator(self::ENGLISH_REFERENCE_COLUMN, self::ENGLISH_REFERENCE_COLUMN);
$cells->setIterateOnlyExistingCells(true);
foreach ($cells as $cell) {
if ($cell->getValue() != '') {
$this->log($cell->getRow() . ' -> ' . $cell->getValueString());
$this->errorCodeMap[$cell->getValueString()] = $cell->getRow();
}
}
}
}
protected function mapFunctionNameRows(): void
{
$this->log('Mapping Functions:');
$functionList = $this->functionNameTranslations->getRowIterator(self::FUNCTION_NAME_LIST_FIRST_ROW);
foreach ($functionList as $functionRow) {
$cells = $functionRow->getCellIterator(self::ENGLISH_REFERENCE_COLUMN, self::ENGLISH_REFERENCE_COLUMN);
$cells->setIterateOnlyExistingCells(true);
foreach ($cells as $cell) {
if ($this->isFunctionCategoryEntry($cell)) {
if (!empty($cell->getValue())) {
$this->log('CATEGORY: ' . $cell->getValueString());
$this->functionNameMap[$cell->getValueString()] = $cell->getRow();
}
continue;
}
if ($cell->getValue() !== '' && $cell->getValue() !== null) {
if (is_bool($cell->getValue())) {
$this->log($cell->getRow() . ' -> ' . ($cell->getValue() ? 'TRUE' : 'FALSE'));
$this->functionNameMap[($cell->getValue() ? 'TRUE' : 'FALSE')] = $cell->getRow();
} else {
$this->log($cell->getRow() . ' -> ' . $cell->getValueString());
$this->functionNameMap[$cell->getValueString()] = $cell->getRow();
}
}
}
}
}
private function isFunctionCategoryEntry(Cell $cell): bool
{
$categoryCheckCell = self::ENGLISH_FUNCTION_CATEGORIES_COLUMN . $cell->getRow();
if ($this->functionNameTranslations->getCell($categoryCheckCell)->getValue() != '') {
return true;
}
return false;
}
private function log(string $message): void
{
if ($this->verbose === false) {
return;
}
echo $message, self::EOL;
}
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/bin/generate-document.php | bin/generate-document.php | #!/usr/bin/env php
<?php
use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
use PhpOffice\PhpSpreadsheetInfra\DocumentGenerator;
require_once __DIR__ . '/..' . '/vendor/autoload.php';
$phpSpreadsheetFunctions = Calculation::getFunctions();
ksort($phpSpreadsheetFunctions);
file_put_contents(
__DIR__ . '/../docs/references/function-list-by-category.md',
DocumentGenerator::generateFunctionListByCategory(
$phpSpreadsheetFunctions
)
);
file_put_contents(
__DIR__ . '/../docs/references/function-list-by-name.md',
DocumentGenerator::generateFunctionListByName(
$phpSpreadsheetFunctions
)
);
file_put_contents(
__DIR__ . '/../docs/references/function-list-by-name-compact.md',
DocumentGenerator::generateFunctionListByName(
$phpSpreadsheetFunctions,
true
)
);
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/bin/check-phpdoc-types.php | bin/check-phpdoc-types.php | #!/usr/bin/env php
<?php
/**
* This will check that the "current patch" does not add or modify lines that contain types as PHPDoc when we can express
* them with PHP native types. The "current patch" is either the file about to be committed, the non-committed file, or
* the latest commit.
*
* This will help us slowly migrate away from PHPDoc typing to PHP native typing.
*/
function checkPhpDocTypes(): int
{
$content = shell_exec('git diff --cached') ?? shell_exec('git diff') ?? shell_exec('git show HEAD');
preg_match_all('~^\+ +\* @(param|var) (mixed|string|int|float|bool|null|array|\?|\|)+( \$\w+)?$~m', "$content", $parameters);
preg_match_all('~^\+ +\* @return (mixed|string|int|float|bool|null|array|void|\?|\|)+$~m', "$content", $returns);
$errors = [
...$parameters[0],
...$returns[0],
];
if (!empty($errors)) {
echo 'PHP native types must be used instead of PHPDoc types (without comments), for the following lines:' . PHP_EOL . PHP_EOL;
echo implode(PHP_EOL, $errors) . PHP_EOL;
return 1;
}
return 0;
}
if (checkPhpDocTypes()) {
exit(1);
}
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
PHPOffice/PhpSpreadsheet | https://github.com/PHPOffice/PhpSpreadsheet/blob/e33834b4ea2a02088becbb41fb8954d915b46b12/bin/generate-locales.php | bin/generate-locales.php | #!/usr/bin/env php
<?php
use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
use PhpOffice\PhpSpreadsheetInfra\LocaleGenerator;
require_once __DIR__ . '/..' . '/vendor/autoload.php';
$phpSpreadsheetFunctions = Calculation::getFunctions();
$localeGenerator = new LocaleGenerator(
__DIR__ . '/../src/PhpSpreadsheet/Calculation/locale/',
'Translations.xlsx',
$phpSpreadsheetFunctions,
true
);
$localeGenerator->generateLocales();
| php | MIT | e33834b4ea2a02088becbb41fb8954d915b46b12 | 2026-01-04T15:02:44.305364Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/SymfonyHttpDriver.php | src/SymfonyHttpDriver.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar;
use DebugBar\HttpDriverInterface;
use Illuminate\Contracts\Session\Session as SessionContract;
use Illuminate\Session\SessionManager;
use Symfony\Component\HttpFoundation\Response;
/**
* HTTP driver for Symfony Request/Session
*
*/
class SymfonyHttpDriver implements HttpDriverInterface
{
protected SessionContract|SessionManager $session;
protected ?Response $response;
public function __construct(SessionContract|SessionManager $session, ?Response $response = null)
{
$this->session = $session;
$this->response = $response;
}
public function setResponse(Response $response): void
{
$this->response = $response;
}
public function setHeaders(array $headers): void
{
if (!is_null($this->response)) {
$this->response->headers->add($headers);
}
}
public function isSessionStarted(): bool
{
if (!$this->session->isStarted()) {
$this->session->start();
}
return $this->session->isStarted();
}
public function setSessionValue(string $name, mixed $value): void
{
$this->session->put($name, $value);
}
/**
* {@inheritDoc}
*/
public function hasSessionValue(string $name): bool
{
return $this->session->has($name);
}
/**
* {@inheritDoc}
*/
public function getSessionValue(string $name): mixed
{
return $this->session->get($name);
}
/**
* {@inheritDoc}
*/
public function deleteSessionValue(string $name): void
{
$this->session->remove($name);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/LaravelDebugbar.php | src/LaravelDebugbar.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar;
use Barryvdh\Debugbar\CollectorProviders\ConfigCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\DefaultRequestCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\ExceptionsCollectorProvider;
use Barryvdh\Debugbar\DataCollector\LaravelCollector;
use Barryvdh\Debugbar\DataCollector\SessionCollector;
use Barryvdh\Debugbar\DataCollector\RequestCollector;
use Barryvdh\Debugbar\DataCollector\ViewCollector;
use Barryvdh\Debugbar\CollectorProviders\AuthCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\CacheCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\DatabaseCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\EventsCollectorCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\GateCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\JobsCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\LaravelCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\LivewireCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\LogCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\MailCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\MemoryCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\MessagesCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\ModelsCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\PennantCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\PhpInfoCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\RouteCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\TimeCollectorProvider;
use Barryvdh\Debugbar\CollectorProviders\ViewsCollectorProvider;
use Barryvdh\Debugbar\Storage\FilesystemStorage;
use Barryvdh\Debugbar\Support\Clockwork\ClockworkCollector;
use Barryvdh\Debugbar\Support\RequestIdGenerator;
use DebugBar\DataCollector\DataCollectorInterface;
use DebugBar\DataCollector\ExceptionsCollector;
use DebugBar\DataCollector\MessagesCollector;
use DebugBar\DebugBar;
use DebugBar\HttpDriverInterface;
use DebugBar\PhpHttpDriver;
use DebugBar\Storage\PdoStorage;
use DebugBar\Storage\RedisStorage;
use Exception;
use Illuminate\Config\Repository;
use Illuminate\Contracts\Foundation\Application;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Throwable;
/**
* Debug bar subclass which adds all without Request and with LaravelCollector.
* Rest is added in Service Provider
*
* @method void emergency(...$message)
* @method void alert(...$message)
* @method void critical(...$message)
* @method void error(...$message)
* @method void warning(...$message)
* @method void notice(...$message)
* @method void info(...$message)
* @method void debug(...$message)
* @method void log(...$message)
*/
class LaravelDebugbar extends DebugBar
{
/**
* The Laravel application instance.
*
*/
protected \Illuminate\Foundation\Application $app;
/**
* Normalized Laravel Version
*
*/
protected string $version;
/**
* True when booted.
*
*/
protected ?bool $booted = false;
/**
* True when enabled, false disabled on null for still unknown
*
*/
protected ?bool $enabled = null;
/**
* Laravel default error handler
*
* @var callable|null
*/
protected $prevErrorHandler = null;
protected ?string $editorTemplate = null;
protected bool $responseIsModified = false;
protected array $stackedData = [];
public function __construct(?\Illuminate\Foundation\Application $app = null)
{
if (!$app) {
/** @var \Illuminate\Foundation\Application $app */
$app = app(); //Fallback when $app is not given
}
$this->app = $app;
$this->version = $app->version();
$this->setRequestIdGenerator(new RequestIdGenerator());
}
/**
* Returns the HTTP driver
*
* If no http driver where defined, a PhpHttpDriver is automatically created
*
*/
public function getHttpDriver(): HttpDriverInterface
{
if ($this->httpDriver === null) {
$this->httpDriver = $this->app->make(SymfonyHttpDriver::class);
}
return $this->httpDriver;
}
/**
* Enable the Debugbar and boot, if not already booted.
*/
public function enable(): void
{
$this->enabled = true;
if (!$this->booted) {
$this->boot();
}
}
/**
* Boot the debugbar (add collectors, renderer and listener)
*/
public function boot(): void
{
if ($this->booted) {
return;
}
/** @var Repository $config */
$config = $this->app->get(Repository::class);
$this->editorTemplate = $config->get('debugbar.editor') ?: $config->get('app.editor');
$this->remotePathReplacements = $this->getRemoteServerReplacements();
// Set custom error handler
if ($config->get('debugbar.error_handler', false)) {
// Get the error_level config, default to E_ALL
$errorLevel = $config->get('debugbar.error_level', E_ALL);
// set error handler with configured error reporting level
$this->prevErrorHandler = set_error_handler([$this, 'handleError'], $errorLevel);
}
$this->selectStorage($this);
$this->registerCollectors();
$renderer = $this->getJavascriptRenderer();
$renderer->setHideEmptyTabs($config->get('debugbar.hide_empty_tabs', true));
$renderer->setIncludeVendors($config->get('debugbar.include_vendors', true));
$renderer->setBindAjaxHandlerToFetch($config->get('debugbar.capture_ajax', true));
$renderer->setBindAjaxHandlerToXHR($config->get('debugbar.capture_ajax', true));
$renderer->setDeferDatasets($config->get('debugbar.defer_datasets', false));
$renderer->setUseDistFiles($config->get('debugbar.use_dist_files', true));
$this->booted = true;
}
protected function registerCollectors()
{
/** @var Repository $config */
$config = $this->app->get(Repository::class);
// Register default Collector Provider
$this->registerCollectorProviders([
'exceptions' => ExceptionsCollectorProvider::class,
'phpinfo' => PhpInfoCollectorProvider::class,
'messages' => MessagesCollectorProvider::class,
'time' => TimeCollectorProvider::class,
'memory' => MemoryCollectorProvider::class,
'laravel' => LaravelCollectorProvider::class,
'default_request' => DefaultRequestCollectorProvider::class,
'events' => EventsCollectorCollectorProvider::class,
'views' => ViewsCollectorProvider::class,
'route' => RouteCollectorProvider::class,
'log' => LogCollectorProvider::class,
'db' => DatabaseCollectorProvider::class,
'models' => ModelsCollectorProvider::class,
'livewire' => LivewireCollectorProvider::class,
'mail' => MailCollectorProvider::class,
'auth' => AuthCollectorProvider::class,
'gate' => GateCollectorProvider::class,
'cache' => CacheCollectorProvider::class,
'jobs' => JobsCollectorProvider::class,
'pennant' => PennantCollectorProvider::class,
'config' => ConfigCollectorProvider::class,
]);
// Register any Custom Collectors
$this->registerCustomCollectorProviders($config->get('debugbar.custom_collectors', []));
}
/**
* @param array<string, string> $providers
*/
protected function registerCollectorProviders(array $providers): void
{
/** @var Repository $config */
$config = $this->app->get(Repository::class);
foreach ($providers as $name => $provider) {
if (!$this->shouldCollect($name)) {
continue;
}
try {
$options = $config->get('debugbar.options.' . $name, []);
$this->app->call($provider, ['options' => $options]);
} catch (Exception $e) {
$this->addCollectorException('Error calling ' . class_basename($provider), $e);
}
}
}
/**
* @param array<string, bool> $providers
*/
protected function registerCustomCollectorProviders(array $providers): void
{
foreach ($providers as $provider => $enabled) {
if (!$enabled) {
continue;
}
try {
$provider = $this->app->make($provider);
// Add collectors directly, otherwise invoke the class
if (is_a($provider, DataCollectorInterface::class)) {
$this->addCollector($provider);
} else {
$this->app->call($provider);
}
} catch (Exception $e) {
$this->addCollectorException('Error calling ' . class_basename($provider), $e);
}
}
}
public function shouldCollect(string $name, bool $default = true): bool
{
return $this->app['config']->get('debugbar.collectors.' . $name, $default);
}
/**
* Handle silenced errors
*/
public function handleError(int $level, string $message, string $file = '', int $line = 0, array $context = []): mixed
{
if ($this->hasCollector('exceptions')) {
/** @var ExceptionsCollector $exceptionCollector */
$exceptionCollector = $this['exceptions'];
$exceptionCollector->addWarning($level, $message, $file, $line);
}
if ($this->hasCollector('messages')) {
/** @var MessagesCollector $messagesCollector */
$messagesCollector = $this['messages'];
$file = $file ? ' on ' . $messagesCollector->normalizeFilePath($file) . ":{$line}" : '';
$messagesCollector->addMessage($message . $file, 'deprecation');
}
if (! $this->prevErrorHandler) {
return null;
}
return call_user_func($this->prevErrorHandler, $level, $message, $file, $line, $context);
}
/**
* Starts a measure
*
* @param string $name Internal name, used to stop the measure
* @param string|null $label Public name
*/
public function startMeasure(string $name, ?string $label = null, ?string $collector = null, ?string $group = null): void
{
if ($this->hasCollector('time')) {
/** @var \DebugBar\DataCollector\TimeDataCollector */
$time = $this->getCollector('time');
$time->startMeasure($name, $label, $collector, $group);
}
}
/**
* Stops a measure
*/
public function stopMeasure(string $name): void
{
if ($this->hasCollector('time')) {
/** @var \DebugBar\DataCollector\TimeDataCollector $collector */
$collector = $this->getCollector('time');
try {
$collector->stopMeasure($name);
} catch (Exception $e) {
// $this->addThrowable($e);
}
}
}
/**
* Alias for addThrowable
*
*/
public function addException(Throwable $e): void
{
$this->addThrowable($e);
}
/**
* Adds an exception to be profiled in the debug bar
*/
public function addThrowable(Throwable $e): void
{
if ($this->hasCollector('exceptions')) {
/** @var \DebugBar\DataCollector\ExceptionsCollector $collector */
$collector = $this->getCollector('exceptions');
$collector->addThrowable($e);
}
}
/**
* Register collector exceptions
*
*/
protected function addCollectorException(string $message, Exception $exception)
{
$this->addThrowable(
new Exception(
$message . ' on Laravel Debugbar: ' . $exception->getMessage(),
(int) $exception->getCode(),
$exception,
),
);
}
/**
* Returns a JavascriptRenderer for this instance
*
*/
public function getJavascriptRenderer(?string $baseUrl = null, ?string $basePath = null): \DebugBar\JavascriptRenderer|JavascriptRenderer
{
if ($this->jsRenderer === null) {
$this->jsRenderer = new JavascriptRenderer($this, $baseUrl, $basePath);
}
return $this->jsRenderer;
}
/**
* Modify the response and inject the debugbar (or data in headers)
*/
public function modifyResponse(Request $request, Response $response): Response
{
$app = $this->app;
if (!$this->isEnabled() || !$this->booted || $this->isDebugbarRequest() || $this->responseIsModified) {
return $response;
}
// Prevent duplicate modification
$this->responseIsModified = true;
// Set the Response if required
$httpDriver = $this->getHttpDriver();
if ($httpDriver instanceof SymfonyHttpDriver) {
$httpDriver->setResponse($response);
}
// Show the Http Response Exception in the Debugbar, when available
if (isset($response->exception)) {
$this->addThrowable($response->exception);
}
// These rely on the Response, so we add them directly here
$sessionHiddens = $app['config']->get('debugbar.options.session.hiddens', []);
$requestHiddens = array_merge(
$app['config']->get('debugbar.options.symfony_request.hiddens', []),
array_map(fn($key) => 'session_attributes.' . $key, $sessionHiddens),
);
$session = $request->hasSession() ? $request->getSession() : null;
if ($session && $this->shouldCollect('session', false) && !$this->hasCollector('session')) {
try {
$this->addCollector(new SessionCollector($session, $sessionHiddens));
} catch (Exception $e) {
$this->addCollectorException('Cannot add SessionCollector', $e);
}
}
if ($this->shouldCollect('symfony_request', true) && !$this->hasCollector('request')) {
try {
$reqId = $this->getCurrentRequestId();
$this->addCollector(new RequestCollector($request, $response, $session, $reqId, $requestHiddens));
} catch (Exception $e) {
$this->addCollectorException('Cannot add SymfonyRequestCollector', $e);
}
}
if ($app['config']->get('debugbar.clockwork') && ! $this->hasCollector('clockwork')) {
try {
$this->addCollector(new ClockworkCollector($request, $response, $session, $requestHiddens));
} catch (Exception $e) {
$this->addCollectorException('Cannot add ClockworkCollector', $e);
}
$this->addClockworkHeaders($response);
}
try {
if ($this->hasCollector('views') && $response->headers->has('X-Inertia')) {
$content = $response->getContent();
if (is_string($content)) {
$content = json_decode($content, true);
}
if (is_array($content)) {
/** @var ViewCollector $viewCollector */
$viewCollector = $this['views'];
$viewCollector->addInertiaAjaxView($content);
}
}
} catch (Exception $e) {
}
if ($app['config']->get('debugbar.add_ajax_timing', false)) {
$this->addServerTimingHeaders($response);
}
if ($response->isRedirection()) {
try {
$this->stackData();
} catch (Exception $e) {
$app['log']->error('Debugbar exception: ' . $e->getMessage());
}
return $response;
}
try {
// Collect + store data, only inject the ID in theheaders
$this->sendDataInHeaders(true);
} catch (Exception $e) {
$app['log']->error('Debugbar exception: ' . $e->getMessage());
}
// Check if it's safe to inject the Debugbar
if (
$app['config']->get('debugbar.inject', true)
&& str_contains($response->headers->get('Content-Type', 'text/html'), 'html')
&& !$this->isJsonRequest($request, $response)
&& $response->getContent() !== false
&& in_array($request->getRequestFormat(), [null, 'html'], true)
&& !$this->isJsonResponse($response)
) {
try {
$this->injectDebugbar($response);
} catch (Exception $e) {
$app['log']->error('Debugbar exception: ' . $e->getMessage());
}
}
return $response;
}
/**
* Check if the Debugbar is enabled
*/
public function isEnabled(): bool
{
if ($this->enabled === null) {
/** @var Repository $config */
$config = $this->app['config'];
$configEnabled = value($config->get('debugbar.enabled'));
if ($configEnabled === null) {
$configEnabled = $config->get('app.debug');
}
$this->enabled = $configEnabled && !$this->app->runningInConsole() && !$this->app->environment('testing');
}
return $this->enabled;
}
/**
* Check if this is a request to the Debugbar OpenHandler
*/
protected function isDebugbarRequest(): bool
{
return $this->app['request']->is($this->app['config']->get('debugbar.route_prefix') . '*');
}
protected function isJsonRequest(Request $request, Response $response): bool
{
// If XmlHttpRequest, Live or HTMX, return true
if (
$request->isXmlHttpRequest()
|| $request->headers->has('X-Livewire')
|| ($request->headers->has('Hx-Request') && $request->headers->has('Hx-Target'))
) {
return true;
}
// Check if the request wants Json
$acceptable = $request->getAcceptableContentTypes();
if (isset($acceptable[0]) && in_array($acceptable[0], ['application/json', 'application/javascript'], true)) {
return true;
}
// Check if content looks like JSON without actually validating
$content = $response->getContent();
if (is_string($content) && strlen($content) > 0 && in_array($content[0], ['{', '['], true)) {
return true;
}
return false;
}
protected function isJsonResponse(Response $response): bool
{
if ($response->headers->get('Content-Type') == 'application/json') {
return true;
}
$content = $response->getContent();
if (is_string($content)) {
$content = trim($content);
if ($content === '') {
return false;
}
// Quick check to see if it looks like JSON
$first = $content[0];
$last = $content[strlen($content) - 1];
if (
($first === '{' && $last === '}')
|| ($first === '[' && $last === ']')
) {
// Must contain a colon or comma
return strpbrk($content, ':,') !== false;
}
}
return false;
}
/**
* Collects the data from the collectors
*
*/
public function collect(): array
{
/** @var Request $request */
$request = $this->app['request'];
$this->data = [
'__meta' => [
'id' => $this->getCurrentRequestId(),
'datetime' => date('Y-m-d H:i:s'),
'utime' => microtime(true),
'method' => $request->getMethod(),
'uri' => $request->getRequestUri(),
'ip' => $request->getClientIp(),
],
];
foreach ($this->collectors as $name => $collector) {
$this->data[$name] = $collector->collect();
}
// Remove all invalid (non UTF-8) characters
array_walk_recursive(
$this->data,
function (&$item) {
if (is_string($item) && !mb_check_encoding($item, 'UTF-8')) {
$item = mb_convert_encoding($item, 'UTF-8', 'UTF-8');
}
},
);
if ($this->storage !== null) {
$this->storage->save($this->getCurrentRequestId(), $this->data);
}
return $this->data;
}
/**
* Injects the web debug toolbar into the given Response.
*
* Based on https://github.com/symfony/WebProfilerBundle/blob/master/EventListener/WebDebugToolbarListener.php
*/
public function injectDebugbar(Response $response): void
{
/** @var Repository $config */
$config = $this->app['config'];
$content = $response->getContent();
$renderer = $this->getJavascriptRenderer();
$autoShow = $config->get('debugbar.ajax_handler_auto_show', true);
$renderer->setAjaxHandlerAutoShow($autoShow);
$enableTab = $config->get('debugbar.ajax_handler_enable_tab', true);
$renderer->setAjaxHandlerEnableTab($enableTab);
if ($this->getStorage()) {
$openHandlerUrl = route('debugbar.openhandler');
$renderer->setOpenHandlerUrl($openHandlerUrl);
}
$widget = "<!-- Laravel Debugbar Widget -->\n" . $renderer->renderHead() . $renderer->render();
// Try to put the widget at the end, directly before the </body>
$pos = strripos($content, '</body>');
if (false !== $pos) {
$content = substr($content, 0, $pos) . $widget . substr($content, $pos);
} else {
$content = $content . $widget;
}
$original = null;
if ($response instanceof \Illuminate\Http\Response && $response->getOriginalContent()) {
$original = $response->getOriginalContent();
}
// Update the new content and reset the content length
$response->setContent($content);
$response->headers->remove('Content-Length');
// Restore original response (e.g. the View or Ajax data)
if ($response instanceof \Illuminate\Http\Response && $original) {
$response->original = $original;
}
}
/**
* Checks if there is stacked data in the session
*/
public function hasStackedData(): bool
{
return count($this->getStackedData(false)) > 0;
}
/**
* Returns the data stacked in the session
*
* @param bool $delete Whether to delete the data in the session
*/
public function getStackedData(bool $delete = true): array
{
$this->stackedData = array_merge($this->stackedData, parent::getStackedData($delete));
return $this->stackedData;
}
/**
* Disable the Debugbar
*/
public function disable(): void
{
$this->enabled = false;
}
/**
* Adds a measure
*/
public function addMeasure(string $label, float $start, float $end, array $params = [], ?string $collector = null, ?string $group = null): void
{
if ($this->hasCollector('time')) {
/** @var \DebugBar\DataCollector\TimeDataCollector */
$time = $this->getCollector('time');
$time->addMeasure($label, $start, $end, $params, $collector, $group);
}
}
/**
* Utility function to measure the execution of a Closure
*/
public function measure(string $label, \Closure $closure, ?string $collector = null, ?string $group = null): mixed
{
if ($this->hasCollector('time')) {
/** @var \DebugBar\DataCollector\TimeDataCollector */
$time = $this->getCollector('time');
$result = $time->measure($label, $closure, $collector, $group);
} else {
$result = $closure();
}
return $result;
}
/**
* Collect data in a CLI request
*/
public function collectConsole(): ?array
{
if (!$this->isEnabled()) {
return null;
}
$this->data = [
'__meta' => [
'id' => $this->getCurrentRequestId(),
'datetime' => date('Y-m-d H:i:s'),
'utime' => microtime(true),
'method' => 'CLI',
'uri' => isset($_SERVER['argv']) ? implode(' ', $_SERVER['argv']) : null,
'ip' => $_SERVER['SSH_CLIENT'] ?? null,
],
];
foreach ($this->collectors as $name => $collector) {
$this->data[$name] = $collector->collect();
}
// Remove all invalid (non UTF-8) characters
array_walk_recursive(
$this->data,
function (&$item) {
if (is_string($item) && !mb_check_encoding($item, 'UTF-8')) {
$item = mb_convert_encoding($item, 'UTF-8', 'UTF-8');
}
},
);
if ($this->storage !== null) {
$this->storage->save($this->getCurrentRequestId(), $this->data);
}
return $this->data;
}
/**
* Magic calls for adding messages
*/
public function __call(string $method, array $args): void
{
$messageLevels = ['emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'log'];
if (in_array($method, $messageLevels)) {
foreach ($args as $arg) {
$this->addMessage($arg, $method);
}
}
}
/**
* Adds a message to the MessagesCollector
*
* A message can be anything from an object to a string
*/
public function addMessage(mixed $message, string $label = 'info'): void
{
if ($this->hasCollector('messages')) {
/** @var \DebugBar\DataCollector\MessagesCollector $collector */
$collector = $this->getCollector('messages');
$collector->addMessage($message, $label);
}
}
/**
* Check the version of Laravel
*/
protected function checkVersion(string $version, string $operator = ">="): bool
{
return version_compare($this->version, $version, $operator);
}
protected function selectStorage(DebugBar $debugbar): void
{
/** @var Repository $config */
$config = $this->app['config'];
if ($config->get('debugbar.storage.enabled')) {
$driver = $config->get('debugbar.storage.driver', 'file');
switch ($driver) {
case 'pdo':
$connection = $config->get('debugbar.storage.connection');
$table = $this->app['db']->getTablePrefix() . 'phpdebugbar';
$pdo = $this->app['db']->connection($connection)->getPdo();
$storage = new PdoStorage($pdo, $table);
break;
case 'redis':
$connection = $config->get('debugbar.storage.connection');
$client = $this->app['redis']->connection($connection);
if (is_a($client, 'Illuminate\Redis\Connections\Connection', false)) {
$client = $client->client();
}
$storage = new RedisStorage($client);
break;
case 'custom':
$class = $config->get('debugbar.storage.provider');
$storage = $this->app->make($class);
break;
case 'socket':
throw new \RuntimeException('Socket storage is not supported anymore.');
break;
case 'file':
default:
$path = $config->get('debugbar.storage.path');
$storage = new FilesystemStorage($this->app['files'], $path);
break;
}
$debugbar->setStorage($storage);
}
}
protected function addClockworkHeaders(Response $response): void
{
$prefix = $this->app['config']->get('debugbar.route_prefix');
$response->headers->set('X-Clockwork-Id', $this->getCurrentRequestId(), true);
$response->headers->set('X-Clockwork-Version', 9, true);
$response->headers->set('X-Clockwork-Path', $prefix . '/clockwork/', true);
}
/**
* Add Server-Timing headers for the TimeData collector
*
* @see https://www.w3.org/TR/server-timing/
*/
protected function addServerTimingHeaders(Response $response): void
{
if ($this->hasCollector('time')) {
$collector = $this->getCollector('time');
$headers = [];
foreach ($collector->collect()['measures'] as $m) {
$headers[] = sprintf('app;desc="%s";dur=%F', str_replace(["\n", "\r"], ' ', str_replace('"', "'", $m['label'])), $m['duration'] * 1000);
}
$response->headers->set('Server-Timing', $headers, false);
}
}
private function getRemoteServerReplacements(): array
{
$localPath = $this->app['config']->get('debugbar.local_sites_path') ?: base_path();
$remotePaths = array_filter(explode(',', $this->app['config']->get('debugbar.remote_sites_path') ?: '')) ?: [base_path()];
return array_fill_keys($remotePaths, $localPath);
}
private function getMonologLogger(): \Monolog\Logger
{
$logger = $this->app['log']->getLogger();
if (get_class($logger) !== 'Monolog\Logger') {
throw new Exception('Logger is not a Monolog\Logger instance');
}
return $logger;
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/helpers.php | src/helpers.php | <?php
declare(strict_types=1);
if (!function_exists('debugbar')) {
/**
* Get the Debugbar instance
*
*/
function debugbar(): \Barryvdh\Debugbar\LaravelDebugbar
{
return app(\Barryvdh\Debugbar\LaravelDebugbar::class);
}
}
if (!function_exists('debug')) {
/**
* Adds one or more messages to the MessagesCollector
*
*/
function debug(mixed ...$value): void
{
$debugbar = debugbar();
foreach (func_get_args() as $value) {
$debugbar->addMessage($value, 'debug');
}
}
}
if (!function_exists('start_measure')) {
/**
* Starts a measure
*
* @param string $name Internal name, used to stop the measure
* @param string $label Public name
*/
function start_measure($name, $label = null): void
{
debugbar()->startMeasure($name, $label);
}
}
if (!function_exists('stop_measure')) {
/**
* Stop a measure
*
* @param string $name Internal name, used to stop the measure
*/
function stop_measure($name): void
{
debugbar()->stopMeasure($name);
}
}
if (!function_exists('add_measure')) {
/**
* Adds a measure
*
* @param string $label
* @param float $start
* @param float $end
*/
function add_measure($label, $start, $end): void
{
debugbar()->addMeasure($label, $start, $end);
}
}
if (!function_exists('measure')) {
/**
* Utility function to measure the execution of a Closure
*
*/
function measure(string $label, \Closure $closure): mixed
{
return debugbar()->measure($label, $closure);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/DebugbarViewEngine.php | src/DebugbarViewEngine.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar;
use Illuminate\Contracts\View\Engine;
class DebugbarViewEngine implements Engine
{
/**
* @var Engine
*/
protected $engine;
/**
* @var LaravelDebugbar
*/
protected $laravelDebugbar;
/**
* @var array
*/
protected $exclude_paths;
public function __construct(Engine $engine, LaravelDebugbar $laravelDebugbar)
{
$this->engine = $engine;
$this->laravelDebugbar = $laravelDebugbar;
$this->exclude_paths = app('config')->get('debugbar.options.views.exclude_paths', []);
}
/**
* @param string $path
*
* @return string
*/
public function get($path, array $data = [])
{
$basePath = base_path();
$shortPath = @file_exists((string) $path) ? realpath($path) : $path;
if (str_starts_with($shortPath, $basePath)) {
$shortPath = ltrim(
str_replace('\\', '/', substr($shortPath, strlen($basePath))),
'/',
);
}
foreach ($this->exclude_paths as $excludePath) {
if (str_starts_with($shortPath, $excludePath)) {
return $this->engine->get($path, $data);
}
}
return $this->laravelDebugbar->measure($shortPath, function () use ($path, $data) {
return $this->engine->get($path, $data);
}, 'views');
}
/**
* NOTE: This is done to support other Engine swap (example: Livewire).
*/
public function __call($name, $arguments)
{
return $this->engine->$name(...$arguments);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/ServiceProvider.php | src/ServiceProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar;
use Barryvdh\Debugbar\Middleware\InjectDebugbar;
use DebugBar\DataFormatter\DataFormatter;
use DebugBar\DataFormatter\DataFormatterInterface;
use Illuminate\Contracts\Http\Kernel;
use Illuminate\Routing\Router;
use Illuminate\Session\SessionManager;
use Illuminate\Support\Collection;
class ServiceProvider extends \Illuminate\Support\ServiceProvider
{
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
$configPath = __DIR__ . '/../config/debugbar.php';
$this->mergeConfigFrom($configPath, 'debugbar');
$this->app->alias(
DataFormatter::class,
DataFormatterInterface::class,
);
$this->app->singleton(LaravelDebugbar::class, function ($app) {
return new LaravelDebugbar($app);
});
$this->app->singleton(SymfonyHttpDriver::class, function ($app) {
return new SymfonyHttpDriver($app->make(SessionManager::class));
});
$this->app->alias(LaravelDebugbar::class, 'debugbar');
$this->app->singleton(
'command.debugbar.clear',
function ($app) {
return new Console\ClearCommand($app['debugbar']);
},
);
Collection::macro('debug', function () {
debug($this);
return $this;
});
}
/**
* Bootstrap the application events.
*
* @return void
*/
public function boot()
{
$configPath = __DIR__ . '/../config/debugbar.php';
$this->publishes([$configPath => $this->getConfigPath()], 'config');
$this->loadRoutesFrom(__DIR__ . '/debugbar-routes.php');
$this->registerMiddleware(InjectDebugbar::class);
$this->commands(['command.debugbar.clear']);
}
/**
* Get the active router.
*
* @return Router
*/
protected function getRouter()
{
return $this->app['router'];
}
/**
* Get the config path
*
* @return string
*/
protected function getConfigPath()
{
return config_path('debugbar.php');
}
/**
* Register the Debugbar Middleware
*
* @param string $middleware
*/
protected function registerMiddleware($middleware)
{
/** @var \Illuminate\Foundation\Http\Kernel $kernel */
$kernel = $this->app[Kernel::class];
$kernel->pushMiddleware($middleware);
if (isset($kernel->getMiddlewareGroups()['web'])) {
$kernel->appendMiddlewareToGroup('web', $middleware);
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/JavascriptRenderer.php | src/JavascriptRenderer.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar;
use DebugBar\DebugBar;
use DebugBar\JavascriptRenderer as BaseJavascriptRenderer;
/**
* {@inheritdoc}
*/
class JavascriptRenderer extends BaseJavascriptRenderer
{
public function __construct(DebugBar $debugBar, $baseUrl = null, $basePath = null)
{
parent::__construct($debugBar, $baseUrl, $basePath);
$resourceDir = __DIR__ . '/../resources';
$this->additionalAssets[] = [
'base_path' => $resourceDir,
'css' => ['laravel-debugbar.css', 'laravel-icons.css'],
];
$this->setTheme(config('debugbar.theme', 'auto'));
}
/**
* {@inheritdoc}
*/
public function renderHead(): string
{
$cssRoute = preg_replace('/\Ahttps?:\/\/[^\/]+/', '', route('debugbar.assets.css', [
'v' => $this->getModifiedTime('css'),
]));
$jsRoute = preg_replace('/\Ahttps?:\/\/[^\/]+/', '', route('debugbar.assets.js', [
'v' => $this->getModifiedTime('js'),
]));
$nonce = $this->getNonceAttribute();
$html = "<link rel='stylesheet' type='text/css' property='stylesheet' href='{$cssRoute}' data-turbolinks-eval='false' data-turbo-eval='false'>";
$html .= "<script{$nonce} src='{$jsRoute}' data-turbolinks-eval='false' data-turbo-eval='false'></script>";
$inlineHtml = $this->getInlineHtml();
if ($nonce != '') {
$inlineHtml = preg_replace("/<(script|style)>/", "<$1{$nonce}>", $inlineHtml);
}
$html .= $inlineHtml;
return $html;
}
protected function getInlineHtml(): string
{
$html = '';
foreach (['head', 'css', 'js'] as $asset) {
foreach ($this->getAssets('inline_' . $asset) as $item) {
$html .= $item . "\n";
}
}
return $html;
}
/**
* Get the last modified time of any assets.
*
* @param string $type 'js' or 'css'
*/
protected function getModifiedTime(string $type): int
{
$files = $this->getAssets($type);
$latest = 0;
foreach ($files as $file) {
$mtime = filemtime($file);
if ($mtime > $latest) {
$latest = $mtime;
}
}
return $latest;
}
/**
* Return assets as a string
*
* @param string $type 'js' or 'css'
*/
public function dumpAssetsToString(string $type): string
{
$files = $this->getAssets($type);
$content = '';
foreach ($files as $file) {
$content .= file_get_contents($file) . "\n";
}
return $content;
}
/**
* Makes a URI relative to another
*/
protected function makeUriRelativeTo(string|array|null $uri, string $root): string|array
{
if (!$root) {
return $uri;
}
if (is_array($uri)) {
$uris = [];
foreach ($uri as $u) {
$uris[] = $this->makeUriRelativeTo($u, $root);
}
return $uris;
}
if (substr($uri ?? '', 0, 1) === '/' || preg_match('/^([a-zA-Z]+:\/\/|[a-zA-Z]:\/|[a-zA-Z]:\\\)/', $uri ?? '')) {
return $uri;
}
return rtrim($root, '/') . "/$uri";
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/debugbar-routes.php | src/debugbar-routes.php | <?php
declare(strict_types=1);
use Barryvdh\Debugbar\Controllers\AssetController;
use Barryvdh\Debugbar\Controllers\CacheController;
use Barryvdh\Debugbar\Controllers\OpenHandlerController;
use Barryvdh\Debugbar\Controllers\QueriesController;
use Barryvdh\Debugbar\Controllers\TelescopeController;
use Barryvdh\Debugbar\Middleware\DebugbarEnabled;
$routeConfig = [
'prefix' => app('config')->get('debugbar.route_prefix'),
'domain' => app('config')->get('debugbar.route_domain'),
'middleware' => array_merge(app('config')->get('debugbar.route_middleware', []), [DebugbarEnabled::class]),
];
app('router')->group($routeConfig, function ($router) {
$router->get('open', [OpenHandlerController::class, 'handle'])->name('debugbar.openhandler');
$router->delete('cache/{key}/{tags?}', [CacheController::class, 'delete'])->name('debugbar.cache.delete');
$router->post('queries/explain', [QueriesController::class, 'explain'])->name('debugbar.queries.explain');
$router->get('clockwork/{id}', [OpenHandlerController::class, 'clockwork'])->name('debugbar.clockwork');
$router->get('assets/stylesheets', [AssetController::class, 'css'])->name('debugbar.assets.css');
$router->get('assets/javascript', [AssetController::class, 'js'])->name('debugbar.assets.js');
if (class_exists(\Laravel\Telescope\Telescope::class)) {
$router->get('telescope/{id}', [TelescopeController::class, 'show'])->name('debugbar.telescope');
}
});
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/Controllers/QueriesController.php | src/Controllers/QueriesController.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\Controllers;
use Barryvdh\Debugbar\Support\Explain;
use Exception;
use Illuminate\Http\Request;
class QueriesController extends BaseController
{
/**
* Generate explain data for query.
*/
public function explain(Request $request)
{
if (!config('debugbar.options.db.explain.enabled', false)) {
return response()->json([
'success' => false,
'message' => 'EXPLAIN is currently disabled in the Debugbar.',
], 400);
}
try {
$explain = new Explain();
if ($request->json('mode') === 'visual') {
return response()->json([
'success' => true,
'data' => $explain->generateVisualExplain($request->json('connection'), $request->json('query'), $request->json('bindings'), $request->json('hash')),
]);
}
return response()->json([
'success' => true,
'data' => $explain->generateRawExplain($request->json('connection'), $request->json('query'), $request->json('bindings'), $request->json('hash')),
'visual' => $explain->isVisualExplainSupported($request->json('connection')) ? [
'confirm' => $explain->confirmVisualExplain($request->json('connection')),
] : null,
]);
} catch (Exception $e) {
return response()->json([
'success' => false,
'message' => $e->getMessage(),
], 400);
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/Controllers/OpenHandlerController.php | src/Controllers/OpenHandlerController.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\Controllers;
use Barryvdh\Debugbar\Support\Clockwork\Converter;
use DebugBar\OpenHandler;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
class OpenHandlerController extends BaseController
{
/**
* Check if the storage is open for inspecting.
*
* @return bool
*/
protected function isStorageOpen(Request $request)
{
$open = config('debugbar.storage.open');
if (is_callable($open)) {
return call_user_func($open, [$request]);
}
if (is_string($open) && class_exists($open)) {
return method_exists($open, 'resolve') ? $open::resolve($request) : false;
}
if (is_bool($open)) {
return $open;
}
// Allow localhost request when not explicitly allowed/disallowed
if (in_array($request->ip(), ['127.0.0.1', '::1'], true)) {
return true;
}
return false;
}
public function handle(Request $request)
{
if ($request->input('op') === 'get' || $this->isStorageOpen($request)) {
$openHandler = new OpenHandler($this->debugbar);
$data = $openHandler->handle($request->input(), false, false);
} else {
$data = [
[
'datetime' => date("Y-m-d H:i:s"),
'id' => null,
'ip' => $request->getClientIp(),
'method' => 'ERROR',
'uri' => '!! To enable public access to previous requests, set debugbar.storage.open to true in your config, or enable DEBUGBAR_OPEN_STORAGE if you did not publish the config. !!',
'utime' => microtime(true),
],
];
}
return new Response(
$data,
200,
[
'Content-Type' => 'application/json',
],
);
}
/**
* Return Clockwork output
*
* @throws \DebugBar\DebugBarException
*/
public function clockwork(Request $request, $id)
{
$request = [
'op' => 'get',
'id' => $id,
];
$openHandler = new OpenHandler($this->debugbar);
$data = $openHandler->handle($request, false, false);
// Convert to Clockwork
$converter = new Converter();
$output = $converter->convert(json_decode($data, true));
return response()->json($output);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/Controllers/TelescopeController.php | src/Controllers/TelescopeController.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\Controllers;
use Laravel\Telescope\Contracts\EntriesRepository;
use Laravel\Telescope\Storage\EntryQueryOptions;
class TelescopeController extends BaseController
{
public function show(EntriesRepository $storage, $uuid)
{
$entry = $storage->find($uuid);
$result = $storage->get('request', (new EntryQueryOptions())->batchId($entry->batchId))->first();
return redirect(config('telescope.domain') . '/' . config('telescope.path') . '/requests/' . $result->id);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/Controllers/AssetController.php | src/Controllers/AssetController.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\Controllers;
use Illuminate\Http\Response;
class AssetController extends BaseController
{
/**
* Return the javascript for the Debugbar
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function js()
{
$renderer = $this->debugbar->getJavascriptRenderer();
$content = $renderer->dumpAssetsToString('js');
$response = new Response(
$content,
200,
[
'Content-Type' => 'text/javascript',
],
);
return $this->cacheResponse($response);
}
/**
* Return the stylesheets for the Debugbar
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function css()
{
$renderer = $this->debugbar->getJavascriptRenderer();
$content = $renderer->dumpAssetsToString('css');
$response = new Response(
$content,
200,
[
'Content-Type' => 'text/css',
],
);
return $this->cacheResponse($response);
}
/**
* Cache the response 1 year (31536000 sec)
*/
protected function cacheResponse(Response $response)
{
$response->setSharedMaxAge(31536000);
$response->setMaxAge(31536000);
$response->setExpires(new \DateTime('+1 year'));
return $response;
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/Controllers/CacheController.php | src/Controllers/CacheController.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\Controllers;
class CacheController extends BaseController
{
/**
* Forget a cache key
*
*/
public function delete($key, $tags = '')
{
$cache = app('cache');
if (!empty($tags)) {
$tags = json_decode($tags, true);
$cache = $cache->tags($tags);
} else {
unset($tags);
}
$success = $cache->forget($key);
return response()->json(compact('success'));
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/Controllers/BaseController.php | src/Controllers/BaseController.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\Controllers;
use Barryvdh\Debugbar\LaravelDebugbar;
use Illuminate\Routing\Controller;
use Illuminate\Http\Request;
use Illuminate\Session\Store;
use Laravel\Telescope\Telescope;
class BaseController extends Controller
{
protected $debugbar;
public function __construct(Request $request, LaravelDebugbar $debugbar)
{
$this->debugbar = $debugbar;
if ($request->hasSession()) {
/** @var Store $session */
$session = $request->session();
$session->reflash();
}
$this->middleware(function ($request, $next) {
if (class_exists(Telescope::class)) {
Telescope::stopRecording();
}
return $next($request);
});
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/SessionCollectorProvider.php | src/CollectorProviders/SessionCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Illuminate\Http\Request;
class SessionCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Request $request, array $options): void {}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/LaravelCollectorProvider.php | src/CollectorProviders/LaravelCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\LaravelCollector;
use Illuminate\Contracts\Foundation\Application;
class LaravelCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Application $app, array $options): void
{
$this->addCollector(new LaravelCollector($app));
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/PennantCollectorProvider.php | src/CollectorProviders/PennantCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\PennantCollector;
use Illuminate\Contracts\Foundation\Application;
use Laravel\Pennant\FeatureManager;
class PennantCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Application $app, array $options): void
{
if (class_exists(FeatureManager::class)
&& $app->bound(FeatureManager::class)
) {
$featureManager = $app->make(FeatureManager::class);
$this->addCollector(new PennantCollector($featureManager));
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/MemoryCollectorProvider.php | src/CollectorProviders/MemoryCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\MemoryCollector;
class MemoryCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(array $options): void
{
$memoryCollector = new MemoryCollector();
$this->addCollector($memoryCollector);
$memoryCollector->setPrecision($options['precision'] ?? 0);
if (function_exists('memory_reset_peak_usage') && ($options['reset_peak_usage'] ?? false)) {
memory_reset_peak_usage();
}
if ($options['with_baseline'] ?? false) {
$memoryCollector->resetMemoryBaseline();
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/PhpInfoCollectorProvider.php | src/CollectorProviders/PhpInfoCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\PhpInfoCollector;
class PhpInfoCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(array $options): void
{
$this->addCollector(new PhpInfoCollector());
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/TimeCollectorProvider.php | src/CollectorProviders/TimeCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\TimeDataCollector;
use Illuminate\Events\Dispatcher;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Http\Request;
use Illuminate\Routing\Events\PreparingResponse;
use Illuminate\Routing\Events\RouteMatched;
use Illuminate\Routing\Events\Routing;
class TimeCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Application $app, Request $request, Dispatcher $events, array $options): void
{
$startTime = (float) $request->server('REQUEST_TIME_FLOAT');
if ($this->hasCollector('time')) {
/** @var TimeDataCollector $timeCollector */
$timeCollector = $this['time'];
} else {
$timeCollector = new TimeDataCollector($startTime);
$this->addCollector($timeCollector);
}
if ($options['memory_usage'] ?? false) {
$timeCollector->showMemoryUsage();
}
if ($startTime) {
$app->booted(
function () use ($startTime, $timeCollector) {
$timeCollector->addMeasure('Booting', $startTime, microtime(true), [], 'time');
},
);
}
$timeCollector->startMeasure('application', 'Application', 'time');
$events->listen(Routing::class, fn() => $timeCollector->startMeasure('Routing'));
$events->listen(RouteMatched::class, fn() => $timeCollector->stopMeasure('Routing'));
$events->listen(PreparingResponse::class, fn() => $timeCollector->startMeasure('Preparing Response'));
$events->listen(PreparingResponse::class, fn() => $timeCollector->stopMeasure('Preparing Response'));
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/JobsCollectorProvider.php | src/CollectorProviders/JobsCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\ObjectCountCollector;
use Illuminate\Events\Dispatcher;
use Illuminate\Queue\Events\JobQueued;
class JobsCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Dispatcher $events, array $options): void
{
$jobs = new ObjectCountCollector('jobs', 'briefcase');
$this->addCollector($jobs);
$events->listen(JobQueued::class, function ($event) use ($jobs) {
$jobs->countClass($event->job);
});
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/GateCollectorProvider.php | src/CollectorProviders/GateCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\GateCollector;
class GateCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(GateCollector $gateCollector, array $options): void
{
$this->addCollector($gateCollector);
if ($options['trace'] ?? false) {
$gateCollector->collectFileTrace(true);
$gateCollector->addBacktraceExcludePaths($options['exclude_paths'] ?? []);
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/DatabaseCollectorProvider.php | src/CollectorProviders/DatabaseCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\QueryCollector;
use DebugBar\DataCollector\TimeDataCollector;
use Illuminate\Events\Dispatcher;
use Illuminate\Database\Events\ConnectionEstablished;
use Illuminate\Database\Events\QueryExecuted;
use Illuminate\Database\Events\TransactionBeginning;
use Illuminate\Database\Events\TransactionCommitted;
use Illuminate\Database\Events\TransactionRolledBack;
use Illuminate\Routing\Router;
class DatabaseCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Dispatcher $events, Router $router, array $options): void
{
if ($this->hasCollector('time') && ($options['timeline'] ?? false)) {
/** @var TimeDataCollector $timeCollector */
$timeCollector = $this['time'];
} else {
$timeCollector = null;
}
$queryCollector = new QueryCollector($timeCollector);
$queryCollector->setLimits($options['soft_limit'] ?? 100, $options['hard_limit'] ?? 500);
$queryCollector->setDurationBackground($options['duration_background'] ?? true);
$threshold = $options['slow_threshold'] ?? false;
if ($threshold && !($options['only_slow_queries'] ?? true)) {
$queryCollector->setSlowThreshold($threshold);
}
if ($options['with_params'] ?? true) {
$queryCollector->setRenderSqlWithParams(true);
}
if ($backtrace = ($options['backtrace'] ?? true)) {
$queryCollector->setFindSource($backtrace, $router->getMiddleware());
}
if ($excludePaths = ($options['exclude_paths'] ?? [])) {
$queryCollector->mergeExcludePaths($excludePaths);
}
if ($excludeBacktracePaths = ($options['backtrace_exclude_paths'] ?? [])) {
$queryCollector->mergeBacktraceExcludePaths($excludeBacktracePaths);
}
if ($options['explain.enabled'] ?? false) {
$queryCollector->setExplainSource(true);
}
$this->addCollector($queryCollector);
try {
$events->listen(
function (QueryExecuted $query) use ($queryCollector, $options) {
// In case Debugbar is disabled after the listener was attached
if (!$this->debugbar->shouldCollect('db', true)) {
return;
}
$threshold = $options['slow_threshold'] ?? false;
$onlyThreshold = $options['only_slow_queries'] ?? true;
//allow collecting only queries slower than a specified amount of milliseconds
if (!$onlyThreshold || !$threshold || $query->time > $threshold) {
$queryCollector->addQuery($query);
}
},
);
} catch (\Throwable $e) {
$this->addCollectorException('Cannot listen to Queries', $e);
}
try {
$events->listen(
TransactionBeginning::class,
fn($transaction) => $queryCollector->collectTransactionEvent('Begin Transaction', $transaction->connection),
);
$events->listen(
TransactionCommitted::class,
fn($transaction) => $queryCollector->collectTransactionEvent('Commit Transaction', $transaction->connection),
);
$events->listen(
TransactionRolledBack::class,
fn($transaction) => $queryCollector->collectTransactionEvent('Rollback Transaction', $transaction->connection),
);
$events->listen(
'connection.*.beganTransaction',
fn($event, $params) => $queryCollector->collectTransactionEvent('Begin Transaction', $params[0]),
);
$events->listen(
'connection.*.committed',
fn($event, $params) => $queryCollector->collectTransactionEvent('Commit Transaction', $params[0]),
);
$events->listen(
'connection.*.rollingBack',
fn($event, $params) => $queryCollector->collectTransactionEvent('Rollback Transaction', $params[0]),
);
$events->listen(
function (ConnectionEstablished $event) use ($queryCollector, $options) {
$queryCollector->collectTransactionEvent('Connection Established', $event->connection);
if ($options['memory_usage'] ?? false) {
$event->connection->beforeExecuting(function () use ($queryCollector) {
$queryCollector->startMemoryUsage();
});
}
},
);
} catch (\Throwable $e) {
$this->addCollectorException('Cannot listen to Queries', $e);
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/LivewireCollectorProvider.php | src/CollectorProviders/LivewireCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\LivewireCollector;
use Illuminate\Contracts\Foundation\Application;
class LivewireCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Application $app): void
{
if ($app->bound('livewire')) {
$this->addCollector($app->make(LivewireCollector::class));
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/ViewsCollectorProvider.php | src/CollectorProviders/ViewsCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\ViewCollector;
use DebugBar\DataCollector\TimeDataCollector;
use Illuminate\Events\Dispatcher;
class ViewsCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Dispatcher $events, array $options): void
{
$collectData = $options['data'] ?? false;
$excludePaths = $options['exclude_paths'] ?? [];
$group = $options['group'] ?? true;
if ($this->hasCollector('time') && ($options['timeline'] ?? false)) {
/** @var TimeDataCollector $timeCollector */
$timeCollector = $this->getCollector('time');
} else {
$timeCollector = null;
}
$viewCollector = new ViewCollector($collectData, $excludePaths, $group, $timeCollector);
$this->addCollector($viewCollector);
$events->listen(
'composing:*',
function ($event, $params) use ($viewCollector) {
$viewCollector->addView($params[0]);
},
);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/CacheCollectorProvider.php | src/CollectorProviders/CacheCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\CacheCollector;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Events\Dispatcher;
use Illuminate\Http\Request;
class CacheCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Application $app, Request $request, Dispatcher $events, array $options): void
{
$collectValues = $options['values'] ?? false;
$startTime = (float) $request->server('REQUEST_TIME_FLOAT');
$cacheCollector = new CacheCollector($startTime, $collectValues);
$this->addCollector($cacheCollector);
$cacheCollector->subscribe($events);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/MailCollectorProvider.php | src/CollectorProviders/MailCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\Bridge\Symfony\SymfonyMailCollector;
use Illuminate\Events\Dispatcher;
use Illuminate\Mail\Events\MessageSent;
class MailCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Dispatcher $events, array $options): void
{
$mailCollector = new SymfonyMailCollector();
$this->addCollector($mailCollector);
$events->listen(function (MessageSent $event) use ($mailCollector) {
$mailCollector->addSymfonyMessage($event->sent->getSymfonySentMessage());
});
if (($options['show_body'] ?? false) || ($options['full_log'] ?? false)) {
$mailCollector->showMessageBody();
}
//
// if ($this->hasCollector('time') && ($options['timeline'] ?? false)) {
// // TODO; use MessageSending and MessageSent events
// }
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/ConfigCollectorProvider.php | src/CollectorProviders/ConfigCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\ConfigCollector;
use Illuminate\Config\Repository;
class ConfigCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Repository $config, array $options): void
{
$configCollector = new ConfigCollector($config);
$this->addCollector($configCollector);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/EventsCollectorCollectorProvider.php | src/CollectorProviders/EventsCollectorCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\EventCollector;
use Illuminate\Events\Dispatcher;
use Illuminate\Http\Request;
class EventsCollectorCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Request $request, Dispatcher $events, array $options): void
{
$startTime = $request->server('REQUEST_TIME_FLOAT');
$collectData = $options['data'] ?? false;
$excludedEvents = $options['excluded'] ?? false;
$eventCollector = new EventCollector($startTime, $collectData, $excludedEvents);
$this->addCollector($eventCollector);
$eventCollector->subscribe($events);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/LogCollectorProvider.php | src/CollectorProviders/LogCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\MessagesCollector;
use Illuminate\Log\Events\MessageLogged;
use Illuminate\Log\Logger;
class LogCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Logger $logger, array $options): void
{
$logCollector = new MessagesCollector('log');
if ($this->hasCollector('messages')) {
/** @var MessagesCollector $messagesCollector */
$messagesCollector = $this->getCollector('messages');
$messagesCollector->aggregate($logCollector);
} else {
$this->addCollector($logCollector);
}
$logger->listen(
function (MessageLogged $log) use ($logCollector) {
try {
$logMessage = (string) $log->message;
if (mb_check_encoding($logMessage, 'UTF-8')) {
$context = $log->context;
$logMessage .= (!empty($context) ? ' ' . json_encode($context, JSON_PRETTY_PRINT) : '');
} else {
$logMessage = "[INVALID UTF-8 DATA]";
}
} catch (\Throwable $e) {
$logMessage = "[Exception: " . $e->getMessage() . "]";
}
$logCollector->addMessage(
'[' . date('H:i:s') . '] ' . "LOG.{$log->level}: " . $logMessage,
$log->level,
false,
);
},
);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/AbstractCollectorProvider.php | src/CollectorProviders/AbstractCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\LaravelDebugbar;
use DebugBar\DataCollector\DataCollectorInterface;
abstract class AbstractCollectorProvider
{
public function __construct(
protected readonly LaravelDebugbar $debugbar,
) {}
protected function addCollector(DataCollectorInterface $collector): void
{
$this->debugbar->addCollector($collector);
}
public function hasCollector(string $name): bool
{
return $this->debugbar->hasCollector($name);
}
public function getCollector(string $name): DataCollectorInterface
{
return $this->debugbar->getCollector($name);
}
protected function addCollectorException(string $message, \Throwable $exception)
{
$this->addThrowable(
new \RuntimeException(
$message . ' on Laravel Debugbar: ' . $exception->getMessage(),
(int) $exception->getCode(),
$exception,
),
);
}
/**
* Adds an exception to be profiled in the debug bar
*/
public function addThrowable(\Throwable $e): void
{
if ($this->hasCollector('exceptions')) {
/** @var \DebugBar\DataCollector\ExceptionsCollector $collector */
$collector = $this->getCollector('exceptions');
$collector->addThrowable($e);
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/ExceptionsCollectorProvider.php | src/CollectorProviders/ExceptionsCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\ExceptionsCollector;
class ExceptionsCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(array $options): void
{
$exceptionCollector = new ExceptionsCollector();
$this->addCollector($exceptionCollector);
$exceptionCollector->setChainExceptions($options['chain'] ?? true);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/ModelsCollectorProvider.php | src/CollectorProviders/ModelsCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\ObjectCountCollector;
use Illuminate\Events\Dispatcher;
class ModelsCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Dispatcher $events, array $options): void
{
$modelsCollector = new ObjectCountCollector('models');
$this->addCollector($modelsCollector);
$eventList = ['retrieved', 'created', 'updated', 'deleted'];
$modelsCollector->setKeyMap(array_combine($eventList, array_map('ucfirst', $eventList)));
$modelsCollector->collectCountSummary(true);
foreach ($eventList as $event) {
$events->listen("eloquent.{$event}: *", function ($event, $models) use ($modelsCollector) {
$event = explode(': ', $event);
$count = count(array_filter($models));
$modelsCollector->countClass($event[1], $count, explode('.', $event[0])[1]);
});
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/LogsCollectorProvider.php | src/CollectorProviders/LogsCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\LogsCollector;
use Illuminate\Log\Logger;
class LogsCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Logger $logger, array $options): void
{
$file = $options['file'] ?? 'laravel.log';
$this->addCollector(new LogsCollector($file));
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/RouteCollectorProvider.php | src/CollectorProviders/RouteCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\RouteCollector;
class RouteCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(RouteCollector $routeCollector, array $options): void
{
$this->addCollector($routeCollector);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/AuthCollectorProvider.php | src/CollectorProviders/AuthCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use Barryvdh\Debugbar\DataCollector\MultiAuthCollector;
use Illuminate\Auth\AuthManager;
use Illuminate\Config\Repository;
class AuthCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(Repository $config, AuthManager $auth, array $options): void
{
$guards = $config->get('auth.guards', []);
$authCollector = new MultiAuthCollector($auth, $guards);
$this->addCollector($authCollector);
$authCollector->setShowName($options['show_name'] ?? false);
$authCollector->setShowGuardsData($options['show_guards'] ?? true);
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/DefaultRequestCollectorProvider.php | src/CollectorProviders/DefaultRequestCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\RequestDataCollector;
class DefaultRequestCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(array $options): void
{
$this->addCollector(new RequestDataCollector());
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
barryvdh/laravel-debugbar | https://github.com/barryvdh/laravel-debugbar/blob/7e9719db094762f08f998521dcc048321d936bcb/src/CollectorProviders/MessagesCollectorProvider.php | src/CollectorProviders/MessagesCollectorProvider.php | <?php
declare(strict_types=1);
namespace Barryvdh\Debugbar\CollectorProviders;
use DebugBar\DataCollector\MessagesCollector;
class MessagesCollectorProvider extends AbstractCollectorProvider
{
public function __invoke(array $options): void
{
$messageCollector = new MessagesCollector();
$this->addCollector($messageCollector);
if ($options['trace'] ?? true) {
$messageCollector->collectFileTrace(true);
}
if ($options['capture_dumps'] ?? false) {
$originalHandler = \Symfony\Component\VarDumper\VarDumper::setHandler(function ($var) use (&$originalHandler, $messageCollector) {
if ($originalHandler) {
$originalHandler($var);
}
$messageCollector->addMessage($var);
});
}
}
}
| php | MIT | 7e9719db094762f08f998521dcc048321d936bcb | 2026-01-04T15:02:34.390506Z | false |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.