wn_
64a36970d6
* Maintains PHP `7.4` compatibility and adds PHP `8.4` compatibility * The `4.4.x` branch does the same, but I didn't see any reason not to go to `5.0.x`. * https://github.com/chillerlan/php-qrcode/releases
64 lines
1.7 KiB
PHP
64 lines
1.7 KiB
PHP
<?php
|
|
/**
|
|
* Interface QRDataModeInterface
|
|
*
|
|
* @created 01.12.2015
|
|
* @author Smiley <smiley@chillerlan.net>
|
|
* @copyright 2015 Smiley
|
|
* @license MIT
|
|
*/
|
|
|
|
namespace chillerlan\QRCode\Data;
|
|
|
|
use chillerlan\QRCode\Common\BitBuffer;
|
|
|
|
/**
|
|
* Specifies the methods reqired for the data modules (Number, Alphanum, Byte and Kanji)
|
|
*/
|
|
interface QRDataModeInterface{
|
|
|
|
/**
|
|
* the current data mode: Number, Alphanum, Kanji, Hanzi, Byte, ECI
|
|
*
|
|
* tbh I hate this constant here, but it's part of the interface, so I can't just declare it in the abstract class.
|
|
* (phan will complain about a PhanAccessOverridesFinalConstant)
|
|
*
|
|
* @see https://wiki.php.net/rfc/final_class_const
|
|
*
|
|
* @var int
|
|
* @see \chillerlan\QRCode\Common\Mode
|
|
* @internal do not call this constant from the interface, but rather from one of the child classes
|
|
*/
|
|
public const DATAMODE = -1;
|
|
|
|
/**
|
|
* retruns the length in bits of the data string
|
|
*/
|
|
public function getLengthInBits():int;
|
|
|
|
/**
|
|
* encoding conversion helper
|
|
*
|
|
* @throws \chillerlan\QRCode\Data\QRCodeDataException
|
|
*/
|
|
public static function convertEncoding(string $string):string;
|
|
|
|
/**
|
|
* checks if the given string qualifies for the encoder module
|
|
*/
|
|
public static function validateString(string $string):bool;
|
|
|
|
/**
|
|
* writes the actual data string to the BitBuffer, uses the given version to determine the length bits
|
|
*
|
|
* @see \chillerlan\QRCode\Data\QRData::writeBitBuffer()
|
|
*/
|
|
public function write(BitBuffer $bitBuffer, int $versionNumber):QRDataModeInterface;
|
|
|
|
/**
|
|
* reads a segment from the BitBuffer and decodes in the current data mode
|
|
*/
|
|
public static function decodeSegment(BitBuffer $bitBuffer, int $versionNumber):string;
|
|
|
|
}
|