Escpos PHP

https://github.com/mike42/escpos-php
Admin
Escpos PHP is a receipt printer library that implements a subset of Epson's ESC/POS protocol to...
Tokens:73,824
Snippets:602
Trust Score:7.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Usage example: loading and printing an image

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/EscposImage.md

Shows how to load an image and use it with the printer's graphics method, and how to get column format for bitImageColumnFormat users.

```php
$img = EscposImage::load("logo.png");
$printer->graphics($img);                       // raster path
$rows = $img->toColumnFormat(true);             // 24px lines, for bitImageColumnFormat users
```

--------------------------------

### WindowsPrintConnector usage examples

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/WindowsPrintConnector.md

Examples of creating a WindowsPrintConnector with SMB URIs, a local port, and using it with a Printer object.

```php
$connector = new WindowsPrintConnector("smb://user:pass@print-server/printer");
$connector = new WindowsPrintConnector("smb://print-server/workgroup/printer"); // workgroup + share
$connector = new WindowsPrintConnector("LPT1");   // Windows only
$printer = new Printer($connector);
```

--------------------------------

### Usage example for getSupportsQrCode

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/CapabilityProfile.md

Shows how to check if a printer supports QR codes and print a message if not.

```php
if (!$profile->getSupportsQrCode()) {
    echo "This printer cannot print QR codes\n";
}
```

--------------------------------

### Usage example with UnifontPrintBuffer

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Experimental/UnifontPrintBuffer.md

Shows how to create a printer, set the Unifont print buffer, and print text with formatting.

```php
use Mike42\Escpos\Experimental\Unifont\UnifontPrintBuffer;

$connector = new FilePrintConnector("php://stdout");
$printer = new Printer($connector);

$unifontBuffer = new UnifontPrintBuffer("/usr/share/unifont/unifont.hex");
$printer->setPrintBuffer($unifontBuffer);

$printer->text("Hello\n");
$printer->setUpsideDown(true);
$printer->text("World\n");
$printer->cut();
$printer->close();
```

--------------------------------

### Clone repository and install dependencies

Source: https://github.com/mike42/escpos-php/blob/development/CONTRIBUTING.md

Commands to fetch a copy of the code and load dependencies with composer.

```bash
git clone https://github.com/mike42/escpos-php
cd escpos-php/
composer install
```

--------------------------------

### Get SMB connector

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/UriPrintConnector.md

Example of using UriPrintConnector::get() with an smb URI. The whole URI is passed to WindowsPrintConnector.

```php
$connector = UriPrintConnector::get("smb://user:pass@print-server/printer");
```

--------------------------------

### Usage example with AuresCustomerDisplay

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Shows how to instantiate the display with a FilePrintConnector and CapabilityProfile, then use text, scroll mode, feed, clear, and close.

```php
use Mike42\Escpos\Devices\AuresCustomerDisplay;
use Mike42\Escpos\PrintConnectors\FilePrintConnector;
use Mike42\Escpos\CapabilityProfile;

$connector = new FilePrintConnector("/dev/ttyACM0");
$profile = CapabilityProfile::load("OCD-300");
$display = new AuresCustomerDisplay($connector, $profile);

$display->text("Line one\nLine two\n");
$display->selectTextScrollMode(AuresCustomerDisplay::TEXT_HORIZONTAL_SCROLL);
$display->feed(2);
$display->clear();
$display->text("Hello World\n");
$display->close();
```

--------------------------------

### Install with Composer

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Adds the mike42/escpos-php package to a PHP project using Composer.

```bash
composer require mike42/escpos-php
```

--------------------------------

### Get TCP connector and create Printer

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/UriPrintConnector.md

Example of using UriPrintConnector::get() with a tcp URI and passing the resulting connector to a new Printer instance.

```php
$uri = "tcp://192.168.1.100:9100";
$connector = UriPrintConnector::get($uri);
$printer = new Printer($connector);
```

--------------------------------

### EscposImage::load() usage example

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/EscposImage.md

Example of loading an image with optimisations disabled to force the pixel-by-pixel path. The second parameter is set to false.

```php
$img = EscposImage::load("resources/escpos-php.png", false); // force pixel-by-pixel path
```

--------------------------------

### selfTest() method

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Starts a self-test/demo sequence by writing \x02\x05\x44\x08\x03.

```php
public function selfTest(): void
```

--------------------------------

### CapabilityProfile simple example

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Loads the 'simple' CapabilityProfile and creates a Printer with a WindowsPrintConnector. Use for new printer brands to avoid advanced features.

```php
use Mike42\Escpos\PrintConnectors\WindowsPrintConnector;
use Mike42\Escpos\CapabilityProfile;
$profile = CapabilityProfile::load("simple");
$connector = new WindowsPrintConnector("smb://computer/printer");
$printer = new Printer($connector, $profile);
```

--------------------------------

### FilePrintConnector example

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Creates a Printer with a FilePrintConnector for a serial printer device file.

```php
use Mike42\Escpos\PrintConnectors\FilePrintConnector;
use Mike42\Escpos\Printer;
$connector = new FilePrintConnector("/dev/ttyS0");
$printer = new Printer($connector);
```

--------------------------------

### CapabilityProfile SP2000 example

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Loads the 'SP2000' CapabilityProfile for Star-branded printers and creates a Printer with a WindowsPrintConnector.

```php
use Mike42\Escpos\PrintConnectors\WindowsPrintConnector;
use Mike42\Escpos\CapabilityProfile;
$profile = CapabilityProfile::load("SP2000")
$connector = new WindowsPrintConnector("smb://computer/printer");
$printer = new Printer($connector, $profile);
```

--------------------------------

### Print image with graphics()

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Minimal example loading an image and printing it with the graphics() method. Requires an EscposImage loaded from a file and a connected printer.

```php
<?php
$img = EscposImage::load("logo.png");
$printer -> graphics($img);
```

--------------------------------

### Loading and printing PDF pages

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/ImagickEscposImage.md

Example of loading a PDF and printing each page using the graphics method.

```php
$pages = ImagickEscposImage::loadPdf("document.pdf");
foreach ($pages as $page) {
    $printer->graphics($page);
}
```

--------------------------------

### Using UnifontPrintBuffer to render text

Source: https://github.com/mike42/escpos-php/wiki/Text-encoding

This example demonstrates how to initialize a printer connection, set the UnifontPrintBuffer with a path to the unifont.hex file, and print text. It requires the autoloader and a printer connected via FilePrintConnector. The printer must support custom fonts and have a Font B close to 8x16 resolution.

```php
<?php

require __DIR__ . '/../vendor/autoload.php';

use Mike42\Escpos\PrintConnectors\FilePrintConnector;
use Mike42\Escpos\Printer;
use Mike42\Escpos\Experimental\Unifont\UnifontPrintBuffer;

$connector = new FilePrintConnector("/dev/usb/lp0");
$printer = new Printer($connector);

// Use Unifont to render text
$unifontBuffer = new UnifontPrintBuffer("/usr/share/unifont/unifont.hex");
$printer -> setPrintBuffer($unifontBuffer);

// Most simple example
$printer->text("Hello World\n");
$printer->cut();
$printer->close();
```

--------------------------------

### RawbtPrintConnector::__construct

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/RawbtPrintConnector.md

Constructor that initializes the connector by starting output buffering and initializing the internal buffer.

```APIDOC
## RawbtPrintConnector::__construct

### Description
Initializes the RawbtPrintConnector by calling ob_start() and initializing the internal buffer.

### Method
__construct

### Signature
public function __construct()

### Parameters
None

### Return Value
void

### Example
```php
$connector = new RawbtPrintConnector();
```
```

--------------------------------

### AuresCustomerDisplay::selfTest

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Starts a self-test/demo sequence on the display.

```APIDOC
## AuresCustomerDisplay::selfTest

### Description
Starts a self-test or demo sequence on the display.

### Method
`public function selfTest(): void`

### Parameters
None.

### Usage
```php
$display->selfTest();
```
```

--------------------------------

### Usage Example: Capturing ESC/POS Output

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/MemoryPrintConnector.md

Demonstrates how to use MemoryPrintConnector to capture raw ESC/POS bytes from a Printer and serve them as a download.

```APIDOC
## Usage Example: Capturing ESC/POS Output

### Description
Demonstrates how to use MemoryPrintConnector to capture raw ESC/POS bytes from a Printer and serve them as a download.

### Code
```php
use Mike42\Escpos\Printer;
use Mike42\Escpos\PrintConnectors\MemoryPrintConnector;

$connector = new MemoryPrintConnector();
$printer = new Printer($connector);
$printer->text("Hello world!\n");
$printer->cut();

$data = $connector->getData(); // raw ESC/POS bytes as a string

// Serve to a cloudPRNT-style endpoint:
header('Content-type: application/octet-stream');
header('Content-Length: ' . strlen($data));
echo $data;

$printer->close();
```
```

--------------------------------

### NetworkPrintConnector example

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Creates a Printer with a NetworkPrintConnector using an IP address and port 9100. The printer is closed in a finally block.

```php
use Mike42\Escpos\PrintConnectors\NetworkPrintConnector;
use Mike42\Escpos\Printer;
$connector = new NetworkPrintConnector("10.x.x.x", 9100);
$printer = new Printer($connector);
try {
    // ... Print stuff
} finally {
    $printer -> close();
}
```

--------------------------------

### Usage skeleton: NetworkPrintConnector and Printer

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/README.md

Basic example of using the library: create a NetworkPrintConnector, instantiate Printer, send text and cut, and close in a finally block.

```php
require __DIR__ . '/vendor/autoload.php';
use Mike42\Escpos\Printer;
use Mike42\Escpos\PrintConnectors\NetworkPrintConnector;

$connector = new NetworkPrintConnector("10.x.x.x", 9100);
$printer = new Printer($connector);
try {
    $printer->text("Hello World!\n");
    $printer->cut();
} finally {
    $printer->close(); // connector->finalize()
}
```

--------------------------------

### Using readImageFromImagick with a logo

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/ImagickEscposImage.md

Example of loading a PNG image with Imagick, creating an ImagickEscposImage, and printing it via the printer's graphics method.

```php
$im = new Imagick();
$im->readimage("logo.png");
$img = new ImagickEscposImage();
$img->readImageFromImagick($im);
$printer->graphics($img);
```

--------------------------------

### Basic usage example

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/RawbtPrintConnector.md

Shows how to use the RawbtPrintConnector with the Printer class: create connector, print text, cut, and close. The close() call triggers finalize() which emits the intent URL to stdout.

```php
use Mike42\Escpos\Printer;
use Mike42\Escpos\PrintConnectors\RawbtPrintConnector;

$connector = new RawbtPrintConnector();
$printer = new Printer($connector);
$printer->text("Hello Android!\n");
$printer->cut();

// Emits: intent:base64,<...>#Intent;scheme=rawbt;package=ru.a402d.rawbtprinter;end;
$printer->close();
```

--------------------------------

### Usage Example: Audit Pattern

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/MemoryPrintConnector.md

Shows how to reset the capture between runs using clear() and retrieve the bytes.

```APIDOC
## Usage Example: Audit Pattern

### Description
Shows how to reset the capture between runs using clear() and retrieve the bytes.

### Code
```php
// Audit pattern: reset the capture between runs
$connector->clear();
$printer->feed(2);
$bytes = $connector->getData();
```
```

--------------------------------

### Construct without filename and handle exceptions

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/NativeEscposImage.md

This creates a NativeEscposImage without a filename, which results in an empty zero-sized image. The example prints it and catches exceptions, which is the recommended approach for malformed files.

```php
// Construct without a filename: an empty zero-sized image, rendered as no data
try {
    $conn = new FilePrintConnector("php://stdout");
    $pr = new Printer($conn);
    $pr->graphics(new NativeEscposImage());
    $pr->close();
} catch (Exception $e) {
    echo $e->getMessage(); // e.g. from the gfx-php file loader for bad files
}
```

--------------------------------

### Create NativeEscposImage from a PNG file

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/NativeEscposImage.md

Constructs a NativeEscposImage with a file and optimizations disabled, then sends it to the printer using the graphics method. This example shows a typical usage with a specific image.

```php
$img = new NativeEscposImage("logo.png", false);
$printer->graphics($img);
```

--------------------------------

### Instantiate CupsPrintConnector with a CUPS printer name

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/CupsPrintConnector.md

Creates a CupsPrintConnector for a CUPS printer named 'epson-tm-t20' and passes it to a Printer instance. The printer must be installed on the local CUPS instance with a raw driver.

```php
$connector = new CupsPrintConnector("epson-tm-t20");
$printer = new Printer($connector);
```

--------------------------------

### Use ImagePrintBuffer to print text as an image

Source: https://github.com/mike42/escpos-php/wiki/Text-encoding

This example sets up a printer with the ImagePrintBuffer to render text as an image, which is useful for printing characters that may not be supported by the printer's default font. It loads the default capability profile, creates a FilePrintConnector to stdout, and prints a Latvian string. The buffer is set before printing, and the printer is cut and closed after.

```php
<?php
require __DIR__ . '/vendor/autoload.php';
use Mike42\Escpos\CapabilityProfile;
use Mike42\Escpos\Printer;
use Mike42\Escpos\PrintConnectors\FilePrintConnector;
use Mike42\Escpos\PrintBuffers\ImagePrintBuffer;


$profile = CapabilityProfile::load("default");
$buffer = new ImagePrintBuffer();
$connector = new FilePrintConnector("php://stdout");
$printer = new Printer($connector, $profile);
$printer -> setPrintBuffer($buffer);
$printer -> text("Glāžšķūņa rūķīši dzērumā čiepj Baha koncertflīģeļu vākus\n");
$printer -> cut();
$printer -> close();
```

--------------------------------

### Handle partial fan-out errors with try-catch-finally

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/MultiplePrintConnector.md

Error handling example: a failing connector raises an exception, but earlier connectors may have already received data (partial fan-out). Catch the exception to log/retry or fall back, then close in finally.

```php
try {
    // A failing connector raises here; earlier connectors in the list have
    // already received the data (partial fan-out is possible).
    $printer = new Printer(new MultiplePrintConnector($kitchen, $counter));
    $printer->text("Order #12\n");
} catch (Exception $e) {
    // log and retry the whole job, or fall back to a single connector
} finally {
    $printer->close();
}
```

--------------------------------

### Serving intent in web endpoint

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/RawbtPrintConnector.md

Example of using the connector in a web context. Comment notes that getData() returns bytes, not the intent; the intent is emitted by finalize(), so to capture it one must wrap stdout. The code shows a partially commented approach.

```php
// web.php
$printer->close();
// stdout now contains the rawbt intent URL; return it as text/plain
echo $connector->getData();               // bytes, not the intent
// — the intent is emitted by finalize(), capture it by wrapping stdout instead
```

--------------------------------

### Iterate over URIs with error handling

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/UriPrintConnector.md

Example of using UriPrintConnector::get() in a loop over multiple URIs, catching InvalidArgumentException for malformed URIs or unsupported schemes.

```php
use Mike42\Escpos\PrintConnectors\UriPrintConnector;

foreach (["file:///dev/usb/lp0", "tcp://10.0.0.5", "smb://host/share"] as $uri) {
    try {
        $printer = new Printer(UriPrintConnector::get($uri));
        $printer->text("test\n");
        $printer->close();
    } catch (InvalidArgumentException $e) {
        // malformed URI or unsupported scheme
    }
}
```

--------------------------------

### Fallback when Imagick missing

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintBuffers/ImagePrintBuffer.md

Example of handling the case when Imagick is missing. Catches the exception and falls back to EscposPrintBuffer.

```php
// Imagick missing?
try {
    $buffer = new ImagePrintBuffer();
} catch (Exception $e) {
    // "ImagePrintBuffer requires the imagick extension"
    $printer->setPrintBuffer(new EscposPrintBuffer());
}
```

--------------------------------

### FilePrintConnector constructor usage with php://stdout

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/FilePrintConnector.md

Creates a FilePrintConnector to write to php://stdout and passes it to a Printer instance. This is a basic example of using the connector with a wrapper stream.

```php
$connector = new FilePrintConnector("php://stdout");
$printer = new Printer($connector);
```

--------------------------------

### Custom connector implementation

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/PrintConnector.md

An example of a custom connector class that implements the interface. The read method returns false when two-way communication is unsupported, and write should contain the transport logic. After this, instantiate with: The Printer will use this connector.

```php
namespace MyApp;
use Mike42\Escpos\PrintConnectors\PrintConnector;

class MyConnector implements PrintConnector {
    public function __destruct() {}
    public function finalize(): void {}
    public function read(int $len): bool|string { return false; }
    public function write(string $data): void { /* transport here */ }
}
```

--------------------------------

### Constructor signature of EscposImage

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/NativeEscposImage.md

Constructor inherited from the EscposImage base class. Accepts a filename and an optimizations flag. This constructor is used in examples to create a NativeEscposImage instance.

```php
public function __construct($filename = null, $allowOptimisations = true)
```

--------------------------------

### Lower-resolution PDF pages printed double-size

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/ImagickEscposImage.md

Example showing how to load a PDF at lower resolution (260 pixels wide) and print pages at double size for faster printing (~75% faster).

```php
// Lower-resolution pages, printed double-size: ~75% faster
$pages = ImagickEscposImage::loadPdf("document.pdf", 260);
foreach ($pages as $page) {
    $printer->graphics($page, Printer::IMG_DOUBLE_HEIGHT | Printer::IMG_DOUBLE_WIDTH);
}
```

--------------------------------

### showFirmwareVersion() method

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Instructs the display to show the firmware version by writing \x02\x05\x56\x01\x03.

```php
public function showFirmwareVersion(): void
```

--------------------------------

### showLogo() method

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Shows a pre-loaded logo by writing \x02\xFC\x55\xAA\x55\xAA. The driver cannot upload a logo; vendor software is required.

```php
public function showLogo(): void
```

--------------------------------

### Hello World receipt (hello-world.php)

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Creates a simple receipt and prints it to stdout using a FilePrintConnector. Save as 'hello-world.php' and run from the command line.

```php
<?php
/* Call this file 'hello-world.php' */
require __DIR__ . '/vendor/autoload.php';
use Mike42\Escpos\PrintConnectors\FilePrintConnector;
use Mike42\Escpos\Printer;
$connector = new FilePrintConnector("php://stdout");
$printer = new Printer($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
$printer -> close();
```

--------------------------------

### WindowsPrintConnector invalid destination exception

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/WindowsPrintConnector.md

Example of catching a BadMethodCallException when an invalid printer name is provided.

```php
try {
    $connector = new WindowsPrintConnector("not a name?");
} catch (BadMethodCallException $e) {
    // "Printer 'not a name?' is not a valid printer name. ..."
}
```

--------------------------------

### initialize()

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Initializes the printer, resetting all formatting back to defaults.

```APIDOC
## initialize()

### Description
Initialize printer. This resets formatting back to the defaults.
```

--------------------------------

### __construct(PrintConnector $connector, ?CapabilityProfile $profile = null)

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Printer.md

Creates a new Printer instance with a connector and optional capability profile. Attaches a new EscposPrintBuffer and calls initialize().

```APIDOC
## __construct(PrintConnector $connector, ?CapabilityProfile $profile = null)

### Description
Creates a new Printer instance. Attaches a new EscposPrintBuffer and calls initialize().

### Method
Constructor

### Parameters
- **connector** (PrintConnector) - Required - Where output is sent
- **profile** (?CapabilityProfile) - Optional - Feature-support profile for the printer (default: CapabilityProfile::load('default'))

### Request Example
```php
$printer = new Printer($connector, $profile);
```

### Response
#### Success Response
Returns a new Printer instance.

#### Response Example
```php
// No return value (void)
```
```

--------------------------------

### Creating GdEscposImage with file and blank

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/GdEscposImage.md

Shows two constructor calls: one with a filename (deferred load) and one for a blank image.

```php
$img = new GdEscposImage("logo.png", false); // file read on first render
$img2 = new GdEscposImage();                 // blank image (0x0)
```

--------------------------------

### Print to CUPS printer via lp/lpr

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Creates a text file from hello-world.php and sends it to a CUPS printer using lpr with raw mode.

```bash
php hello-world.php > foo.txt
lpr -o raw -H localhost -P printer foo.txt
```

--------------------------------

### initialize(): void

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Printer.md

Resets formatting to printer defaults (ESC @) and sets the internal character table to 0. Returns void.

```APIDOC
## initialize(): void

### Description
Resets formatting to printer defaults (ESC @) and sets the internal character table to 0.

### Method
initialize

### Parameters
None

### Request Example
```php
$printer->initialize();
```

### Response
#### Success Response
Returns void.

#### Response Example
```php
// No return value
```
```

--------------------------------

### Print to USB printer on Linux

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Redirects the output of hello-world.php to the USB printer device file /dev/usb/lp0.

```bash
php hello-world.php > /dev/usb/lp0
```

--------------------------------

### Load profile and create Printer

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/CapabilityProfile.md

Loads a profile by ID and passes it to the Printer constructor. The profile ID must exist in capabilities.json; otherwise an InvalidArgumentException is thrown.

```php
$profile = CapabilityProfile::load("TM-T88V");
$printer = new Printer($connector, $profile);
```

--------------------------------

### Handling loadPdf exceptions

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/ImagickEscposImage.md

Example of catching exceptions from loadPdf when the PDF file is missing, showing the wrapped Imagick error or the custom message.

```php
try {
    $pages = ImagickEscposImage::loadPdf("missing.pdf");
} catch (Exception $e) {
    echo $e->getMessage(); // wrapped Imagick error, or "loadPdf requires imagick extension."
}
```

--------------------------------

### initialize() method

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Selects ESC/POS mode, calls parent::initialize() (ESC @), re-selects character table 0, and defaults to TEXT_VERTICAL_SCROLL scroll mode.

```php
public function initialize(): void
```

--------------------------------

### Usage with custom TTF font

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintBuffers/ImagePrintBuffer.md

Usage example with a custom TTF font for a branded look. Sets font to DejaVuSans.ttf and font size 24.

```php
// Custom TTF for a branded look
$buffer = new ImagePrintBuffer();
$buffer->setFont("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf");
$buffer->setFontSize(24);
$printer->setPrintBuffer($buffer);
$printer->text("Hello\n");
$printer->close();
```

--------------------------------

### Usage with Cyrillic and emoji

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintBuffers/ImagePrintBuffer.md

Usage example showing how to use ImagePrintBuffer to print text that the printer's code pages cannot express, such as Cyrillic and emoji.

```php
use Mike42\Escpos\PrintBuffers\ImagePrintBuffer;

$buffer = new ImagePrintBuffer();
$buffer->setFontSize(21);
$printer->setPrintBuffer($buffer);

// Text that the printer's code pages cannot express:
$printer->text("Cyrillic: Привет\n");
$printer->text("Emoji: 🎉\n");
```

--------------------------------

### Print to Ethernet printer with netcat

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Pipes the output of hello-world.php to a network printer using netcat on port 9100.

```bash
php hello-world.php | nc 10.x.x.x. 9100
```

--------------------------------

### Constructor signature

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Experimental/UnifontPrintBuffer.md

Defines the constructor that takes a path to a Unifont .hex file. Throws an exception if the file cannot be read.

```php
public function __construct(string $unifontFilename)
```

--------------------------------

### EscposImage::load(string $filename, bool $allowOptimisations = true, array $preferred = ['imagick', 'gd', 'native'])

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/EscposImage.md

Loads an image file and returns an EscposImage instance, automatically selecting the best available implementation based on the preferred order and loaded PHP extensions. Throws exceptions if the file is not readable or no suitable implementation is found.

```APIDOC
## EscposImage::load

### Description
Loads an image file and returns an EscposImage instance, automatically selecting the best available implementation based on the preferred order and loaded PHP extensions. Throws exceptions if the file is not readable or no suitable implementation is found.

### Method
Static method

### Signature
php
public static function load(
    string $filename,
    bool $allowOptimisations = true,
    array $preferred = ['imagick', 'gd', 'native']
)


### Parameters
- **filename** (string) - Required - File to load (must exist and be readable)
- **allowOptimisations** (bool) - Optional - Allow fastest library-specific rendering shortcuts. Default: `true`
- **preferred** (array) - Optional - Order in which to try implementations; items may be `'imagick'`, `'gd'`, `'native'`. Default: `['imagick', 'gd', 'native']`

### Implementation Selection
- `'imagick'` → `ImagickEscposImage` (if extension loaded)
- `'gd'` → `GdEscposImage` (if extension loaded)
- `'native'` → `NativeEscposImage` for extensions `bmp`, `gif`, `pbm`, `png`, `ppm`, `pgm`, `wbmp`

### Exceptions
- `Exception("File '$filename' does not exist, or is not readable.")` - thrown early if file is not readable
- `InvalidArgumentException("'$implementation' is not a known EscposImage implementation")` - thrown for unknown entries in `preferred`
- `InvalidArgumentException("No suitable EscposImage implementation found for '$filename'.")` - thrown when no implementation matches

### Example
php
$img = EscposImage::load("resources/escpos-php.png", false); // force pixel-by-pixel path

```

--------------------------------

### Build developer docs with doxygen

Source: https://github.com/mike42/escpos-php/blob/development/CONTRIBUTING.md

Rebuilds the developer docs to check for documentation warnings.

```bash
make -C doc clean && make -C doc
```

--------------------------------

### Constructor

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/WindowsPrintConnector.md

Creates a new WindowsPrintConnector instance with the given destination. The destination can be a local port, an SMB URI, or a local printer name.

```APIDOC
## Constructor

### Description
Creates a new WindowsPrintConnector instance. The destination must be a local port (LPT\d/COM\d), an SMB URI (smb://...), or a local printer name.

### Method
Constructor

### Signature
```php
public function __construct($dest)
```

### Parameters
- **dest** (string) - Required - One of: local port (`LPT\d`/`COM\d`), `smb://…` URI, or plain printer name

### Parsing Rules
1. Matches `REGEX_LOCAL`: local port. Allowed only when `getCurrentPlatform() === PLATFORM_WIN`; otherwise throws `BadMethodCallException("WindowsPrintConnector can only be used to print to a local printer ('$dest') on a Windows computer.")`.
2. Matches `REGEX_SMB`: `smb://[user[:pass]@]host[/workgroup]/printer`. Host is from `parse_url`; a slashed path yields `workgroup` + `printer`; optional `user`/`pass` are stored for authentication.
3. Matches `REGEX_PRINTERNAME`: local printer name; hostname set to `gethostname()` (or `"localhost"`).
4. Otherwise throws `BadMethodCallException("Printer '$dest' is not a valid printer name. Use local port (LPT1, COM1, etc) or smb://computer/printer notation.")`.

### Example
```php
$connector = new WindowsPrintConnector("smb://user:pass@print-server/printer");
$connector = new WindowsPrintConnector("smb://print-server/workgroup/printer"); // workgroup + share
$connector = new WindowsPrintConnector("LPT1");   // Windows only
$printer = new Printer($connector);
```

### Error Handling
```php
try {
    $connector = new WindowsPrintConnector("not a name?");
} catch (BadMethodCallException $e) {
    // "Printer 'not a name?' is not a valid printer name. ..."
}
```
```

--------------------------------

### Load image with preferred format list

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/NativeEscposImage.md

Uses the auto-selecting factory to load an image with 'native' as the first preferred format, then prints it via bitImage. This allows explicit preference for the native implementation.

```php
$img = EscposImage::load("logo.png", true, ['native', 'imagick', 'gd']);
$printer->bitImage($img);
```

--------------------------------

### FilePrintConnector constructor with error handling

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/FilePrintConnector.md

Attempts to open a device file /dev/usb/lp0 and catches the exception thrown when fopen fails. The comment notes the error message and suggests a permissions problem.

```php
try {
    $connector = new FilePrintConnector("/dev/usb/lp0");
} catch (Exception $e) {
    // "Cannot initialise FilePrintConnector."
    // (usually a permissions problem; see doc/FAQ.md)
}
```

--------------------------------

### Constructor signature

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Inherited from Printer. Accepts a PrintConnector and an optional CapabilityProfile.

```php
public function __construct(PrintConnector $connector, ?CapabilityProfile $profile = null)
```

--------------------------------

### Create MultiplePrintConnector with network and file connectors

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/MultiplePrintConnector.md

Creates a MultiplePrintConnector with two connectors (network and file) and passes it to a Printer. Broadcasts output to both.

```php
$connector = new MultiplePrintConnector(
    new NetworkPrintConnector("10.0.0.10", 9100),
    new FilePrintConnector("php://stdout")
);
$printer = new Printer($connector);
```

--------------------------------

### readImageFromGdResource($im)

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/GdEscposImage.md

Loads actual image pixels from an in-memory GD resource. Averages RGB channels, blends alpha, negates to a 1/0 string (1 = black), then sets image dimensions and data. Throws exceptions for invalid resource or missing GD extension.

```APIDOC
## readImageFromGdResource($im)

### Description
Loads actual image pixels from an in-memory GD resource. Averages RGB channels, blends alpha, negates to a 1/0 string (1 = black), then calls setImgWidth/setImgHeight/setImgData.

### Method
public function readImageFromGdResource($im)

### Parameters
- **im** (resource / \GdImage) - Required - GD image resource to read pixels from

### Exceptions
- Exception("Failed to load image.") when $im is neither a resource nor a \GdImage
- Exception(__FUNCTION__ . " requires 'gd' extension.") when gd is not loaded

### Example
```php
$im = imagecreatefrompng("logo.png");
$escposImage = new GdEscposImage();
$escposImage->readImageFromGdResource($im);
$printer->graphics($escposImage);
```
```

--------------------------------

### AuresCustomerDisplay::showFirmwareVersion

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Displays the firmware version on the customer display.

```APIDOC
## AuresCustomerDisplay::showFirmwareVersion

### Description
Instructs the display to show its firmware version.

### Method
`public function showFirmwareVersion(): void`

### Parameters
None.

### Usage
```php
$display->showFirmwareVersion();
```
```

--------------------------------

### Constructor: __construct(string $unifontFilename)

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Experimental/UnifontPrintBuffer.md

Creates a new UnifontPrintBuffer instance, reading the specified Unifont .hex file. Throws an exception if the file cannot be read.

```APIDOC
## Constructor: __construct(string $unifontFilename)

### Description
Creates a new UnifontPrintBuffer instance, reading the specified Unifont .hex file. Throws an exception if the file cannot be read.

### Method
Constructor

### Parameters
- **unifontFilename** (string) - Required - Path to a Unifont `.hex` file (e.g. `/usr/share/unifont/unifont.hex`)

### Exceptions
- `\Exception("Could not read $unifontFilename")` when the read fails.

### Usage Example
```php
$unifontBuffer = new UnifontPrintBuffer("/usr/share/unifont/unifont.hex");
```
```

--------------------------------

### pulse() method signature

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Printer.md

Sends pulse to drawer kick-out connector. Defaults open an Epson drawer. Throws InvalidArgumentException outside ranges.

```php
public function pulse(int $pin = 0, int $on_ms = 120, int $off_ms = 240): void
```

--------------------------------

### Load Unifont glyphs and map a character with FontMap

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Experimental/UnifontInternal.md

Use this snippet to initialize a UnifontGlyphFactory from a Unifont hex file, create a FontMap bound to the printer, and add/write a character (e.g., SNOWMAN) if the mapping succeeds. Requires the unifont.hex file path and an initialized printer instance.

```php
use Mike42\Escpos\Experimental\Unifont\UnifontGlyphFactory;
use Mike42\Escpos\Experimental\Unifont\FontMap;

$lines = explode("\n", file_get_contents("/usr/share/unifont/unifont.hex"));
$factory = new UnifontGlyphFactory($lines);
$map = new FontMap($factory, $printer);
if ($map->addChar(0x2603, true)) {   // SNOWMAN
    $map->writeChar(0x2603);
}
```

--------------------------------

### flush, writeTextRaw, and getPrinter method signatures

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Experimental/UnifontPrintBuffer.md

flush() and writeTextRaw() are no-ops; getPrinter() returns the attached printer or null.

```php
public function flush(): void
public function writeTextRaw(string $text): void
public function getPrinter(): ?Printer
```

--------------------------------

### FilePrintConnector::__construct

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/FilePrintConnector.md

Creates a new FilePrintConnector instance by opening the specified file for binary writing. Throws an exception if the file cannot be opened.

```APIDOC
## FilePrintConnector::__construct

### Description
Creates a new FilePrintConnector instance by opening the specified file for binary writing. Throws an exception if the file cannot be opened.

### Method
Constructor

### Signature
```php
public function __construct(string $filename)
```

### Parameters
- **filename** (string) - Required - Path to open for binary writing — e.g. `"php://stdout"`, `"/dev/usb/lp0"`, `"/dev/ttyS0"`, `"/dev/lp0"`, `"LPT1"` (on Windows access)

### Exceptions
- **Exception** - Throws `Exception("Cannot initialise FilePrintConnector.")` when `fopen` returns `false`.

### Example
```php
$connector = new FilePrintConnector("php://stdout");
$printer = new Printer($connector);
```

```php
try {
    $connector = new FilePrintConnector("/dev/usb/lp0");
} catch (Exception $e) {
    // "Cannot initialise FilePrintConnector."
    // (usually a permissions problem; see doc/FAQ.md)
}
```
```

--------------------------------

### ImagePrintBuffer::__construct

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintBuffers/ImagePrintBuffer.md

Constructor for ImagePrintBuffer. Throws an exception if the Imagick extension is not loaded.

```APIDOC
## ImagePrintBuffer::__construct

### Description
Initializes a new ImagePrintBuffer instance. Throws an exception if the Imagick extension is not loaded.

### Method
__construct

### Signature
public function __construct()

### Parameters
None

### Exceptions
- **Exception** - Thrown when `EscposImage::isImagickLoaded()` is false. Message: "ImagePrintBuffer requires the imagick extension"

### Notes
Initializes `font = null` and `fontSize = 24`.
```

--------------------------------

### selectPrintMode($mode)

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Selects print mode(s) with options for font and formatting. Similar to running initialize().

```APIDOC
## selectPrintMode($mode)

### Description
Select print mode(s).

### Parameters
- **int $mode** - Required - The mode to use. Default is `Printer::MODE_FONT_A`, with no special formatting. This has a similar effect to running `initialize()`. Several MODE_* constants can be OR'd together passed to this function's `$mode` argument. The valid modes are: `MODE_FONT_A`, `MODE_FONT_B`, `MODE_EMPHASIZED`, `MODE_DOUBLE_HEIGHT`, `MODE_DOUBLE_WIDTH`, `MODE_UNDERLINE`.

```

--------------------------------

### Constructor for EscposPrintBuffer

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintBuffers/EscposPrintBuffer.md

Public constructor with no parameters. Creates a detached buffer with $printer set to null.

```php
public function __construct()
```

--------------------------------

### Usage: default buffer

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintBuffers/EscposPrintBuffer.md

Shows how to use the default buffer with a new Printer. The text method automatically selects code pages per codepoint.

```php
// Default buffer — no action needed:
$printer = new Printer($connector);
$printer->text("Café €5\n"); // auto-selects code pages per codepoint
```

--------------------------------

### AuresCustomerDisplay::initialize

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Initializes the display, selecting ESC/POS mode and setting default scroll mode.

```APIDOC
## AuresCustomerDisplay::initialize

### Description
Initializes the display by selecting ESC/POS mode, calling the parent initialize method, re-selecting character table 0, and setting the default scroll mode to vertical scroll.

### Method
`public function initialize(): void`

### Parameters
None.

### Usage
```php
$display->initialize();
```
```

--------------------------------

### MemoryPrintConnector::__construct()

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/MemoryPrintConnector.md

Initializes a new MemoryPrintConnector with an empty buffer.

```APIDOC
## `MemoryPrintConnector::__construct()`

### Description
Initializes a new MemoryPrintConnector instance with an empty buffer.

### Method
`public function __construct()`

### Parameters
None.

### Response
No return value.
```

--------------------------------

### getId, getName, getVendor method signatures

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/CapabilityProfile.md

Declares the public getter methods for profile ID, name, and vendor.

```php
public function getId() : string
public function getName() : string
public function getVendor() : string
```

--------------------------------

### NetworkPrintConnector constructor and printing workflow

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/FilePrintConnector.md

Creates NetworkPrintConnector instances with default and custom ports/timeouts, then prints text and cuts the paper, ensuring the printer is closed in a finally block.

```php
$connector = new NetworkPrintConnector("192.168.1.100");          // port 9100
$connector = new NetworkPrintConnector("10.0.0.5", 9100, 5);     // 5 s timeout
$printer = new Printer($connector);
try {
    $printer->text("Hello\n");
    $printer->cut();
} finally {
    $printer->close();
}
```

--------------------------------

### flush, getPrinter, setPrinter methods

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintBuffers/ImagePrintBuffer.md

flush() throws LogicException("Not attached to a printer.") when detached, otherwise no-op. setPrinter()/getPrinter() manage attachment (one-to-one with a Printer).

```php
public function flush(): void
public function getPrinter(): ?Printer
public function setPrinter(?Printer $printer = null): void
```

--------------------------------

### FontMap constructor

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Experimental/UnifontInternal.md

Initializes a FontMap with a glyph factory and a printer to upload fonts to the font memory.

```php
public function __construct(ColumnFormatGlyphFactory $glyphFactory, Printer $printer)
```

--------------------------------

### bitImage(EscposImage $image, $size)

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Prints an image using the bit image command. This is an alias for graphics() and takes the same parameters.

```APIDOC
## bitImage(EscposImage $image, $size)

### Description
See graphics() below.
```

--------------------------------

### text($str)

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Adds text to the buffer. Should be followed by a line-break or feed() call.

```APIDOC
## text($str)

### Description
Add text to the buffer. Text should either be followed by a line-break, or `feed()` should be called after this.

### Parameters
- **string $str** - Required - The string to print.

```

--------------------------------

### AuresCustomerDisplay::showLogo

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Shows a pre-loaded logo on the display.

```APIDOC
## AuresCustomerDisplay::showLogo

### Description
Shows a pre-loaded logo on the display. The driver cannot upload a logo; vendor software is required for that.

### Method
`public function showLogo(): void`

### Parameters
None.

### Usage
```php
$display->showLogo();
```
```

--------------------------------

### Constructor: __construct

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/MultiplePrintConnector.md

Creates a new MultiplePrintConnector instance that broadcasts to the given connectors.

```APIDOC
## Constructor: __construct

### Description
Initializes a MultiplePrintConnector with one or more PrintConnector instances to broadcast to.

### Method
Constructor

### Signature
```php
public function __construct(PrintConnector ...$connectors)
```

### Parameters
- **connectors** (PrintConnector ...) - Required - One or more connector instances to broadcast to.

### Example
```php
$connector = new MultiplePrintConnector(
    new NetworkPrintConnector("10.0.0.10", 9100),
    new FilePrintConnector("php://stdout")
);
$printer = new Printer($connector);
```
```

--------------------------------

### selectEscposMode() protected method

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Devices/AuresCustomerDisplay.md

Writes \x02\x05\x43\x31\x03 to select ESC/POS mode. Other modes exist but are not used.

```php
protected function selectEscposMode(): void
```

--------------------------------

### __construct(PrintConnector $connector, CapabilityProfile $profile)

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Constructs a new print object with a specified connector and capability profile. The connector determines how data is sent to the printer, and the profile defines supported features.

```APIDOC
## __construct(PrintConnector $connector, CapabilityProfile $profile)

### Description
Construct new print object.

### Parameters
- **$connector** (PrintConnector) - Required - The PrintConnector to send data to.
- **$profile** (CapabilityProfile) - Optional - Supported features of this printer. If not set, the "default" CapabilityProfile will be used, which is suitable for Epson printers.

### Notes
See example/interface/ for ways to open connections for different platforms and interfaces.
```

--------------------------------

### Run unit tests with phpunit

Source: https://github.com/mike42/escpos-php/blob/development/CONTRIBUTING.md

Executes unit tests via phpunit with code coverage text output.

```bash
php vendor/bin/phpunit --coverage-text
```

--------------------------------

### Using readImageFromGdResource with a GD resource

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/GdEscposImage.md

Creates a GD image from a PNG file, reads it into a GdEscposImage, and sends it to the printer.

```php
$im = imagecreatefrompng("logo.png");
$escposImage = new GdEscposImage();
$escposImage->readImageFromGdResource($im);
$printer->graphics($escposImage);
```

--------------------------------

### Capture raw ESC/POS output with MemoryPrintConnector

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/PrintConnectors/MemoryPrintConnector.md

Creates a MemoryPrintConnector, prints text and a cut command, retrieves the raw bytes, and serves them as an octet-stream. Retrieve data before closing the connector, as finalize() sets the buffer to null.

```php
use Mike42\Escpos\Printer;
use Mike42\Escpos\PrintConnectors\MemoryPrintConnector;

$connector = new MemoryPrintConnector();
$printer = new Printer($connector);
$printer->text("Hello world!\n");
$printer->cut();

$data = $connector->getData(); // raw ESC/POS bytes as a string

// Serve to a cloudPRNT-style endpoint:
header('Content-type: application/octet-stream');
header('Content-Length: ' . strlen($data));
echo $data;

$printer->close();
```

--------------------------------

### FontMap::__construct(ColumnFormatGlyphFactory $glyphFactory, Printer $printer)

Source: https://github.com/mike42/escpos-php/blob/development/_autodocs/api-reference/Experimental/UnifontInternal.md

Constructs a FontMap instance with a glyph factory and a printer for uploading fonts.

```APIDOC
## FontMap::__construct(ColumnFormatGlyphFactory $glyphFactory, Printer $printer)

### Description
Constructs a FontMap instance with a glyph factory and a printer for uploading fonts.

### Method
__construct

### Signature
public function __construct(ColumnFormatGlyphFactory $glyphFactory, Printer $printer)

### Parameters
- **glyphFactory** (ColumnFormatGlyphFactory) - Required - Glyph source
- **printer** (Printer) - Required - Printer to upload fonts to
```

--------------------------------

### Run unit tests with code coverage

Source: https://github.com/mike42/escpos-php/blob/development/README.md

Runs the unit tests with code coverage enabled via Xdebug.

```bash
XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
```
Tokens:
Raw