CsvPrinter

MMO\core\printers · 1 symbol · generated 30 Sep 2026

class

CsvPrinter

A XlsxPrinter that renders to CSV text instead of xlsx cell values: same row/column flattening, but plain-text/RFC-4180-style quoting (exportString) instead of Excel formulas for repeated references.

class MMO\core\printers\CsvPrinter extends MMO\core\printers\XlsxPrinter

Namespace: MMO\core\printers
Extends: XlsxPrinter

CsvPrinter::Encode([['name' => 'Marc', 'age' => 42]], ['headers' => ['Name', 'Age']]);

Index

	UTF8_BOM	UTF-8 byte-order mark, prefixed to every encoded CSV so spreadsheet apps (Excel in particular) detect the encoding correctly.
	Encode($lines, $options) static	NOTE: \MMO\core\strings\csvEncode() expects its $headers argument as a (field key => display title) map, matched against each row's own keys -- but this class's 'headers' option (like \MMO\core\doc…
	exportArray($value, $options)	Same as `XlsxPrinter::exportArray`, but quoted (unless embedded in an outer value) since the joined text may itself contain the CSV separator.
	exportBoolean($value, $options)
	exportDateTime($value, $options)
	exportEntity($value, $options)
	exportNull($value, $options)
	exportNumber($value, $options)
	exportObject($value, $options)	Same as `XlsxPrinter::exportObject`, but quoted (unless embedded) -- see `exportArray`.
	exportString($value, $options)
	__construct($config)

Constants1

UTF8_BOM

UTF-8 byte-order mark, prefixed to every encoded CSV so spreadsheet apps (Excel in particular) detect the encoding correctly.

const UTF8_BOM = ''

Methods10

Encode($lines, $options)

staticCsvPrinter.php:44

NOTE: \MMO\core\strings\csvEncode() expects its $headers argument as a (field key => display title) map, matched against each row's own keys -- but this class's 'headers' option (like \MMO\core\documents\xlsx\Document::addContent's) is a plain, position-ordered list of titles (e.g.

static function Encode(array $lines, MMO\core\interfaces\iOptions|array $options = []): string

['Name', 'Age']), matching this framework's convention elsewhere. Passing that list straight through used to make csvEncode() look each column up by its (numeric, 0/1/2/...) list index instead of its real field name -- always missing, so the header row came out correct but every data row was rendered completely blank. Fixed by remapping a plain headers list onto the exported rows' actual field keys, by position, before handing it to csvEncode(); an already (key => title)-shaped $headers is passed through unchanged.

$lines	array
$options = []	iOptions \| array
returns	string	CSV text, UTF-8 BOM-prefixed.

CsvPrinter::Encode($rows, new PrintOptions(headers: ['Name', 'Age'], separator: ','));

exportArray($value, $options)

CsvPrinter.php:61

Same as XlsxPrinter::exportArray, but quoted (unless embedded in an outer value) since the joined text may itself contain the CSV separator.

function exportArray(array $value, array $options = []): string

$value	array
$options = []	array
returns	string

exportBoolean($value, $options)

CsvPrinter.php:87

function exportBoolean(mixed $value, array $options = []): string

$value	mixed
$options = []	array
returns	string	'TRUE' or 'FALSE'.

exportDateTime($value, $options)

CsvPrinter.php:114

function exportDateTime(mixed $value, array $options = []): string

$value	mixed
$options = []	array	'lang'.
returns	string	'Y-m-d H:i:s' formatted.

exportEntity($value, $options)

CsvPrinter.php:123

function exportEntity(MMO\core\interfaces\iEntity $value, array $options = []): string

$value	iEntity
$options = []	array
returns	string	`XlsxPrinter::exportEntity`'s result, quoted as a string (`exportString`) instead of left as an Excel formula/plain text.

exportNull($value, $options)

CsvPrinter.php:105

function exportNull(mixed $value, array $options = []): string

$value	mixed
$options = []	array
returns	string	always 'NULL' (unlike a bare empty CSV field, distinguishable from an empty string).

exportNumber($value, $options)

CsvPrinter.php:96

function exportNumber(mixed $value, array $options = []): string

$value	mixed
$options = []	array	'precision'/'separator-decimal' (default '.')/'separator-thousand' (default '').
returns	string

exportObject($value, $options)

CsvPrinter.php:67

Same as XlsxPrinter::exportObject, but quoted (unless embedded) -- see exportArray.

function exportObject(array $value, array $options = []): string

$value	array
$options = []	array
returns	string

exportString($value, $options)

CsvPrinter.php:77

function exportString(mixed $value, array $options = []): string

$value	mixed
$options = []	array
returns	string	RFC-4180-quoted (internal `"` doubled), unless embedded in an outer (already-quoted) value.

__construct($config)

CsvPrinter.php:16

function __construct(array &$config)

$config

array

Inherited members (72)

Constants	Declared by	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Properties	Declared by	Description
	`functions`	aConverter
	`globalOptions`	aConverter
	`verbosity`	aModule

Methods	Declared by	Description
`addOptions($type, $options)`	aConverter	Merge $options into $type's existing options (via `merge`), rather than replacing them wholesale like `setOptions`.
`alert($message, $context)`	aModule	Action must be taken immediately.
`backtraces($message, $context)`	aModule	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`call($type, $value, $options)`	aConverter	Call the function associated to a type
`clear()`	aConverter	Remove every registered type/function.
`Configure($config)`	aModule	Merge $config into this module's configuration in the shared `Configuration`.
`critical($message, $context)`	aModule	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aModule	Detailed debug information.
`debugName()`	aModule	Human-readable identifier used as the default `{origin}` in this instance's log messages.
`DefaultConfig()`	aModule	The config a module starts from before anything loaded via `Configuration` is merged in.
`emergency($message, $context)`	aModule	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aModule	Runtime errors that do not require immediate action but should typically be logged and monitored.
`Export($value, $options, $type)`	aExporter	Export any value, dispatching to the right converter based on its type (or the explicit $type).
`exportEnum($value, $options)`	aExporter	Built-in 'enum' converter.
`exportInstance($value, $options)`	XlsxPrinter
`ExportLines($lines, $options)`	XlsxPrinter	Flatten each row (see the class docblock).
`ExportProperties($value, $options)`	aExporter	Export an object `exportInstance` method
`exportsProperty($prop, $value)`	aExporter	Whether `exportInstance` exports $prop of $value: not a static property -- it is the class's, not $value's -- nor an uninitialized one, which has no value (the properties `(array)$value` holds).
`exportUnitEnum($value, $options)`	XlsxPrinter
`flatten($value, $options)`	XlsxPrinter	Recursively flatten $value into a single-level `column => string` map: a nested associative array's keys are joined with the parent key via `/` (e.g.
`getClassFunction($class)`	aConverter	Find which registered type (a class or interface name) applies to $class: itself if directly registered, else the closest registered ancestor class or implemented interface.
`getFunction($type)`	aConverter
`getFunctions()`	aConverter
`getOptions($type)`	aConverter
`getType($value, $allowClass)`	aConverter	Normalize $value's type into one of this converter's type names.
`getVerbosity()`	aModule
`hash($value, $options)`	XlsxPrinter	NOTE: this used to always add 1 to $options['line'] (itself already the 1-based position within the DATA rows passed to `ExportLines`, i.e.
`hasType($type)`	aConverter
`info($message, $context)`	aModule	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`Instantiate($config)`	aModule	(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
`IsShared()`	aModule
`log($level, $message, $context)`	aModule	Logs with an arbitrary level.
`notice($message, $context)`	aModule	Normal but significant events.
`offsetExists($key)`	aModule	\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
`offsetGet($key)`	aModule	\ArrayAccess::offsetGet -- reads a property directly, unless it has a `#[Serialize(serialize: 'methodName')]` attribute, in which case that zero-argument method is called instead (e.g.
`offsetSet($key, $value)`	aModule	\ArrayAccess::offsetSet -- sets a property directly, unless it has a `#[Serialize(unserialize: 'methodName')]` attribute, in which case that method is called with $value instead (e.g.
`offsetUnset($key)`	aModule	\ArrayAccess::offsetUnset -- equivalent to `$module[$key] = null`.
`resetHash($value, $options)`	aExporter	Forget that $value was already seen, within the given $options['hashes'] tracking map: the next time $value is encountered in this same export, it is exported in full again instead of collapsing to…
`serialize($path, $serializer)`	aModule	\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
`setFunction($type, $fn, $options)`	aConverter	Set a coercer
`setFunctions($fns)`	aConverter	Register many functions at once, e.g.
`setOptions($type, $options)`	aConverter	Replace $type's options wholesale.
`setVerbosity($verb)`	aModule	Set the current verbosity mask, replacing whatever it was before.
`Shared()`	aModule	Get the shared instance, creating (and configuring) it on first call.
`testVerbosity($level)`	aModule	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`traitUnshare($serialize)`	aModule	Remove the shared instance, so the next `Shared()` call creates a fresh one.
`unserialize($data, $path, $instances)`	aModule	\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto `DefaultConfig`, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
`Unshare($serialize)`	aModule	Like `tSingleton::Unshare`, but also disconnects this module's instance from every event it was listening to (via `Event::DisconnectListeners`) before dropping it.
`warning($message, $context)`	aModule	Exceptional occurrences that are not errors.
`__invoke($value, $options, $type)`	aExporter	The actual export entry point (also what `iExporter`'s `$exporter($value)` calling convention invokes).