Skip to content

Examples for using some of the new NumberFormat Wizards #3485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 29, 2023
Merged

Examples for using some of the new NumberFormat Wizards #3485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9810e72
Examples for using some of the new NumberFormat Wizards
MarkBaker Mar 27, 2023
3c82cea
Examples for using some of the new NumberFormat Wizards
MarkBaker Mar 27, 2023
45eef3e
Merge remote-tracking branch 'origin/Examples-NumberFormat-Wizards' i…
MarkBaker Mar 27, 2023
378f120
PHPCS fixes
MarkBaker Mar 28, 2023
32b4dfb
Tweaks
MarkBaker Mar 28, 2023
a69ab80
Build currencies list for Currency and Accounting Wizards
MarkBaker Mar 28, 2023
aa9e1ed
Merge branch 'master' into Examples-NumberFormat-Wizards
MarkBaker Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions samples/Basic/45_Quadratic_equation_solver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
<?php

use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\Settings;

require __DIR__ . '/../Header.php';

$helper = new Sample();
if ($helper->isCli()) {
$helper->log('This example should only be run from a Web Browser' . PHP_EOL);

return;
}
?>
<form action="45_Quadratic_equation_solver.php" method="POST">
Enter the coefficients for the Ax<sup>2</sup> + Bx + C = 0
Expand Down
111 changes: 111 additions & 0 deletions samples/Wizards/NumberFormat/Accounting.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<?php

use PhpOffice\PhpSpreadsheet\Exception as SpreadsheetException;
use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\Settings;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;

require __DIR__ . '/../../Header.php';

$helper = new Sample();
if ($helper->isCli()) {
$helper->log('This example should only be run from a Web Browser' . PHP_EOL);

return;
}

$currencies = [
'$' => 'US Dollars ($)',
'€' => 'Euro (€)',
'¥' => 'Japanese Yen (¥)',
'£' => 'Pound Sterling (£)',
'₹' => 'Rupee (₹)',
'₽' => 'Rouble (₽)',
];

?>
<form action=Accounting.php method="POST">
<div class="mb-3 row">
<label for="number" class="col-sm-2 col-form-label">Sample Number Value</label>
<div class="col-sm-10">
<input name="number" type="text" size="8" value="<?php echo (isset($_POST['number'])) ? htmlentities($_POST['number'], Settings::htmlEntityFlags()) : '1234.5678'; ?>">
</div>
</div>
<div class="mb-3 row">
<hr />
</div>
<div class="mb-3 row">
<label for="currency" class="col-sm-2 col-form-label">Currency</label>
<div class="col-sm-10">
<select name="currency" class="form-select">
<?php foreach ($currencies as $currencySymbol => $currencyName) {
echo "<option value=\"{$currencySymbol}\" " . ((isset($_POST['currency']) && $_POST['currency'] === $currencySymbol) ? 'selected' : '') . ">{$currencyName}</option>", PHP_EOL;
} ?>
</select>
</div>
</div>
<div class="mb-3 row">
<label for="decimals" class="col-sm-2 col-form-label">Decimal Places</label>
<div class="col-sm-10">
<input name="decimals" type="number" size="2" min="0" max="14" value="<?php echo (isset($_POST['decimals'])) ? htmlentities($_POST['decimals'], Settings::htmlEntityFlags()) : '2'; ?>">
</div>
</div>
<div class="mb-3 row">
<label for="thousands" class="col-sm-2 col-form-label">Use Thousands Separator</label>
<div class="col-sm-10">
<input name="thousands" type="checkbox" <?php echo (isset($_POST['thousands'])) ? 'value="on"' : ''; ?> <?php echo (isset($_POST['thousands'])) ? 'checked' : ''; ?>>
</div>
</div>
<div class="mb-3 row">
<label for="position" class="col-sm-2 col-form-label">Currency Position</label>
<div class="col-sm-10">
<input name="position" type="radio" value="1" <?php echo ((isset($_POST['position']) === false) || (isset($_POST['position']) && $_POST['position'] === '1')) ? 'checked' : ''; ?>>Leading
<input name="position" type="radio" value="0" <?php echo (isset($_POST['position']) && $_POST['position'] === '0') ? 'checked' : ''; ?>>Trailing
</div>
</div>
<div class="mb-3 row">
<label for="spacing" class="col-sm-2 col-form-label">Currency Spacing</label>
<div class="col-sm-10">
<input name="spacing" type="radio" value="1" <?php echo (isset($_POST['spacing']) && $_POST['spacing'] === '1') ? 'checked' : ''; ?>>Yes
<input name="spacing" type="radio" value="0" <?php echo ((isset($_POST['spacing']) === false) || (isset($_POST['spacing']) && $_POST['spacing'] === '0')) ? 'checked' : ''; ?>>No
</div>
</div>
<div class="mb-3 row">
<div class="col-sm-10">
<input class="btn btn-primary" name="submit" type="submit" value="Display Mask"><br />
</div>
</div>
</form>

<?php
/** If the user has submitted the form, then we need to use the wizard to build a mask and display the result */
if (isset($_POST['submit'])) {
if (!is_numeric($_POST['number'])) {
$helper->log('The Sample Number Value must be numeric');
} elseif (!is_numeric($_POST['decimals']) || strpos($_POST['decimals'], '.') !== false || (int) $_POST['decimals'] < 0) {
$helper->log('The Decimal Places value must be positive integer');
} else {
try {
$wizard = new Wizard\Accounting($_POST['currency'], $_POST['decimals'], isset($_POST['thousands']), (bool) $_POST['position'], (bool) $_POST['spacing']);
$mask = $wizard->format();
$example = (string) NumberFormat::toFormattedString((float) $_POST['number'], $mask);
$helper->log('<hr /><b>Code:</b><br />');
$helper->log('use PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;');
$helper->log(
"\$mask = Wizard\\Accounting('{$_POST['currency']}', {$_POST['decimals']}, Wizard\\Number::" .
(isset($_POST['thousands']) ? 'WITH_THOUSANDS_SEPARATOR' : 'WITHOUT_THOUSANDS_SEPARATOR') .
', Wizard\Currency::' . (((bool) $_POST['position']) ? 'LEADING_SYMBOL' : 'TRAILING_SYMBOL') .
', Wizard\Currency::' . (((bool) $_POST['spacing']) ? 'SYMBOL_WITH_SPACING' : 'SYMBOL_WITHOUT_SPACING') .
');<br />'
);
$helper->log('echo (string) $mask;');
$helper->log('<hr /><b>Mask:</b><br />');
$helper->log($mask . '<br />');
$helper->log('<br /><b>Example:</b><br />');
$helper->log($example);
} catch (SpreadsheetException $e) {
$helper->log("Exception: {$e->getMessage()}");
}
}
}
111 changes: 111 additions & 0 deletions samples/Wizards/NumberFormat/Currency.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<?php

use PhpOffice\PhpSpreadsheet\Exception as SpreadsheetException;
use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\Settings;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;

require __DIR__ . '/../../Header.php';

$helper = new Sample();
if ($helper->isCli()) {
$helper->log('This example should only be run from a Web Browser' . PHP_EOL);

return;
}

$currencies = [
'$' => 'US Dollars ($)',
'€' => 'Euro (€)',
'¥' => 'Japanese Yen (¥)',
'£' => 'Pound Sterling (£)',
'₹' => 'Rupee (₹)',
'₽' => 'Rouble (₽)',
];

?>
<form action="Currency.php" method="POST">
<div class="mb-3 row">
<label for="number" class="col-sm-2 col-form-label">Sample Number Value</label>
<div class="col-sm-10">
<input name="number" type="text" size="8" value="<?php echo (isset($_POST['number'])) ? htmlentities($_POST['number'], Settings::htmlEntityFlags()) : '1234.5678'; ?>">
</div>
</div>
<div class="mb-3 row">
<hr />
</div>
<div class="mb-3 row">
<label for="currency" class="col-sm-2 col-form-label">Currency</label>
<div class="col-sm-10">
<select name="currency" class="form-select">
<?php foreach ($currencies as $currencySymbol => $currencyName) {
echo "<option value=\"{$currencySymbol}\" " . ((isset($_POST['currency']) && $_POST['currency'] === $currencySymbol) ? 'selected' : '') . ">{$currencyName}</option>", PHP_EOL;
} ?>
</select>
</div>
</div>
<div class="mb-3 row">
<label for="decimals" class="col-sm-2 col-form-label">Decimal Places</label>
<div class="col-sm-10">
<input name="decimals" type="number" size="2" min="0" max="14" value="<?php echo (isset($_POST['decimals'])) ? htmlentities($_POST['decimals'], Settings::htmlEntityFlags()) : '2'; ?>">
</div>
</div>
<div class="mb-3 row">
<label for="thousands" class="col-sm-2 col-form-label">Use Thousands Separator</label>
<div class="col-sm-10">
<input name="thousands" type="checkbox" <?php echo (isset($_POST['thousands'])) ? 'value="on"' : ''; ?> <?php echo (isset($_POST['thousands'])) ? 'checked' : ''; ?>>
</div>
</div>
<div class="mb-3 row">
<label for="position" class="col-sm-2 col-form-label">Currency Position</label>
<div class="col-sm-10">
<input name="position" type="radio" value="1" <?php echo ((isset($_POST['position']) === false) || (isset($_POST['position']) && $_POST['position'] === '1')) ? 'checked' : ''; ?>>Leading
<input name="position" type="radio" value="0" <?php echo (isset($_POST['position']) && $_POST['position'] === '0') ? 'checked' : ''; ?>>Trailing
</div>
</div>
<div class="mb-3 row">
<label for="spacing" class="col-sm-2 col-form-label">Currency Spacing</label>
<div class="col-sm-10">
<input name="spacing" type="radio" value="1" <?php echo (isset($_POST['spacing']) && $_POST['spacing'] === '1') ? 'checked' : ''; ?>>Yes
<input name="spacing" type="radio" value="0" <?php echo ((isset($_POST['spacing']) === false) || (isset($_POST['spacing']) && $_POST['spacing'] === '0')) ? 'checked' : ''; ?>>No
</div>
</div>
<div class="mb-3 row">
<div class="col-sm-10">
<input class="btn btn-primary" name="submit" type="submit" value="Display Mask"><br />
</div>
</div>
</form>

<?php
/** If the user has submitted the form, then we need to use the wizard to build a mask and display the result */
if (isset($_POST['submit'])) {
if (!is_numeric($_POST['number'])) {
$helper->log('The Sample Number Value must be numeric');
} elseif (!is_numeric($_POST['decimals']) || strpos($_POST['decimals'], '.') !== false || (int) $_POST['decimals'] < 0) {
$helper->log('The Decimal Places value must be positive integer');
} else {
try {
$wizard = new Wizard\Currency($_POST['currency'], $_POST['decimals'], isset($_POST['thousands']), (bool) $_POST['position'], (bool) $_POST['spacing']);
$mask = $wizard->format();
$example = (string) NumberFormat::toFormattedString((float) $_POST['number'], $mask);
$helper->log('<hr /><b>Code:</b><br />');
$helper->log('use PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;');
$helper->log(
"\$mask = Wizard\\Currency('{$_POST['currency']}', {$_POST['decimals']}, Wizard\\Number::" .
(isset($_POST['thousands']) ? 'WITH_THOUSANDS_SEPARATOR' : 'WITHOUT_THOUSANDS_SEPARATOR') .
', Wizard\Currency::' . (((bool) $_POST['position']) ? 'LEADING_SYMBOL' : 'TRAILING_SYMBOL') .
', Wizard\Currency::' . (((bool) $_POST['spacing']) ? 'SYMBOL_WITH_SPACING' : 'SYMBOL_WITHOUT_SPACING') .
');<br />'
);
$helper->log('echo (string) $mask;');
$helper->log('<hr /><b>Mask:</b><br />');
$helper->log($mask . '<br />');
$helper->log('<br /><b>Example:</b><br />');
$helper->log($example);
} catch (SpreadsheetException $e) {
$helper->log("Exception: {$e->getMessage()}");
}
}
}
75 changes: 75 additions & 0 deletions samples/Wizards/NumberFormat/Number.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?php

use PhpOffice\PhpSpreadsheet\Exception as SpreadsheetException;
use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\Settings;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;

require __DIR__ . '/../../Header.php';

$helper = new Sample();
if ($helper->isCli()) {
$helper->log('This example should only be run from a Web Browser' . PHP_EOL);

return;
}
?>
<form action="Number.php" method="POST">
<div class="mb-3 row">
<label for="number" class="col-sm-2 col-form-label">Sample Number Value</label>
<div class="col-sm-10">
<input name="number" type="text" size="8" value="<?php echo (isset($_POST['number'])) ? htmlentities($_POST['number'], Settings::htmlEntityFlags()) : '1234.5678'; ?>">
</div>
</div>
<div class="mb-3 row">
<hr />
</div>
<div class="mb-3 row">
<label for="decimals" class="col-sm-2 col-form-label">Decimal Places</label>
<div class="col-sm-10">
<input name="decimals" type="number" size="2" min="0" max="14" value="<?php echo (isset($_POST['decimals'])) ? htmlentities($_POST['decimals'], Settings::htmlEntityFlags()) : '2'; ?>">
</div>
</div>
<div class="mb-3 row">
<label for="thousands" class="col-sm-2 col-form-label">Use Thousands Separator</label>
<div class="col-sm-10">
<input name="thousands" type="checkbox" <?php echo (isset($_POST['thousands'])) ? 'value="on"' : ''; ?> <?php echo (isset($_POST['thousands'])) ? 'checked' : ''; ?>>
</div>
</div>
<div class="mb-3 row">
<div class="col-sm-10">
<input class="btn btn-primary" name="submit" type="submit" value="Display Mask"><br />
</div>
</div>
</form>

<?php
/** If the user has submitted the form, then we need to use the wizard to build a mask and display the result */
if (isset($_POST['submit'])) {
if (!is_numeric($_POST['number'])) {
$helper->log('The Sample Number Value must be numeric');
} elseif (!is_numeric($_POST['decimals']) || strpos($_POST['decimals'], '.') !== false || (int) $_POST['decimals'] < 0) {
$helper->log('The Decimal Places value must be positive integer');
} else {
try {
$wizard = new Wizard\Number($_POST['decimals'], isset($_POST['thousands']));
$mask = $wizard->format();
$example = NumberFormat::toFormattedString((float) $_POST['number'], $mask);
$helper->log('<hr /><b>Code:</b><br />');
$helper->log('use PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;');
$helper->log(
"\$mask = Wizard\\Number({$_POST['decimals']}, Wizard\\Number::" .
(isset($_POST['thousands']) ? 'WITH_THOUSANDS_SEPARATOR' : 'WITHOUT_THOUSANDS_SEPARATOR') .
');<br />'
);
$helper->log('echo (string) $mask;');
$helper->log('<hr /><b>Mask:</b>');
$helper->log($mask);
$helper->log('<b>Example:</b>');
$helper->log($example);
} catch (SpreadsheetException $e) {
$helper->log("Exception: {$e->getMessage()}");
}
}
}
65 changes: 65 additions & 0 deletions samples/Wizards/NumberFormat/Percentage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<?php

use PhpOffice\PhpSpreadsheet\Exception as SpreadsheetException;
use PhpOffice\PhpSpreadsheet\Helper\Sample;
use PhpOffice\PhpSpreadsheet\Settings;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;

require __DIR__ . '/../../Header.php';

$helper = new Sample();
if ($helper->isCli()) {
$helper->log('This example should only be run from a Web Browser' . PHP_EOL);

return;
}
?>
<form action="Percentage.php" method="POST">
<div class="mb-3 row">
<label for="number" class="col-sm-2 col-form-label">Sample Number Value</label>
<div class="col-sm-10">
<input name="number" type="text" size="8" value="<?php echo (isset($_POST['number'])) ? htmlentities($_POST['number'], Settings::htmlEntityFlags()) : '1234.5678'; ?>">
</div>
</div>
<div class="mb-3 row">
<hr />
</div>
<div class="mb-3 row">
<label for="decimals" class="col-sm-2 col-form-label">Decimal Places</label>
<div class="col-sm-10">
<input name="decimals" type="number" size="2" min="0" max="14" value="<?php echo (isset($_POST['decimals'])) ? htmlentities($_POST['decimals'], Settings::htmlEntityFlags()) : '2'; ?>">
</div>
</div>
<div class="mb-3 row">
<div class="col-sm-10">
<input class="btn btn-primary" name="submit" type="submit" value="Display Mask"><br />
</div>
</div>
</form>

<?php
/** If the user has submitted the form, then we need to use the wizard to build a mask and display the result */
if (isset($_POST['submit'])) {
if (!is_numeric($_POST['number'])) {
$helper->log('The Sample Number Value must be numeric');
} elseif (!is_numeric($_POST['decimals']) || strpos($_POST['decimals'], '.') !== false || (int) $_POST['decimals'] < 0) {
$helper->log('The Decimal Places value must be positive integer');
} else {
try {
$wizard = new Wizard\Percentage($_POST['decimals']);
$mask = $wizard->format();
$example = (string) NumberFormat::toFormattedString((float) $_POST['number'], $mask);
$helper->log('<hr /><b>Code:</b><br />');
$helper->log('use PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;');
$helper->log("\$mask = Wizard\\Percentage({$_POST['decimals']});<br />");
$helper->log('echo (string) $mask;');
$helper->log('<hr /><b>Mask:</b><br />');
$helper->log($mask . '<br />');
$helper->log('<br /><b>Example:</b><br />');
$helper->log($example);
} catch (SpreadsheetException $e) {
$helper->log("Exception: {$e->getMessage()}");
}
}
}
Loading