Copyright (c) 2014-2015 Michael Billington ,
incorporating modifications by:
- Roni Saha
- Gergely Radics
- Warren Doyle
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Print buffers manage newlines and character encoding for the target printer.
They are used as a swappable component: text or image-based output.
- Text output (EscposPrintBuffer) is the fast default, and is recommended for
most people, as the text output can be more directly manipulated by ESC/POS
commands.
- Image output (ImagePrintBuffer) is designed to accept more encodings than the
physical printer supports, by rendering the text to small images on-the-fly.
This takes a lot more CPU than sending text, but is necessary for some users.
- If your use case fits outside these, then a further speed/flexibility trade-off
can be made by printing directly from generated HTML or PDF.
/**
* Attach a different print buffer to the printer. Buffers are responsible for handling text output to the printer.
*
* @param PrintBuffer $buffer The buffer to use.
* @throws InvalidArgumentException Where the buffer is already attached to a different printer.
*/
function setPrintBuffer(PrintBuffer $buffer)
{
if ($buffer === $this->buffer) {
return;
}
if ($buffer->getPrinter() != null) {
throw new InvalidArgumentException("This buffer is already attached to a printer.");
}
if ($this->buffer !== null) {
$this->buffer->setPrinter(null);
}
$this->buffer = $buffer;
$this->buffer->setPrinter($this);
}
/**
* Add text to the buffer without attempting to interpret chararacter codes.
*
* Text should either be followed by a line-break, or feed() should be called
* after this to clear the print buffer.
*
* @param string $str Text to print
*/
public function textRaw($str = "")
{
self::validateString($str, __FUNCTION__);
$this->buffer->writeTextRaw((string) $str);
}