woocommerce-pos / vendor_prefixed / chillerlan / php-qrcode / src / Output / QROutputInterface.php

QROutputInterface.php in WCPOS – Point of Sale (POS) plugin for WooCommerce 1.9.15, at vendor_prefixed/chillerlan/php-qrcode/src/Output/QROutputInterface.php

194 lines 6.5 KB

Raw Download Zip

1	<?php
2
3	/**
4	* Interface QROutputInterface,
5	*
6	* @created 02.12.2015
7	* @author Smiley <smiley@chillerlan.net>
8	* @copyright 2015 Smiley
9	* @license MIT
10	*/
11	namespace WCPOS\Vendor\chillerlan\QRCode\Output;
12
13	use WCPOS\Vendor\chillerlan\QRCode\Data\QRMatrix;
14	/**
15	* Converts the data matrix into readable output
16	*/
17	interface QROutputInterface
18	{
19	/**
20	* @var string
21	* @deprecated 5.0.0 <no replacement>
22	* @see https://github.com/chillerlan/php-qrcode/issues/223
23	*/
24	public const MARKUP_HTML = 'html';
25	/**
26	* @var string
27	* @deprecated 5.0.0 <no replacement>
28	* @see https://github.com/chillerlan/php-qrcode/issues/223
29	*/
30	public const MARKUP_SVG = 'svg';
31	/**
32	* @var string
33	* @deprecated 5.0.0 <no replacement>
34	* @see https://github.com/chillerlan/php-qrcode/issues/223
35	*/
36	public const GDIMAGE_BMP = 'bmp';
37	/**
38	* @var string
39	* @deprecated 5.0.0 <no replacement>
40	* @see https://github.com/chillerlan/php-qrcode/issues/223
41	*/
42	public const GDIMAGE_GIF = 'gif';
43	/**
44	* @var string
45	* @deprecated 5.0.0 <no replacement>
46	* @see https://github.com/chillerlan/php-qrcode/issues/223
47	*/
48	public const GDIMAGE_JPG = 'jpg';
49	/**
50	* @var string
51	* @deprecated 5.0.0 <no replacement>
52	* @see https://github.com/chillerlan/php-qrcode/issues/223
53	*/
54	public const GDIMAGE_PNG = 'png';
55	/**
56	* @var string
57	* @deprecated 5.0.0 <no replacement>
58	* @see https://github.com/chillerlan/php-qrcode/issues/223
59	*/
60	public const GDIMAGE_WEBP = 'webp';
61	/**
62	* @var string
63	* @deprecated 5.0.0 <no replacement>
64	* @see https://github.com/chillerlan/php-qrcode/issues/223
65	*/
66	public const STRING_JSON = 'json';
67	/**
68	* @var string
69	* @deprecated 5.0.0 <no replacement>
70	* @see https://github.com/chillerlan/php-qrcode/issues/223
71	*/
72	public const STRING_TEXT = 'text';
73	/**
74	* @var string
75	* @deprecated 5.0.0 <no replacement>
76	* @see https://github.com/chillerlan/php-qrcode/issues/223
77	*/
78	public const IMAGICK = 'imagick';
79	/**
80	* @var string
81	* @deprecated 5.0.0 <no replacement>
82	* @see https://github.com/chillerlan/php-qrcode/issues/223
83	*/
84	public const FPDF = 'fpdf';
85	/**
86	* @var string
87	* @deprecated 5.0.0 <no replacement>
88	* @see https://github.com/chillerlan/php-qrcode/issues/223
89	*/
90	public const EPS = 'eps';
91	/**
92	* @var string
93	* @deprecated 5.0.0 <no replacement>
94	* @see https://github.com/chillerlan/php-qrcode/issues/223
95	*/
96	public const CUSTOM = 'custom';
97	/**
98	* Map of built-in output modes => class FQN
99	*
100	* @var string[]
101	* @deprecated 5.0.0 <no replacement>
102	* @see https://github.com/chillerlan/php-qrcode/issues/223
103	*/
104	public const MODES = [self::MARKUP_SVG => QRMarkupSVG::class, self::MARKUP_HTML => QRMarkupHTML::class, self::GDIMAGE_BMP => QRGdImageBMP::class, self::GDIMAGE_GIF => QRGdImageGIF::class, self::GDIMAGE_JPG => QRGdImageJPEG::class, self::GDIMAGE_PNG => QRGdImagePNG::class, self::GDIMAGE_WEBP => QRGdImageWEBP::class, self::STRING_JSON => QRStringJSON::class, self::STRING_TEXT => QRStringText::class, self::IMAGICK => QRImagick::class, self::FPDF => QRFpdf::class, self::EPS => QREps::class];
105	/**
106	* Map of module type => default value
107	*
108	* @var bool[]
109	*/
110	public const DEFAULT_MODULE_VALUES = [
111	// light
112	QRMatrix::M_NULL => \false,
113	QRMatrix::M_DARKMODULE_LIGHT => \false,
114	QRMatrix::M_DATA => \false,
115	QRMatrix::M_FINDER => \false,
116	QRMatrix::M_SEPARATOR => \false,
117	QRMatrix::M_ALIGNMENT => \false,
118	QRMatrix::M_TIMING => \false,
119	QRMatrix::M_FORMAT => \false,
120	QRMatrix::M_VERSION => \false,
121	QRMatrix::M_QUIETZONE => \false,
122	QRMatrix::M_LOGO => \false,
123	QRMatrix::M_FINDER_DOT_LIGHT => \false,
124	// dark
125	QRMatrix::M_DARKMODULE => \true,
126	QRMatrix::M_DATA_DARK => \true,
127	QRMatrix::M_FINDER_DARK => \true,
128	QRMatrix::M_SEPARATOR_DARK => \true,
129	QRMatrix::M_ALIGNMENT_DARK => \true,
130	QRMatrix::M_TIMING_DARK => \true,
131	QRMatrix::M_FORMAT_DARK => \true,
132	QRMatrix::M_VERSION_DARK => \true,
133	QRMatrix::M_QUIETZONE_DARK => \true,
134	QRMatrix::M_LOGO_DARK => \true,
135	QRMatrix::M_FINDER_DOT => \true,
136	];
137	/**
138	* Map of module type => readable name (for CSS etc.)
139	*
140	* @var string[]
141	*/
142	public const LAYERNAMES = [
143	// light
144	QRMatrix::M_NULL => 'null',
145	QRMatrix::M_DARKMODULE_LIGHT => 'darkmodule-light',
146	QRMatrix::M_DATA => 'data',
147	QRMatrix::M_FINDER => 'finder',
148	QRMatrix::M_SEPARATOR => 'separator',
149	QRMatrix::M_ALIGNMENT => 'alignment',
150	QRMatrix::M_TIMING => 'timing',
151	QRMatrix::M_FORMAT => 'format',
152	QRMatrix::M_VERSION => 'version',
153	QRMatrix::M_QUIETZONE => 'quietzone',
154	QRMatrix::M_LOGO => 'logo',
155	QRMatrix::M_FINDER_DOT_LIGHT => 'finder-dot-light',
156	// dark
157	QRMatrix::M_DARKMODULE => 'darkmodule',
158	QRMatrix::M_DATA_DARK => 'data-dark',
159	QRMatrix::M_FINDER_DARK => 'finder-dark',
160	QRMatrix::M_SEPARATOR_DARK => 'separator-dark',
161	QRMatrix::M_ALIGNMENT_DARK => 'alignment-dark',
162	QRMatrix::M_TIMING_DARK => 'timing-dark',
163	QRMatrix::M_FORMAT_DARK => 'format-dark',
164	QRMatrix::M_VERSION_DARK => 'version-dark',
165	QRMatrix::M_QUIETZONE_DARK => 'quietzone-dark',
166	QRMatrix::M_LOGO_DARK => 'logo-dark',
167	QRMatrix::M_FINDER_DOT => 'finder-dot',
168	];
169	/**
170	* @var string
171	* @see \chillerlan\QRCode\Output\QROutputAbstract::toBase64DataURI()
172	* @internal do not call this constant from the interface, but rather from one of the child classes
173	*/
174	public const MIME_TYPE = '';
175	/**
176	* Determines whether the given value is valid
177	*
178	* @param mixed $value
179	*/
180	public static function moduleValueIsValid($value) : bool;
181	/**
182	* Generates the output, optionally dumps it to a file, and returns it
183	*
184	* please note that the value of QROptions::$cachefile is already evaluated at this point.
185	* if the output module is invoked manually, it has no effect at all.
186	* you need to supply the $file parameter here in that case (or handle the option value in your custom output module).
187	*
188	* @see \chillerlan\QRCode\QRCode::renderMatrix()
189	*
190	* @return mixed
191	*/
192	public function dump(?string $file = null);
193	}
194