php-qrcode/src/Output/qrcode.schema.json at v6.0.x · chillerlan/php-qrcode · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"title": "chillerlan php-qrcode schema",
	"type": "object",
	"required": [
		"qrcode"
	],
	"properties": {
		"qrcode": {
			"$ref": "#/$defs/qrcode"
		}
	},
	"$defs": {
		"qrcode": {
			"description": "QR Code root element",
			"type": "object",
			"required": [
				"eccLevel",
				"matrix",
				"version"
			],
			"properties": {
				"version": {
					"description": "The QR Code version: [1...40]",
					"type": "integer",
					"minimum": 1,
					"maximum": 40
				},
				"eccLevel": {
					"description": "The ECC level: [L, M, Q, H]",
					"enum": [
						"L",
						"M",
						"Q",
						"H"
					]
				},
				"matrix": {
					"$ref": "#/$defs/matrix"
				}
			}
		},
		"matrix": {
			"description": "The matrix holds the encoded data in a 2-dimensional array of modules.",
			"type": "object",
			"required": [
				"size",
				"quietzoneSize",
				"maskPattern",
				"width",
				"height"
			],
			"properties": {
				"size": {
					"description": "The side length of the QR symbol, excluding the quiet zone (version * 4 + 17). [21...177]",
					"type": "integer",
					"minimum": 21,
					"maximum": 177
				},
				"quietzoneSize": {
					"description": "The size of the quiet zone (margin around the QR symbol).",
					"type": "integer",
					"minimum": 0
				},
				"maskPattern": {
					"description": "The detected mask pattern that was used to mask this matrix. [0...7].",
					"type": "integer",
					"minimum": 0,
					"maximum": 7
				},
				"width": {
					"description": "The total width of the matrix, including the quiet zone.",
					"type": "integer",
					"minimum": 21
				},
				"height": {
					"description": "The total height of the matrix, including the quiet zone.",
					"type": "integer",
					"minimum": 21
				},
				"rows": {
					"type": "array",
					"items": {
						"$ref": "#/$defs/row"
					},
					"minItems": 0
				}
			}
		},
		"row": {
			"description": "A row holds an array of modules",
			"type": "object",
			"required": [
				"y",
				"modules"
			],
			"properties": {
				"y": {
					"description": "The 'y' (vertical) coordinate of this row.",
					"type": "integer",
					"minimum": 0
				},
				"modules": {
					"type": "array",
					"items": {
						"$ref": "#/$defs/module"
					},
					"minItems": 0
				}
			}
		},
		"module": {
			"description": "Represents a single module (pixel) of a QR symbol.",
			"type": "object",
			"required": [
				"dark",
				"layer",
				"value",
				"x"
			],
			"properties": {
				"dark": {
					"description": "Indicates whether this module is dark.",
					"type": "boolean"
				},
				"layer": {
					"description": "The layer (functional pattern) this module belongs to.",
					"type": "string"
				},
				"value": {
					"description": "The value for this module.",
					"type": "string"
				},
				"x": {
					"description": "The 'x' (horizontal) coordinate of this module.",
					"type": "integer",
					"minimum": 0
				}
			}
		}
	}
}