added composer files and installed vendor packages. Also modified xsls to display base project
This commit is contained in:
+20
@@ -0,0 +1,20 @@
|
||||
# Ref: https://EditorConfig.org
|
||||
|
||||
# top-most EditorConfig file
|
||||
root = true
|
||||
|
||||
# Unix-style end of lines and a blank line at the end of the file
|
||||
[*]
|
||||
indent_style = tab
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
||||
[*.php]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.{js,json,scss,css,yml,vue}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. ...
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Logs**
|
||||
If applicable, copy the relevant logs to help explain your problem.
|
||||
|
||||
**Environment:**
|
||||
- OS:
|
||||
- PHP version:
|
||||
- Version:
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
@@ -0,0 +1,25 @@
|
||||
# Description
|
||||
|
||||
Please include a summary of the change and include relevant motivation and context.
|
||||
|
||||
...
|
||||
|
||||
|
||||
## Checklist:
|
||||
|
||||
- [ ] The `make buildall` command has been run successfully without any error or warning.
|
||||
- [ ] Any new code line is covered by unit tests and the coverage has not dropped.
|
||||
- [ ] Any new code follows the style guidelines of this project.
|
||||
- [ ] The code changes have been self-reviewed.
|
||||
- [ ] Corresponding changes to the documentation have been made.
|
||||
- [ ] The version has been updated in the VERSION file.
|
||||
|
||||
## Type of change:
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue) → The patch number in the VERSION file has been increased.
|
||||
- [ ] New feature (non-breaking change which adds functionality) → The minor number in the VERSION file has been increased.
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) → The major number in the VERSION file has been increased.
|
||||
- [ ] Automation.
|
||||
- [ ] Documentation.
|
||||
- [ ] Example.
|
||||
- [ ] Testing.
|
||||
@@ -0,0 +1,63 @@
|
||||
name: check
|
||||
|
||||
env:
|
||||
XDEBUG_MODE: coverage
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- 'main'
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
test-php:
|
||||
name: Test on php ${{ matrix.php-version }} and ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
continue-on-error: ${{ matrix.experimental }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
php-version: ["8.2", "8.3", "8.4", "8.5"]
|
||||
experimental: [false]
|
||||
os: [ubuntu-latest]
|
||||
coverage-extension: [xdebug]
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
- name: Use php ${{ matrix.php-version }}
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: ${{ matrix.php-version }}
|
||||
coverage: ${{ matrix.coverage-extension }}
|
||||
extensions: xdebug, bcmath, curl, date, gd, hash, imagick, json, mbstring, openssl, pcre, zlib
|
||||
ini-values: display_errors=on, error_reporting=-1, zend.assertions=1
|
||||
- name: List php modules
|
||||
run: php -m
|
||||
- name: List php modules using "no php ini" mode
|
||||
run: php -m -n
|
||||
- name: Cache module
|
||||
uses: actions/cache@v6
|
||||
with:
|
||||
path: ~/.composer/cache/
|
||||
key: composer-cache
|
||||
- name: Install dependencies
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: make deps
|
||||
- name: Check code formatting
|
||||
run: ./vendor/bin/mago fmt --check src test example
|
||||
- name: Run all tests
|
||||
run: make qa
|
||||
- name: Run all tests without the optional bcmath extension
|
||||
run: php -d disable_functions=bcadd,bcmul,bcdiv,bcmod vendor/bin/phpunit --no-coverage --stderr test
|
||||
- name: Send coverage
|
||||
uses: codecov/codecov-action@v7
|
||||
with:
|
||||
flags: php-${{ matrix.php-version }}-${{ matrix.os }}
|
||||
name: php-${{ matrix.php-version }}-${{ matrix.os }}
|
||||
@@ -0,0 +1,21 @@
|
||||
.phpdoc
|
||||
.phpunit.cache
|
||||
.phpunit.result.cache
|
||||
**/._*
|
||||
**/.#*
|
||||
**/.DS_Store
|
||||
**/.idea
|
||||
**/.vagrant
|
||||
**/*.bak
|
||||
**/*.tmp
|
||||
**/auth.json
|
||||
**/nbproject
|
||||
**/temp.php
|
||||
**/test.php
|
||||
composer.lock
|
||||
ecs.php
|
||||
phpunit.xml
|
||||
PLAN_*
|
||||
rector.php
|
||||
target
|
||||
vendor
|
||||
+1
@@ -0,0 +1 @@
|
||||
* @nicolaasuni
|
||||
+128
@@ -0,0 +1,128 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
+194
@@ -0,0 +1,194 @@
|
||||
# Contributing to tc-lib-barcode
|
||||
|
||||
Thank you for your interest in contributing to **tc-lib-barcode**.
|
||||
Contributions of all kinds are welcome: bug reports, bug fixes, documentation improvements, new features, and refactors.
|
||||
|
||||
Please take a moment to read this guide before opening an issue or pull request.
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Security Vulnerabilities](#security-vulnerabilities)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Reporting a Bug](#reporting-a-bug)
|
||||
- [Submitting a Bug Fix](#submitting-a-bug-fix)
|
||||
- [Proposing a New Feature](#proposing-a-new-feature)
|
||||
- [Development Workflow](#development-workflow)
|
||||
- [Coding Standards](#coding-standards)
|
||||
- [Testing](#testing)
|
||||
- [Pull Request Guidelines](#pull-request-guidelines)
|
||||
- [Commit Message Guidelines](#commit-message-guidelines)
|
||||
|
||||
---
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating you agree to abide by its terms. Please report unacceptable behaviour to [info@tecnick.com](mailto:info@tecnick.com).
|
||||
|
||||
---
|
||||
|
||||
## Security Vulnerabilities
|
||||
|
||||
**Do not open a public GitHub issue for security vulnerabilities.**
|
||||
Please follow the [Security Policy](SECURITY.md) and report them privately.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Requirements
|
||||
|
||||
- PHP **≥ 8.2**
|
||||
- [Composer](https://getcomposer.org/) v2
|
||||
- `make`, `git`
|
||||
- Optional: `rpmbuild` (RPM packaging), `dpkg-buildpackage` (DEB packaging)
|
||||
|
||||
### Local setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/tecnickcom/tc-lib-barcode.git
|
||||
cd tc-lib-barcode
|
||||
make buildall
|
||||
```
|
||||
|
||||
To verify everything is working after a change:
|
||||
|
||||
```bash
|
||||
make qa
|
||||
```
|
||||
|
||||
This runs linting, static analysis, and the full unit-test suite with coverage.
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Bug
|
||||
|
||||
Before opening an issue:
|
||||
|
||||
1. **Check the [Security Policy](SECURITY.md)** — if the bug is a security vulnerability, do not file a public issue.
|
||||
2. **Search [existing issues](https://github.com/tecnickcom/tc-lib-barcode/issues)** to avoid duplicates.
|
||||
|
||||
If no existing issue matches, [open a new one](https://github.com/tecnickcom/tc-lib-barcode/issues/new) and include:
|
||||
|
||||
- A **clear title and description** of the problem.
|
||||
- The **library version** (`composer show tecnickcom/tc-lib-barcode`) and PHP version.
|
||||
- A **minimal, self-contained reproduction** — a short PHP script or a failing PHPUnit test case is ideal.
|
||||
- **Expected vs. actual behaviour** — what you expected to happen and what actually happened.
|
||||
- Any relevant **stack trace or error output**.
|
||||
|
||||
The more precise and reproducible the report, the faster it can be triaged and fixed.
|
||||
|
||||
---
|
||||
|
||||
## Submitting a Bug Fix
|
||||
|
||||
1. [Fork the repository](https://github.com/tecnickcom/tc-lib-barcode/fork) and create a branch from `main`:
|
||||
```bash
|
||||
git checkout -b fix/short-description-of-bug
|
||||
```
|
||||
2. Make your changes, following the [Coding Standards](#coding-standards) below.
|
||||
3. Add or update unit tests to cover the changes.
|
||||
4. Run the full quality-assurance suite locally and ensure it passes:
|
||||
```bash
|
||||
make qa
|
||||
```
|
||||
5. Commit your changes (see [Commit Message Guidelines](#commit-message-guidelines)).
|
||||
6. Open a pull request against `main` and fill in the PR template:
|
||||
- Describe the problem and your solution.
|
||||
- Reference the related issue number (e.g. `Fixes #123`).
|
||||
|
||||
---
|
||||
|
||||
## Proposing a New Feature
|
||||
|
||||
Before writing any code:
|
||||
|
||||
1. **Open a Feature Request** on [GitHub Issues](https://github.com/tecnickcom/tc-lib-barcode/issues/new) describing the use case and proposed API.
|
||||
2. Wait for feedback from the maintainer. This avoids investing time in a direction that may not be accepted.
|
||||
|
||||
Once the feature is agreed upon, follow the same branch → code → test → PR workflow as for bug fixes, using a branch named `feature/short-description`.
|
||||
|
||||
---
|
||||
|
||||
## Development Workflow
|
||||
|
||||
The `Makefile` exposes all common development tasks:
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `make qa` | Run linting, static analysis, tests, and reports |
|
||||
| `make test` | Run PHPUnit with code coverage |
|
||||
| `make lint` | Check coding standards |
|
||||
| `make format` | Auto-format the code |
|
||||
| `make buildall` | Install dependencies, fix style, run QA, and build packages |
|
||||
| `make clean` | Remove `vendor/` and `target/` directories |
|
||||
| `make server` | Start the built-in PHP development server for the examples |
|
||||
|
||||
Run `make help` to see the full list of available targets.
|
||||
|
||||
---
|
||||
|
||||
## Coding Standards
|
||||
|
||||
- The codebase follows **PSR-12** for formatting.
|
||||
- Run `make format` to auto-format the code.
|
||||
- Run `make lint` to catch remaining issues.
|
||||
- All source files live under `src/`, all tests under `test/`.
|
||||
- Use strict types and explicit visibility on all class members.
|
||||
- Avoid introducing new external dependencies without prior discussion.
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
Tests are written with [PHPUnit](https://phpunit.de/) and live in `test/`.
|
||||
|
||||
```bash
|
||||
# Run the full test suite with coverage
|
||||
make test
|
||||
|
||||
# Run a specific test file
|
||||
XDEBUG_MODE=coverage ./vendor/bin/phpunit test/HTMLTest.php
|
||||
```
|
||||
|
||||
Requirements for contributions:
|
||||
|
||||
- Every bug fix must be accompanied by a regression test that fails before the fix and passes after.
|
||||
- Every new feature must be accompanied by tests that cover both the happy path and edge cases.
|
||||
|
||||
Coverage reports are generated in `target/coverage/`.
|
||||
|
||||
---
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
- Target the `main` branch.
|
||||
- Keep PRs focused — one fix or feature per PR.
|
||||
- Ensure `make qa` passes locally before opening the PR.
|
||||
- Do not bump the version number in your PR; that is handled by the maintainer at release time.
|
||||
- Be responsive to review feedback; stale PRs may be closed after an extended period of inactivity.
|
||||
|
||||
---
|
||||
|
||||
## Commit Message Guidelines
|
||||
|
||||
Use concise, imperative-mood commit messages:
|
||||
|
||||
```
|
||||
fix: correct path traversal in font loader
|
||||
feat: add support for XYZ
|
||||
test: add regression test for #123
|
||||
docs: update CONTRIBUTING workflow
|
||||
refactor: extract text measurement into helper
|
||||
```
|
||||
|
||||
Prefix tags: `fix`, `feat`, `test`, `docs`, `refactor`, `chore`, `ci`.
|
||||
Reference issues where relevant: `fix: correct X (closes #42)`.
|
||||
|
||||
---
|
||||
|
||||
## Questions?
|
||||
|
||||
If you have a question that is not covered here, feel free to open a [GitHub Discussion](https://github.com/tecnickcom/tc-lib-barcode/discussions) or contact the maintainer at [info@tecnick.com](mailto:info@tecnick.com).
|
||||
+862
@@ -0,0 +1,862 @@
|
||||
**********************************************************************
|
||||
* LICENSE
|
||||
*
|
||||
* SOFTWARE : tc-lib-barcode
|
||||
* AUTHOR : Nicola Asuni <info@tecnick.com>
|
||||
* COPYRIGHT : 2001-2026 Nicola Asuni - Tecnick.com LTD
|
||||
**********************************************************************
|
||||
|
||||
This is free software: you can redistribute it and/or modify it
|
||||
under the terms of the GNU Lesser General Public License as
|
||||
published by the Free Software Foundation, either version 3 of the
|
||||
License, or (at your option) any later version.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://www.fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser General Public License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://www.fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
+286
@@ -0,0 +1,286 @@
|
||||
# makefile
|
||||
#
|
||||
# @since 2015-02-21
|
||||
# @category Library
|
||||
# @package Barcode
|
||||
# @author Nicola Asuni <info@tecnick.com>
|
||||
# @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
# @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
# @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
#
|
||||
# This file is part of tc-lib-barcode software library.
|
||||
# ----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
SHELL=/bin/bash
|
||||
.SHELLFLAGS=-o pipefail -c
|
||||
|
||||
# Project owner
|
||||
OWNER=tecnickcom
|
||||
|
||||
# Project vendor
|
||||
VENDOR=${OWNER}
|
||||
|
||||
# Project name
|
||||
PROJECT=tc-lib-barcode
|
||||
|
||||
# Project version
|
||||
VERSION=$(shell cat VERSION)
|
||||
|
||||
# Project release number (packaging build number)
|
||||
RELEASE=$(shell cat RELEASE)
|
||||
|
||||
# Name of RPM or DEB package
|
||||
PKGNAME=php-${OWNER}-${PROJECT}
|
||||
|
||||
# Data dir
|
||||
DATADIR=usr/share
|
||||
|
||||
# PHP home folder
|
||||
PHPHOME=${DATADIR}/php/Com/Tecnick
|
||||
|
||||
# Default installation path for code
|
||||
LIBPATH=${PHPHOME}/Barcode/
|
||||
|
||||
# Path for configuration files (etc/$(PKGNAME)/)
|
||||
CONFIGPATH=
|
||||
|
||||
# Default installation path for documentation
|
||||
DOCPATH=${DATADIR}/doc/$(PKGNAME)/
|
||||
|
||||
# Installation path for the code
|
||||
PATHINSTBIN=$(DESTDIR)/$(LIBPATH)
|
||||
|
||||
# Installation path for the configuration files
|
||||
PATHINSTCFG=$(DESTDIR)/$(CONFIGPATH)
|
||||
|
||||
# Installation path for documentation
|
||||
PATHINSTDOC=$(DESTDIR)/$(DOCPATH)
|
||||
|
||||
# Current directory
|
||||
CURRENTDIR=$(CURDIR)/
|
||||
|
||||
# Target directory
|
||||
TARGETDIR=target
|
||||
|
||||
# RPM Packaging path (where RPMs will be stored)
|
||||
PATHRPMPKG=$(TARGETDIR)/RPM
|
||||
|
||||
# RPM local database path (avoid host rpmdb permission issues)
|
||||
RPMDBPATH=$(PATHRPMPKG)/.rpmdb
|
||||
|
||||
# DEB Packaging path (where DEBs will be stored)
|
||||
PATHDEBPKG=$(TARGETDIR)/DEB
|
||||
|
||||
# BZ2 Packaging path (where BZ2s will be stored)
|
||||
PATHBZ2PKG=$(TARGETDIR)/BZ2
|
||||
|
||||
# sed argument for in-place substitutions
|
||||
SEDINPLACE=-i
|
||||
ifeq ($(shell uname -s),Darwin)
|
||||
SEDINPLACE=-i ''
|
||||
endif
|
||||
|
||||
# Default port number for the example server
|
||||
PORT?=8000
|
||||
|
||||
# PHP binary
|
||||
PHP=$(shell which php)
|
||||
|
||||
# Composer executable (disable APC to as a work-around of a bug)
|
||||
COMPOSER=$(PHP) -d "apc.enable_cli=0" $(shell which composer)
|
||||
|
||||
# phpDocumentor executable file
|
||||
PHPDOC=$(shell which phpDocumentor)
|
||||
|
||||
# Mago version
|
||||
MAGOVERSION=1.43.0
|
||||
|
||||
# --- MAKE TARGETS ---
|
||||
|
||||
# Display general help about this command
|
||||
.PHONY: help
|
||||
help:
|
||||
@echo ""
|
||||
@echo "$(PROJECT) Makefile."
|
||||
@echo "The following commands are available:"
|
||||
@echo ""
|
||||
@awk '/^## /{desc=substr($$0,4)} /^\.PHONY:/{if(NF>1) {target=$$2; if(desc) printf " make %-15s: %s\n",target,desc; desc=""}}' Makefile
|
||||
@echo ""
|
||||
@echo "To test and build everything from scratch, use the shortcut:"
|
||||
@echo " make x"
|
||||
@echo ""
|
||||
|
||||
# alias for help target
|
||||
.PHONY: all
|
||||
all: help
|
||||
|
||||
# Full build and test sequence
|
||||
.PHONY: x
|
||||
x: buildall
|
||||
|
||||
## Full build and test sequence
|
||||
.PHONY: buildall
|
||||
buildall: deps format qa bz2 rpm deb
|
||||
|
||||
## Package the library in a compressed bz2 archive
|
||||
.PHONY: bz2
|
||||
bz2:
|
||||
rm -rf "$(PATHBZ2PKG)"
|
||||
make install DESTDIR="$(PATHBZ2PKG)"
|
||||
tar -jcvf "$(PATHBZ2PKG)/$(PKGNAME)-$(VERSION)-$(RELEASE).tbz2" -C "$(PATHBZ2PKG)" "$(DATADIR)"
|
||||
|
||||
## Delete the vendor and target directories
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf ./vendor "$(TARGETDIR)"
|
||||
|
||||
## Fix code style violations
|
||||
.PHONY: codefix
|
||||
codefix:
|
||||
#./vendor/bin/phpcbf --config-set ignore_non_auto_fixable_on_exit 1
|
||||
./vendor/bin/phpcbf --ignore="\./vendor/" --standard=psr12 src test
|
||||
|
||||
## Build a DEB package for Debian-like Linux distributions
|
||||
.PHONY: deb
|
||||
deb:
|
||||
rm -rf "$(PATHDEBPKG)"
|
||||
$(MAKE) install DESTDIR="$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)"
|
||||
rm -f "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/$(DOCPATH)LICENSE"
|
||||
tar -zcvf "$(PATHDEBPKG)/$(PKGNAME)_$(VERSION).orig.tar.gz" -C "$(PATHDEBPKG)/" "$(PKGNAME)-$(VERSION)"
|
||||
cp -rf ./resources/debian "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian"
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -name '*.bak' -delete
|
||||
chmod 755 "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/rules"
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#DATE#~/`date -R`/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#VENDOR#~/$(VENDOR)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#PROJECT#~/$(PROJECT)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#PKGNAME#~/$(PKGNAME)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#VERSION#~/$(VERSION)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#RELEASE#~/$(RELEASE)/" {} \;
|
||||
echo "$(LIBPATH)" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(LIBPATH)* $(LIBPATH)" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
echo "$(DOCPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(DOCPATH)* $(DOCPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
ifneq ($(strip $(CONFIGPATH)),)
|
||||
echo "$(CONFIGPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(CONFIGPATH)* $(CONFIGPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
endif
|
||||
echo "new-package-should-close-itp-bug" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).lintian-overrides"
|
||||
cd "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)" && debuild -us -uc
|
||||
|
||||
## Clean all artifacts and download all dependencies
|
||||
.PHONY: deps
|
||||
deps: ensuretarget
|
||||
rm -rf ./vendor/*
|
||||
($(COMPOSER) install -vvv --no-interaction)
|
||||
curl --proto '=https' --tlsv1.2 --silent --show-error --fail --location https://carthage.software/mago.sh | bash -s -- --install-dir=./vendor/bin --version=$(MAGOVERSION)
|
||||
|
||||
## Generate source code documentation
|
||||
.PHONY: doc
|
||||
doc: ensuretarget
|
||||
rm -rf "$(TARGETDIR)/doc"
|
||||
$(PHPDOC) -d ./src -t "$(TARGETDIR)/doc/"
|
||||
|
||||
## Create missing target directories for test and build artifacts
|
||||
.PHONY: ensuretarget
|
||||
ensuretarget:
|
||||
mkdir -p "$(TARGETDIR)/test"
|
||||
mkdir -p "$(TARGETDIR)/report"
|
||||
mkdir -p "$(TARGETDIR)/doc"
|
||||
|
||||
## Install this application
|
||||
.PHONY: install
|
||||
install: uninstall
|
||||
mkdir -p "$(PATHINSTBIN)"
|
||||
cp -rf ./src/* "$(PATHINSTBIN)"
|
||||
cp -f ./resources/autoload.php "$(PATHINSTBIN)"
|
||||
find "$(PATHINSTBIN)" -type d -exec chmod 755 {} \;
|
||||
find "$(PATHINSTBIN)" -type f -exec chmod 644 {} \;
|
||||
mkdir -p "$(PATHINSTDOC)"
|
||||
cp -f ./LICENSE "$(PATHINSTDOC)"
|
||||
cp -f ./README.md "$(PATHINSTDOC)"
|
||||
cp -f ./VERSION "$(PATHINSTDOC)"
|
||||
cp -f ./RELEASE "$(PATHINSTDOC)"
|
||||
chmod -R 644 "$(PATHINSTDOC)"*
|
||||
ifneq ($(strip $(CONFIGPATH)),)
|
||||
mkdir -p "$(PATHINSTCFG)"
|
||||
touch -c "$(PATHINSTCFG)"*
|
||||
cp -ru "./resources/${CONFIGPATH}"* "$(PATHINSTCFG)"
|
||||
find "$(PATHINSTCFG)" -type d -exec chmod 755 {} \;
|
||||
find "$(PATHINSTCFG)" -type f -exec chmod 644 {} \;
|
||||
endif
|
||||
|
||||
## Format the source code
|
||||
.PHONY: format
|
||||
format:
|
||||
./vendor/bin/mago fmt src test example
|
||||
|
||||
## Analyze and Lint the source code
|
||||
.PHONY: lint
|
||||
lint:
|
||||
./vendor/bin/mago --config ./mago.src.toml analyze src
|
||||
./vendor/bin/mago --config ./mago.test.toml analyze test
|
||||
./vendor/bin/mago --config ./mago.src.toml lint src
|
||||
./vendor/bin/mago --config ./mago.test.toml lint test
|
||||
|
||||
## Run all tests and reports
|
||||
.PHONY: qa
|
||||
qa: ensuretarget lint test report
|
||||
|
||||
## Generate various reports
|
||||
.PHONY: report
|
||||
report: ensuretarget
|
||||
./vendor/bin/pdepend --jdepend-xml="$(TARGETDIR)/report/dependencies.xml" --summary-xml="$(TARGETDIR)/report/metrics.xml" --jdepend-chart="$(TARGETDIR)/report/dependecies.svg" --overview-pyramid="$(TARGETDIR)/report/overview-pyramid.svg" --ignore=vendor ./src
|
||||
#./vendor/bartlett/php-compatinfo/bin/phpcompatinfo --no-ansi analyser:run src/ > $(TARGETDIR)/report/phpcompatinfo.txt
|
||||
|
||||
## Build the RPM package for RedHat-like Linux distributions
|
||||
.PHONY: rpm
|
||||
rpm:
|
||||
@test $(words $(CURDIR)) -eq 1 || { echo "ERROR: rpmbuild does not support spaces in the project path: $(CURDIR)"; exit 1; }
|
||||
rm -rf "$(PATHRPMPKG)"
|
||||
mkdir -p "$(RPMDBPATH)" "$(PATHRPMPKG)/tmp"
|
||||
rpmbuild \
|
||||
--define "_topdir $(CURRENTDIR)$(PATHRPMPKG)" \
|
||||
--define "_dbpath $(CURRENTDIR)$(RPMDBPATH)" \
|
||||
--define "_tmppath $(CURRENTDIR)$(PATHRPMPKG)/tmp" \
|
||||
--define "_vendor $(VENDOR)" \
|
||||
--define "_owner $(OWNER)" \
|
||||
--define "_project $(PROJECT)" \
|
||||
--define "_package $(PKGNAME)" \
|
||||
--define "_version $(VERSION)" \
|
||||
--define "_release $(RELEASE)" \
|
||||
--define "_current_directory $(CURRENTDIR)" \
|
||||
--define "_libpath /$(LIBPATH)" \
|
||||
--define "_docpath /$(DOCPATH)" \
|
||||
--define "_configpath /$(CONFIGPATH)" \
|
||||
-bb resources/rpm/rpm.spec
|
||||
|
||||
## Start the development server
|
||||
.PHONY: server
|
||||
server:
|
||||
$(PHP) -t example -S localhost:$(PORT)
|
||||
|
||||
## Tag this GIT version
|
||||
.PHONY: tag
|
||||
tag:
|
||||
git checkout main && \
|
||||
git tag -a ${VERSION} -m "Release ${VERSION}" && \
|
||||
git push origin --tags && \
|
||||
git pull
|
||||
|
||||
## Run unit tests
|
||||
.PHONY: test
|
||||
test:
|
||||
cp phpunit.xml.dist phpunit.xml
|
||||
#./vendor/bin/phpunit --migrate-configuration || true
|
||||
XDEBUG_MODE=coverage ./vendor/bin/phpunit --stderr test
|
||||
|
||||
## Remove all installed files
|
||||
.PHONY: uninstall
|
||||
uninstall:
|
||||
rm -rf "$(PATHINSTBIN)"
|
||||
rm -rf "$(PATHINSTDOC)"
|
||||
|
||||
## Increase the version patch number
|
||||
.PHONY: versionup
|
||||
versionup:
|
||||
echo ${VERSION} | gawk -F. '{printf("%d.%d.%d\n",$$1,$$2,(($$3+1)));}' > VERSION
|
||||
+185
@@ -0,0 +1,185 @@
|
||||
# tc-lib-barcode
|
||||
|
||||
> PHP library for generating linear and 2D barcodes.
|
||||
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-barcode)
|
||||
[](https://github.com/tecnickcom/tc-lib-barcode/actions/workflows/check.yml)
|
||||
[](https://codecov.io/gh/tecnickcom/tc-lib-barcode)
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-barcode)
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-barcode)
|
||||
|
||||
[](https://github.com/sponsors/tecnickcom)
|
||||
|
||||
> 💖 Part of the [tc-lib-pdf / TCPDF](https://github.com/tecnickcom/tc-lib-pdf) ecosystem (100M+ installs). [Sponsor its maintenance →](https://github.com/sponsors/tecnickcom)
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
`tc-lib-barcode` is a pure-PHP barcode generation library with broad support for industrial, retail, logistics, and document automation use cases.
|
||||
|
||||
It focuses on deterministic output and specification-driven encoding, making it suitable for labels, tickets, warehouse flows, and compliance documents. The API is structured so applications can generate barcode data once and render it as vectors or raster images depending on their output target.
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Namespace** | `\Com\Tecnick\Barcode` |
|
||||
| **Author** | Nicola Asuni <info@tecnick.com> |
|
||||
| **License** | [GNU LGPL v3](https://www.gnu.org/copyleft/lesser.html) - see [LICENSE](LICENSE) |
|
||||
| **API docs** | <https://tcpdf.org/docs/srcdoc/tc-lib-barcode> |
|
||||
| **Packagist** | <https://packagist.org/packages/tecnickcom/tc-lib-barcode> |
|
||||
|
||||
---
|
||||
|
||||
## Supported Formats
|
||||
|
||||
### Linear
|
||||
|
||||
| Format | Description |
|
||||
|--------|-------------|
|
||||
| C39 | CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9 |
|
||||
| C39+ | CODE 39 with checksum |
|
||||
| C39E | CODE 39 EXTENDED |
|
||||
| C39E+ | CODE 39 EXTENDED + CHECKSUM |
|
||||
| C93 | CODE 93 - USS-93 |
|
||||
| S25 | Standard 2 of 5 |
|
||||
| S25+ | Standard 2 of 5 + CHECKSUM |
|
||||
| I25 | Interleaved 2 of 5 |
|
||||
| I25+ | Interleaved 2 of 5 + CHECKSUM |
|
||||
| C128 | CODE 128 |
|
||||
| C128A | CODE 128 A |
|
||||
| C128B | CODE 128 B |
|
||||
| C128C | CODE 128 C |
|
||||
| EAN2 | 2-Digits UPC-Based Extension |
|
||||
| EAN5 | 5-Digits UPC-Based Extension |
|
||||
| EAN8 | EAN 8 |
|
||||
| EAN13 | EAN 13 |
|
||||
| UPCA | UPC-A |
|
||||
| UPCE | UPC-E |
|
||||
| MSI | MSI (Variation of Plessey code) |
|
||||
| MSI+ | MSI + CHECKSUM (modulo 11) |
|
||||
| CODABAR | CODABAR |
|
||||
| CODE11 | CODE 11 |
|
||||
| PHARMA | PHARMACODE |
|
||||
| PHARMA2T | PHARMACODE TWO-TRACKS |
|
||||
|
||||
### 2D
|
||||
|
||||
| Format | Description |
|
||||
|--------|-------------|
|
||||
| AZTEC | AZTEC Code (ISO/IEC 24778:2008) |
|
||||
| DATAMATRIX | DATAMATRIX (ISO/IEC 16022) |
|
||||
| PDF417 | PDF417 (ISO/IEC 15438:2006) |
|
||||
| QRCODE | QR-CODE |
|
||||
| SRAW | 2D RAW MODE (comma-separated rows of 01 strings) |
|
||||
|
||||
### Postal
|
||||
|
||||
| Format | Description |
|
||||
|--------|-------------|
|
||||
| POSTNET | POSTNET |
|
||||
| PLANET | PLANET |
|
||||
| RMS4CC | RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code) |
|
||||
| KIX | KIX (Klant index - Customer index) |
|
||||
| IMB | IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200 |
|
||||
| IMBPRE | IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200 - pre-processed |
|
||||
|
||||
## Rendering
|
||||
- HTML output for web previews
|
||||
- Image-based rendering for downstream processing
|
||||
- Configurable dimensions, padding, and color
|
||||
|
||||
### Output Formats
|
||||
- PNG Image
|
||||
- SVG Image
|
||||
- HTML DIV
|
||||
- Unicode String
|
||||
- Binary String
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
- PHP 8.2 or later
|
||||
- Extensions: `gd`
|
||||
- Optional extensions: `bcmath` (speeds up the arbitrary precision arithmetic used by the IMB and PDF417 types, a pure-PHP implementation is used when it is missing)
|
||||
- Composer
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
composer require tecnickcom/tc-lib-barcode
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
require_once __DIR__ . '/vendor/autoload.php';
|
||||
|
||||
$barcode = new \Com\Tecnick\Barcode\Barcode();
|
||||
$bobj = $barcode->getBarcodeObj(
|
||||
type: 'QRCODE,H',
|
||||
code: 'https://tecnick.com',
|
||||
width: -4,
|
||||
height: -4,
|
||||
color: 'black',
|
||||
padding: [-2, -2, -2, -2],
|
||||
)->setBackgroundColor('white');
|
||||
|
||||
echo $bobj->getInlineSvgCode();
|
||||
```
|
||||
|
||||
For more formats and rendering options, see the `example/` directory.
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
make deps
|
||||
make help
|
||||
make qa
|
||||
```
|
||||
|
||||
To preview the example app in a browser:
|
||||
|
||||
```bash
|
||||
make server
|
||||
```
|
||||
|
||||
Then open <http://localhost:8000/> (served from the `example/` directory).
|
||||
|
||||
To use a different port:
|
||||
|
||||
```bash
|
||||
make server PORT=8080
|
||||
```
|
||||
|
||||
Build artifacts and reports are generated in `target/`.
|
||||
|
||||
---
|
||||
|
||||
## Packaging
|
||||
|
||||
```bash
|
||||
make rpm
|
||||
make deb
|
||||
```
|
||||
|
||||
For system packages, bootstrap with:
|
||||
|
||||
```php
|
||||
require_once '/usr/share/php/Com/Tecnick/Barcode/autoload.php';
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md), [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and [SECURITY.md](SECURITY.md) before submitting a pull request.
|
||||
|
||||
+1
@@ -0,0 +1 @@
|
||||
1
|
||||
+62
@@ -0,0 +1,62 @@
|
||||
# Security Policy
|
||||
|
||||
This document describes the security policy for **tc-lib-barcode**.
|
||||
|
||||
---
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Security fixes are applied only to the **latest stable release** on the `main` branch.
|
||||
|
||||
We strongly recommend always running the latest release.
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
**Please do not open a public GitHub issue for security vulnerabilities.**
|
||||
|
||||
If you discover a security vulnerability — or suspect one — follow responsible disclosure:
|
||||
|
||||
1. **Email** the maintainer directly at **[info@tecnick.com](mailto:info@tecnick.com)** with the subject line:
|
||||
`[SECURITY] tc-lib-barcode – <brief description>`
|
||||
2. Include as much detail as possible (see [What to include](#what-to-include) below).
|
||||
3. You will receive an acknowledgement as soon as possible.
|
||||
4. We will work on a fix or mitigation as promptly as the complexity of the issue allows.
|
||||
|
||||
If you do not receive a timely response, please follow up by replying to the same email thread.
|
||||
|
||||
---
|
||||
|
||||
## What to Include
|
||||
|
||||
A high-quality report helps us triage and fix issues faster. Please provide:
|
||||
|
||||
- **Description** — a clear summary of the vulnerability and its potential impact.
|
||||
- **Affected component** — which class, method, or feature is involved (e.g., `HTML::render()`, font loading, image processing).
|
||||
- **Steps to reproduce** — a minimal, self-contained PHP script or unit test that demonstrates the issue.
|
||||
- **Expected vs. actual behaviour** — what you expected to happen and what actually happened.
|
||||
- **Environment** — PHP version, OS, library version (output of `composer show tecnickcom/tc-lib-barcode`).
|
||||
- **CVE / CWE reference** (optional) — if you have already identified a relevant classification.
|
||||
- **Suggested fix** (optional) — a patch or proposed mitigation if you have one.
|
||||
|
||||
---
|
||||
|
||||
## Security Best Practices for Integrators
|
||||
|
||||
Integrators are responsible for sanitising input **before** passing it to the library. We recommend:
|
||||
|
||||
- **Validate and sanitise all user-supplied data**. Use a dedicated sanitiser when accepting content from end users.
|
||||
- **Keep dependencies up to date.** Run `composer update` regularly and monitor advisories via [Packagist Security Advisories](https://packagist.org/packages/tecnickcom/tc-lib-barcode) or tools such as `composer audit`.
|
||||
- **Pin versions in production.** Use `composer.lock` and review changes on every update.
|
||||
|
||||
---
|
||||
|
||||
## Contact
|
||||
|
||||
| Channel | Details |
|
||||
|---------|---------|
|
||||
| Security email | [info@tecnick.com](mailto:info@tecnick.com) |
|
||||
| Project website | <https://tcpdf.org> |
|
||||
| GitHub repository | <https://github.com/tecnickcom/tc-lib-barcode> |
|
||||
| Packagist | <https://packagist.org/packages/tecnickcom/tc-lib-barcode> |
|
||||
+1
@@ -0,0 +1 @@
|
||||
2.13.2
|
||||
+105
@@ -0,0 +1,105 @@
|
||||
{
|
||||
"name": "tecnickcom/tc-lib-barcode",
|
||||
"description": "PHP library to generate linear and bidimensional barcodes",
|
||||
"type": "library",
|
||||
"homepage": "https://tcpdf.org",
|
||||
"license": "LGPL-3.0-or-later",
|
||||
"keywords": [
|
||||
"tc-lib-barcode",
|
||||
"barcode",
|
||||
"3 of 9",
|
||||
"ANSI MH10.8M-1983",
|
||||
"AZTEC",
|
||||
"barcode",
|
||||
"CBC",
|
||||
"CODABAR",
|
||||
"CODE 11",
|
||||
"CODE 128 A B C",
|
||||
"CODE 39",
|
||||
"CODE 93",
|
||||
"Datamatrix",
|
||||
"EAN 13",
|
||||
"EAN 8",
|
||||
"ECC200",
|
||||
"Intelligent Mail Barcode",
|
||||
"Interleaved 2 of 5",
|
||||
"ISO IEC 15438 2006",
|
||||
"ISO IEC 16022",
|
||||
"ISO IEC 24778 2008",
|
||||
"KIX",
|
||||
"Klant",
|
||||
"MSI",
|
||||
"Onecode",
|
||||
"PDF417",
|
||||
"PHARMACODE TWO-TRACKS",
|
||||
"PHARMACODE",
|
||||
"PLANET",
|
||||
"POSTNET",
|
||||
"QR-Code",
|
||||
"RMS4CC",
|
||||
"Royal Mail",
|
||||
"Standard 2 of 5",
|
||||
"tc-lib-barcode",
|
||||
"UPC-A",
|
||||
"UPC-E",
|
||||
"UPC",
|
||||
"USD-3",
|
||||
"USPS-B-3200",
|
||||
"USS-93"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Nicola Asuni",
|
||||
"email": "info@tecnick.com",
|
||||
"role": "lead"
|
||||
}
|
||||
],
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/tecnickcom"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=8.2",
|
||||
"ext-ctype": "*",
|
||||
"ext-gd": "*",
|
||||
"ext-pcre": "*",
|
||||
"tecnickcom/tc-lib-color": "^2.13"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-bcmath": "Speeds up the arbitrary precision arithmetic used by the IMB and PDF417 barcode types (a pure-PHP implementation is used when missing)",
|
||||
"ext-imagick": "Alternative PNG renderer used by getPngData() when the extension is loaded"
|
||||
},
|
||||
"minimum-stability": "stable",
|
||||
"prefer-stable": true,
|
||||
"require-dev": {
|
||||
"pdepend/pdepend": "^2.16",
|
||||
"phpunit/phpunit": "^11.5 || ^12.5 || ^13.2"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Com\\Tecnick\\Barcode\\": "src"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Test\\": "test"
|
||||
}
|
||||
},
|
||||
"support": {
|
||||
"issues": "https://github.com/tecnickcom/tc-lib-barcode/issues",
|
||||
"source": "https://github.com/tecnickcom/tc-lib-barcode"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "@php -d xdebug.mode=coverage vendor/bin/phpunit --stderr test",
|
||||
"analyse": ["@analyse:src", "@analyse:test"],
|
||||
"analyse:src": "mago --config mago.src.toml analyze src",
|
||||
"analyse:test": "mago --config mago.test.toml analyze test",
|
||||
"cs-check": ["@cs-check:src", "@cs-check:test"],
|
||||
"cs-check:src": "mago --config mago.src.toml lint src",
|
||||
"cs-check:test": "mago --config mago.test.toml lint test",
|
||||
"cs-fix": "mago fmt src test",
|
||||
"qa": ["@cs-check", "@analyse", "@test"]
|
||||
}
|
||||
}
|
||||
+166
@@ -0,0 +1,166 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* index.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
// autoloader when using Composer
|
||||
require __DIR__ . '/../vendor/autoload.php';
|
||||
|
||||
// autoloader when using RPM or DEB package installation
|
||||
//require ('/usr/share/php/Com/Tecnick/Barcode/autoload.php');
|
||||
|
||||
// data to generate for each barcode type
|
||||
$linear = [
|
||||
'C128A' => ['0123456789', 'CODE 128 A'],
|
||||
'C128B' => ['0123456789', 'CODE 128 B'],
|
||||
'C128C' => ['0123456789', 'CODE 128 C'],
|
||||
'C128' => ['0123456789', 'CODE 128'],
|
||||
'C39E+' => ['0123456789', 'CODE 39 EXTENDED + CHECKSUM'],
|
||||
'C39E' => ['0123456789', 'CODE 39 EXTENDED'],
|
||||
'C39+' => ['0123456789', 'CODE 39 + CHECKSUM'],
|
||||
'C39' => ['0123456789', 'CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9'],
|
||||
'C93' => ['0123456789', 'CODE 93 - USS-93'],
|
||||
'CODABAR' => ['0123456789', 'CODABAR'],
|
||||
'CODE11' => ['0123456789', 'CODE 11'],
|
||||
'EAN13' => ['0123456789', 'EAN 13'],
|
||||
'EAN2' => ['12', 'EAN 2-Digits UPC-Based Extension'],
|
||||
'EAN5' => ['12345', 'EAN 5-Digits UPC-Based Extension'],
|
||||
'EAN8' => ['1234567', 'EAN 8'],
|
||||
'I25+' => ['0123456789', 'Interleaved 2 of 5 + CHECKSUM'],
|
||||
'I25' => ['0123456789', 'Interleaved 2 of 5'],
|
||||
'IMB' => ['01234567094987654321-01234567891', 'IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200'],
|
||||
'IMBPRE' => ['AADTFFDFTDADTAADAATFDTDDAAADDTDTTDAFADADDDTFFFDDTTTADFAAADFTDAADA', 'IMB pre-processed'],
|
||||
'KIX' => ['0123456789', 'KIX (Klant index - Customer index)'],
|
||||
'MSI+' => ['0123456789', 'MSI + CHECKSUM (modulo 11)'],
|
||||
'MSI' => ['0123456789', 'MSI (Variation of Plessey code)'],
|
||||
'PHARMA2T' => ['0123456789', 'PHARMACODE TWO-TRACKS'],
|
||||
'PHARMA' => ['0123456789', 'PHARMACODE'],
|
||||
'PLANET' => ['0123456789', 'PLANET'],
|
||||
'POSTNET' => ['0123456789', 'POSTNET'],
|
||||
'RMS4CC' => ['0123456789', 'RMS4CC (Royal Mail 4-state Customer Bar Code)'],
|
||||
'S25+' => ['0123456789', 'Standard 2 of 5 + CHECKSUM'],
|
||||
'S25' => ['0123456789', 'Standard 2 of 5'],
|
||||
'UPCA' => ['72527273070', 'UPC-A'],
|
||||
'UPCE' => ['725277', 'UPC-E'],
|
||||
];
|
||||
|
||||
$square = [
|
||||
'LRAW' => ['0101010101', '1D RAW MODE (comma-separated rows of 01 strings)'],
|
||||
'SRAW' => ['0101,1010', '2D RAW MODE (comma-separated rows of 01 strings)'],
|
||||
'AZTEC' => ['ABCDabcd01234', 'AZTEC (ISO/IEC 24778:2008)'],
|
||||
'AZTEC,50,A,A' => ['ABCDabcd01234', 'AZTEC (ISO/IEC 24778:2008)'],
|
||||
'PDF417' => ['0123456789', 'PDF417 (ISO/IEC 15438:2006)'],
|
||||
'QRCODE' => ['0123456789', 'QR-CODE'],
|
||||
'QRCODE,H,ST,0,0' => ['abcdefghijklmnopqrstuvwxy0123456789', 'QR-CODE WITH PARAMETERS'],
|
||||
'DATAMATRIX' => ['0123456789', 'DATAMATRIX (ISO/IEC 16022) SQUARE'],
|
||||
'DATAMATRIX,R' => [
|
||||
'0123456789012345678901234567890123456789',
|
||||
'DATAMATRIX Rectangular (ISO/IEC 16022) RECTANGULAR',
|
||||
],
|
||||
'DATAMATRIX,S,GS1' => [
|
||||
\chr(232) . '01095011010209171719050810ABCD1234' . \chr(232) . '2110',
|
||||
'GS1 DATAMATRIX (ISO/IEC 16022) SQUARE GS1',
|
||||
],
|
||||
'DATAMATRIX,R,GS1' => [
|
||||
\chr(232) . '01095011010209171719050810ABCD1234' . \chr(232) . '2110',
|
||||
'GS1 DATAMATRIX (ISO/IEC 16022) RECTANGULAR GS1',
|
||||
],
|
||||
];
|
||||
|
||||
$barcode = new \Com\Tecnick\Barcode\Barcode();
|
||||
|
||||
$examples = '<h3>Linear</h3>' . "\n";
|
||||
foreach ($linear as $type => $code) {
|
||||
$bobj = $barcode->getBarcodeObj($type, $code[0], -3, -30, 'black', [0, 0, 0, 0]);
|
||||
$examples .=
|
||||
'<h4>[<span>'
|
||||
. $type
|
||||
. '</span>] '
|
||||
. $code[1]
|
||||
. '</h4><p style="font-family:monospace;">'
|
||||
. $bobj->getHtmlDiv()
|
||||
. '</p>'
|
||||
. "\n";
|
||||
}
|
||||
|
||||
$examples .= '<h3>Square</h3>' . "\n";
|
||||
foreach ($square as $type => $code) {
|
||||
$bobj = $barcode->getBarcodeObj($type, $code[0], -4, -4, 'black', [0, 0, 0, 0]);
|
||||
$examples .=
|
||||
'<h4>[<span>'
|
||||
. $type
|
||||
. '</span>] '
|
||||
. $code[1]
|
||||
. '</h4><p style="font-family:monospace;">'
|
||||
. $bobj->getHtmlDiv()
|
||||
. '</p>'
|
||||
. "\n";
|
||||
}
|
||||
|
||||
$bobj = $barcode->getBarcodeObj('QRCODE,H', 'https://tecnick.com', -4, -4, 'black', [
|
||||
-2,
|
||||
-2,
|
||||
-2,
|
||||
-2,
|
||||
])->setBackgroundColor('#f0f0f0');
|
||||
|
||||
echo
|
||||
'
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Usage example of tc-lib-barcode library</title>
|
||||
<meta charset="utf-8">
|
||||
<style>
|
||||
body {font-family:Arial, Helvetica, sans-serif;margin:30px;}
|
||||
table {border: 1px solid black;}
|
||||
th {border: 1px solid black;padding:4px;background-color:cornsilk;}
|
||||
td {border: 1px solid black;padding:4px;}
|
||||
h3 {color:darkblue;}
|
||||
h4 {color:darkgreen;}
|
||||
h4 span {color:firebrick;}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Usage example of tc-lib-barcode library</h1>
|
||||
<p>This is a usage example of <a href="https://github.com/tecnickcom/tc-lib-barcode" title="tc-lib-barcode: PHP library to generate linear and bidimensional barcodes">tc-lib-barcode</a> library.</p>
|
||||
<h2>Output Formats</h2>
|
||||
<h3>PNG Image</h3>
|
||||
<p><img alt="Embedded Image" src="data:image/png;base64,'
|
||||
. \base64_encode($bobj->getPngData())
|
||||
. '" /></p>
|
||||
<h3>SVG Image</h3>
|
||||
<p style="font-family:monospace;">'
|
||||
. $bobj->getSvgCode()
|
||||
. '</p>
|
||||
<h3>HTML DIV</h3>
|
||||
<p style="font-family:monospace;">'
|
||||
. $bobj->getHtmlDiv()
|
||||
. '</p>
|
||||
<h3>Unicode String</h3>
|
||||
<pre style="font-family:monospace;line-height:0.61em;font-size:6px;">'
|
||||
. $bobj->getGrid(\json_decode('"\u00A0"'), \json_decode('"\u2584"'))
|
||||
. '</pre>
|
||||
<h3>Binary String</h3>
|
||||
<pre style="font-family:monospace;">'
|
||||
. $bobj->getGrid()
|
||||
. '</pre>
|
||||
<h2>Barcode Types</h2>
|
||||
'
|
||||
. $examples
|
||||
. '
|
||||
</body>
|
||||
</html>
|
||||
'
|
||||
;
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
#:schema https://mago.carthage.software/1.43.0/schema.json
|
||||
version = "1"
|
||||
php-version = "8.2.0"
|
||||
|
||||
[source]
|
||||
workspace = "."
|
||||
paths = ["src"]
|
||||
includes = ["vendor"]
|
||||
excludes = []
|
||||
|
||||
[source.glob]
|
||||
literal-separator = true
|
||||
|
||||
[formatter]
|
||||
print-width = 120
|
||||
tab-width = 4
|
||||
use-tabs = false
|
||||
|
||||
[linter]
|
||||
integrations = []
|
||||
|
||||
[linter.rules]
|
||||
ambiguous-function-call = { enabled = false }
|
||||
literal-named-argument = { enabled = false }
|
||||
cyclomatic-complexity = { enabled = false }
|
||||
excessive-parameter-list = { enabled = false }
|
||||
halstead = { enabled = true, difficulty-threshold = 50, effort-threshold = 90000, volume-threshold = 2000 }
|
||||
identity-comparison = { enabled = true }
|
||||
kan-defect = { enabled = false }
|
||||
no-boolean-flag-parameter = { enabled = false }
|
||||
no-else-clause = { enabled = false }
|
||||
no-empty = { enabled = true }
|
||||
too-many-properties = { enabled = false }
|
||||
too-many-methods = { enabled = false }
|
||||
too-many-enum-cases = { enabled = false }
|
||||
no-isset = { enabled = true, allow-array-checks = true }
|
||||
|
||||
[analyzer]
|
||||
plugins = []
|
||||
find-unused-definitions = true
|
||||
find-unused-expressions = true
|
||||
analyze-dead-code = true
|
||||
memoize-properties = true
|
||||
check-throws = true
|
||||
unchecked-exceptions = [
|
||||
"Error",
|
||||
"LogicException",
|
||||
"ReflectionException",
|
||||
]
|
||||
unchecked-exception-classes = []
|
||||
check-missing-override = true
|
||||
find-unused-parameters = true
|
||||
strict-list-index-checks = true
|
||||
strict-array-index-existence = true
|
||||
allow-array-truthy-operand = false
|
||||
no-boolean-literal-comparison = true
|
||||
check-missing-type-hints = true
|
||||
register-super-globals = true
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
#:schema https://mago.carthage.software/1.43.0/schema.json
|
||||
version = "1"
|
||||
php-version = "8.2.0"
|
||||
|
||||
[source]
|
||||
workspace = "."
|
||||
paths = ["src", "test"]
|
||||
includes = ["vendor"]
|
||||
excludes = []
|
||||
|
||||
[source.glob]
|
||||
literal-separator = true
|
||||
|
||||
[formatter]
|
||||
print-width = 120
|
||||
tab-width = 4
|
||||
use-tabs = false
|
||||
|
||||
[linter]
|
||||
integrations = ["phpunit"]
|
||||
|
||||
[linter.rules]
|
||||
ambiguous-function-call = { enabled = false }
|
||||
literal-named-argument = { enabled = false }
|
||||
assertion-style = { enabled = false }
|
||||
cyclomatic-complexity = { enabled = false }
|
||||
excessive-parameter-list = { enabled = false }
|
||||
halstead = { enabled = false, effort-threshold = 7000 }
|
||||
identity-comparison = { enabled = false }
|
||||
kan-defect = { enabled = false }
|
||||
no-boolean-flag-parameter = { enabled = false }
|
||||
no-else-clause = { enabled = false }
|
||||
no-debug-symbols = { enabled = false }
|
||||
no-empty = { enabled = false }
|
||||
no-empty-catch-clause = { enabled = false }
|
||||
no-isset = { enabled = false }
|
||||
readable-literal = { enabled = false }
|
||||
str-contains = { enabled = false }
|
||||
strict-assertions = { enabled = false }
|
||||
strict-behavior = { enabled = false }
|
||||
strict-types = { enabled = false }
|
||||
too-many-methods = { enabled = false }
|
||||
|
||||
[analyzer]
|
||||
plugins = []
|
||||
find-unused-definitions = true
|
||||
find-unused-expressions = true
|
||||
analyze-dead-code = true
|
||||
memoize-properties = true
|
||||
check-throws = true
|
||||
unchecked-exceptions = [
|
||||
"Error",
|
||||
"LogicException",
|
||||
"ReflectionException",
|
||||
"PHPUnit\\Framework\\Exception",
|
||||
"PHPUnit\\Framework\\ExpectationFailedException",
|
||||
"PHPUnit\\Framework\\UnknownClassOrInterfaceException",
|
||||
]
|
||||
unchecked-exception-classes = []
|
||||
check-missing-override = true
|
||||
find-unused-parameters = true
|
||||
strict-list-index-checks = true
|
||||
strict-array-index-existence = true
|
||||
allow-array-truthy-operand = false
|
||||
no-boolean-literal-comparison = true
|
||||
check-missing-type-hints = true
|
||||
register-super-globals = true
|
||||
@@ -0,0 +1,35 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit backupGlobals="false"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
displayDetailsOnTestsThatTriggerDeprecations="true"
|
||||
displayDetailsOnTestsThatTriggerErrors="true"
|
||||
displayDetailsOnTestsThatTriggerNotices="true"
|
||||
displayDetailsOnTestsThatTriggerWarnings="true"
|
||||
displayDetailsOnPhpunitDeprecations="true"
|
||||
failOnDeprecation="true"
|
||||
failOnNotice="true"
|
||||
failOnWarning="true"
|
||||
failOnPhpunitDeprecation="true"
|
||||
processIsolation="false"
|
||||
stopOnFailure="false">
|
||||
<testsuites>
|
||||
<testsuite name="tc-lib-barcode Test Suite">
|
||||
<directory>./test</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<source>
|
||||
<include>
|
||||
<directory suffix=".php">src</directory>
|
||||
</include>
|
||||
</source>
|
||||
<coverage>
|
||||
<report>
|
||||
<clover outputFile="target/coverage/coverage.xml"/>
|
||||
<html outputDirectory="target/coverage" lowUpperBound="50" highLowerBound="90"/>
|
||||
</report>
|
||||
</coverage>
|
||||
<logging>
|
||||
<junit outputFile="target/logs/junit.xml"/>
|
||||
</logging>
|
||||
</phpunit>
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
/**
|
||||
* autoload.php
|
||||
*
|
||||
* Autoloader for Tecnick.com libraries
|
||||
*
|
||||
* @since 2015-03-04
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
\spl_autoload_register(
|
||||
function ($class) {
|
||||
$prefix = 'Com\\Tecnick\\';
|
||||
$len = \strlen($prefix);
|
||||
if (\strncmp($prefix, $class, $len) !== 0) {
|
||||
return;
|
||||
}
|
||||
$relative_class = \substr($class, $len);
|
||||
$file = \dirname(__DIR__).'/'.\str_replace('\\', '/', $relative_class).'.php';
|
||||
if (\file_exists($file)) {
|
||||
require $file;
|
||||
}
|
||||
}
|
||||
);
|
||||
@@ -0,0 +1,7 @@
|
||||
~#PKGNAME#~ (~#VERSION#~-~#RELEASE#~) UNRELEASED; urgency=low
|
||||
|
||||
* Please check the
|
||||
https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
commit history
|
||||
|
||||
-- Nicola Asuni <info@tecnick.com> ~#DATE#~
|
||||
@@ -0,0 +1,26 @@
|
||||
Source: ~#PKGNAME#~
|
||||
Maintainer: Nicola Asuni <info@tecnick.com>
|
||||
Section: php
|
||||
Priority: optional
|
||||
Build-Depends: debhelper-compat (= 13)
|
||||
Standards-Version: 4.7.2
|
||||
Rules-Requires-Root: no
|
||||
Homepage: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
Vcs-Git: https://github.com/~#VENDOR#~/~#PROJECT#~.git
|
||||
Vcs-Browser: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
|
||||
Package: ~#PKGNAME#~
|
||||
Provides: php-~#PROJECT#~
|
||||
Architecture: all
|
||||
Depends: php (>= 8.2.0), php-ctype, php-gd, php-tecnickcom-tc-lib-color (<< 3.0.0), php-tecnickcom-tc-lib-color (>= 2.13.3), ${misc:Depends}
|
||||
Recommends: php-bcmath, php-imagick
|
||||
Description: PHP Barcode library
|
||||
This library includes PHP classes to generate linear
|
||||
and bidimensional barcodes:
|
||||
CODE 39, ANSI MH10.8M-1983, USD-3, 3 of 9, CODE 93,
|
||||
USS-93, Standard 2 of 5, Interleaved 2 of 5, CODE 128 A/B/C,
|
||||
2 and 5 Digits UPC-Based Extension, EAN 8, EAN 13, UPC-A,
|
||||
UPC-E, MSI, POSTNET, PLANET, RMS4CC (Royal Mail 4-state Customer Code),
|
||||
CBC (Customer Bar Code), KIX (Klant index - Customer index),
|
||||
Intelligent Mail Barcode, Onecode, USPS-B-3200, CODABAR, CODE 11,
|
||||
PHARMACODE, PHARMACODE TWO-TRACKS, AZTEC, Datamatrix ECC200, QR-Code, PDF417.
|
||||
@@ -0,0 +1,20 @@
|
||||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Upstream-Name: ~#PROJECT#~
|
||||
Source: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
|
||||
Files: *
|
||||
Copyright: Copyright 2001-2026 Nicola Asuni <info@tecnick.com>
|
||||
License: LGPL-3
|
||||
|
||||
License: LGPL-3
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as
|
||||
published by the Free Software Foundation, either version 3 of the
|
||||
License, or (at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/> or
|
||||
/usr/share/common-licenses/LGPL-3
|
||||
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/make -f
|
||||
%:
|
||||
dh $@
|
||||
@@ -0,0 +1 @@
|
||||
3.0 (quilt)
|
||||
@@ -0,0 +1,4 @@
|
||||
version=4
|
||||
opts=filenamemangle=s/.+\/v?(\d[\d\.]+)\.tar\.gz/~#PKGNAME#~_$1.orig.tar.gz/ \
|
||||
https://github.com/~#VENDOR#~/~#PROJECT#~/tags \
|
||||
.*/archive/refs/tags/v?(\d[\d\.]*)\.tar\.gz
|
||||
@@ -0,0 +1,22 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ruleset name="pcsg-generated-ruleset"
|
||||
xmlns="http://pmd.sf.net/ruleset/1.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
|
||||
xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
|
||||
<description>Created with the PHP Coding Standard Generator. http://edorian.github.com/php-coding-standard-generator/
|
||||
</description>
|
||||
<rule ref="rulesets/codesize.xml/CyclomaticComplexity"/>
|
||||
<rule ref="rulesets/codesize.xml/NPathComplexity"/>
|
||||
<rule ref="rulesets/codesize.xml/ExcessiveMethodLength"/>
|
||||
<rule ref="rulesets/codesize.xml/ExcessiveClassLength"/>
|
||||
<rule ref="rulesets/codesize.xml/ExcessiveParameterList"/>
|
||||
<rule ref="rulesets/codesize.xml/ExcessivePublicCount"/>
|
||||
<rule ref="rulesets/codesize.xml/TooManyFields"/>
|
||||
<rule ref="rulesets/codesize.xml/TooManyMethods"/>
|
||||
<rule ref="rulesets/codesize.xml/ExcessiveClassComplexity">
|
||||
<properties>
|
||||
<property name="maximum" value="60"/>
|
||||
</properties>
|
||||
</rule>
|
||||
</ruleset>
|
||||
@@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ruleset name="pcsg-generated-ruleset"
|
||||
xmlns="http://pmd.sf.net/ruleset/1.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
|
||||
xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
|
||||
<description>Created with the PHP Coding Standard Generator. http://edorian.github.com/php-coding-standard-generator/
|
||||
</description>
|
||||
<rule ref="rulesets/design.xml/ExitExpression"/>
|
||||
<rule ref="rulesets/design.xml/EvalExpression"/>
|
||||
<rule ref="rulesets/design.xml/GotoStatement"/>
|
||||
<rule ref="rulesets/design.xml/DepthOfInheritance">
|
||||
<properties>
|
||||
<property name="minimum" value="7"/>
|
||||
</properties>
|
||||
</rule>
|
||||
<rule ref="rulesets/design.xml/CouplingBetweenObjects"/>
|
||||
</ruleset>
|
||||
@@ -0,0 +1,60 @@
|
||||
# SPEC file
|
||||
|
||||
%global c_vendor %{_vendor}
|
||||
%global gh_owner %{_owner}
|
||||
%global gh_project %{_project}
|
||||
|
||||
Name: %{_package}
|
||||
Version: %{_version}
|
||||
Release: %{_release}%{?dist}
|
||||
Summary: PHP library to generate linear and bidimensional barcodes
|
||||
|
||||
License: LGPLv3+
|
||||
URL: https://github.com/%{gh_owner}/%{gh_project}
|
||||
|
||||
BuildArch: noarch
|
||||
|
||||
Requires: php(language) >= 8.2.0
|
||||
Requires: php-composer(%{c_vendor}/tc-lib-color) < 3.0.0
|
||||
Requires: php-composer(%{c_vendor}/tc-lib-color) >= 2.13.3
|
||||
Requires: php-ctype
|
||||
Requires: php-date
|
||||
Requires: php-gd
|
||||
Requires: php-pcre
|
||||
|
||||
Recommends: php-bcmath
|
||||
Recommends: php-pecl-imagick
|
||||
|
||||
Provides: php-composer(%{c_vendor}/%{gh_project}) = %{version}
|
||||
Provides: php-%{gh_project} = %{version}
|
||||
|
||||
%description
|
||||
PHP classes to generate linear and bidimensional barcodes:
|
||||
CODE 39, ANSI MH10.8M-1983, USD-3, 3 of 9, CODE 93, USS-93,
|
||||
Standard 2 of 5, Interleaved 2 of 5, CODE 128 A/B/C,
|
||||
2 and 5 Digits UPC-Based Extension, EAN 8, EAN 13, UPC-A,
|
||||
UPC-E, MSI, POSTNET, PLANET, RMS4CC (Royal Mail 4-state Customer Code),
|
||||
CBC (Customer Bar Code), KIX (Klant index - Customer index),
|
||||
Intelligent Mail Barcode, Onecode, USPS-B-3200, CODABAR, CODE 11,
|
||||
PHARMACODE, PHARMACODE TWO-TRACKS, AZTEC, Datamatrix ECC200, QR-Code, PDF417.
|
||||
|
||||
Optional dependency: php-pecl-imagick
|
||||
|
||||
%build
|
||||
#(cd %{_current_directory} && make build)
|
||||
|
||||
%install
|
||||
rm -rf "%{buildroot}"
|
||||
(cd "%{_current_directory}" && make install DESTDIR="%{buildroot}")
|
||||
|
||||
%files
|
||||
%attr(-,root,root) %{_libpath}
|
||||
%attr(-,root,root) %{_docpath}
|
||||
%docdir %{_docpath}
|
||||
# Optional config files can be listed here when used by a project.
|
||||
|
||||
%changelog
|
||||
* Thu Jul 02 2026 Nicola Asuni <info@tecnick.com> 1.2.0-1
|
||||
- Changed package name, add provides section
|
||||
* Tue Feb 24 2026 Nicola Asuni <info@tecnick.com> 1.0.0-1
|
||||
- Initial Commit
|
||||
+325
@@ -0,0 +1,325 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Barcode.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Barcode
|
||||
*
|
||||
* Barcode Barcode class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Barcode
|
||||
{
|
||||
/**
|
||||
* Maximum accepted length of the barcode payload.
|
||||
*
|
||||
* No single barcode symbology can encode anywhere near this much data
|
||||
* (the densest, QR version 40-L, tops out at ~7089 numeric digits), so
|
||||
* this is a defensive upper bound to reject abusive inputs early, before
|
||||
* any encoder spends time and memory on data it can never represent.
|
||||
*/
|
||||
public const MAX_CODE_LENGTH = 30_000;
|
||||
|
||||
/**
|
||||
* List of supported Barcode Types with description.
|
||||
*
|
||||
* @var array<string, string>
|
||||
*/
|
||||
public const BARCODETYPES = [
|
||||
'C128' => 'CODE 128',
|
||||
'C128A' => 'CODE 128 A',
|
||||
'C128B' => 'CODE 128 B',
|
||||
'C128C' => 'CODE 128 C',
|
||||
'C39' => 'CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.',
|
||||
'C39+' => 'CODE 39 + CHECKSUM',
|
||||
'C39E' => 'CODE 39 EXTENDED',
|
||||
'C39E+' => 'CODE 39 EXTENDED + CHECKSUM',
|
||||
'C93' => 'CODE 93 - USS-93',
|
||||
'CODABAR' => 'CODABAR',
|
||||
'CODE11' => 'CODE 11',
|
||||
'EAN13' => 'EAN 13',
|
||||
'EAN2' => 'EAN 2-Digits UPC-Based Extension',
|
||||
'EAN5' => 'EAN 5-Digits UPC-Based Extension',
|
||||
'EAN8' => 'EAN 8',
|
||||
'I25' => 'Interleaved 2 of 5',
|
||||
'I25+' => 'Interleaved 2 of 5 + CHECKSUM',
|
||||
'IMB' => 'IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200',
|
||||
'IMBPRE' => 'IMB - Intelligent Mail Barcode pre-processed',
|
||||
'KIX' => 'KIX (Klant index - Customer index)',
|
||||
'LRAW' => '1D RAW MODE (comma-separated rows of 01 strings)',
|
||||
'MSI' => 'MSI (Variation of Plessey code)',
|
||||
'MSI+' => 'MSI + CHECKSUM (modulo 11)',
|
||||
'PHARMA' => 'PHARMACODE',
|
||||
'PHARMA2T' => 'PHARMACODE TWO-TRACKS',
|
||||
'PLANET' => 'PLANET',
|
||||
'POSTNET' => 'POSTNET',
|
||||
'RMS4CC' => 'RMS4CC (Royal Mail 4-state Customer Bar Code)',
|
||||
'S25' => 'Standard 2 of 5',
|
||||
'S25+' => 'Standard 2 of 5 + CHECKSUM',
|
||||
'UPCA' => 'UPC-A',
|
||||
'UPCE' => 'UPC-E',
|
||||
'AZTEC' => 'AZTEC Code (ISO/IEC 24778:2008)',
|
||||
'DATAMATRIX' => 'DATAMATRIX (ISO/IEC 16022)',
|
||||
'PDF417' => 'PDF417 (ISO/IEC 15438:2006)',
|
||||
'QRCODE' => 'QR-CODE',
|
||||
'SRAW' => '2D RAW MODE (comma-separated rows of 01 strings)',
|
||||
];
|
||||
|
||||
/**
|
||||
* Get the barcode object
|
||||
*
|
||||
* @param string|BarcodeType $type Barcode type (leading token, optionally followed by
|
||||
* comma-separated extra parameters), or a BarcodeType enum case
|
||||
* @param string $code Barcode content
|
||||
* @param int $width Barcode width in user units (excluding padding).
|
||||
* A negative value indicates the multiplication
|
||||
* factor for each column.
|
||||
* @param int $height Barcode height in user units (excluding padding).
|
||||
* A negative value indicates the multiplication
|
||||
* factor for each row.
|
||||
* @param string $color Foreground color in Web notation
|
||||
* (color name, or hexadecimal code, or CSS syntax)
|
||||
* @param array{int, int, int, int} $padding Additional padding to add around the barcode
|
||||
* (top, right, bottom, left) in user units. A
|
||||
* negative value indicates the multiplication
|
||||
* factor for each row or column.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
* @throws \Com\Tecnick\Color\Exception in case of color parsing errors
|
||||
*/
|
||||
public function getBarcodeObj(
|
||||
string|BarcodeType $type,
|
||||
string $code,
|
||||
int $width = -1,
|
||||
int $height = -1,
|
||||
string $color = 'black',
|
||||
array $padding = [0, 0, 0, 0],
|
||||
): Model {
|
||||
if ($type instanceof BarcodeType) {
|
||||
$type = $type->value;
|
||||
}
|
||||
|
||||
if (\strlen($code) > self::MAX_CODE_LENGTH) {
|
||||
throw new BarcodeException(
|
||||
'The barcode payload is too long: ' . \strlen($code) . ' bytes (maximum ' . self::MAX_CODE_LENGTH . ')',
|
||||
);
|
||||
}
|
||||
|
||||
// extract extra parameters (if any)
|
||||
$params = \explode(',', $type);
|
||||
$type = \array_shift($params);
|
||||
|
||||
return match ($type) {
|
||||
'C128' => new \Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'C128A' => new \Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightA(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'C128B' => new \Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightB(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'C128C' => new \Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightC(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'C39' => new \Com\Tecnick\Barcode\Type\Linear\CodeThreeNine(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'C39+' => new \Com\Tecnick\Barcode\Type\Linear\CodeThreeNineCheck(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'C39E' => new \Com\Tecnick\Barcode\Type\Linear\CodeThreeNineExt(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'C39E+' => new \Com\Tecnick\Barcode\Type\Linear\CodeThreeNineExtCheck(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'C93' => new \Com\Tecnick\Barcode\Type\Linear\CodeNineThree(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'CODABAR' => new \Com\Tecnick\Barcode\Type\Linear\Codabar(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'CODE11' => new \Com\Tecnick\Barcode\Type\Linear\CodeOneOne(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'EAN13' => new \Com\Tecnick\Barcode\Type\Linear\EanOneThree(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'EAN2' => new \Com\Tecnick\Barcode\Type\Linear\EanTwo($code, $width, $height, $color, $params, $padding),
|
||||
'EAN5' => new \Com\Tecnick\Barcode\Type\Linear\EanFive($code, $width, $height, $color, $params, $padding),
|
||||
'EAN8' => new \Com\Tecnick\Barcode\Type\Linear\EanEight($code, $width, $height, $color, $params, $padding),
|
||||
'I25' => new \Com\Tecnick\Barcode\Type\Linear\InterleavedTwoOfFive(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'I25+' => new \Com\Tecnick\Barcode\Type\Linear\InterleavedTwoOfFiveCheck(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'IMB' => new \Com\Tecnick\Barcode\Type\Linear\Imb($code, $width, $height, $color, $params, $padding),
|
||||
'IMBPRE' => new \Com\Tecnick\Barcode\Type\Linear\ImbPre($code, $width, $height, $color, $params, $padding),
|
||||
'KIX' => new \Com\Tecnick\Barcode\Type\Linear\KlantIndex($code, $width, $height, $color, $params, $padding),
|
||||
'LRAW' => new \Com\Tecnick\Barcode\Type\Linear\Raw($code, $width, $height, $color, $params, $padding),
|
||||
'MSI' => new \Com\Tecnick\Barcode\Type\Linear\Msi($code, $width, $height, $color, $params, $padding),
|
||||
'MSI+' => new \Com\Tecnick\Barcode\Type\Linear\MsiCheck($code, $width, $height, $color, $params, $padding),
|
||||
'PHARMA' => new \Com\Tecnick\Barcode\Type\Linear\Pharma($code, $width, $height, $color, $params, $padding),
|
||||
'PHARMA2T' => new \Com\Tecnick\Barcode\Type\Linear\PharmaTwoTracks(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'PLANET' => new \Com\Tecnick\Barcode\Type\Linear\Planet($code, $width, $height, $color, $params, $padding),
|
||||
'POSTNET' => new \Com\Tecnick\Barcode\Type\Linear\Postnet(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'RMS4CC' => new \Com\Tecnick\Barcode\Type\Linear\RoyalMailFourCc(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'S25' => new \Com\Tecnick\Barcode\Type\Linear\StandardTwoOfFive(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'S25+' => new \Com\Tecnick\Barcode\Type\Linear\StandardTwoOfFiveCheck(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'UPCA' => new \Com\Tecnick\Barcode\Type\Linear\UpcA($code, $width, $height, $color, $params, $padding),
|
||||
'UPCE' => new \Com\Tecnick\Barcode\Type\Linear\UpcE($code, $width, $height, $color, $params, $padding),
|
||||
'AZTEC' => new \Com\Tecnick\Barcode\Type\Square\Aztec($code, $width, $height, $color, $params, $padding),
|
||||
'DATAMATRIX' => new \Com\Tecnick\Barcode\Type\Square\Datamatrix(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'PDF417' => new \Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven(
|
||||
$code,
|
||||
$width,
|
||||
$height,
|
||||
$color,
|
||||
$params,
|
||||
$padding,
|
||||
),
|
||||
'QRCODE' => new \Com\Tecnick\Barcode\Type\Square\QrCode($code, $width, $height, $color, $params, $padding),
|
||||
'SRAW' => new \Com\Tecnick\Barcode\Type\Square\Raw($code, $width, $height, $color, $params, $padding),
|
||||
default => throw new BarcodeException('Unsupported barcode type: ' . $type),
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* BarcodeType.php
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\BarcodeType
|
||||
*
|
||||
* Backed enum for the supported barcode symbologies. The backing value of each
|
||||
* case is the leading type token accepted by Barcode::getBarcodeObj() (before
|
||||
* any comma-separated extra parameters).
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
enum BarcodeType: string
|
||||
{
|
||||
case C128 = 'C128';
|
||||
|
||||
case C128A = 'C128A';
|
||||
|
||||
case C128B = 'C128B';
|
||||
|
||||
case C128C = 'C128C';
|
||||
|
||||
case C39 = 'C39';
|
||||
|
||||
case C39Plus = 'C39+';
|
||||
|
||||
case C39E = 'C39E';
|
||||
|
||||
case C39EPlus = 'C39E+';
|
||||
|
||||
case C93 = 'C93';
|
||||
|
||||
case CODABAR = 'CODABAR';
|
||||
|
||||
case CODE11 = 'CODE11';
|
||||
|
||||
case EAN13 = 'EAN13';
|
||||
|
||||
case EAN2 = 'EAN2';
|
||||
|
||||
case EAN5 = 'EAN5';
|
||||
|
||||
case EAN8 = 'EAN8';
|
||||
|
||||
case I25 = 'I25';
|
||||
|
||||
case I25Plus = 'I25+';
|
||||
|
||||
case IMB = 'IMB';
|
||||
|
||||
case IMBPRE = 'IMBPRE';
|
||||
|
||||
case KIX = 'KIX';
|
||||
|
||||
case LRAW = 'LRAW';
|
||||
|
||||
case MSI = 'MSI';
|
||||
|
||||
case MSIPlus = 'MSI+';
|
||||
|
||||
case PHARMA = 'PHARMA';
|
||||
|
||||
case PHARMA2T = 'PHARMA2T';
|
||||
|
||||
case PLANET = 'PLANET';
|
||||
|
||||
case POSTNET = 'POSTNET';
|
||||
|
||||
case RMS4CC = 'RMS4CC';
|
||||
|
||||
case S25 = 'S25';
|
||||
|
||||
case S25Plus = 'S25+';
|
||||
|
||||
case UPCA = 'UPCA';
|
||||
|
||||
case UPCE = 'UPCE';
|
||||
|
||||
case AZTEC = 'AZTEC';
|
||||
|
||||
case DATAMATRIX = 'DATAMATRIX';
|
||||
|
||||
case PDF417 = 'PDF417';
|
||||
|
||||
case QRCODE = 'QRCODE';
|
||||
|
||||
case SRAW = 'SRAW';
|
||||
|
||||
/**
|
||||
* Resolve a loose barcode type token to the matching enum case.
|
||||
*
|
||||
* Accepts the exact leading type token (as validated by getBarcodeObj) or an
|
||||
* enum instance (returned unchanged). Unknown values throw.
|
||||
*
|
||||
* @param string|self $value Barcode type token or enum case.
|
||||
*
|
||||
* @throws BarcodeException if the value does not match a known barcode type.
|
||||
*/
|
||||
public static function fromLoose(string|self $value): self
|
||||
{
|
||||
if ($value instanceof self) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
return self::tryFrom($value) ?? throw new BarcodeException('Unsupported barcode type: ' . $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Exception.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Exception
|
||||
*
|
||||
* Custom Exception class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Exception extends \Exception {}
|
||||
+375
@@ -0,0 +1,375 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Math.php
|
||||
*
|
||||
* @since 2026-08-06
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Math
|
||||
*
|
||||
* Arbitrary precision arithmetic on non-negative decimal integer strings.
|
||||
* The bcmath extension is used when available, otherwise the equivalent
|
||||
* pure-PHP implementation is used, so bcmath is an optional dependency.
|
||||
*
|
||||
* @since 2026-08-06
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
final class Math
|
||||
{
|
||||
/**
|
||||
* Maximum number of digits of a divisor that can be processed as an integer
|
||||
* without overflowing the running remainder, including on 32 bit platforms.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
private const MAX_INT_DIGITS = 8;
|
||||
|
||||
/**
|
||||
* Cached availability of the bcmath functions.
|
||||
*/
|
||||
private static ?bool $bcmath = null;
|
||||
|
||||
/**
|
||||
* Returns true if the bcmath functions are available.
|
||||
*/
|
||||
public static function hasBcmath(): bool
|
||||
{
|
||||
return self::$bcmath ??=
|
||||
\function_exists('bcadd')
|
||||
&& \function_exists('bcmul')
|
||||
&& \function_exists('bcdiv')
|
||||
&& \function_exists('bcmod');
|
||||
}
|
||||
|
||||
/**
|
||||
* Add two non-negative decimal integers.
|
||||
*
|
||||
* @param string $left First operand
|
||||
* @param string $right Second operand
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
public static function add(string $left, string $right): string
|
||||
{
|
||||
if (!self::hasBcmath()) {
|
||||
return self::fallbackAdd($left, $right);
|
||||
}
|
||||
|
||||
return \bcadd(self::normalize($left), self::normalize($right), 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Multiply two non-negative decimal integers.
|
||||
*
|
||||
* @param string $left First operand
|
||||
* @param string $right Second operand
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
public static function mul(string $left, string $right): string
|
||||
{
|
||||
if (!self::hasBcmath()) {
|
||||
return self::fallbackMul($left, $right);
|
||||
}
|
||||
|
||||
return \bcmul(self::normalize($left), self::normalize($right), 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Integer division of two non-negative decimal integers.
|
||||
*
|
||||
* @param string $left Dividend
|
||||
* @param string $right Divisor
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
public static function div(string $left, string $right): string
|
||||
{
|
||||
if (!self::hasBcmath()) {
|
||||
return self::fallbackDiv($left, $right);
|
||||
}
|
||||
|
||||
return \bcdiv(self::normalize($left), self::normalize($right), 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remainder of the integer division of two non-negative decimal integers.
|
||||
*
|
||||
* @param string $left Dividend
|
||||
* @param string $right Divisor
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
public static function mod(string $left, string $right): string
|
||||
{
|
||||
if (!self::hasBcmath()) {
|
||||
return self::fallbackMod($left, $right);
|
||||
}
|
||||
|
||||
return \bcmod(self::normalize($left), self::normalize($right), 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add two non-negative decimal integers without bcmath.
|
||||
*
|
||||
* @param string $left First operand
|
||||
* @param string $right Second operand
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
public static function fallbackAdd(string $left, string $right): string
|
||||
{
|
||||
$lft = self::normalize($left);
|
||||
$rgt = self::normalize($right);
|
||||
$pl = \strlen($lft) - 1;
|
||||
$pr = \strlen($rgt) - 1;
|
||||
$carry = 0;
|
||||
$sum = '';
|
||||
while ($pl >= 0 || $pr >= 0 || $carry > 0) {
|
||||
$digit = $carry;
|
||||
if ($pl >= 0) {
|
||||
$digit += (int) $lft[$pl];
|
||||
--$pl;
|
||||
}
|
||||
|
||||
if ($pr >= 0) {
|
||||
$digit += (int) $rgt[$pr];
|
||||
--$pr;
|
||||
}
|
||||
|
||||
$sum = (string) ($digit % 10) . $sum;
|
||||
$carry = \intdiv($digit, 10);
|
||||
}
|
||||
|
||||
return self::normalize($sum);
|
||||
}
|
||||
|
||||
/**
|
||||
* Multiply two non-negative decimal integers without bcmath.
|
||||
*
|
||||
* @param string $left First operand
|
||||
* @param string $right Second operand
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
public static function fallbackMul(string $left, string $right): string
|
||||
{
|
||||
$lft = self::normalize($left);
|
||||
$rgt = self::normalize($right);
|
||||
if ($lft === '0' || $rgt === '0') {
|
||||
return '0';
|
||||
}
|
||||
|
||||
$llen = \strlen($lft);
|
||||
$rlen = \strlen($rgt);
|
||||
// partial products, least significant digit first
|
||||
$digits = \array_fill(0, $llen + $rlen, 0);
|
||||
for ($pl = $llen - 1; $pl >= 0; --$pl) {
|
||||
$mul = (int) $lft[$pl];
|
||||
$carry = 0;
|
||||
$pos = $llen - 1 - $pl;
|
||||
for ($pr = $rlen - 1; $pr >= 0; --$pr) {
|
||||
$cur = ($digits[$pos] ?? 0) + ($mul * (int) $rgt[$pr]) + $carry;
|
||||
$digits[$pos] = $cur % 10;
|
||||
$carry = \intdiv($cur, 10);
|
||||
++$pos;
|
||||
}
|
||||
|
||||
while ($carry > 0) {
|
||||
$cur = ($digits[$pos] ?? 0) + $carry;
|
||||
$digits[$pos] = $cur % 10;
|
||||
$carry = \intdiv($cur, 10);
|
||||
++$pos;
|
||||
}
|
||||
}
|
||||
|
||||
$product = '';
|
||||
foreach ($digits as $digit) {
|
||||
$product = (string) $digit . $product;
|
||||
}
|
||||
|
||||
return self::normalize($product);
|
||||
}
|
||||
|
||||
/**
|
||||
* Integer division of two non-negative decimal integers without bcmath.
|
||||
*
|
||||
* @param string $left Dividend
|
||||
* @param string $right Divisor
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
public static function fallbackDiv(string $left, string $right): string
|
||||
{
|
||||
return self::fallbackDivMod($left, $right)[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* Remainder of the integer division of two non-negative decimal integers without bcmath.
|
||||
*
|
||||
* @param string $left Dividend
|
||||
* @param string $right Divisor
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
public static function fallbackMod(string $left, string $right): string
|
||||
{
|
||||
return self::fallbackDivMod($left, $right)[1];
|
||||
}
|
||||
|
||||
/**
|
||||
* Long division of two non-negative decimal integers.
|
||||
*
|
||||
* @param string $left Dividend
|
||||
* @param string $right Divisor
|
||||
*
|
||||
* @return array{numeric-string, numeric-string} Quotient and remainder
|
||||
*/
|
||||
private static function fallbackDivMod(string $left, string $right): array
|
||||
{
|
||||
$lft = self::normalize($left);
|
||||
$rgt = self::normalize($right);
|
||||
if ($rgt === '0') {
|
||||
throw new \DivisionByZeroError('Division by zero');
|
||||
}
|
||||
|
||||
// divisors small enough to keep the running remainder inside an integer
|
||||
if (\strlen($rgt) <= self::MAX_INT_DIGITS) {
|
||||
return self::fallbackDivModInt($lft, (int) $rgt);
|
||||
}
|
||||
|
||||
$quotient = '';
|
||||
$remainder = '0';
|
||||
$len = \strlen($lft);
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
// shift the next dividend digit into the remainder
|
||||
$remainder = self::normalize($remainder . $lft[$pos]);
|
||||
$digit = 0;
|
||||
while (self::compare($remainder, $rgt) >= 0) {
|
||||
$remainder = self::subtract($remainder, $rgt);
|
||||
++$digit;
|
||||
}
|
||||
|
||||
$quotient .= (string) $digit;
|
||||
}
|
||||
|
||||
return [self::normalize($quotient), $remainder];
|
||||
}
|
||||
|
||||
/**
|
||||
* Long division of a non-negative decimal integer by an integer divisor.
|
||||
*
|
||||
* @param numeric-string $left Normalized dividend
|
||||
* @param int $right Divisor greater than zero
|
||||
*
|
||||
* @return array{numeric-string, numeric-string} Quotient and remainder
|
||||
*/
|
||||
private static function fallbackDivModInt(string $left, int $right): array
|
||||
{
|
||||
$quotient = '';
|
||||
$remainder = 0;
|
||||
$len = \strlen($left);
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
$remainder = ($remainder * 10) + (int) $left[$pos];
|
||||
$quotient .= (string) \intdiv($remainder, $right);
|
||||
$remainder %= $right;
|
||||
}
|
||||
|
||||
return [self::normalize($quotient), (string) $remainder];
|
||||
}
|
||||
|
||||
/**
|
||||
* Compare two normalized non-negative decimal integers.
|
||||
*
|
||||
* @param string $left First operand
|
||||
* @param string $right Second operand
|
||||
*
|
||||
* @return int Negative if left is lower, zero if equal, positive if left is greater
|
||||
*/
|
||||
private static function compare(string $left, string $right): int
|
||||
{
|
||||
$llen = \strlen($left);
|
||||
$rlen = \strlen($right);
|
||||
if ($llen !== $rlen) {
|
||||
return $llen <=> $rlen;
|
||||
}
|
||||
|
||||
return \strcmp($left, $right);
|
||||
}
|
||||
|
||||
/**
|
||||
* Subtract two normalized non-negative decimal integers, where the first one is the greater.
|
||||
*
|
||||
* @param string $left Minuend
|
||||
* @param string $right Subtrahend
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
private static function subtract(string $left, string $right): string
|
||||
{
|
||||
$pl = \strlen($left) - 1;
|
||||
$pr = \strlen($right) - 1;
|
||||
$borrow = 0;
|
||||
$diff = '';
|
||||
while ($pl >= 0) {
|
||||
$digit = (int) $left[$pl] - $borrow;
|
||||
if ($pr >= 0) {
|
||||
$digit -= (int) $right[$pr];
|
||||
--$pr;
|
||||
}
|
||||
|
||||
if ($digit < 0) {
|
||||
$digit += 10;
|
||||
$borrow = 1;
|
||||
} else {
|
||||
$borrow = 0;
|
||||
}
|
||||
|
||||
$diff = (string) $digit . $diff;
|
||||
--$pl;
|
||||
}
|
||||
|
||||
return self::normalize($diff);
|
||||
}
|
||||
|
||||
/**
|
||||
* Strip the leading zeros from a non-negative decimal integer string.
|
||||
*
|
||||
* @param string $number Number to normalize
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
private static function normalize(string $number): string
|
||||
{
|
||||
if ($number === '' || !\ctype_digit($number)) {
|
||||
throw new \ValueError('Expecting a non-negative decimal integer string');
|
||||
}
|
||||
|
||||
$number = \ltrim($number, '0');
|
||||
if ($number === '') {
|
||||
return '0';
|
||||
}
|
||||
|
||||
/** @var numeric-string */
|
||||
return $number;
|
||||
}
|
||||
}
|
||||
+201
@@ -0,0 +1,201 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Model.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
use Com\Tecnick\Color\Exception as ColorException;
|
||||
use Com\Tecnick\Color\Model\Rgb;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Model
|
||||
*
|
||||
* Barcode Model interface
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
interface Model
|
||||
{
|
||||
/**
|
||||
* Set the size of the barcode to be exported
|
||||
*
|
||||
* @param int $width Barcode width in user units (excluding padding).
|
||||
* A negative value indicates the multiplication
|
||||
* factor for each column.
|
||||
* @param int $height Barcode height in user units (excluding padding).
|
||||
* A negative value indicates the multiplication
|
||||
* factor for each row.
|
||||
* @param array{int, int, int, int} $padding Additional padding to add around the barcode
|
||||
* (top, right, bottom, left) in user units. A
|
||||
* negative value indicates the number of rows
|
||||
* or columns.
|
||||
*/
|
||||
public function setSize(int $width, int $height, array $padding = [0, 0, 0, 0]): static;
|
||||
|
||||
/**
|
||||
* Set the color of the bars.
|
||||
* An empty or transparent foreground color is rejected with a BarcodeException.
|
||||
*
|
||||
* @param string $color Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax)
|
||||
*
|
||||
* @throws ColorException in case of color error
|
||||
* @throws BarcodeException in case of empty or transparent color
|
||||
*/
|
||||
public function setColor(string $color): static;
|
||||
|
||||
/**
|
||||
* Set the background color
|
||||
*
|
||||
* @param string $color Background color in Web notation (color name, or hexadecimal code, or CSS syntax)
|
||||
*
|
||||
* @throws ColorException in case of color error
|
||||
*/
|
||||
public function setBackgroundColor(string $color): static;
|
||||
|
||||
/**
|
||||
* Get the barcode raw array
|
||||
*
|
||||
* @return array{
|
||||
* 'type': string,
|
||||
* 'format': string,
|
||||
* 'params': array<int|float|string>,
|
||||
* 'code': string,
|
||||
* 'extcode': string,
|
||||
* 'ncols': int,
|
||||
* 'nrows': int,
|
||||
* 'width': int,
|
||||
* 'height': int,
|
||||
* 'width_ratio': float,
|
||||
* 'height_ratio': float,
|
||||
* 'padding': array{'T': int, 'R': int, 'B': int, 'L': int},
|
||||
* 'full_width': int,
|
||||
* 'full_height': int,
|
||||
* 'color_obj': Rgb,
|
||||
* 'bg_color_obj': ?Rgb,
|
||||
* 'bars': array<array{int, int, int, int}>,
|
||||
* }
|
||||
*/
|
||||
public function getArray(): array;
|
||||
|
||||
/**
|
||||
* Get the extended code (code + checksum)
|
||||
*/
|
||||
public function getExtendedCode(): string;
|
||||
|
||||
/**
|
||||
* Get the barcode as SVG image object
|
||||
*
|
||||
* @param string|null $filename The file name without extension (optional).
|
||||
* Only allows alphanumeric characters, underscores and hyphens.
|
||||
* Defaults to a md5 hash of the data.
|
||||
* The file extension is always '.svg'.
|
||||
*/
|
||||
public function getSvg(?string $filename = null): void;
|
||||
|
||||
/**
|
||||
* Get the barcode as inline SVG code.
|
||||
*
|
||||
* @return string Inline SVG code.
|
||||
*/
|
||||
public function getInlineSvgCode(): string;
|
||||
|
||||
/**
|
||||
* Get the barcode as SVG code, including the XML declaration.
|
||||
*
|
||||
* @return string SVG code
|
||||
*/
|
||||
public function getSvgCode(): string;
|
||||
|
||||
/**
|
||||
* Get an HTML representation of the barcode.
|
||||
*
|
||||
* @return string HTML code (DIV block)
|
||||
*/
|
||||
public function getHtmlDiv(): string;
|
||||
|
||||
/**
|
||||
* Get Barcode as PNG Image (requires GD or Imagick library)
|
||||
*
|
||||
* @param string|null $filename The file name without extension (optional).
|
||||
* Only allows alphanumeric characters, underscores and hyphens.
|
||||
* Defaults to a md5 hash of the data.
|
||||
* The file extension is always '.png'.
|
||||
*/
|
||||
public function getPng(?string $filename = null): void;
|
||||
|
||||
/**
|
||||
* Get the barcode as PNG image (requires GD or Imagick library)
|
||||
*
|
||||
* @param bool $imagick If true try to use the Imagick extension
|
||||
*
|
||||
* @return string PNG image data
|
||||
*/
|
||||
public function getPngData(bool $imagick = true): string;
|
||||
|
||||
/**
|
||||
* Get the barcode as PNG image (requires Imagick library)
|
||||
*
|
||||
* @throws BarcodeException if the Imagick library is not installed
|
||||
*/
|
||||
public function getPngDataImagick(): string;
|
||||
|
||||
/**
|
||||
* Get the barcode as GD image object (requires GD library)
|
||||
*
|
||||
* @throws BarcodeException if the GD library is not installed
|
||||
*/
|
||||
public function getGd(): \GdImage;
|
||||
|
||||
/**
|
||||
* Get a raw barcode string representation using characters
|
||||
*
|
||||
* @param string $space_char Character or string to use for filling empty spaces
|
||||
* @param string $bar_char Character or string to use for filling bars
|
||||
*/
|
||||
public function getGrid(string $space_char = '0', string $bar_char = '1'): string;
|
||||
|
||||
/**
|
||||
* Get a raw barcode grid array
|
||||
*
|
||||
* @param string $space_char Character or string to use for filling empty spaces
|
||||
* @param string $bar_char Character or string to use for filling bars
|
||||
*
|
||||
* @return array<int, array<int, string>>
|
||||
*/
|
||||
public function getGridArray(string $space_char = '0', string $bar_char = '1'): array;
|
||||
|
||||
/**
|
||||
* Get the array containing all the formatted bars coordinates
|
||||
*
|
||||
* @return array<int, array{float, float, float, float}>
|
||||
*/
|
||||
public function getBarsArrayXYXY(): array;
|
||||
|
||||
/**
|
||||
* Get the array containing all the formatted bars coordinates
|
||||
*
|
||||
* @return array<int, array{float, float, float, float}>
|
||||
*/
|
||||
public function getBarsArrayXYWH(): array;
|
||||
}
|
||||
+737
@@ -0,0 +1,737 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Type.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
use Com\Tecnick\Color\Exception as ColorException;
|
||||
use Com\Tecnick\Color\Model\Rgb;
|
||||
use Com\Tecnick\Color\Pdf;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type
|
||||
*
|
||||
* Barcode Type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
|
||||
*/
|
||||
abstract class Type extends \Com\Tecnick\Barcode\Type\Convert implements Model
|
||||
{
|
||||
/**
|
||||
* Initialize a new barcode object
|
||||
*
|
||||
* @param string $code Barcode content
|
||||
* @param int $width Barcode width in user units (excluding padding).
|
||||
* A negative value indicates the multiplication
|
||||
* factor for each column.
|
||||
* @param int $height Barcode height in user units (excluding padding).
|
||||
* A negative value indicates the multiplication
|
||||
* factor for each row.
|
||||
* @param string $color Foreground color in Web notation
|
||||
* (color name, or hexadecimal code, or CSS syntax)
|
||||
* @param array<int|float|string> $params Array containing extra parameters for the specified barcode type
|
||||
* @param array{int, int, int, int} $padding Additional padding to add around the barcode
|
||||
* (top, right, bottom, left) in user units. A
|
||||
* negative value indicates the number of rows
|
||||
* or columns.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
* @throws ColorException in case of color error
|
||||
*/
|
||||
public function __construct(
|
||||
string $code,
|
||||
int $width = -1,
|
||||
int $height = -1,
|
||||
string $color = 'black',
|
||||
array $params = [],
|
||||
array $padding = [0, 0, 0, 0],
|
||||
) {
|
||||
$this->code = $code;
|
||||
$this->extcode = $code;
|
||||
$this->params = $params;
|
||||
$this->setParameters();
|
||||
$this->setBars();
|
||||
$this->setSize($width, $height, $padding);
|
||||
$this->setColor($color);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set extra (optional) parameters
|
||||
*/
|
||||
protected function setParameters(): void {}
|
||||
|
||||
/**
|
||||
* Set the bars array
|
||||
*/
|
||||
protected function setBars(): void {}
|
||||
|
||||
/**
|
||||
* Set the size of the barcode to be exported
|
||||
*
|
||||
* @param int $width Barcode width in user units (excluding padding).
|
||||
* A negative value indicates the multiplication
|
||||
* factor for each column.
|
||||
* @param int $height Barcode height in user units (excluding padding).
|
||||
* A negative value indicates the multiplication
|
||||
* factor for each row.
|
||||
* @param array{int, int, int, int} $padding Additional padding to add around the barcode
|
||||
* (top, right, bottom, left) in user units. A
|
||||
* negative value indicates the number of rows
|
||||
* or columns.
|
||||
*
|
||||
* @throws BarcodeException in case of an empty barcode or invalid padding
|
||||
*/
|
||||
public function setSize(int $width, int $height, array $padding = [0, 0, 0, 0]): static
|
||||
{
|
||||
if ($this->ncols <= 0 || $this->nrows <= 0) {
|
||||
throw new BarcodeException('Empty barcode: the number of rows and columns must be greater than zero');
|
||||
}
|
||||
|
||||
$this->width = $width;
|
||||
if ($this->width <= 0) {
|
||||
$this->width = \abs(\min(-1, $this->width)) * $this->ncols;
|
||||
}
|
||||
|
||||
$this->height = $height;
|
||||
if ($this->height <= 0) {
|
||||
$this->height = \abs(\min(-1, $this->height)) * $this->nrows;
|
||||
}
|
||||
|
||||
$this->width_ratio = $this->width / $this->ncols;
|
||||
$this->height_ratio = $this->height / $this->nrows;
|
||||
|
||||
$this->setPadding($padding);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the barcode padding
|
||||
*
|
||||
* @param array{int, int, int, int} $padding Additional padding to add around the barcode
|
||||
* (top, right, bottom, left) in user units.
|
||||
* A negative value indicates the number of rows or columns.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setPadding(array $padding): static
|
||||
{
|
||||
if (\count($padding) !== 4) {
|
||||
throw new BarcodeException('Invalid padding, expecting an array of 4 numbers (top, right, bottom, left)');
|
||||
}
|
||||
|
||||
foreach ($padding as $key => $val) {
|
||||
$side = match ($key) {
|
||||
0 => 'T',
|
||||
1 => 'R',
|
||||
2 => 'B',
|
||||
3 => 'L',
|
||||
};
|
||||
$ratio = match ($key) {
|
||||
0, 2 => $this->height_ratio,
|
||||
1, 3 => $this->width_ratio,
|
||||
};
|
||||
if ($val < 0) {
|
||||
$val = \abs(\min(-1, $val)) * $ratio;
|
||||
}
|
||||
|
||||
$this->padding[$side] = (int) $val;
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, float> $rgbcolor
|
||||
*/
|
||||
protected function getRgbComponent(array $rgbcolor, string $channel): float
|
||||
{
|
||||
return $rgbcolor[$channel] ?? 0.0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the color of the bars.
|
||||
* An empty or transparent foreground color is rejected with a BarcodeException.
|
||||
*
|
||||
* @param string $color Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax)
|
||||
*
|
||||
* @throws ColorException in case of color error
|
||||
* @throws BarcodeException in case of empty or transparent color
|
||||
*/
|
||||
public function setColor(string $color): static
|
||||
{
|
||||
$colobj = $this->getRgbColorObject($color);
|
||||
if (!$colobj instanceof \Com\Tecnick\Color\Model\Rgb) {
|
||||
throw new BarcodeException('The foreground color cannot be empty or transparent');
|
||||
}
|
||||
|
||||
$this->color_obj = $colobj;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the background color
|
||||
*
|
||||
* @param string $color Background color in Web notation (color name, or hexadecimal code, or CSS syntax)
|
||||
*
|
||||
* @throws ColorException in case of color error
|
||||
*/
|
||||
public function setBackgroundColor(string $color): static
|
||||
{
|
||||
$this->bg_color_obj = $this->getRgbColorObject($color);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the RGB Color object for the given color representation
|
||||
*
|
||||
* @param string $color Color in Web notation (color name, or hexadecimal code, or CSS syntax)
|
||||
*
|
||||
* @throws ColorException in case of color error
|
||||
*/
|
||||
protected function getRgbColorObject(string $color): ?Rgb
|
||||
{
|
||||
$pdf = new Pdf();
|
||||
$cobj = $pdf->getColorObject($color);
|
||||
if ($cobj instanceof \Com\Tecnick\Color\Model) {
|
||||
return new Rgb($cobj->toRgbArray());
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the barcode raw array
|
||||
*
|
||||
* @return array{
|
||||
* 'type': string,
|
||||
* 'format': string,
|
||||
* 'params': array<int|float|string>,
|
||||
* 'code': string,
|
||||
* 'extcode': string,
|
||||
* 'ncols': int,
|
||||
* 'nrows': int,
|
||||
* 'width': int,
|
||||
* 'height': int,
|
||||
* 'width_ratio': float,
|
||||
* 'height_ratio': float,
|
||||
* 'padding': array{'T': int, 'R': int, 'B': int, 'L': int},
|
||||
* 'full_width': int,
|
||||
* 'full_height': int,
|
||||
* 'color_obj': Rgb,
|
||||
* 'bg_color_obj': ?Rgb,
|
||||
* 'bars': array<array{int, int, int, int}>,
|
||||
* }
|
||||
*/
|
||||
public function getArray(): array
|
||||
{
|
||||
return [
|
||||
'type' => $this::TYPE,
|
||||
'format' => $this::FORMAT,
|
||||
'params' => $this->params,
|
||||
'code' => $this->code,
|
||||
'extcode' => $this->extcode,
|
||||
'ncols' => $this->ncols,
|
||||
'nrows' => $this->nrows,
|
||||
'width' => $this->width,
|
||||
'height' => $this->height,
|
||||
'width_ratio' => $this->width_ratio,
|
||||
'height_ratio' => $this->height_ratio,
|
||||
'padding' => $this->padding,
|
||||
'full_width' => $this->width + $this->padding['L'] + $this->padding['R'],
|
||||
'full_height' => $this->height + $this->padding['T'] + $this->padding['B'],
|
||||
'color_obj' => $this->color_obj,
|
||||
'bg_color_obj' => $this->bg_color_obj,
|
||||
'bars' => $this->bars,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the extended code (code + checksum)
|
||||
*/
|
||||
public function getExtendedCode(): string
|
||||
{
|
||||
return $this->extcode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends the data as file to the browser.
|
||||
*
|
||||
* @param string $data The file data.
|
||||
* @param string $mime The file MIME type (i.e. 'application/svg+xml' or 'image/png').
|
||||
* @param string $fileext The file extension (i.e. 'svg' or 'png').
|
||||
* @param string|null $filename The file name without extension (optional).
|
||||
* Only allows alphanumeric characters, underscores and hyphens.
|
||||
* Defaults to a md5 hash of the data.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function getHTTPFile(string $data, string $mime, string $fileext, ?string $filename = null): void
|
||||
{
|
||||
if (\is_null($filename) || \preg_match('/^[a-zA-Z0-9_\-]{1,250}$/', $filename) !== 1) {
|
||||
$filename = \md5($data);
|
||||
}
|
||||
|
||||
\header('Content-Type: ' . $mime);
|
||||
\header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
|
||||
\header('Pragma: public');
|
||||
\header('Expires: Thu, 04 jan 1973 00:00:00 GMT'); // Date in the past
|
||||
\header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
|
||||
\header('Content-Disposition: inline; filename="' . $filename . '.' . $fileext . '";');
|
||||
if (($_SERVER['HTTP_ACCEPT_ENCODING'] ?? null) === null) {
|
||||
// the content length may vary if the server is using compression
|
||||
\header('Content-Length: ' . \strlen($data));
|
||||
}
|
||||
|
||||
echo $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the barcode as SVG image object.
|
||||
*
|
||||
* @param string|null $filename The file name without extension (optional).
|
||||
* Only allows alphanumeric characters, underscores and hyphens.
|
||||
* Defaults to a md5 hash of the data.
|
||||
* The file extension is always '.svg'.
|
||||
*/
|
||||
public function getSvg(?string $filename = null): void
|
||||
{
|
||||
$this->getHTTPFile($this->getSvgCode(), 'application/svg+xml', 'svg', $filename);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the barcode as inline SVG code.
|
||||
*
|
||||
* @return string Inline SVG code.
|
||||
*/
|
||||
public function getInlineSvgCode(): string
|
||||
{
|
||||
// flags for htmlspecialchars
|
||||
$hflag = ENT_NOQUOTES;
|
||||
if (\defined('ENT_XML1') && \defined('ENT_DISALLOWED')) {
|
||||
$hflag = ENT_XML1 | ENT_DISALLOWED;
|
||||
}
|
||||
|
||||
$width = \sprintf('%F', $this->width + $this->padding['L'] + $this->padding['R']);
|
||||
$height = \sprintf('%F', $this->height + $this->padding['T'] + $this->padding['B']);
|
||||
|
||||
$svg =
|
||||
'<svg'
|
||||
. ' version="1.2"'
|
||||
. ' baseProfile="full"'
|
||||
. ' xmlns="http://www.w3.org/2000/svg"'
|
||||
. ' xmlns:xlink="http://www.w3.org/1999/xlink"'
|
||||
. ' xmlns:ev="http://www.w3.org/2001/xml-events"'
|
||||
. ' width="'
|
||||
. $width
|
||||
. '"'
|
||||
. ' height="'
|
||||
. $height
|
||||
. '"'
|
||||
. ' viewBox="0 0 '
|
||||
. $width
|
||||
. ' '
|
||||
. $height
|
||||
. '"'
|
||||
. '>'
|
||||
. "\n"
|
||||
. "\t"
|
||||
. '<desc>'
|
||||
. \htmlspecialchars($this->code, $hflag, 'UTF-8')
|
||||
. '</desc>'
|
||||
. "\n";
|
||||
if ($this->bg_color_obj instanceof \Com\Tecnick\Color\Model\Rgb) {
|
||||
$svg .=
|
||||
' <rect x="0" y="0" width="'
|
||||
. $width
|
||||
. '"'
|
||||
. ' height="'
|
||||
. $height
|
||||
. '"'
|
||||
. ' fill="'
|
||||
. $this->bg_color_obj->getRgbHexColor()
|
||||
. '"'
|
||||
. ' stroke="none"'
|
||||
. ' stroke-width="0"'
|
||||
. ' stroke-linecap="square"'
|
||||
. ' />'
|
||||
. "\n";
|
||||
}
|
||||
|
||||
$svg .=
|
||||
' <g id="bars" fill="'
|
||||
. $this->color_obj->getRgbHexColor()
|
||||
. '"'
|
||||
. ' stroke="none"'
|
||||
. ' stroke-width="0"'
|
||||
. ' stroke-linecap="square"'
|
||||
. '>'
|
||||
. "\n";
|
||||
$bars = $this->getBarsArrayXYWH();
|
||||
foreach ($bars as $bar) {
|
||||
$svg .= \sprintf(
|
||||
' <rect x="%F" y="%F" width="%F" height="%F" />' . "\n",
|
||||
$bar[0],
|
||||
$bar[1],
|
||||
$bar[2],
|
||||
$bar[3],
|
||||
);
|
||||
}
|
||||
|
||||
return $svg . (' </g>' . "\n" . '</svg>' . "\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the barcode as SVG code, including the XML declaration.
|
||||
*
|
||||
* @return string SVG code
|
||||
*/
|
||||
public function getSvgCode(): string
|
||||
{
|
||||
return '<?xml version="1.0" standalone="no" ?>' . "\n" . $this->getInlineSvgCode();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an HTML representation of the barcode.
|
||||
*
|
||||
* @return string HTML code (DIV block)
|
||||
*/
|
||||
public function getHtmlDiv(): string
|
||||
{
|
||||
$html = \sprintf(
|
||||
'<div style="width:%Fpx;height:%Fpx;position:relative;font-size:0;border:none;padding:0;margin:0;',
|
||||
$this->width + $this->padding['L'] + $this->padding['R'],
|
||||
$this->height + $this->padding['T'] + $this->padding['B'],
|
||||
);
|
||||
if ($this->bg_color_obj instanceof \Com\Tecnick\Color\Model\Rgb) {
|
||||
$html .= 'background-color:' . $this->bg_color_obj->getCssColor() . ';';
|
||||
}
|
||||
|
||||
$html .= '">' . "\n";
|
||||
$bars = $this->getBarsArrayXYWH();
|
||||
foreach ($bars as $bar) {
|
||||
$html .= \sprintf(
|
||||
' <div style="background-color:%s;left:%Fpx;top:%Fpx;width:%Fpx;height:%Fpx;position:absolute;border:none;padding:0;margin:0;"> </div>'
|
||||
. "\n",
|
||||
$this->color_obj->getCssColor(),
|
||||
$bar[0],
|
||||
$bar[1],
|
||||
$bar[2],
|
||||
$bar[3],
|
||||
);
|
||||
}
|
||||
|
||||
return $html . ('</div>' . "\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Barcode as PNG Image (requires GD or Imagick library)
|
||||
*
|
||||
* @param string|null $filename The file name without extension (optional).
|
||||
* Only allows alphanumeric characters, underscores and hyphens.
|
||||
* Defaults to a md5 hash of the data.
|
||||
* The file extension is always '.png'.
|
||||
*
|
||||
* @throws BarcodeException in case image generation fails
|
||||
*/
|
||||
public function getPng(?string $filename = null): void
|
||||
{
|
||||
$this->getHTTPFile($this->getPngData(), 'image/png', 'png', $filename);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the barcode as PNG image (requires GD or Imagick library)
|
||||
*
|
||||
* @param bool $imagick If true try to use the Imagick extension
|
||||
*
|
||||
* @return string PNG image data
|
||||
*
|
||||
* @throws BarcodeException in case image generation fails
|
||||
*/
|
||||
public function getPngData(bool $imagick = true): string
|
||||
{
|
||||
if ($imagick && \extension_loaded('imagick')) {
|
||||
return $this->getPngDataImagick();
|
||||
}
|
||||
|
||||
$gdImage = $this->getGd();
|
||||
\ob_start();
|
||||
\imagepng($gdImage);
|
||||
$data = \ob_get_clean();
|
||||
if ($data === false) {
|
||||
throw new BarcodeException('Unable to get PNG data');
|
||||
}
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Maximum width or height, in pixels, of a rendered barcode image.
|
||||
* Guards against pathological size multipliers triggering huge allocations.
|
||||
*/
|
||||
protected const MAX_IMAGE_SIDE = 30_000;
|
||||
|
||||
/**
|
||||
* Compute and validate the rendered image dimensions, in pixels.
|
||||
*
|
||||
* @return array{int, int} [width, height], each at least 1 pixel
|
||||
*
|
||||
* @throws BarcodeException if the requested image size is too large
|
||||
*/
|
||||
protected function getImageSize(): array
|
||||
{
|
||||
$width = \max(1, (int) \ceil($this->width + $this->padding['L'] + $this->padding['R']));
|
||||
$height = \max(1, (int) \ceil($this->height + $this->padding['T'] + $this->padding['B']));
|
||||
if ($width > self::MAX_IMAGE_SIDE || $height > self::MAX_IMAGE_SIDE) {
|
||||
throw new BarcodeException(
|
||||
'The requested image size ('
|
||||
. $width
|
||||
. 'x'
|
||||
. $height
|
||||
. ' px) exceeds the maximum of '
|
||||
. self::MAX_IMAGE_SIDE
|
||||
. ' px per side',
|
||||
);
|
||||
}
|
||||
|
||||
return [$width, $height];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the barcode as PNG image (requires Imagick library)
|
||||
*
|
||||
* @throws BarcodeException if the Imagick library is not installed or the image is too large
|
||||
*/
|
||||
public function getPngDataImagick(): string
|
||||
{
|
||||
$imagick = new \Imagick();
|
||||
[$width, $height] = $this->getImageSize();
|
||||
$imagick->newImage($width, $height, 'none', 'png');
|
||||
$imagickdraw = new \ImagickDraw();
|
||||
if ($this->bg_color_obj instanceof \Com\Tecnick\Color\Model\Rgb) {
|
||||
$rgbcolor = $this->bg_color_obj->getNormalizedArray(255);
|
||||
$imagickdraw->setfillcolor(
|
||||
'rgb('
|
||||
. (string) $this->getRgbComponent($rgbcolor, 'R')
|
||||
. ','
|
||||
. (string) $this->getRgbComponent($rgbcolor, 'G')
|
||||
. ','
|
||||
. (string) $this->getRgbComponent($rgbcolor, 'B')
|
||||
. ')',
|
||||
);
|
||||
$imagickdraw->rectangle(0, 0, $width, $height);
|
||||
}
|
||||
|
||||
$rgbcolor = $this->color_obj->getNormalizedArray(255);
|
||||
$imagickdraw->setfillcolor(
|
||||
'rgb('
|
||||
. (string) $this->getRgbComponent($rgbcolor, 'R')
|
||||
. ','
|
||||
. (string) $this->getRgbComponent($rgbcolor, 'G')
|
||||
. ','
|
||||
. (string) $this->getRgbComponent($rgbcolor, 'B')
|
||||
. ')',
|
||||
);
|
||||
$bars = $this->getBarsArrayXYXY();
|
||||
foreach ($bars as $bar) {
|
||||
$imagickdraw->rectangle($bar[0], $bar[1], $bar[2], $bar[3]);
|
||||
}
|
||||
|
||||
$imagick->drawimage($imagickdraw);
|
||||
return $imagick->getImageBlob();
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply GD background color/alpha strategy.
|
||||
*
|
||||
* @throws BarcodeException if background allocation fails
|
||||
*/
|
||||
protected function applyGdBackground(\GdImage $img, int $width, int $height): void
|
||||
{
|
||||
$bgColorObj = $this->bg_color_obj;
|
||||
if ($bgColorObj instanceof \Com\Tecnick\Color\Model\Rgb) {
|
||||
$rgbcolor = $bgColorObj->getNormalizedArray(255);
|
||||
$bg_color = \imagecolorallocate(
|
||||
$img,
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'R')),
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'G')),
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'B')),
|
||||
);
|
||||
if ($bg_color === false) {
|
||||
throw new BarcodeException('Unable to allocate GD background color');
|
||||
}
|
||||
\imagefilledrectangle($img, 0, 0, $width, $height, $bg_color);
|
||||
return;
|
||||
}
|
||||
|
||||
$bgobj = clone $this->color_obj;
|
||||
$rgbcolor = $bgobj->invertColor()->getNormalizedArray(255);
|
||||
$background_color = \imagecolorallocate(
|
||||
$img,
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'R')),
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'G')),
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'B')),
|
||||
);
|
||||
if ($background_color === false) {
|
||||
throw new BarcodeException('Unable to allocate default GD background color');
|
||||
}
|
||||
\imagecolortransparent($img, $background_color);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the barcode as GD image object (requires GD library)
|
||||
*
|
||||
* @throws BarcodeException if the GD library is not installed or the image is too large
|
||||
*/
|
||||
public function getGd(): \GdImage
|
||||
{
|
||||
[$width, $height] = $this->getImageSize();
|
||||
$img = \imagecreate($width, $height);
|
||||
if ($img === false) {
|
||||
throw new BarcodeException('Unable to create GD image');
|
||||
}
|
||||
|
||||
$this->applyGdBackground($img, $width, $height);
|
||||
|
||||
$rgbcolor = $this->color_obj->getNormalizedArray(255);
|
||||
$bar_color = \imagecolorallocate(
|
||||
$img,
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'R')),
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'G')),
|
||||
(int) \round($this->getRgbComponent($rgbcolor, 'B')),
|
||||
);
|
||||
if ($bar_color === false) {
|
||||
throw new BarcodeException('Unable to allocate GD foreground color');
|
||||
}
|
||||
$bars = $this->getBarsArrayXYXY();
|
||||
foreach ($bars as $bar) {
|
||||
\imagefilledrectangle(
|
||||
$img,
|
||||
(int) \floor($bar[0]),
|
||||
(int) \floor($bar[1]),
|
||||
(int) \floor($bar[2]),
|
||||
(int) \floor($bar[3]),
|
||||
$bar_color,
|
||||
);
|
||||
}
|
||||
|
||||
return $img;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a raw barcode string representation using characters
|
||||
*
|
||||
* @param string $space_char Character or string to use for filling empty spaces
|
||||
* @param string $bar_char Character or string to use for filling bars
|
||||
*/
|
||||
public function getGrid(string $space_char = '0', string $bar_char = '1'): string
|
||||
{
|
||||
$raw = $this->getGridArray($space_char, $bar_char);
|
||||
$grid = '';
|
||||
foreach ($raw as $row) {
|
||||
$grid .= \implode('', $row) . "\n";
|
||||
}
|
||||
|
||||
return $grid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the array containing all the formatted bars coordinates
|
||||
*
|
||||
* @return array<int, array{float, float, float, float}>
|
||||
*/
|
||||
public function getBarsArrayXYXY(): array
|
||||
{
|
||||
$rect = [];
|
||||
foreach ($this->bars as $bar) {
|
||||
if ($bar[2] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($bar[3] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$rect[] = $this->getBarRectXYXY($bar);
|
||||
}
|
||||
|
||||
if ($this->nrows > 1) {
|
||||
// reprint rotated to cancel row gaps
|
||||
$rot = $this->getRotatedBarArray();
|
||||
foreach ($rot as $bar) {
|
||||
if ($bar[2] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($bar[3] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$rect[] = $this->getBarRectXYXY($bar);
|
||||
}
|
||||
}
|
||||
|
||||
return $rect;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the array containing all the formatted bars coordinates
|
||||
*
|
||||
* @return array<int, array{float, float, float, float}>
|
||||
*/
|
||||
public function getBarsArrayXYWH(): array
|
||||
{
|
||||
$rect = [];
|
||||
foreach ($this->bars as $bar) {
|
||||
if ($bar[2] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($bar[3] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$rect[] = $this->getBarRectXYWH($bar);
|
||||
}
|
||||
|
||||
if ($this->nrows > 1) {
|
||||
// reprint rotated to cancel row gaps
|
||||
$rot = $this->getRotatedBarArray();
|
||||
foreach ($rot as $bar) {
|
||||
if ($bar[2] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($bar[3] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$rect[] = $this->getBarRectXYWH($bar);
|
||||
}
|
||||
}
|
||||
|
||||
return $rect;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,400 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Convert.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
use Com\Tecnick\Barcode\Math;
|
||||
use Com\Tecnick\Color\Model\Rgb as Color;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Convert
|
||||
*
|
||||
* Barcode Convert class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Convert
|
||||
{
|
||||
/**
|
||||
* Barcode type (linear or square)
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const TYPE = '';
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = '';
|
||||
|
||||
/**
|
||||
* Array containing extra parameters for the specified barcode type
|
||||
*
|
||||
* @var array<int|float|string>
|
||||
*/
|
||||
protected array $params = [];
|
||||
|
||||
/**
|
||||
* Code to convert (barcode content)
|
||||
*/
|
||||
protected string $code = '';
|
||||
|
||||
/**
|
||||
* Resulting code after applying checksum etc.
|
||||
*/
|
||||
protected string $extcode = '';
|
||||
|
||||
/**
|
||||
* Total number of columns
|
||||
*/
|
||||
protected int $ncols = 0;
|
||||
|
||||
/**
|
||||
* Total number of rows
|
||||
*/
|
||||
protected int $nrows = 1;
|
||||
|
||||
/**
|
||||
* Array containing the position and dimensions of each barcode bar
|
||||
* (x, y, width, height)
|
||||
*
|
||||
* @var array<array{int, int, int, int}>
|
||||
*/
|
||||
protected array $bars = [];
|
||||
|
||||
/**
|
||||
* Barcode width
|
||||
*/
|
||||
protected int $width = 0;
|
||||
|
||||
/**
|
||||
* Barcode height
|
||||
*/
|
||||
protected int $height = 0;
|
||||
|
||||
/**
|
||||
* Additional padding to add around the barcode (top, right, bottom, left) in user units.
|
||||
* A negative value indicates the multiplication factor for each row or column.
|
||||
*
|
||||
* @var array{'T': int, 'R': int, 'B': int, 'L': int}
|
||||
*/
|
||||
protected array $padding = [
|
||||
'T' => 0,
|
||||
'R' => 0,
|
||||
'B' => 0,
|
||||
'L' => 0,
|
||||
];
|
||||
|
||||
/**
|
||||
* Ratio between the barcode width and the number of columns
|
||||
*/
|
||||
protected float $width_ratio = 0;
|
||||
|
||||
/**
|
||||
* Ratio between the barcode height and the number of rows
|
||||
*/
|
||||
protected float $height_ratio = 0;
|
||||
|
||||
/**
|
||||
* Foreground Color object
|
||||
*/
|
||||
protected Color $color_obj;
|
||||
|
||||
/**
|
||||
* Background Color object
|
||||
*/
|
||||
protected ?Color $bg_color_obj = null;
|
||||
|
||||
/**
|
||||
* Process binary sequence rows.
|
||||
*
|
||||
* @param array<int, string|array<int>> $rows Binary sequence data to process
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function processBinarySequence(array $rows): void
|
||||
{
|
||||
if ($rows === []) {
|
||||
throw new BarcodeException('Empty input string');
|
||||
}
|
||||
|
||||
$this->nrows = \count($rows);
|
||||
$firstRow = $rows[0] ?? '';
|
||||
$this->ncols = \is_array($firstRow) ? \count($firstRow) : \strlen($firstRow);
|
||||
|
||||
if ($this->ncols === 0) {
|
||||
throw new BarcodeException('Empty columns');
|
||||
}
|
||||
|
||||
$this->bars = [];
|
||||
foreach ($rows as $posy => $row) {
|
||||
if (!\is_array($row)) {
|
||||
$row = \str_split($row, 1);
|
||||
}
|
||||
|
||||
$prevcol = '';
|
||||
$bar_width = 0;
|
||||
$row[] = '0';
|
||||
for ($posx = 0; $posx <= $this->ncols; ++$posx) {
|
||||
if (($row[$posx] ?? '0') !== $prevcol) {
|
||||
if ($prevcol === '1') {
|
||||
$this->bars[] = [$posx - $bar_width, $posy, $bar_width, 1];
|
||||
}
|
||||
|
||||
$bar_width = 0;
|
||||
}
|
||||
|
||||
++$bar_width;
|
||||
$prevcol = (string) ($row[$posx] ?? '0');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract rows from a binary sequence of comma-separated 01 strings.
|
||||
*
|
||||
* @return array<int, string>
|
||||
*
|
||||
* @throws BarcodeException in case of invalid input pattern
|
||||
*/
|
||||
protected function getRawCodeRows(string $data): array
|
||||
{
|
||||
$search = [
|
||||
'/[\s]*/s', // remove spaces and newlines
|
||||
'/^[\[,]+/', // remove leading brackets or commas
|
||||
'/[\],]+$/', // remove trailing brackets or commas
|
||||
'/[\]][\[]/', // convert bracket-separated rows to comma-separated
|
||||
];
|
||||
|
||||
$replace = ['', '', '', ','];
|
||||
|
||||
$code = \preg_replace($search, $replace, $data);
|
||||
if ($code === null) {
|
||||
throw new BarcodeException('Invalid input string');
|
||||
}
|
||||
|
||||
return \explode(',', $code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add two non-negative decimal integers.
|
||||
*
|
||||
* @param numeric-string $left First operand
|
||||
* @param numeric-string $right Second operand
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
protected function addNumeric(string $left, string $right): string
|
||||
{
|
||||
return Math::add($left, $right);
|
||||
}
|
||||
|
||||
/**
|
||||
* Multiply two non-negative decimal integers.
|
||||
*
|
||||
* @param numeric-string $left First operand
|
||||
* @param numeric-string $right Second operand
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
protected function mulNumeric(string $left, string $right): string
|
||||
{
|
||||
return Math::mul($left, $right);
|
||||
}
|
||||
|
||||
/**
|
||||
* Integer division of two non-negative decimal integers.
|
||||
*
|
||||
* @param numeric-string $left Dividend
|
||||
* @param numeric-string $right Divisor
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
protected function divNumeric(string $left, string $right): string
|
||||
{
|
||||
return Math::div($left, $right);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remainder of the integer division of two non-negative decimal integers.
|
||||
*
|
||||
* @param numeric-string $left Dividend
|
||||
* @param numeric-string $right Divisor
|
||||
*/
|
||||
protected function modNumeric(string $left, string $right): int
|
||||
{
|
||||
return (int) Math::mod($left, $right);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert large integer number to hexadecimal representation.
|
||||
*
|
||||
* @param string $number Number to convert (as string)
|
||||
*
|
||||
* @return string hexadecimal representation
|
||||
*/
|
||||
protected function convertDecToHex(string $number): string
|
||||
{
|
||||
if (!\preg_match('/^[0-9]+$/', $number)) {
|
||||
return '00';
|
||||
}
|
||||
|
||||
$number = \ltrim($number, '0');
|
||||
if ($number === '') {
|
||||
return '00';
|
||||
}
|
||||
|
||||
/** @var numeric-string $number */
|
||||
$hex = [];
|
||||
while ($number !== '0') {
|
||||
$hex[] = \strtoupper(\dechex($this->modNumeric($number, '16')));
|
||||
$number = $this->divNumeric($number, '16');
|
||||
}
|
||||
|
||||
$hex = \array_reverse($hex);
|
||||
return \implode('', $hex);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert large hexadecimal number to decimal representation (string).
|
||||
*
|
||||
* @param string $hex Hexadecimal number to convert (as string)
|
||||
*
|
||||
* @return numeric-string decimal representation
|
||||
*/
|
||||
protected function convertHexToDec(string $hex): string
|
||||
{
|
||||
$dec = '0';
|
||||
$bitval = '1';
|
||||
$len = \strlen($hex);
|
||||
for ($pos = $len - 1; $pos >= 0; --$pos) {
|
||||
$dec = $this->addNumeric($dec, $this->mulNumeric((string) \hexdec($hex[$pos]), $bitval));
|
||||
$bitval = $this->mulNumeric($bitval, '16');
|
||||
}
|
||||
|
||||
return $dec;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a raw barcode grid array
|
||||
*
|
||||
* @param string $space_char Character or string to use for filling empty spaces
|
||||
* @param string $bar_char Character or string to use for filling bars
|
||||
*
|
||||
* @return array<int, array<int, string>>
|
||||
*/
|
||||
public function getGridArray(string $space_char = '0', string $bar_char = '1'): array
|
||||
{
|
||||
$raw = \array_fill(0, \max(0, $this->nrows), \array_fill(0, \max(0, $this->ncols), $space_char));
|
||||
foreach ($this->bars as $bar) {
|
||||
if ($bar[2] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($bar[3] <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
for ($vert = 0; $vert < $bar[3]; ++$vert) {
|
||||
for ($horiz = 0; $horiz < $bar[2]; ++$horiz) {
|
||||
$raw[$bar[1] + $vert][$bar[0] + $horiz] = $bar_char;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $raw;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the bars array ordered by columns
|
||||
*
|
||||
* @return array<int, array{int, int, int, int}>
|
||||
*/
|
||||
protected function getRotatedBarArray(): array
|
||||
{
|
||||
$grid = $this->getGridArray();
|
||||
if ($grid === []) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$cols = \array_map(null, ...$grid);
|
||||
$bars = [];
|
||||
foreach ($cols as $posx => $col) {
|
||||
$prevrow = '';
|
||||
$bar_height = 0;
|
||||
$col[] = '0';
|
||||
for ($posy = 0; $posy <= $this->nrows; ++$posy) {
|
||||
if (($col[$posy] ?? '0') !== $prevrow) {
|
||||
if ($prevrow === '1') {
|
||||
$bars[] = [$posx, $posy - $bar_height, 1, $bar_height];
|
||||
}
|
||||
|
||||
$bar_height = 0;
|
||||
}
|
||||
|
||||
++$bar_height;
|
||||
$prevrow = $col[$posy] ?? '0';
|
||||
}
|
||||
}
|
||||
|
||||
return $bars;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the adjusted rectangular coordinates (x1,y1,x2,y2) for the specified bar
|
||||
*
|
||||
* @param array{int, int, int, int} $bar Raw bar coordinates
|
||||
*
|
||||
* @return array{float, float, float, float} Bar coordinates
|
||||
*/
|
||||
protected function getBarRectXYXY(array $bar): array
|
||||
{
|
||||
return [
|
||||
$this->padding['L'] + ($bar[0] * $this->width_ratio),
|
||||
$this->padding['T'] + ($bar[1] * $this->height_ratio),
|
||||
$this->padding['L'] + (($bar[0] + $bar[2]) * $this->width_ratio) - 1,
|
||||
$this->padding['T'] + (($bar[1] + $bar[3]) * $this->height_ratio) - 1,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the adjusted rectangular coordinates (x,y,w,h) for the specified bar
|
||||
*
|
||||
* @param array{int, int, int, int} $bar Raw bar coordinates
|
||||
*
|
||||
* @return array{float, float, float, float} Bar coordinates
|
||||
*/
|
||||
protected function getBarRectXYWH(array $bar): array
|
||||
{
|
||||
return [
|
||||
$this->padding['L'] + ($bar[0] * $this->width_ratio),
|
||||
$this->padding['T'] + ($bar[1] * $this->height_ratio),
|
||||
$bar[2] * $this->width_ratio,
|
||||
$bar[3] * $this->height_ratio,
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Linear.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear
|
||||
*
|
||||
* Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Linear extends \Com\Tecnick\Barcode\Type
|
||||
{
|
||||
/**
|
||||
* Barcode type
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const TYPE = 'linear';
|
||||
}
|
||||
@@ -0,0 +1,117 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Codabar.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\Codabar;
|
||||
*
|
||||
* Codabar Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Codabar extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
protected function getBarWidth(string $char, int $pos): int
|
||||
{
|
||||
$pattern = $this::CHBAR[$char] ?? '11111111';
|
||||
return (int) ($pattern[$pos] ?? '1');
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'CODABAR';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '11111221',
|
||||
'1' => '11112211',
|
||||
'2' => '11121121',
|
||||
'3' => '22111111',
|
||||
'4' => '11211211',
|
||||
'5' => '21111211',
|
||||
'6' => '12111121',
|
||||
'7' => '12112111',
|
||||
'8' => '12211111',
|
||||
'9' => '21121111',
|
||||
'-' => '11122111',
|
||||
'$' => '11221111',
|
||||
':' => '21112121',
|
||||
'/' => '21211121',
|
||||
'.' => '21212111',
|
||||
'+' => '11222221',
|
||||
'A' => '11221211',
|
||||
'B' => '12121121',
|
||||
'C' => '11121221',
|
||||
'D' => '11122211',
|
||||
];
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = 'A' . \strtoupper($this->code) . 'A';
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 1;
|
||||
$this->bars = [];
|
||||
$this->formatCode();
|
||||
$clen = \strlen($this->extcode);
|
||||
for ($chr = 0; $chr < $clen; ++$chr) {
|
||||
$char = $this->extcode[$chr];
|
||||
if (!\array_key_exists($char, $this::CHBAR)) {
|
||||
throw new BarcodeException('Invalid character: ' . (\ord($char) & 0xFF));
|
||||
}
|
||||
|
||||
for ($pos = 0; $pos < 8; ++$pos) {
|
||||
$bar_width = $this->getBarWidth($char, $pos);
|
||||
if (($pos % 2) === 0) {
|
||||
$this->bars[] = [$this->ncols, 0, $bar_width, 1];
|
||||
}
|
||||
|
||||
$this->ncols += $bar_width;
|
||||
}
|
||||
}
|
||||
|
||||
--$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,373 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeNineThree.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeNineThree;
|
||||
*
|
||||
* CodeNineThree Barcode type class
|
||||
* CODE 93 - USS-93
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeNineThree extends \Com\Tecnick\Barcode\Type\Linear\CodeThreeNineExtCheck
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C93';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
32 => '311211', // space
|
||||
36 => '321111', // $
|
||||
37 => '211131', // %
|
||||
42 => '111141', // start-stop
|
||||
43 => '113121', // +
|
||||
45 => '121131', // -
|
||||
46 => '311112', // .
|
||||
47 => '112131', // /
|
||||
48 => '131112', // 0
|
||||
49 => '111213', // 1
|
||||
50 => '111312', // 2
|
||||
51 => '111411', // 3
|
||||
52 => '121113', // 4
|
||||
53 => '121212', // 5
|
||||
54 => '121311', // 6
|
||||
55 => '111114', // 7
|
||||
56 => '131211', // 8
|
||||
57 => '141111', // 9
|
||||
65 => '211113', // A
|
||||
66 => '211212', // B
|
||||
67 => '211311', // C
|
||||
68 => '221112', // D
|
||||
69 => '221211', // E
|
||||
70 => '231111', // F
|
||||
71 => '112113', // G
|
||||
72 => '112212', // H
|
||||
73 => '112311', // I
|
||||
74 => '122112', // J
|
||||
75 => '132111', // K
|
||||
76 => '111123', // L
|
||||
77 => '111222', // M
|
||||
78 => '111321', // N
|
||||
79 => '121122', // O
|
||||
80 => '131121', // P
|
||||
81 => '212112', // Q
|
||||
82 => '212211', // R
|
||||
83 => '211122', // S
|
||||
84 => '211221', // T
|
||||
85 => '221121', // U
|
||||
86 => '222111', // V
|
||||
87 => '112122', // W
|
||||
88 => '112221', // X
|
||||
89 => '122121', // Y
|
||||
90 => '123111', // Z
|
||||
128 => '121221', // ($)
|
||||
129 => '311121', // (/)
|
||||
130 => '122211', // (+)
|
||||
131 => '312111', // (%)
|
||||
];
|
||||
|
||||
/**
|
||||
* Map for extended characters
|
||||
*
|
||||
* @var array<string>
|
||||
*/
|
||||
protected const EXTCODES = [
|
||||
"\x83U",
|
||||
"\x80A",
|
||||
"\x80B",
|
||||
"\x80C",
|
||||
"\x80D",
|
||||
"\x80E",
|
||||
"\x80F",
|
||||
"\x80G",
|
||||
"\x80H",
|
||||
"\x80I",
|
||||
"\x80J",
|
||||
"\x80K",
|
||||
"\x80L",
|
||||
"\x80M",
|
||||
"\x80N",
|
||||
"\x80O",
|
||||
"\x80P",
|
||||
"\x80Q",
|
||||
"\x80R",
|
||||
"\x80S",
|
||||
"\x80T",
|
||||
"\x80U",
|
||||
"\x80V",
|
||||
"\x80W",
|
||||
"\x80X",
|
||||
"\x80Y",
|
||||
"\x80Z",
|
||||
"\x83A",
|
||||
"\x83B",
|
||||
"\x83C",
|
||||
"\x83D",
|
||||
"\x83E",
|
||||
' ',
|
||||
"\x81A",
|
||||
"\x81B",
|
||||
"\x81C",
|
||||
"\x81D",
|
||||
"\x81E",
|
||||
|
||||
"\x81F",
|
||||
"\x81G",
|
||||
"\x81H",
|
||||
"\x81I",
|
||||
"\x81J",
|
||||
"\x81K",
|
||||
"\x81L",
|
||||
'-',
|
||||
'.',
|
||||
"\x81O",
|
||||
'0',
|
||||
'1',
|
||||
'2',
|
||||
'3',
|
||||
'4',
|
||||
'5',
|
||||
'6',
|
||||
'7',
|
||||
'8',
|
||||
'9',
|
||||
"\x81Z",
|
||||
"\x83F",
|
||||
"\x83G",
|
||||
"\x83H",
|
||||
"\x83I",
|
||||
"\x83J",
|
||||
"\x83V",
|
||||
'A',
|
||||
'B',
|
||||
'C',
|
||||
'D',
|
||||
'E',
|
||||
'F',
|
||||
'G',
|
||||
'H',
|
||||
'I',
|
||||
'J',
|
||||
'K',
|
||||
'L',
|
||||
'M',
|
||||
'N',
|
||||
'O',
|
||||
'P',
|
||||
'Q',
|
||||
'R',
|
||||
'S',
|
||||
'T',
|
||||
'U',
|
||||
'V',
|
||||
'W',
|
||||
'X',
|
||||
'Y',
|
||||
'Z',
|
||||
"\x83K",
|
||||
"\x83L",
|
||||
"\x83M",
|
||||
"\x83N",
|
||||
"\x83O",
|
||||
"\x83W",
|
||||
"\x82A",
|
||||
"\x82B",
|
||||
"\x82C",
|
||||
"\x82D",
|
||||
"\x82E",
|
||||
"\x82F",
|
||||
"\x82G",
|
||||
"\x82H",
|
||||
"\x82I",
|
||||
"\x82J",
|
||||
"\x82K",
|
||||
"\x82L",
|
||||
"\x82M",
|
||||
"\x82N",
|
||||
"\x82O",
|
||||
"\x82P",
|
||||
"\x82Q",
|
||||
"\x82R",
|
||||
"\x82S",
|
||||
"\x82T",
|
||||
"\x82U",
|
||||
"\x82V",
|
||||
"\x82W",
|
||||
"\x82X",
|
||||
"\x82Y",
|
||||
"\x82Z",
|
||||
"\x83P",
|
||||
"\x83Q",
|
||||
"\x83R",
|
||||
"\x83S",
|
||||
"\x83T",
|
||||
];
|
||||
|
||||
/**
|
||||
* Characters used for checksum
|
||||
*
|
||||
* @var array<string>
|
||||
*/
|
||||
protected const CHKSUM = [
|
||||
'0',
|
||||
'1',
|
||||
'2',
|
||||
'3',
|
||||
'4',
|
||||
'5',
|
||||
'6',
|
||||
'7',
|
||||
'8',
|
||||
'9',
|
||||
'A',
|
||||
'B',
|
||||
'C',
|
||||
'D',
|
||||
'E',
|
||||
'F',
|
||||
'G',
|
||||
'H',
|
||||
'I',
|
||||
'J',
|
||||
'K',
|
||||
'L',
|
||||
'M',
|
||||
'N',
|
||||
'O',
|
||||
'P',
|
||||
'Q',
|
||||
'R',
|
||||
'S',
|
||||
'T',
|
||||
'U',
|
||||
'V',
|
||||
'W',
|
||||
'X',
|
||||
'Y',
|
||||
'Z',
|
||||
'-',
|
||||
'.',
|
||||
' ',
|
||||
'$',
|
||||
'/',
|
||||
'+',
|
||||
'%',
|
||||
'<',
|
||||
'=',
|
||||
'>',
|
||||
'?',
|
||||
];
|
||||
|
||||
protected function getBarPattern(int $char): string
|
||||
{
|
||||
return $this::CHBAR[$char] ?? '000000';
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate CODE 93 checksum (modulo 47).
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return string char checksum.
|
||||
*/
|
||||
protected function getChecksum(string $code): string
|
||||
{
|
||||
// translate special characters
|
||||
$code = \strtr($code, \chr(128) . \chr(131) . \chr(129) . \chr(130), '<=>?');
|
||||
$clen = \strlen($code);
|
||||
// calculate check digit C
|
||||
$pck = 1;
|
||||
$check = 0;
|
||||
for ($idx = $clen - 1; $idx >= 0; --$idx) {
|
||||
$check += $this->getChecksumIndex($code[$idx]) * $pck;
|
||||
++$pck;
|
||||
if ($pck > 20) {
|
||||
$pck = 1;
|
||||
}
|
||||
}
|
||||
|
||||
$check %= 47;
|
||||
$chk = $this->getChecksumChar($check);
|
||||
$code .= $chk;
|
||||
// calculate check digit K
|
||||
$pck = 1;
|
||||
$check = 0;
|
||||
for ($idx = $clen; $idx >= 0; --$idx) {
|
||||
$check += $this->getChecksumIndex($code[$idx]) * $pck;
|
||||
++$pck;
|
||||
if ($pck > 15) {
|
||||
$pck = 1;
|
||||
}
|
||||
}
|
||||
|
||||
$check %= 47;
|
||||
$key = $this->getChecksumChar($check);
|
||||
$checksum = $chk . $key;
|
||||
// restore special characters
|
||||
return \strtr($checksum, '<=>?', \chr(128) . \chr(131) . \chr(129) . \chr(130));
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.ExcessiveMethodLength")
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 1;
|
||||
$this->bars = [];
|
||||
$this->formatCode();
|
||||
$clen = \strlen($this->extcode);
|
||||
for ($chr = 0; $chr < $clen; ++$chr) {
|
||||
$char = \ord($this->extcode[$chr]);
|
||||
$pattern = $this->getBarPattern($char);
|
||||
for ($pos = 0; $pos < 6; ++$pos) {
|
||||
$bar_width = (int) ($pattern[$pos] ?? '0');
|
||||
if (($pos % 2) === 0) {
|
||||
$this->bars[] = [$this->ncols, 0, $bar_width, 1];
|
||||
}
|
||||
|
||||
$this->ncols += $bar_width;
|
||||
}
|
||||
}
|
||||
|
||||
$this->bars[] = [$this->ncols, 0, 1, 1];
|
||||
++$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,163 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeOneOne.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeOneOne;
|
||||
*
|
||||
* CodeOneOne Barcode type class
|
||||
* CODE 11
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeOneOne extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
protected function getBarWidth(string $char, int $pos): int
|
||||
{
|
||||
$pattern = $this::CHBAR[$char] ?? '000000';
|
||||
return (int) ($pattern[$pos] ?? '0');
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'CODE11';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '111121',
|
||||
'1' => '211121',
|
||||
'2' => '121121',
|
||||
'3' => '221111',
|
||||
'4' => '112121',
|
||||
'5' => '212111',
|
||||
'6' => '122111',
|
||||
'7' => '111221',
|
||||
'8' => '211211',
|
||||
'9' => '211111',
|
||||
'-' => '112111',
|
||||
'S' => '112211',
|
||||
];
|
||||
|
||||
/**
|
||||
* Calculate the checksum.
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return string char checksum.
|
||||
*/
|
||||
protected function getChecksum(string $code): string
|
||||
{
|
||||
$len = \strlen($code);
|
||||
// calculate check digit C
|
||||
$ptr = 1;
|
||||
$cval = 0;
|
||||
for ($pos = $len - 1; $pos >= 0; --$pos) {
|
||||
$digit = $code[$pos];
|
||||
$dval = $digit === '-' ? 10 : (int) $digit;
|
||||
|
||||
$cval += $dval * $ptr;
|
||||
++$ptr;
|
||||
if ($ptr > 10) {
|
||||
$ptr = 1;
|
||||
}
|
||||
}
|
||||
|
||||
$cval %= 11;
|
||||
$ccheck = $cval === 10 ? '-' : (string) $cval;
|
||||
|
||||
if ($len <= 10) {
|
||||
return $ccheck;
|
||||
}
|
||||
|
||||
// calculate check digit K (computed over the code with the C check digit appended)
|
||||
$code .= $ccheck;
|
||||
$klen = \strlen($code);
|
||||
$ptr = 1;
|
||||
$kval = 0;
|
||||
for ($pos = $klen - 1; $pos >= 0; --$pos) {
|
||||
$digit = $code[$pos];
|
||||
$dval = $digit === '-' ? 10 : (int) $digit;
|
||||
|
||||
$kval += $dval * $ptr;
|
||||
++$ptr;
|
||||
if ($ptr > 9) {
|
||||
$ptr = 1;
|
||||
}
|
||||
}
|
||||
|
||||
$kval %= 11;
|
||||
$kcheck = $kval === 10 ? '-' : (string) $kval;
|
||||
|
||||
return $ccheck . $kcheck;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = 'S' . $this->code . $this->getChecksum($this->code) . 'S';
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 1;
|
||||
$this->bars = [];
|
||||
$this->formatCode();
|
||||
$clen = \strlen($this->extcode);
|
||||
for ($chr = 0; $chr < $clen; ++$chr) {
|
||||
$char = $this->extcode[$chr];
|
||||
if (!\array_key_exists($char, $this::CHBAR)) {
|
||||
throw new BarcodeException('Invalid character: ' . (\ord($char) & 0xFF));
|
||||
}
|
||||
|
||||
for ($pos = 0; $pos < 6; ++$pos) {
|
||||
$bar_width = $this->getBarWidth($char, $pos);
|
||||
if (($pos % 2) === 0 && $bar_width > 0) {
|
||||
$this->bars[] = [$this->ncols, 0, $bar_width, 1];
|
||||
}
|
||||
|
||||
$this->ncols += $bar_width;
|
||||
}
|
||||
}
|
||||
|
||||
--$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,267 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeOneTwoEight.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight;
|
||||
*
|
||||
* CodeOneTwoEight Barcode type class
|
||||
* CODE 128
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeOneTwoEight extends \Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\Process
|
||||
{
|
||||
/**
|
||||
* Get the code point array
|
||||
*
|
||||
* @return array<int, int>
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCodeData(): array
|
||||
{
|
||||
$code = $this->code;
|
||||
// array of symbols
|
||||
$code_data = [];
|
||||
// split code into sequences
|
||||
$sequence = $this->getNumericSequence($code);
|
||||
// process the sequence
|
||||
$startid = 0;
|
||||
foreach ($sequence as $key => $seq) {
|
||||
switch ($seq[0]) {
|
||||
case 'A':
|
||||
$this->processSequenceA($sequence, $code_data, $startid, $key, $seq);
|
||||
break;
|
||||
case 'B':
|
||||
$this->processSequenceB($sequence, $code_data, $startid, $key, $seq);
|
||||
break;
|
||||
case 'C':
|
||||
$this->processSequenceC($sequence, $code_data, $startid, $key, $seq);
|
||||
break;
|
||||
default:
|
||||
throw new BarcodeException('Invalid sequence mode');
|
||||
}
|
||||
}
|
||||
|
||||
return $this->finalizeCodeData($code_data, $startid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, array{0: string, 1: string, 2: int, 3?: string}> $sequence
|
||||
*/
|
||||
protected function getSequenceMode(array $sequence, int $key): string
|
||||
{
|
||||
return $sequence[$key][0] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, array{0: string, 1: string, 2: int, 3?: string}> $sequence
|
||||
*/
|
||||
protected function hasSequenceShift(array $sequence, int $key): bool
|
||||
{
|
||||
return ($sequence[$key][3] ?? null) !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Process the A sequence
|
||||
*
|
||||
* @param array<int, array{0: string, 1: string, 2: int, 3?: string}> $sequence Sequence to process
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param int $startid Start ID
|
||||
* @param int $key Sequence current key
|
||||
* @param array{string, string, int} $seq Sequence current value
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function processSequenceA(array &$sequence, array &$code_data, int &$startid, int $key, array $seq): void
|
||||
{
|
||||
$prev_mode = $this->getSequenceMode($sequence, $key - 1);
|
||||
if ($key === 0) {
|
||||
$startid = 103;
|
||||
}
|
||||
|
||||
if ($key !== 0 && $prev_mode !== 'A') {
|
||||
$hasPrevShift = $this->hasSequenceShift($sequence, $key - 1);
|
||||
$singleShift = $seq[2] === 1 && $prev_mode === 'B' && !$hasPrevShift;
|
||||
$codeSwitch = match (true) {
|
||||
$singleShift => 98,
|
||||
!$hasPrevShift => 101,
|
||||
default => null,
|
||||
};
|
||||
|
||||
if ($codeSwitch !== null) {
|
||||
$code_data[] = $codeSwitch;
|
||||
if ($codeSwitch === 98) {
|
||||
// mark single shift
|
||||
$sequence[$key][3] = '';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$this->getCodeDataA($code_data, $seq[1], (int) $seq[2]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Process the B sequence
|
||||
*
|
||||
* @param array<int, array{0: string, 1: string, 2: int, 3?: string}> $sequence Sequence to process
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param int $startid Start ID
|
||||
* @param int $key Sequence current key
|
||||
* @param array{string, string, int} $seq Sequence current value
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function processSequenceB(array &$sequence, array &$code_data, int &$startid, int $key, array $seq): void
|
||||
{
|
||||
$prev_mode = $this->getSequenceMode($sequence, $key - 1);
|
||||
if ($key === 0) {
|
||||
$this->processSequenceBA($sequence, $code_data, $startid, $key, $seq);
|
||||
}
|
||||
|
||||
if ($key !== 0 && $prev_mode !== 'B') {
|
||||
$this->processSequenceBB($sequence, $code_data, $key, $seq);
|
||||
}
|
||||
|
||||
$this->getCodeDataB($code_data, $seq[1], (int) $seq[2]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Process the B-A sequence
|
||||
*
|
||||
* @param array<int, array{0: string, 1: string, 2: int, 3?: string}> $sequence Sequence to process
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param int $startid Start ID
|
||||
* @param int $key Sequence current key
|
||||
* @param array{string, string, int} $seq Sequence current value
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function processSequenceBA(array &$sequence, array &$code_data, int &$startid, int $key, array $seq): void
|
||||
{
|
||||
$tmpchr = \ord($seq[1][0]);
|
||||
$next_mode = $this->getSequenceMode($sequence, $key + 1);
|
||||
$startid = 104;
|
||||
if ($seq[2] === 1 && $tmpchr >= 241 && $tmpchr <= 244 && $next_mode !== '' && $next_mode !== 'B') {
|
||||
switch ($next_mode) {
|
||||
case 'A':
|
||||
$startid = 103;
|
||||
$sequence[$key][0] = 'A';
|
||||
$code_data[] = $this->getFncAValue($tmpchr);
|
||||
break;
|
||||
case 'C':
|
||||
$startid = 105;
|
||||
$sequence[$key][0] = 'C';
|
||||
$code_data[] = $this->getFncAValue($tmpchr);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Process the B-B sequence
|
||||
*
|
||||
* @param array<int, array{0: string, 1: string, 2: int, 3?: string}> $sequence Sequence to process
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param int $key Sequence current key
|
||||
* @param array{string, string, int} $seq Sequence current value
|
||||
*/
|
||||
protected function processSequenceBB(array &$sequence, array &$code_data, int $key, array $seq): void
|
||||
{
|
||||
$prev_mode = $this->getSequenceMode($sequence, $key - 1);
|
||||
$hasPrevShift = $this->hasSequenceShift($sequence, $key - 1);
|
||||
$singleShift = $seq[2] === 1 && $prev_mode === 'A' && !$hasPrevShift;
|
||||
$codeSwitch = match (true) {
|
||||
$singleShift => 98,
|
||||
!$hasPrevShift => 100,
|
||||
default => null,
|
||||
};
|
||||
|
||||
if ($codeSwitch !== null) {
|
||||
$code_data[] = $codeSwitch;
|
||||
if ($codeSwitch === 98) {
|
||||
// mark single shift
|
||||
$sequence[$key][3] = '';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Process the C sequence
|
||||
*
|
||||
* @param array<int, array{0: string, 1: string, 2: int, 3?: string}> $sequence Sequence to process
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param int $startid Start ID
|
||||
* @param int $key Sequence current key
|
||||
* @param array{string, string, int} $seq Sequence current value
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function processSequenceC(array &$sequence, array &$code_data, int &$startid, int $key, array $seq): void
|
||||
{
|
||||
$prev_mode = $this->getSequenceMode($sequence, $key - 1);
|
||||
if ($key === 0) {
|
||||
$startid = 105;
|
||||
}
|
||||
|
||||
if ($key !== 0 && $prev_mode !== 'C') {
|
||||
$code_data[] = 99;
|
||||
}
|
||||
|
||||
$this->getCodeDataC($code_data, $seq[1]);
|
||||
}
|
||||
|
||||
protected function getBarPattern(int $value): string
|
||||
{
|
||||
return $this::CHBAR[$value] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$code_data = $this->getCodeData();
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 1;
|
||||
$this->bars = [];
|
||||
foreach ($code_data as $val) {
|
||||
$seq = $this->getBarPattern($val);
|
||||
for ($pos = 0; $pos < 6; ++$pos) {
|
||||
$bar_width = (int) ($seq[$pos] ?? '0');
|
||||
if (($pos % 2) === 0 && $bar_width > 0) {
|
||||
$this->bars[] = [$this->ncols, 0, $bar_width, 1];
|
||||
}
|
||||
|
||||
$this->ncols += $bar_width;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+61
@@ -0,0 +1,61 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeOneTwoEightA.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightA;
|
||||
*
|
||||
* CodeOneTwoEightA Barcode type class
|
||||
* CODE 128 A
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeOneTwoEightA extends \Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C128A';
|
||||
|
||||
/**
|
||||
* Get the code point array
|
||||
*
|
||||
* @return array<int, int>
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCodeData(): array
|
||||
{
|
||||
$code = $this->code;
|
||||
$len = \strlen($code);
|
||||
$code_data = [];
|
||||
$this->getCodeDataA($code_data, $code, $len);
|
||||
return $this->finalizeCodeData($code_data, 103);
|
||||
}
|
||||
}
|
||||
+61
@@ -0,0 +1,61 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeOneTwoEightB.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightB;
|
||||
*
|
||||
* CodeOneTwoEightB Barcode type class
|
||||
* CODE 128 B
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeOneTwoEightB extends \Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C128B';
|
||||
|
||||
/**
|
||||
* Get the code point array
|
||||
*
|
||||
* @return array<int, int>
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCodeData(): array
|
||||
{
|
||||
$code = $this->code;
|
||||
$len = \strlen($code);
|
||||
$code_data = [];
|
||||
$this->getCodeDataB($code_data, $code, $len);
|
||||
return $this->finalizeCodeData($code_data, 104);
|
||||
}
|
||||
}
|
||||
+65
@@ -0,0 +1,65 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeOneTwoEightC.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightC;
|
||||
*
|
||||
* CodeOneTwoEightC Barcode type class
|
||||
* CODE 128 C
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeOneTwoEightC extends \Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C128C';
|
||||
|
||||
/**
|
||||
* Get the code point array
|
||||
*
|
||||
* @return array<int, int>
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCodeData(): array
|
||||
{
|
||||
$code = $this->code;
|
||||
$code_data = [];
|
||||
if ($code !== '' && \ord($code[0]) === 241) {
|
||||
$code_data[] = 102;
|
||||
$code = \substr($code, 1);
|
||||
}
|
||||
|
||||
$this->getCodeDataC($code_data, $code);
|
||||
return $this->finalizeCodeData($code_data, 105);
|
||||
}
|
||||
}
|
||||
+470
@@ -0,0 +1,470 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Process.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\Process;
|
||||
*
|
||||
* Process methods for CodeOneTwoEight Barcode type class
|
||||
* CODE 128
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Process extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C128';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'212222', // 00
|
||||
'222122', // 01
|
||||
'222221', // 02
|
||||
'121223', // 03
|
||||
'121322', // 04
|
||||
'131222', // 05
|
||||
'122213', // 06
|
||||
'122312', // 07
|
||||
'132212', // 08
|
||||
'221213', // 09
|
||||
'221312', // 10
|
||||
'231212', // 11
|
||||
'112232', // 12
|
||||
'122132', // 13
|
||||
'122231', // 14
|
||||
'113222', // 15
|
||||
'123122', // 16
|
||||
'123221', // 17
|
||||
'223211', // 18
|
||||
'221132', // 19
|
||||
'221231', // 20
|
||||
'213212', // 21
|
||||
'223112', // 22
|
||||
'312131', // 23
|
||||
'311222', // 24
|
||||
'321122', // 25
|
||||
'321221', // 26
|
||||
'312212', // 27
|
||||
'322112', // 28
|
||||
'322211', // 29
|
||||
'212123', // 30
|
||||
'212321', // 31
|
||||
'232121', // 32
|
||||
'111323', // 33
|
||||
'131123', // 34
|
||||
'131321', // 35
|
||||
'112313', // 36
|
||||
'132113', // 37
|
||||
'132311', // 38
|
||||
'211313', // 39
|
||||
'231113', // 40
|
||||
'231311', // 41
|
||||
'112133', // 42
|
||||
'112331', // 43
|
||||
'132131', // 44
|
||||
'113123', // 45
|
||||
'113321', // 46
|
||||
'133121', // 47
|
||||
'313121', // 48
|
||||
'211331', // 49
|
||||
'231131', // 50
|
||||
'213113', // 51
|
||||
'213311', // 52
|
||||
'213131', // 53
|
||||
'311123', // 54
|
||||
'311321', // 55
|
||||
'331121', // 56
|
||||
'312113', // 57
|
||||
'312311', // 58
|
||||
'332111', // 59
|
||||
'314111', // 60
|
||||
'221411', // 61
|
||||
'431111', // 62
|
||||
'111224', // 63
|
||||
'111422', // 64
|
||||
'121124', // 65
|
||||
'121421', // 66
|
||||
'141122', // 67
|
||||
'141221', // 68
|
||||
'112214', // 69
|
||||
'112412', // 70
|
||||
'122114', // 71
|
||||
'122411', // 72
|
||||
'142112', // 73
|
||||
'142211', // 74
|
||||
'241211', // 75
|
||||
'221114', // 76
|
||||
'413111', // 77
|
||||
'241112', // 78
|
||||
'134111', // 79
|
||||
'111242', // 80
|
||||
'121142', // 81
|
||||
'121241', // 82
|
||||
'114212', // 83
|
||||
'124112', // 84
|
||||
'124211', // 85
|
||||
'411212', // 86
|
||||
'421112', // 87
|
||||
'421211', // 88
|
||||
'212141', // 89
|
||||
'214121', // 90
|
||||
'412121', // 91
|
||||
'111143', // 92
|
||||
'111341', // 93
|
||||
'131141', // 94
|
||||
'114113', // 95
|
||||
'114311', // 96
|
||||
'411113', // 97
|
||||
'411311', // 98
|
||||
'113141', // 99
|
||||
'114131', // 100
|
||||
'311141', // 101
|
||||
'411131', // 102
|
||||
'211412', // 103 START A
|
||||
'211214', // 104 START B
|
||||
'211232', // 105 START C
|
||||
'233111', // STOP
|
||||
'200000', // END
|
||||
];
|
||||
|
||||
/**
|
||||
* Map ASCII characters for code A (ASCII 00 - 95)
|
||||
* // 128A (Code Set A) - ASCII characters 00 to 95 (0-9, A-Z and control codes), special characters
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const KEYS_A =
|
||||
' !"#$%&\'()*+,-./'
|
||||
. '0123456789'
|
||||
. ':;<=>?@'
|
||||
. 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
|
||||
. '[\\]^_'
|
||||
. "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F"
|
||||
. "\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F";
|
||||
|
||||
/**
|
||||
* Map ASCII characters for code B (ASCII 32 - 127)
|
||||
* // 128B (Code Set B) - ASCII characters 32 to 127 (0-9, A-Z, a-z), special characters
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const KEYS_B =
|
||||
' !"#$%&\'()*+,-./'
|
||||
. '0123456789'
|
||||
. ':;<=>?@'
|
||||
. 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
|
||||
. '[\\]^_`'
|
||||
. 'abcdefghijklmnopqrstuvwxyz'
|
||||
. '{|}~'
|
||||
. "\x7F";
|
||||
|
||||
protected function getFncAValue(int $char_id): int
|
||||
{
|
||||
return match ($char_id) {
|
||||
241 => 102,
|
||||
242 => 97,
|
||||
243 => 96,
|
||||
244 => 101,
|
||||
default => 0,
|
||||
};
|
||||
}
|
||||
|
||||
protected function getFncBValue(int $char_id): int
|
||||
{
|
||||
return match ($char_id) {
|
||||
241 => 102,
|
||||
242 => 97,
|
||||
243 => 96,
|
||||
244 => 100,
|
||||
default => 0,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the numeric sequence (if any)
|
||||
*
|
||||
* @param string $code Code to parse
|
||||
*
|
||||
* @return array<int, array{string, string, int}>
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getNumericSequence(string $code): array
|
||||
{
|
||||
$sequence = [];
|
||||
$len = \strlen($code);
|
||||
$end_offset = 0;
|
||||
$offset = 0;
|
||||
|
||||
while ($offset < $len) {
|
||||
$chr = $code[$offset];
|
||||
$ord = \ord($chr);
|
||||
|
||||
if ($ord < 48 || $ord > 57) {
|
||||
++$offset;
|
||||
continue;
|
||||
}
|
||||
|
||||
$digit_start = $offset;
|
||||
while ($offset < $len) {
|
||||
$digit_chr = $code[$offset];
|
||||
$digit_ord = \ord($digit_chr);
|
||||
if ($digit_ord < 48 || $digit_ord > 57) {
|
||||
break;
|
||||
}
|
||||
|
||||
++$offset;
|
||||
}
|
||||
|
||||
$digit_len = $offset - $digit_start;
|
||||
if ($digit_len < 4) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$num_offset = $digit_start;
|
||||
$num_len = $digit_len;
|
||||
if (($num_len % 2) !== 0) {
|
||||
--$num_len;
|
||||
++$num_offset;
|
||||
}
|
||||
|
||||
if ($num_len <= 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($num_offset > $end_offset) {
|
||||
$sequence = \array_merge(
|
||||
$sequence,
|
||||
$this->get128ABsequence(\substr($code, $end_offset, $num_offset - $end_offset)),
|
||||
);
|
||||
}
|
||||
|
||||
$sequence[] = ['C', \substr($code, $num_offset, $num_len), $num_len];
|
||||
$end_offset = $num_offset + $num_len;
|
||||
}
|
||||
|
||||
if ($end_offset < $len) {
|
||||
$sequence = \array_merge($sequence, $this->get128ABsequence(\substr($code, $end_offset)));
|
||||
}
|
||||
|
||||
if ($sequence === []) {
|
||||
$sequence[] = ['B', $code, $len];
|
||||
}
|
||||
|
||||
return $sequence;
|
||||
}
|
||||
|
||||
/**
|
||||
* Split text code in A/B sequence for 128 code
|
||||
*
|
||||
* @param string $code Code to split
|
||||
*
|
||||
* @return array<int, array{string, string, int}>
|
||||
*/
|
||||
protected function get128ABsequence(string $code): array
|
||||
{
|
||||
$len = \strlen($code);
|
||||
$sequence = [];
|
||||
|
||||
$has_a_only = false;
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
if (\ord($code[$pos]) >= 32) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$has_a_only = true;
|
||||
break;
|
||||
}
|
||||
|
||||
if (!$has_a_only) {
|
||||
$sequence[] = ['B', $code, $len];
|
||||
|
||||
return $sequence;
|
||||
}
|
||||
|
||||
$end_offset = 0;
|
||||
$pos = 0;
|
||||
while ($pos < $len) {
|
||||
if (\ord($code[$pos]) > 95) {
|
||||
++$pos;
|
||||
continue;
|
||||
}
|
||||
|
||||
$start = $pos;
|
||||
while ($pos < $len && \ord($code[$pos]) <= 95) {
|
||||
++$pos;
|
||||
}
|
||||
|
||||
if ($start > $end_offset) {
|
||||
$slen = $start - $end_offset;
|
||||
$sequence[] = ['B', \substr($code, $end_offset, $slen), $slen];
|
||||
}
|
||||
|
||||
$slen = $pos - $start;
|
||||
$sequence[] = ['A', \substr($code, $start, $slen), $slen];
|
||||
$end_offset = $pos;
|
||||
}
|
||||
|
||||
if ($end_offset < $len) {
|
||||
$slen = $len - $end_offset;
|
||||
$sequence[] = ['B', \substr($code, $end_offset, $slen), $slen];
|
||||
}
|
||||
|
||||
return $sequence;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the A code point array
|
||||
*
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param string $code Code to process
|
||||
* @param int $len Number of characters to process
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCodeDataA(array &$code_data, string $code, int $len): void
|
||||
{
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
$char = $code[$pos];
|
||||
$char_id = \ord($char);
|
||||
if ($char_id >= 241 && $char_id <= 244) {
|
||||
$code_data[] = $this->getFncAValue($char_id);
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($char_id <= 95) {
|
||||
$cdpos = \strpos($this::KEYS_A, $char);
|
||||
$code_data[] = \is_int($cdpos) ? $cdpos : 0;
|
||||
continue;
|
||||
}
|
||||
|
||||
throw new BarcodeException('Invalid character sequence');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the B code point array
|
||||
*
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param string $code Code to process
|
||||
* @param int $len Number of characters to process
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCodeDataB(array &$code_data, string $code, int $len): void
|
||||
{
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
$char = $code[$pos];
|
||||
$char_id = \ord($char);
|
||||
if ($char_id >= 241 && $char_id <= 244) {
|
||||
$code_data[] = $this->getFncBValue($char_id);
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($char_id >= 32 && $char_id <= 127) {
|
||||
$cdpos = \strpos($this::KEYS_B, $char);
|
||||
$code_data[] = \is_int($cdpos) ? $cdpos : 0;
|
||||
continue;
|
||||
}
|
||||
|
||||
throw new BarcodeException('Invalid character sequence: ' . $char_id);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the C code point array
|
||||
*
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param string $code Code to process
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCodeDataC(array &$code_data, string $code): void
|
||||
{
|
||||
// code blocks separated by FNC1 (chr 241)
|
||||
$blocks = \explode(\chr(241), $code);
|
||||
|
||||
foreach ($blocks as $block) {
|
||||
$len = \strlen($block);
|
||||
|
||||
if (($len % 2) !== 0) {
|
||||
throw new BarcodeException('The length of each FNC1-separated code block must be even');
|
||||
}
|
||||
|
||||
for ($pos = 0; $pos < $len; $pos += 2) {
|
||||
$chrnum = $block[$pos] . $block[$pos + 1];
|
||||
if (\preg_match('/(\d{2})/', $chrnum) === 1) {
|
||||
$code_data[] = (int) $chrnum;
|
||||
continue;
|
||||
}
|
||||
|
||||
throw new BarcodeException('Invalid character sequence');
|
||||
}
|
||||
|
||||
$code_data[] = 102;
|
||||
}
|
||||
|
||||
// remove last 102 code
|
||||
\array_pop($code_data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Finalize code data
|
||||
*
|
||||
* @param array<int, int> $code_data Array of codepoints to alter
|
||||
* @param int $startid Start ID code
|
||||
*
|
||||
* @return array<int, int> Array of codepoints
|
||||
*/
|
||||
protected function finalizeCodeData(array $code_data, int $startid): array
|
||||
{
|
||||
// calculate check character
|
||||
$sum = $startid;
|
||||
foreach ($code_data as $key => $val) {
|
||||
$sum += $val * ($key + 1);
|
||||
}
|
||||
|
||||
// add check character
|
||||
$code_data[] = $sum % 103;
|
||||
|
||||
// add stop sequence
|
||||
$code_data[] = 106;
|
||||
$code_data[] = 107;
|
||||
// add start code at the beginning
|
||||
\array_unshift($code_data, $startid);
|
||||
|
||||
return $code_data;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeThreeNine.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeThreeNine
|
||||
*
|
||||
* CodeThreeNine Barcode type class
|
||||
* CODE 39
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeThreeNine extends \Com\Tecnick\Barcode\Type\Linear\CodeThreeNineExtCheck
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C39';
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = '*' . \strtoupper($this->code) . '*';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeThreeNineCheck.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeThreeNineCheck
|
||||
*
|
||||
* CodeThreeNineCheck Barcode type class
|
||||
* CODE 39 + CHECKSUM
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeThreeNineCheck extends \Com\Tecnick\Barcode\Type\Linear\CodeThreeNineExtCheck
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C39+';
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$code = \strtoupper($this->code);
|
||||
$this->extcode = '*' . $code . $this->getChecksum($code) . '*';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeThreeNineExt.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeThreeNineExt
|
||||
*
|
||||
* CodeThreeNineExt Barcode type class
|
||||
* CODE 39 EXTENDED
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeThreeNineExt extends \Com\Tecnick\Barcode\Type\Linear\CodeThreeNineExtCheck
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C39E';
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = '*' . $this->getExtendCode(\strtoupper($this->code)) . '*';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,392 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* CodeThreeNineExtCheck.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\CodeThreeNineExtCheck
|
||||
*
|
||||
* CodeThreeNineExtCheck Barcode type class
|
||||
* CODE 39 EXTENDED + CHECKSUM
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class CodeThreeNineExtCheck extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'C39E+';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '111331311',
|
||||
'1' => '311311113',
|
||||
'2' => '113311113',
|
||||
'3' => '313311111',
|
||||
'4' => '111331113',
|
||||
'5' => '311331111',
|
||||
'6' => '113331111',
|
||||
'7' => '111311313',
|
||||
'8' => '311311311',
|
||||
'9' => '113311311',
|
||||
'A' => '311113113',
|
||||
'B' => '113113113',
|
||||
'C' => '313113111',
|
||||
'D' => '111133113',
|
||||
'E' => '311133111',
|
||||
'F' => '113133111',
|
||||
'G' => '111113313',
|
||||
'H' => '311113311',
|
||||
'I' => '113113311',
|
||||
'J' => '111133311',
|
||||
'K' => '311111133',
|
||||
'L' => '113111133',
|
||||
'M' => '313111131',
|
||||
'N' => '111131133',
|
||||
'O' => '311131131',
|
||||
'P' => '113131131',
|
||||
'Q' => '111111333',
|
||||
'R' => '311111331',
|
||||
'S' => '113111331',
|
||||
'T' => '111131331',
|
||||
'U' => '331111113',
|
||||
'V' => '133111113',
|
||||
'W' => '333111111',
|
||||
'X' => '131131113',
|
||||
'Y' => '331131111',
|
||||
'Z' => '133131111',
|
||||
'-' => '131111313',
|
||||
'.' => '331111311',
|
||||
' ' => '133111311',
|
||||
'$' => '131313111',
|
||||
'/' => '131311131',
|
||||
'+' => '131113131',
|
||||
'%' => '111313131',
|
||||
'*' => '131131311',
|
||||
];
|
||||
|
||||
/**
|
||||
* Map for extended characters
|
||||
*
|
||||
* @var array<string>
|
||||
*/
|
||||
protected const EXTCODES = [
|
||||
'%U',
|
||||
'$A',
|
||||
'$B',
|
||||
'$C',
|
||||
'$D',
|
||||
'$E',
|
||||
'$F',
|
||||
'$G',
|
||||
'$H',
|
||||
'$I',
|
||||
'$J',
|
||||
'$K',
|
||||
'$L',
|
||||
'$M',
|
||||
'$N',
|
||||
'$O',
|
||||
'$P',
|
||||
'$Q',
|
||||
'$R',
|
||||
'$S',
|
||||
'$T',
|
||||
'$U',
|
||||
'$V',
|
||||
'$W',
|
||||
'$X',
|
||||
'$Y',
|
||||
'$Z',
|
||||
'%A',
|
||||
'%B',
|
||||
'%C',
|
||||
'%D',
|
||||
'%E',
|
||||
' ',
|
||||
'/A',
|
||||
'/B',
|
||||
'/C',
|
||||
'/D',
|
||||
'/E',
|
||||
'/F',
|
||||
'/G',
|
||||
'/H',
|
||||
'/I',
|
||||
'/J',
|
||||
'/K',
|
||||
'/L',
|
||||
'-',
|
||||
'.',
|
||||
'/O',
|
||||
'0',
|
||||
'1',
|
||||
'2',
|
||||
'3',
|
||||
'4',
|
||||
'5',
|
||||
'6',
|
||||
'7',
|
||||
'8',
|
||||
'9',
|
||||
'/Z',
|
||||
'%F',
|
||||
'%G',
|
||||
'%H',
|
||||
'%I',
|
||||
'%J',
|
||||
'%V',
|
||||
'A',
|
||||
'B',
|
||||
'C',
|
||||
'D',
|
||||
'E',
|
||||
'F',
|
||||
'G',
|
||||
'H',
|
||||
'I',
|
||||
'J',
|
||||
'K',
|
||||
'L',
|
||||
'M',
|
||||
'N',
|
||||
'O',
|
||||
'P',
|
||||
'Q',
|
||||
'R',
|
||||
'S',
|
||||
'T',
|
||||
'U',
|
||||
'V',
|
||||
'W',
|
||||
'X',
|
||||
'Y',
|
||||
'Z',
|
||||
'%K',
|
||||
'%L',
|
||||
'%M',
|
||||
'%N',
|
||||
'%O',
|
||||
'%W',
|
||||
'+A',
|
||||
'+B',
|
||||
'+C',
|
||||
'+D',
|
||||
'+E',
|
||||
'+F',
|
||||
'+G',
|
||||
'+H',
|
||||
'+I',
|
||||
'+J',
|
||||
'+K',
|
||||
'+L',
|
||||
'+M',
|
||||
'+N',
|
||||
'+O',
|
||||
'+P',
|
||||
'+Q',
|
||||
'+R',
|
||||
'+S',
|
||||
'+T',
|
||||
'+U',
|
||||
'+V',
|
||||
'+W',
|
||||
'+X',
|
||||
'+Y',
|
||||
'+Z',
|
||||
'%P',
|
||||
'%Q',
|
||||
'%R',
|
||||
'%S',
|
||||
'%T',
|
||||
];
|
||||
|
||||
/**
|
||||
* Characters used for checksum
|
||||
*
|
||||
* @var array<string>
|
||||
*/
|
||||
protected const CHKSUM = [
|
||||
'0',
|
||||
'1',
|
||||
'2',
|
||||
'3',
|
||||
'4',
|
||||
'5',
|
||||
'6',
|
||||
'7',
|
||||
'8',
|
||||
'9',
|
||||
'A',
|
||||
'B',
|
||||
'C',
|
||||
'D',
|
||||
'E',
|
||||
'F',
|
||||
'G',
|
||||
'H',
|
||||
'I',
|
||||
'J',
|
||||
'K',
|
||||
'L',
|
||||
'M',
|
||||
'N',
|
||||
'O',
|
||||
'P',
|
||||
'Q',
|
||||
'R',
|
||||
'S',
|
||||
'T',
|
||||
'U',
|
||||
'V',
|
||||
'W',
|
||||
'X',
|
||||
'Y',
|
||||
'Z',
|
||||
'-',
|
||||
'.',
|
||||
' ',
|
||||
'$',
|
||||
'/',
|
||||
'+',
|
||||
'%',
|
||||
];
|
||||
|
||||
protected function getExtendedCodeValue(int $item): string
|
||||
{
|
||||
return $this::EXTCODES[$item] ?? '';
|
||||
}
|
||||
|
||||
protected function getChecksumIndex(string $char): int
|
||||
{
|
||||
$index = \array_search($char, $this::CHKSUM, true);
|
||||
if (\is_int($index)) {
|
||||
return $index;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
protected function getChecksumChar(int $index): string
|
||||
{
|
||||
return $this::CHKSUM[$index] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode a string to be used for CODE 39 Extended mode.
|
||||
*
|
||||
* @param string $code Code to extend
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getExtendCode(string $code): string
|
||||
{
|
||||
$ext = '';
|
||||
$clen = \strlen($code);
|
||||
for ($chr = 0; $chr < $clen; ++$chr) {
|
||||
$item = \ord($code[$chr]);
|
||||
if ($item > 127) {
|
||||
throw new BarcodeException('Invalid character: ' . ($item & 0xFF));
|
||||
}
|
||||
|
||||
$ext .= $this->getExtendedCodeValue($item);
|
||||
}
|
||||
|
||||
return $ext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate CODE 39 checksum (modulo 43).
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return string char checksum.
|
||||
*/
|
||||
protected function getChecksum(string $code): string
|
||||
{
|
||||
$sum = 0;
|
||||
$clen = \strlen($code);
|
||||
for ($chr = 0; $chr < $clen; ++$chr) {
|
||||
$sum += $this->getChecksumIndex($code[$chr]);
|
||||
}
|
||||
|
||||
$idx = $sum % 43;
|
||||
return $this->getChecksumChar($idx);
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$code = $this->getExtendCode(\strtoupper($this->code));
|
||||
$this->extcode = '*' . $code . $this->getChecksum($code) . '*';
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 1;
|
||||
$this->bars = [];
|
||||
$this->formatCode();
|
||||
$clen = \strlen($this->extcode);
|
||||
for ($chr = 0; $chr < $clen; ++$chr) {
|
||||
$char = $this->extcode[$chr];
|
||||
$pattern = $this::CHBAR[$char] ?? null;
|
||||
if ($pattern === null) {
|
||||
throw new BarcodeException('Invalid character: ' . (\ord($char) & 0xFF));
|
||||
}
|
||||
|
||||
for ($pos = 0; $pos < 9; ++$pos) {
|
||||
$bar_width = (int) ($pattern[$pos] ?? '0');
|
||||
if (($pos % 2) === 0 && $bar_width > 0) {
|
||||
$this->bars[] = [$this->ncols, 0, $bar_width, 1];
|
||||
}
|
||||
|
||||
$this->ncols += $bar_width;
|
||||
}
|
||||
|
||||
// intercharacter gap
|
||||
++$this->ncols;
|
||||
}
|
||||
|
||||
--$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,77 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* EanEight.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\EanEight;
|
||||
*
|
||||
* EanEight Barcode type class
|
||||
* EAN 8
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class EanEight extends \Com\Tecnick\Barcode\Type\Linear\EanOneThree
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'EAN8';
|
||||
|
||||
/**
|
||||
* Fixed code length
|
||||
*/
|
||||
protected int $code_length = 8;
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
if (!\is_numeric($this->code)) {
|
||||
throw new BarcodeException('Input code must be a number');
|
||||
}
|
||||
|
||||
$this->formatCode();
|
||||
$seq = '101'; // left guard bar
|
||||
$half_len = (int) \ceil($this->code_length / 2);
|
||||
for ($pos = 0; $pos < $half_len; ++$pos) {
|
||||
$seq .= $this->getBarPattern('A', $this->getCharAt($this->extcode, $pos));
|
||||
}
|
||||
|
||||
$seq .= '01010'; // center guard bar
|
||||
for ($pos = $half_len; $pos < $this->code_length; ++$pos) {
|
||||
$seq .= $this->getBarPattern('C', $this->getCharAt($this->extcode, $pos));
|
||||
}
|
||||
|
||||
$seq .= '101'; // right guard bar
|
||||
$this->processBinarySequence($this->getRawCodeRows($seq));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* EanFive.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\EanFive;
|
||||
*
|
||||
* EanFive Barcode type class
|
||||
* EAN 5-Digits UPC-Based Extension
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class EanFive extends \Com\Tecnick\Barcode\Type\Linear\EanTwo
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'EAN5';
|
||||
|
||||
/**
|
||||
* Fixed code length
|
||||
*/
|
||||
protected int $code_length = 5;
|
||||
|
||||
/**
|
||||
* Map parities
|
||||
*
|
||||
* @var array<int|string, array<string>>
|
||||
*/
|
||||
protected const PARITIES = [
|
||||
'0' => ['B', 'B', 'A', 'A', 'A'],
|
||||
'1' => ['B', 'A', 'B', 'A', 'A'],
|
||||
'2' => ['B', 'A', 'A', 'B', 'A'],
|
||||
'3' => ['B', 'A', 'A', 'A', 'B'],
|
||||
'4' => ['A', 'B', 'B', 'A', 'A'],
|
||||
'5' => ['A', 'A', 'B', 'B', 'A'],
|
||||
'6' => ['A', 'A', 'A', 'B', 'B'],
|
||||
'7' => ['A', 'B', 'A', 'B', 'A'],
|
||||
'8' => ['A', 'B', 'A', 'A', 'B'],
|
||||
'9' => ['A', 'A', 'B', 'A', 'B'],
|
||||
];
|
||||
|
||||
/**
|
||||
* Calculate checksum
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return int char checksum.
|
||||
*/
|
||||
protected function getChecksum(string $code): int
|
||||
{
|
||||
return (
|
||||
((3 * ((int) $code[0] + (int) $code[2] + (int) $code[4])) + (9 * ((int) $code[1] + (int) $code[3]))) % 10
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,227 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* EanOneThree.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\EanOneThree;
|
||||
*
|
||||
* EanOneThree Barcode type class
|
||||
* EAN 13
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class EanOneThree extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
protected function getCharAt(string $value, int $index): string
|
||||
{
|
||||
return $value[$index] ?? '0';
|
||||
}
|
||||
|
||||
protected function getParityPattern(string $digit): string
|
||||
{
|
||||
return $this::PARITIES[$digit] ?? 'AAAAAA';
|
||||
}
|
||||
|
||||
protected function getBarPattern(string $parity, string $digit): string
|
||||
{
|
||||
return $this::CHBAR[$parity][$digit] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'EAN13';
|
||||
|
||||
/**
|
||||
* Fixed code length
|
||||
*/
|
||||
protected int $code_length = 13;
|
||||
|
||||
/**
|
||||
* Check digit
|
||||
*/
|
||||
protected int $check = 0;
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, array<int|string, string>>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'A' => [
|
||||
// left odd parity
|
||||
'0' => '0001101',
|
||||
'1' => '0011001',
|
||||
'2' => '0010011',
|
||||
'3' => '0111101',
|
||||
'4' => '0100011',
|
||||
'5' => '0110001',
|
||||
'6' => '0101111',
|
||||
'7' => '0111011',
|
||||
'8' => '0110111',
|
||||
'9' => '0001011',
|
||||
],
|
||||
'B' => [
|
||||
// left even parity
|
||||
'0' => '0100111',
|
||||
'1' => '0110011',
|
||||
'2' => '0011011',
|
||||
'3' => '0100001',
|
||||
'4' => '0011101',
|
||||
'5' => '0111001',
|
||||
'6' => '0000101',
|
||||
'7' => '0010001',
|
||||
'8' => '0001001',
|
||||
'9' => '0010111',
|
||||
],
|
||||
'C' => [
|
||||
// right
|
||||
'0' => '1110010',
|
||||
'1' => '1100110',
|
||||
'2' => '1101100',
|
||||
'3' => '1000010',
|
||||
'4' => '1011100',
|
||||
'5' => '1001110',
|
||||
'6' => '1010000',
|
||||
'7' => '1000100',
|
||||
'8' => '1001000',
|
||||
'9' => '1110100',
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* Map parities
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const PARITIES = [
|
||||
'0' => 'AAAAAA',
|
||||
'1' => 'AABABB',
|
||||
'2' => 'AABBAB',
|
||||
'3' => 'AABBBA',
|
||||
'4' => 'ABAABB',
|
||||
'5' => 'ABBAAB',
|
||||
'6' => 'ABBBAA',
|
||||
'7' => 'ABABAB',
|
||||
'8' => 'ABABBA',
|
||||
'9' => 'ABBABA',
|
||||
];
|
||||
|
||||
/**
|
||||
* Calculate checksum
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return int char checksum.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getChecksum(string $code): int
|
||||
{
|
||||
$data_len = $this->code_length - 1;
|
||||
$code_len = \strlen($code);
|
||||
$sum_a = 0;
|
||||
for ($pos = 1; $pos < $data_len; $pos += 2) {
|
||||
$sum_a += (int) $code[$pos];
|
||||
}
|
||||
|
||||
if ($this->code_length > 12) {
|
||||
$sum_a *= 3;
|
||||
}
|
||||
|
||||
$sum_b = 0;
|
||||
for ($pos = 0; $pos < $data_len; $pos += 2) {
|
||||
$sum_b += (int) $code[$pos];
|
||||
}
|
||||
|
||||
if ($this->code_length < 13) {
|
||||
$sum_b *= 3;
|
||||
}
|
||||
|
||||
$this->check = ($sum_a + $sum_b) % 10;
|
||||
if ($this->check > 0) {
|
||||
$this->check = 10 - $this->check;
|
||||
}
|
||||
|
||||
if ($code_len === $data_len) {
|
||||
// add check digit
|
||||
return $this->check;
|
||||
}
|
||||
|
||||
if ($this->check !== (int) $code[$data_len]) {
|
||||
// wrong check digit
|
||||
throw new BarcodeException('Invalid check digit: ' . $this->check);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$code = \str_pad($this->code, $this->code_length - 1, '0', STR_PAD_LEFT);
|
||||
// getChecksum() returns the missing check digit, or validates (and returns 0)
|
||||
// when the input already carries it; in the latter case keep the code unchanged
|
||||
// to avoid appending a spurious extra digit to the extended code.
|
||||
$check = $this->getChecksum($code);
|
||||
$this->extcode = \strlen($code) >= $this->code_length ? $code : $code . $check;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
if (!\is_numeric($this->code)) {
|
||||
throw new BarcodeException('Input code must be a number');
|
||||
}
|
||||
|
||||
$this->formatCode();
|
||||
$seq = '101'; // left guard bar
|
||||
$half_len = (int) \ceil($this->code_length / 2);
|
||||
$parity = $this->getParityPattern($this->getCharAt($this->extcode, 0));
|
||||
for ($pos = 1; $pos < $half_len; ++$pos) {
|
||||
$seq .= $this->getBarPattern($this->getCharAt($parity, $pos - 1), $this->getCharAt($this->extcode, $pos));
|
||||
}
|
||||
|
||||
$seq .= '01010'; // center guard bar
|
||||
for ($pos = $half_len; $pos < $this->code_length; ++$pos) {
|
||||
$seq .= $this->getBarPattern('C', $this->getCharAt($this->extcode, $pos));
|
||||
}
|
||||
|
||||
$seq .= '101'; // right guard bar
|
||||
$this->processBinarySequence($this->getRawCodeRows($seq));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,159 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* EanTwo.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\EanTwo;
|
||||
*
|
||||
* EanTwo Barcode type class
|
||||
* EAN 2-Digits UPC-Based Extension
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class EanTwo extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
protected function getCharAt(string $value, int $index): string
|
||||
{
|
||||
return $value[$index] ?? '0';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, string>
|
||||
*/
|
||||
protected function getParityPattern(int $check): array
|
||||
{
|
||||
$pattern = $this::PARITIES[$check] ?? ['A', 'A'];
|
||||
return \array_values($pattern);
|
||||
}
|
||||
|
||||
protected function getBarPattern(string $parity, string $digit): string
|
||||
{
|
||||
return $this::CHBAR[$parity][$digit] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'EAN2';
|
||||
|
||||
/**
|
||||
* Fixed code length
|
||||
*/
|
||||
protected int $code_length = 2;
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<string, array<int|string, string>>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'A' => [
|
||||
// left odd parity
|
||||
'0' => '0001101',
|
||||
'1' => '0011001',
|
||||
'2' => '0010011',
|
||||
'3' => '0111101',
|
||||
'4' => '0100011',
|
||||
'5' => '0110001',
|
||||
'6' => '0101111',
|
||||
'7' => '0111011',
|
||||
'8' => '0110111',
|
||||
'9' => '0001011',
|
||||
],
|
||||
'B' => [
|
||||
// left even parity
|
||||
'0' => '0100111',
|
||||
'1' => '0110011',
|
||||
'2' => '0011011',
|
||||
'3' => '0100001',
|
||||
'4' => '0011101',
|
||||
'5' => '0111001',
|
||||
'6' => '0000101',
|
||||
'7' => '0010001',
|
||||
'8' => '0001001',
|
||||
'9' => '0010111',
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* Map parities
|
||||
*
|
||||
* @var array<int|string, array<string>>
|
||||
*/
|
||||
protected const PARITIES = [
|
||||
'0' => ['A', 'A'],
|
||||
'1' => ['A', 'B'],
|
||||
'2' => ['B', 'A'],
|
||||
'3' => ['B', 'B'],
|
||||
];
|
||||
|
||||
/**
|
||||
* Calculate checksum
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return int char checksum.
|
||||
*/
|
||||
protected function getChecksum(string $code): int
|
||||
{
|
||||
return (int) $code % 4;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = \str_pad($this->code, $this->code_length, '0', STR_PAD_LEFT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->formatCode();
|
||||
$chk = $this->getChecksum($this->extcode);
|
||||
$parity = $this->getParityPattern($chk);
|
||||
$seq = '1011'; // left guard bar
|
||||
$seq .= $this->getBarPattern($this->getCharAt($parity[0] ?? 'A', 0), $this->getCharAt($this->extcode, 0));
|
||||
$len = \strlen($this->extcode);
|
||||
for ($pos = 1; $pos < $len; ++$pos) {
|
||||
$seq .= '01'; // separator
|
||||
$seq .= $this->getBarPattern(
|
||||
$this->getCharAt($parity[$pos] ?? 'A', 0),
|
||||
$this->getCharAt($this->extcode, $pos),
|
||||
);
|
||||
}
|
||||
|
||||
$this->processBinarySequence($this->getRawCodeRows($seq));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,661 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Imb.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\Imb;
|
||||
*
|
||||
* Imb Barcode type class
|
||||
* IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200
|
||||
*
|
||||
* Intelligent Mail barcode is a 65-bar code for use on mail in the United States.
|
||||
* The fields are described as follows:
|
||||
* * The Barcode Identifier shall be assigned by USPS to encode the presort identification that is currently
|
||||
* printed in human readable form on the optional endorsement line (OEL) as well as for future USPS use.
|
||||
* This shall be two digits, with the second digit in the range of 0–4. The allowable encoding ranges shall be
|
||||
* 00–04, 10–14, 20–24, 30–34, 40–44, 50–54, 60–64, 70–74, 80–84, and 90–94.
|
||||
* * The Service Type Identifier shall be assigned by USPS for any combination of services requested on the mailpiece.
|
||||
* The allowable encoding range shall be 000–999.
|
||||
* Each 3-digit value shall correspond to a particular mail class with a particular combination of service(s).
|
||||
* Each service program, such as OneCode Confirm and OneCode ACS, shall provide the list of Service Type Identifier
|
||||
* values.
|
||||
* * The Mailer or Customer Identifier shall be assigned by USPS as a unique, 6 or 9 digit number that identifies
|
||||
* a business entity. The allowable encoding range for the 6 digit Mailer ID shall be 000000- 899999, while the
|
||||
* allowable encoding range for the 9 digit Mailer ID shall be 900000000-999999999. The Serial or
|
||||
* Sequence Number shall be assigned by the mailer for uniquely identifying and tracking mailpieces.
|
||||
* The allowable encoding range shall be 000000000–999999999 when used with a 6 digit Mailer ID and 000000-999999
|
||||
* when used with a 9 digit Mailer ID. e. The Delivery Point ZIP Code shall be assigned by the mailer for routing
|
||||
* the mailpiece. This shall replace POSTNET for routing the mailpiece to its final delivery point.
|
||||
* The length may be 0, 5, 9, or 11 digits. The allowable encoding ranges shall be no ZIP Code, 00000–99999,
|
||||
* 000000000–999999999, and 00000000000–99999999999. A hyphen '-' is required before the zip/delivery point.
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Imb extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'IMB';
|
||||
|
||||
/**
|
||||
* ASC characters
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected const ASC_CHR = [
|
||||
4,
|
||||
0,
|
||||
2,
|
||||
6,
|
||||
3,
|
||||
5,
|
||||
1,
|
||||
9,
|
||||
8,
|
||||
7,
|
||||
1,
|
||||
2,
|
||||
0,
|
||||
6,
|
||||
4,
|
||||
8,
|
||||
2,
|
||||
9,
|
||||
5,
|
||||
3,
|
||||
0,
|
||||
1,
|
||||
3,
|
||||
7,
|
||||
4,
|
||||
6,
|
||||
8,
|
||||
9,
|
||||
2,
|
||||
0,
|
||||
5,
|
||||
1,
|
||||
9,
|
||||
4,
|
||||
3,
|
||||
8,
|
||||
6,
|
||||
7,
|
||||
1,
|
||||
2,
|
||||
4,
|
||||
3,
|
||||
9,
|
||||
5,
|
||||
7,
|
||||
8,
|
||||
3,
|
||||
0,
|
||||
2,
|
||||
1,
|
||||
4,
|
||||
0,
|
||||
9,
|
||||
1,
|
||||
7,
|
||||
0,
|
||||
2,
|
||||
4,
|
||||
6,
|
||||
3,
|
||||
7,
|
||||
1,
|
||||
9,
|
||||
5,
|
||||
8,
|
||||
];
|
||||
|
||||
/**
|
||||
* DSC characters
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected const DSC_CHR = [
|
||||
7,
|
||||
1,
|
||||
9,
|
||||
5,
|
||||
8,
|
||||
0,
|
||||
2,
|
||||
4,
|
||||
6,
|
||||
3,
|
||||
5,
|
||||
8,
|
||||
9,
|
||||
7,
|
||||
3,
|
||||
0,
|
||||
6,
|
||||
1,
|
||||
7,
|
||||
4,
|
||||
6,
|
||||
8,
|
||||
9,
|
||||
2,
|
||||
5,
|
||||
1,
|
||||
7,
|
||||
5,
|
||||
4,
|
||||
3,
|
||||
8,
|
||||
7,
|
||||
6,
|
||||
0,
|
||||
2,
|
||||
5,
|
||||
4,
|
||||
9,
|
||||
3,
|
||||
0,
|
||||
1,
|
||||
6,
|
||||
8,
|
||||
2,
|
||||
0,
|
||||
4,
|
||||
5,
|
||||
9,
|
||||
6,
|
||||
7,
|
||||
5,
|
||||
2,
|
||||
6,
|
||||
3,
|
||||
8,
|
||||
5,
|
||||
1,
|
||||
9,
|
||||
8,
|
||||
7,
|
||||
4,
|
||||
0,
|
||||
2,
|
||||
6,
|
||||
3,
|
||||
];
|
||||
|
||||
/**
|
||||
* ASC positions
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected const ASC_POS = [
|
||||
3,
|
||||
0,
|
||||
8,
|
||||
11,
|
||||
1,
|
||||
12,
|
||||
8,
|
||||
11,
|
||||
10,
|
||||
6,
|
||||
4,
|
||||
12,
|
||||
2,
|
||||
7,
|
||||
9,
|
||||
6,
|
||||
7,
|
||||
9,
|
||||
2,
|
||||
8,
|
||||
4,
|
||||
0,
|
||||
12,
|
||||
7,
|
||||
10,
|
||||
9,
|
||||
0,
|
||||
7,
|
||||
10,
|
||||
5,
|
||||
7,
|
||||
9,
|
||||
6,
|
||||
8,
|
||||
2,
|
||||
12,
|
||||
1,
|
||||
4,
|
||||
2,
|
||||
0,
|
||||
1,
|
||||
5,
|
||||
4,
|
||||
6,
|
||||
12,
|
||||
1,
|
||||
0,
|
||||
9,
|
||||
4,
|
||||
7,
|
||||
5,
|
||||
10,
|
||||
2,
|
||||
6,
|
||||
9,
|
||||
11,
|
||||
2,
|
||||
12,
|
||||
6,
|
||||
7,
|
||||
5,
|
||||
11,
|
||||
0,
|
||||
3,
|
||||
2,
|
||||
];
|
||||
|
||||
/**
|
||||
* DSC positions
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected const DSC_POS = [
|
||||
2,
|
||||
10,
|
||||
12,
|
||||
5,
|
||||
9,
|
||||
1,
|
||||
5,
|
||||
4,
|
||||
3,
|
||||
9,
|
||||
11,
|
||||
5,
|
||||
10,
|
||||
1,
|
||||
6,
|
||||
3,
|
||||
4,
|
||||
1,
|
||||
10,
|
||||
0,
|
||||
2,
|
||||
11,
|
||||
8,
|
||||
6,
|
||||
1,
|
||||
12,
|
||||
3,
|
||||
8,
|
||||
6,
|
||||
4,
|
||||
4,
|
||||
11,
|
||||
0,
|
||||
6,
|
||||
1,
|
||||
9,
|
||||
11,
|
||||
5,
|
||||
3,
|
||||
7,
|
||||
3,
|
||||
10,
|
||||
7,
|
||||
11,
|
||||
8,
|
||||
2,
|
||||
10,
|
||||
3,
|
||||
5,
|
||||
8,
|
||||
0,
|
||||
3,
|
||||
12,
|
||||
11,
|
||||
8,
|
||||
4,
|
||||
5,
|
||||
1,
|
||||
3,
|
||||
0,
|
||||
7,
|
||||
12,
|
||||
9,
|
||||
8,
|
||||
10,
|
||||
];
|
||||
|
||||
/**
|
||||
* Reverse unsigned short value
|
||||
*
|
||||
* @param int $num Value to reverse
|
||||
*
|
||||
* @return int reversed value
|
||||
*/
|
||||
protected function getReversedUnsignedShort(int $num): int
|
||||
{
|
||||
$rev = 0;
|
||||
for ($pos = 0; $pos < 16; ++$pos) {
|
||||
$rev <<= 1;
|
||||
$rev |= $num & 1;
|
||||
$num >>= 1;
|
||||
}
|
||||
|
||||
return $rev;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, string> $code_arr
|
||||
*/
|
||||
protected function getCodeByte(array $code_arr, int $index): string
|
||||
{
|
||||
return $code_arr[$index] ?? '00';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return numeric-string
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function toNumericString(string $value): string
|
||||
{
|
||||
if ($value === '' || !\ctype_digit($value)) {
|
||||
throw new BarcodeException('Invalid numeric string');
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return numeric-string
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getTrackingDigit(string $tracking_number, int $index): string
|
||||
{
|
||||
$digit = $tracking_number[$index] ?? '';
|
||||
if (!\ctype_digit($digit)) {
|
||||
throw new BarcodeException('Invalid tracking number');
|
||||
}
|
||||
|
||||
return $digit;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, int> $table
|
||||
*/
|
||||
protected function getTableCode(array $table, int $index): int
|
||||
{
|
||||
return $table[$index] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, int> $chars
|
||||
*/
|
||||
protected function getCharValue(array $chars, int $index): int
|
||||
{
|
||||
return $chars[$index] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Frame Check Sequence
|
||||
*
|
||||
* @param array<int, string> $code_arr Array of hexadecimal values (13 bytes holding 102 bits right justified).
|
||||
*
|
||||
* @return int 11 bit Frame Check Sequence as integer (decimal base)
|
||||
*/
|
||||
protected function getFrameCheckSequence(array $code_arr): int
|
||||
{
|
||||
$genpoly = 0x0F35; // generator polynomial
|
||||
$fcs = 0x07FF; // Frame Check Sequence
|
||||
// do most significant byte skipping the 2 most significant bits
|
||||
$data = \hexdec($this->getCodeByte($code_arr, 0)) << 5;
|
||||
for ($bit = 2; $bit < 8; ++$bit) {
|
||||
$fcs = (($fcs ^ $data) & 0x400) !== 0 ? ($fcs << 1) ^ $genpoly : $fcs << 1;
|
||||
|
||||
$fcs &= 0x7FF;
|
||||
$data <<= 1;
|
||||
}
|
||||
|
||||
// do rest of bytes
|
||||
for ($byte = 1; $byte < 13; ++$byte) {
|
||||
$data = \hexdec($this->getCodeByte($code_arr, $byte)) << 3;
|
||||
for ($bit = 0; $bit < 8; ++$bit) {
|
||||
$fcs = (($fcs ^ $data) & 0x400) !== 0 ? ($fcs << 1) ^ $genpoly : $fcs << 1;
|
||||
|
||||
$fcs &= 0x7FF;
|
||||
$data <<= 1;
|
||||
}
|
||||
}
|
||||
|
||||
return $fcs;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Nof13 tables
|
||||
*
|
||||
* @param int $type Table type: 2 for 2of13 table, 5 for 5of13table
|
||||
* @param int $size Table size (78 for n=2 and 1287 for n=5)
|
||||
*
|
||||
* @return array<int, int> requested table
|
||||
*/
|
||||
protected function getTables(int $type, int $size): array
|
||||
{
|
||||
$table = [];
|
||||
$lli = 0; // LUT lower index
|
||||
$lui = $size - 1; // LUT upper index
|
||||
for ($count = 0; $count < 8192; ++$count) {
|
||||
$bit_count = 0;
|
||||
for ($bit_index = 0; $bit_index < 13; ++$bit_index) {
|
||||
$bit_count += (int) (($count & (1 << $bit_index)) !== 0);
|
||||
}
|
||||
|
||||
// if we don't have the right number of bits on, go on to the next value
|
||||
if ($bit_count === $type) {
|
||||
$reverse = $this->getReversedUnsignedShort($count) >> 3;
|
||||
// if the reverse is less than count, we have already visited this pair before
|
||||
if ($reverse >= $count) {
|
||||
// If count is symmetric, place it at the first free slot from the end of the list.
|
||||
// Otherwise, place it at the first free slot from the beginning of the list AND place
|
||||
// $reverse ath the next free slot from the beginning of the list
|
||||
if ($reverse === $count) {
|
||||
$table[$lui] = $count;
|
||||
--$lui;
|
||||
continue;
|
||||
}
|
||||
|
||||
$table[$lli] = $count;
|
||||
++$lli;
|
||||
$table[$lli] = $reverse;
|
||||
++$lli;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $table;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the routing code binary block
|
||||
*
|
||||
* @param string $routing_code the routing code
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getRoutingCode(string $routing_code): string
|
||||
{
|
||||
if ($routing_code !== '' && !\ctype_digit($routing_code)) {
|
||||
throw new BarcodeException('Invalid routing code');
|
||||
}
|
||||
|
||||
if ($routing_code === '') {
|
||||
return '0';
|
||||
}
|
||||
|
||||
$routing_code = $this->toNumericString($routing_code);
|
||||
|
||||
// Conversion of Routing Code
|
||||
return match (\strlen($routing_code)) {
|
||||
5 => $this->addNumeric($routing_code, '1'),
|
||||
9 => $this->addNumeric($routing_code, '100001'),
|
||||
11 => $this->addNumeric($routing_code, '1000100001'),
|
||||
default => throw new BarcodeException('Invalid routing code'),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the processed array of characters
|
||||
*
|
||||
* @return array<int, int>
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCharsArray(): array
|
||||
{
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 3;
|
||||
$this->bars = [];
|
||||
$code_arr = \explode('-', $this->code);
|
||||
$tracking_number = $code_arr[0];
|
||||
if (!\preg_match('/^\d{2,20}$/', $tracking_number)) {
|
||||
throw new BarcodeException('Invalid tracking number');
|
||||
}
|
||||
|
||||
$binary_code = '0';
|
||||
if (($code_arr[1] ?? null) !== null) {
|
||||
$binary_code = $this->getRoutingCode($code_arr[1]);
|
||||
}
|
||||
|
||||
$binary_code = $this->toNumericString($binary_code);
|
||||
|
||||
$binary_code = $this->mulNumeric($binary_code, '10');
|
||||
$binary_code = $this->addNumeric($binary_code, $this->getTrackingDigit($tracking_number, 0));
|
||||
$binary_code = $this->mulNumeric($binary_code, '5');
|
||||
$binary_code = $this->addNumeric($binary_code, $this->getTrackingDigit($tracking_number, 1));
|
||||
$binary_code = $this->toNumericString($binary_code . \substr($tracking_number, 2, 18));
|
||||
// convert to hexadecimal
|
||||
$binary_code = $this->convertDecToHex($binary_code);
|
||||
// pad to get 13 bytes
|
||||
$binary_code = \str_pad($binary_code, 26, '0', STR_PAD_LEFT);
|
||||
// convert string to array of bytes
|
||||
$binary_code_arr = \chunk_split($binary_code, 2, "\r");
|
||||
$binary_code_arr = \substr($binary_code_arr, 0, -1);
|
||||
$binary_code_arr = \explode("\r", $binary_code_arr);
|
||||
// calculate frame check sequence
|
||||
$fcs = $this->getFrameCheckSequence($binary_code_arr);
|
||||
// exclude first 2 bits from first byte
|
||||
$first_byte = \sprintf('%2s', \dechex((int) (\hexdec($binary_code_arr[0]) << 2) >> 2));
|
||||
$binary_code_102bit = $first_byte . \substr($binary_code, 2);
|
||||
// convert binary data to codewords
|
||||
$codewords = [];
|
||||
$data = $this->toNumericString($this->convertHexToDec($binary_code_102bit));
|
||||
$codewords[0] = $this->modNumeric($data, '636') * 2;
|
||||
$data = $this->divNumeric($data, '636');
|
||||
for ($pos = 1; $pos < 9; ++$pos) {
|
||||
$codewords[$pos] = $this->modNumeric($data, '1365');
|
||||
$data = $this->divNumeric($data, '1365');
|
||||
}
|
||||
|
||||
$codewords[9] = (int) $data;
|
||||
if (($fcs >> 10) === 1) {
|
||||
$codewords[9] += 659;
|
||||
}
|
||||
|
||||
// generate lookup tables
|
||||
$table2of13 = $this->getTables(2, 78);
|
||||
$table5of13 = $this->getTables(5, 1287);
|
||||
// convert codewords to characters
|
||||
$characters = [];
|
||||
$bitmask = 512;
|
||||
foreach ($codewords as $codeword) {
|
||||
$chrcode = $codeword <= 1286
|
||||
? $this->getTableCode($table5of13, $codeword)
|
||||
: $this->getTableCode($table2of13, $codeword - 1287);
|
||||
|
||||
if (($fcs & $bitmask) > 0) {
|
||||
// bitwise invert
|
||||
$chrcode = ~(int) $chrcode & 8191;
|
||||
}
|
||||
|
||||
$characters[] = $chrcode;
|
||||
$bitmask /= 2;
|
||||
}
|
||||
|
||||
return \array_reverse($characters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$chars = $this->getCharsArray();
|
||||
for ($pos = 0; $pos < 65; ++$pos) {
|
||||
$asc_chr = self::ASC_CHR[$pos] ?? 0;
|
||||
$asc_pos = self::ASC_POS[$pos] ?? 0;
|
||||
$dsc_chr = self::DSC_CHR[$pos] ?? 0;
|
||||
$dsc_pos = self::DSC_POS[$pos] ?? 0;
|
||||
$asc = ($this->getCharValue($chars, $asc_chr) & (2 ** $asc_pos)) > 0;
|
||||
$dsc = ($this->getCharValue($chars, $dsc_chr) & (2 ** $dsc_pos)) > 0;
|
||||
if ($asc && $dsc) {
|
||||
// full bar (F)
|
||||
$this->bars[] = [$this->ncols, 0, 1, 3];
|
||||
$this->ncols += 2;
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($asc) {
|
||||
// ascender (A)
|
||||
$this->bars[] = [$this->ncols, 0, 1, 2];
|
||||
$this->ncols += 2;
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($dsc) {
|
||||
// descender (D)
|
||||
$this->bars[] = [$this->ncols, 1, 1, 2];
|
||||
$this->ncols += 2;
|
||||
continue;
|
||||
}
|
||||
|
||||
// tracker (T)
|
||||
$this->bars[] = [$this->ncols, 1, 1, 1];
|
||||
$this->ncols += 2;
|
||||
}
|
||||
|
||||
--$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* ImbPre.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\ImbPre;
|
||||
*
|
||||
* ImbPre Barcode type class
|
||||
* IMB - Intelligent Mail Barcode pre-processed (USPS-B-3200)
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class ImbPre extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'IMBPRE';
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$code = \strtolower($this->code);
|
||||
if (\preg_match('/^[fadt]{65}$/', $code) !== 1) {
|
||||
throw new BarcodeException('Invalid character sequence');
|
||||
}
|
||||
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 3;
|
||||
$this->bars = [];
|
||||
for ($pos = 0; $pos < 65; ++$pos) {
|
||||
switch ($code[$pos]) {
|
||||
case 'f':
|
||||
// full bar
|
||||
$this->bars[] = [$this->ncols, 0, 1, 3];
|
||||
break;
|
||||
case 'a':
|
||||
// ascender
|
||||
$this->bars[] = [$this->ncols, 0, 1, 2];
|
||||
break;
|
||||
case 'd':
|
||||
// descender
|
||||
$this->bars[] = [$this->ncols, 1, 1, 2];
|
||||
break;
|
||||
case 't':
|
||||
// tracker (short)
|
||||
$this->bars[] = [$this->ncols, 1, 1, 1];
|
||||
break;
|
||||
}
|
||||
|
||||
$this->ncols += 2;
|
||||
}
|
||||
|
||||
--$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* InterleavedTwoOfFive.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\InterleavedTwoOfFive;
|
||||
*
|
||||
* InterleavedTwoOfFive Barcode type class
|
||||
* Interleaved 2 of 5
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class InterleavedTwoOfFive extends \Com\Tecnick\Barcode\Type\Linear\InterleavedTwoOfFiveCheck
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'I25';
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = $this->code;
|
||||
}
|
||||
}
|
||||
+127
@@ -0,0 +1,127 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* InterleavedTwoOfFiveCheck.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\InterleavedTwoOfFiveCheck;
|
||||
*
|
||||
* InterleavedTwoOfFiveCheck Barcode type class
|
||||
* Interleaved 2 of 5 + CHECKSUM
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class InterleavedTwoOfFiveCheck extends \Com\Tecnick\Barcode\Type\Linear\StandardTwoOfFiveCheck
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'I25+';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '11221',
|
||||
'1' => '21112',
|
||||
'2' => '12112',
|
||||
'3' => '22111',
|
||||
'4' => '11212',
|
||||
'5' => '21211',
|
||||
'6' => '12211',
|
||||
'7' => '11122',
|
||||
'8' => '21121',
|
||||
'9' => '12121',
|
||||
'A' => '11',
|
||||
'Z' => '21',
|
||||
];
|
||||
|
||||
protected function getPattern(string $digit): string
|
||||
{
|
||||
return $this::CHBAR[$digit] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = $this->code . $this->getChecksum($this->code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->formatCode();
|
||||
if ((\strlen($this->extcode) % 2) !== 0) {
|
||||
// add leading zero if code-length is odd
|
||||
$this->extcode = '0' . $this->extcode;
|
||||
}
|
||||
|
||||
// add start and stop codes
|
||||
$this->extcode = 'AA' . \strtolower($this->extcode) . 'ZA';
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 1;
|
||||
$this->bars = [];
|
||||
$clen = \strlen($this->extcode);
|
||||
for ($idx = 0; $idx < $clen; $idx += 2) {
|
||||
$char_bar = $this->extcode[$idx];
|
||||
$char_space = $this->extcode[$idx + 1];
|
||||
if (!\array_key_exists($char_bar, $this::CHBAR) || !\array_key_exists($char_space, $this::CHBAR)) {
|
||||
throw new BarcodeException('Invalid character sequence: ' . $char_bar . $char_space);
|
||||
}
|
||||
|
||||
// create a bar-space sequence
|
||||
$seq = '';
|
||||
$bar_pattern = $this->getPattern($char_bar);
|
||||
$space_pattern = $this->getPattern($char_space);
|
||||
$chrlen = \strlen($bar_pattern);
|
||||
for ($pos = 0; $pos < $chrlen; ++$pos) {
|
||||
$seq .= ($bar_pattern[$pos] ?? '0') . ($space_pattern[$pos] ?? '0');
|
||||
}
|
||||
|
||||
$seqlen = \strlen($seq);
|
||||
for ($pos = 0; $pos < $seqlen; ++$pos) {
|
||||
$bar_width = (int) $seq[$pos];
|
||||
if (($pos % 2) === 0 && $bar_width > 0) {
|
||||
$this->bars[] = [$this->ncols, 0, $bar_width, 1];
|
||||
}
|
||||
|
||||
$this->ncols += $bar_width;
|
||||
}
|
||||
}
|
||||
|
||||
--$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* KlantIndex.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\KlantIndex;
|
||||
*
|
||||
* KlantIndex Barcode type class
|
||||
* KIX (Klant index - Customer index)
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class KlantIndex extends \Com\Tecnick\Barcode\Type\Linear\RoyalMailFourCc
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'KIX';
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$code = \strtoupper($this->code);
|
||||
$len = \strlen($code);
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
if (!\array_key_exists($code[$pos], $this::CHBAR)) {
|
||||
throw new BarcodeException('Invalid character: ' . (\ord($code[$pos]) & 0xFF));
|
||||
}
|
||||
}
|
||||
|
||||
$this->extcode = $code;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 3;
|
||||
$this->bars = [];
|
||||
$this->getCoreBars();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Msi.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\Msi;
|
||||
*
|
||||
* Msi Barcode type class
|
||||
* MSI (Variation of Plessey code)
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Msi extends \Com\Tecnick\Barcode\Type\Linear\MsiCheck
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'MSI';
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = $this->code;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,138 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* MsiCheck.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\MsiCheck;
|
||||
*
|
||||
* MsiCheck Barcode type class
|
||||
* MSI + CHECKSUM (modulo 11)
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class MsiCheck extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
protected function getPattern(string $digit): string
|
||||
{
|
||||
return $this::CHBAR[$digit] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'MSI+';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '100100100100',
|
||||
'1' => '100100100110',
|
||||
'2' => '100100110100',
|
||||
'3' => '100100110110',
|
||||
'4' => '100110100100',
|
||||
'5' => '100110100110',
|
||||
'6' => '100110110100',
|
||||
'7' => '100110110110',
|
||||
'8' => '110100100100',
|
||||
'9' => '110100100110',
|
||||
'A' => '110100110100',
|
||||
'B' => '110100110110',
|
||||
'C' => '110110100100',
|
||||
'D' => '110110100110',
|
||||
'E' => '110110110100',
|
||||
'F' => '110110110110',
|
||||
];
|
||||
|
||||
/**
|
||||
* Calculate the checksum
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return int char checksum.
|
||||
*/
|
||||
protected function getChecksum(string $code): int
|
||||
{
|
||||
$clen = \strlen($code);
|
||||
$pix = 2;
|
||||
$check = 0;
|
||||
for ($pos = $clen - 1; $pos >= 0; --$pos) {
|
||||
$hex = $code[$pos];
|
||||
if (!\ctype_xdigit($hex)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$check += \hexdec($hex) * $pix;
|
||||
++$pix;
|
||||
if ($pix > 7) {
|
||||
$pix = 2;
|
||||
}
|
||||
}
|
||||
|
||||
$check %= 11;
|
||||
if ($check > 0) {
|
||||
return 11 - $check;
|
||||
}
|
||||
|
||||
return $check;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = $this->code . (string) $this->getChecksum($this->code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->formatCode();
|
||||
$seq = '110'; // left guard
|
||||
$clen = \strlen($this->extcode);
|
||||
for ($pos = 0; $pos < $clen; ++$pos) {
|
||||
$digit = $this->extcode[$pos];
|
||||
if (!\array_key_exists($digit, $this::CHBAR)) {
|
||||
throw new BarcodeException('Invalid character: ' . (\ord($digit) & 0xFF));
|
||||
}
|
||||
|
||||
$seq .= $this->getPattern($digit);
|
||||
}
|
||||
|
||||
$seq .= '1001'; // right guard
|
||||
$this->processBinarySequence($this->getRawCodeRows($seq));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Pharma.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\Pharma;
|
||||
*
|
||||
* Pharma Barcode type class
|
||||
* PHARMACODE
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Pharma extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'PHARMA';
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$seq = '';
|
||||
$code = (int) $this->code;
|
||||
while ($code > 0) {
|
||||
if (($code % 2) === 0) {
|
||||
$seq .= '11100';
|
||||
$code -= 2;
|
||||
$code /= 2;
|
||||
continue;
|
||||
}
|
||||
|
||||
$seq .= '100';
|
||||
--$code;
|
||||
$code /= 2;
|
||||
}
|
||||
|
||||
$seq = \substr($seq, 0, -2);
|
||||
$seq = \strrev($seq);
|
||||
$this->processBinarySequence($this->getRawCodeRows($seq));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* PharmaTwoTracks.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\PharmaTwoTracks;
|
||||
*
|
||||
* PharmaTwoTracks Barcode type class
|
||||
* PHARMACODE TWO-TRACKS
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class PharmaTwoTracks extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'PHARMA2T';
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
if (!\ctype_digit($this->code) || (int) $this->code < 1) {
|
||||
throw new BarcodeException('Invalid barcode value: the code must be a positive integer');
|
||||
}
|
||||
|
||||
$seq = '';
|
||||
$code = (int) $this->code;
|
||||
|
||||
do {
|
||||
switch ($code % 3) {
|
||||
case 0:
|
||||
$seq .= '3';
|
||||
$code = ($code - 3) / 3;
|
||||
break;
|
||||
case 1:
|
||||
$seq .= '1';
|
||||
$code = ($code - 1) / 3;
|
||||
break;
|
||||
case 2:
|
||||
$seq .= '2';
|
||||
$code = ($code - 2) / 3;
|
||||
}
|
||||
} while ($code !== 0);
|
||||
|
||||
$seq = \strrev($seq);
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 2;
|
||||
$this->bars = [];
|
||||
$len = \strlen($seq);
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
switch ($seq[$pos]) {
|
||||
case '1':
|
||||
$this->bars[] = [$this->ncols, 1, 1, 1];
|
||||
break;
|
||||
case '2':
|
||||
$this->bars[] = [$this->ncols, 0, 1, 1];
|
||||
break;
|
||||
case '3':
|
||||
$this->bars[] = [$this->ncols, 0, 1, 2];
|
||||
break;
|
||||
}
|
||||
|
||||
$this->ncols += 2;
|
||||
}
|
||||
|
||||
--$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Planet.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\Planet;
|
||||
*
|
||||
* Planet Barcode type class
|
||||
* PLANET
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Planet extends \Com\Tecnick\Barcode\Type\Linear\Postnet
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'PLANET';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '11222',
|
||||
'1' => '22211',
|
||||
'2' => '22121',
|
||||
'3' => '22112',
|
||||
'4' => '21221',
|
||||
'5' => '21212',
|
||||
'6' => '21122',
|
||||
'7' => '12221',
|
||||
'8' => '12212',
|
||||
'9' => '12122',
|
||||
];
|
||||
}
|
||||
@@ -0,0 +1,139 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Postnet.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\Postnet;
|
||||
*
|
||||
* Postnet Barcode type class
|
||||
* POSTNET
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Postnet extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
protected function getBarHeight(string $char, int $pos): int
|
||||
{
|
||||
$pattern = $this::CHBAR[$char] ?? '11111';
|
||||
return (int) ($pattern[$pos] ?? '1');
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'POSTNET';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '22111',
|
||||
'1' => '11122',
|
||||
'2' => '11212',
|
||||
'3' => '11221',
|
||||
'4' => '12112',
|
||||
'5' => '12121',
|
||||
'6' => '12211',
|
||||
'7' => '21112',
|
||||
'8' => '21121',
|
||||
'9' => '21211',
|
||||
];
|
||||
|
||||
/**
|
||||
* Calculate the checksum.
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return int char checksum.
|
||||
*/
|
||||
protected function getChecksum(string $code): int
|
||||
{
|
||||
$sum = 0;
|
||||
$len = \strlen($code);
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
$sum += (int) $code[$pos];
|
||||
}
|
||||
|
||||
$check = $sum % 10;
|
||||
if ($check > 0) {
|
||||
return 10 - $check;
|
||||
}
|
||||
|
||||
return $check;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$code = \preg_replace('/[-\s]+/', '', $this->code);
|
||||
if ($code === null) {
|
||||
throw new BarcodeException('Code not valid');
|
||||
}
|
||||
$this->extcode = $code . $this->getChecksum($code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 2;
|
||||
$this->bars = [];
|
||||
$this->formatCode();
|
||||
$clen = \strlen($this->extcode);
|
||||
// start bar
|
||||
$this->bars[] = [$this->ncols, 0, 1, 2];
|
||||
$this->ncols += 2;
|
||||
for ($chr = 0; $chr < $clen; ++$chr) {
|
||||
$char = $this->extcode[$chr];
|
||||
if (!\array_key_exists($char, $this::CHBAR)) {
|
||||
throw new BarcodeException('Invalid character: ' . (\ord($char) & 0xFF));
|
||||
}
|
||||
|
||||
for ($pos = 0; $pos < 5; ++$pos) {
|
||||
$bar_height = $this->getBarHeight($char, $pos);
|
||||
$this->bars[] = [$this->ncols, (int) \floor(1 / $bar_height), 1, $bar_height];
|
||||
$this->ncols += 2;
|
||||
}
|
||||
}
|
||||
|
||||
// end bar
|
||||
$this->bars[] = [$this->ncols, 0, 1, 2];
|
||||
++$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Raw.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\Raw
|
||||
*
|
||||
* Raw Barcode type class
|
||||
* RAW MODE (comma-separated rows)
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Raw extends \Com\Tecnick\Barcode\Type\Raw
|
||||
{
|
||||
/**
|
||||
* Barcode type
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const TYPE = 'linear';
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'LRAW';
|
||||
}
|
||||
@@ -0,0 +1,240 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* RoyalMailFourCc.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\RoyalMailFourCc;
|
||||
*
|
||||
* RoyalMailFourCc Barcode type class
|
||||
* RMS4CC (Royal Mail 4-state Customer Bar Code)
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class RoyalMailFourCc extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
protected function getChecksumDigit(string $char, int $idx): int
|
||||
{
|
||||
$pair = $this::CHKSUM[$char] ?? '00';
|
||||
return (int) ($pair[$idx] ?? '0');
|
||||
}
|
||||
|
||||
protected function getBarPattern(string $char, int $pos): string
|
||||
{
|
||||
$pattern = $this::CHBAR[$char] ?? '0000';
|
||||
return $pattern[$pos] ?? '0';
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'RMS4CC';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '3322',
|
||||
'1' => '3412',
|
||||
'2' => '3421',
|
||||
'3' => '4312',
|
||||
'4' => '4321',
|
||||
'5' => '4411',
|
||||
'6' => '3142',
|
||||
'7' => '3232',
|
||||
'8' => '3241',
|
||||
'9' => '4132',
|
||||
'A' => '4141',
|
||||
'B' => '4231',
|
||||
'C' => '3124',
|
||||
'D' => '3214',
|
||||
'E' => '3223',
|
||||
'F' => '4114',
|
||||
'G' => '4123',
|
||||
'H' => '4213',
|
||||
'I' => '1342',
|
||||
'J' => '1432',
|
||||
'K' => '1441',
|
||||
'L' => '2332',
|
||||
'M' => '2341',
|
||||
'N' => '2431',
|
||||
'O' => '1324',
|
||||
'P' => '1414',
|
||||
'Q' => '1423',
|
||||
'R' => '2314',
|
||||
'S' => '2323',
|
||||
'T' => '2413',
|
||||
'U' => '1144',
|
||||
'V' => '1234',
|
||||
'W' => '1243',
|
||||
'X' => '2134',
|
||||
'Y' => '2143',
|
||||
'Z' => '2233',
|
||||
];
|
||||
|
||||
/**
|
||||
* Characters used for checksum
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHKSUM = [
|
||||
'0' => '11',
|
||||
'1' => '12',
|
||||
'2' => '13',
|
||||
'3' => '14',
|
||||
'4' => '15',
|
||||
'5' => '10',
|
||||
'6' => '21',
|
||||
'7' => '22',
|
||||
'8' => '23',
|
||||
'9' => '24',
|
||||
'A' => '25',
|
||||
'B' => '20',
|
||||
'C' => '31',
|
||||
'D' => '32',
|
||||
'E' => '33',
|
||||
'F' => '34',
|
||||
'G' => '35',
|
||||
'H' => '30',
|
||||
'I' => '41',
|
||||
'J' => '42',
|
||||
'K' => '43',
|
||||
'L' => '44',
|
||||
'M' => '45',
|
||||
'N' => '40',
|
||||
'O' => '51',
|
||||
'P' => '52',
|
||||
'Q' => '53',
|
||||
'R' => '54',
|
||||
'S' => '55',
|
||||
'T' => '50',
|
||||
'U' => '01',
|
||||
'V' => '02',
|
||||
'W' => '03',
|
||||
'X' => '04',
|
||||
'Y' => '05',
|
||||
'Z' => '00',
|
||||
];
|
||||
|
||||
/**
|
||||
* Calculate the checksum.
|
||||
*
|
||||
* @param string $code code to represent.
|
||||
*
|
||||
* @return string char checksum.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getChecksum(string $code): string
|
||||
{
|
||||
$row = 0;
|
||||
$col = 0;
|
||||
$len = \strlen($code);
|
||||
for ($pos = 0; $pos < $len; ++$pos) {
|
||||
$char = $code[$pos];
|
||||
if (!\array_key_exists($char, $this::CHKSUM)) {
|
||||
throw new BarcodeException('Invalid character: ' . (\ord($char) & 0xFF));
|
||||
}
|
||||
|
||||
$row += $this->getChecksumDigit($char, 0);
|
||||
$col += $this->getChecksumDigit($char, 1);
|
||||
}
|
||||
|
||||
$row %= 6;
|
||||
$col %= 6;
|
||||
$check = \array_keys($this::CHKSUM, $row . $col, true);
|
||||
return (string) ($check[0] ?? '0');
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$code = \strtoupper($this->code);
|
||||
$this->extcode = $code . $this->getChecksum($code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the central bars
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCoreBars(): void
|
||||
{
|
||||
$this->formatCode();
|
||||
$clen = \strlen($this->extcode);
|
||||
for ($chr = 0; $chr < $clen; ++$chr) {
|
||||
$char = $this->extcode[$chr];
|
||||
for ($pos = 0; $pos < 4; ++$pos) {
|
||||
switch ($this->getBarPattern($char, $pos)) {
|
||||
case '1':
|
||||
$this->bars[] = [$this->ncols, 0, 1, 2];
|
||||
break;
|
||||
case '2':
|
||||
$this->bars[] = [$this->ncols, 0, 1, 3];
|
||||
break;
|
||||
case '3':
|
||||
$this->bars[] = [$this->ncols, 1, 1, 1];
|
||||
break;
|
||||
case '4':
|
||||
$this->bars[] = [$this->ncols, 1, 1, 2];
|
||||
break;
|
||||
}
|
||||
|
||||
$this->ncols += 2;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->ncols = 0;
|
||||
$this->nrows = 3;
|
||||
$this->bars = [];
|
||||
|
||||
// start bar
|
||||
$this->bars[] = [$this->ncols, 0, 1, 2];
|
||||
$this->ncols += 2;
|
||||
|
||||
$this->getCoreBars();
|
||||
|
||||
// stop bar
|
||||
$this->bars[] = [$this->ncols, 0, 1, 3];
|
||||
++$this->ncols;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* StandardTwoOfFive.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\StandardTwoOfFive;
|
||||
*
|
||||
* StandardTwoOfFive Barcode type class
|
||||
* Standard 2 of 5
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class StandardTwoOfFive extends \Com\Tecnick\Barcode\Type\Linear\StandardTwoOfFiveCheck
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'S25';
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = $this->code;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* StandardTwoOfFiveCheck.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\StandardTwoOfFiveCheck;
|
||||
*
|
||||
* StandardTwoOfFiveCheck Barcode type class
|
||||
* Standard 2 of 5 + CHECKSUM
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class StandardTwoOfFiveCheck extends \Com\Tecnick\Barcode\Type\Linear
|
||||
{
|
||||
protected function getPattern(string $digit): string
|
||||
{
|
||||
return $this::CHBAR[$digit] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'S25+';
|
||||
|
||||
/**
|
||||
* Map characters to barcodes
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const CHBAR = [
|
||||
'0' => '10101110111010',
|
||||
'1' => '11101010101110',
|
||||
'2' => '10111010101110',
|
||||
'3' => '11101110101010',
|
||||
'4' => '10101110101110',
|
||||
'5' => '11101011101010',
|
||||
'6' => '10111011101010',
|
||||
'7' => '10101011101110',
|
||||
'8' => '11101010111010',
|
||||
'9' => '10111010111010',
|
||||
];
|
||||
|
||||
/**
|
||||
* Calculate the checksum
|
||||
*
|
||||
* @param string $code Code to represent.
|
||||
*
|
||||
* @return int char checksum.
|
||||
*/
|
||||
protected function getChecksum(string $code): int
|
||||
{
|
||||
$clen = \strlen($code);
|
||||
$sum = 0;
|
||||
for ($idx = 0; $idx < $clen; $idx += 2) {
|
||||
$sum += (int) $code[$idx];
|
||||
}
|
||||
|
||||
$sum *= 3;
|
||||
for ($idx = 1; $idx < $clen; $idx += 2) {
|
||||
$sum += (int) $code[$idx];
|
||||
}
|
||||
|
||||
$check = $sum % 10;
|
||||
if ($check > 0) {
|
||||
return 10 - $check;
|
||||
}
|
||||
|
||||
return $check;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format code
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$this->extcode = $this->code . (string) $this->getChecksum($this->code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->formatCode();
|
||||
if ((\strlen($this->extcode) % 2) !== 0) {
|
||||
// add leading zero if code-length is odd
|
||||
$this->extcode = '0' . $this->extcode;
|
||||
}
|
||||
|
||||
$seq = '1110111010';
|
||||
$clen = \strlen($this->extcode);
|
||||
for ($idx = 0; $idx < $clen; ++$idx) {
|
||||
$digit = $this->extcode[$idx];
|
||||
if (!\array_key_exists($digit, $this::CHBAR)) {
|
||||
throw new BarcodeException('Invalid character: ' . (\ord($digit) & 0xFF));
|
||||
}
|
||||
|
||||
$seq .= $this->getPattern($digit);
|
||||
}
|
||||
|
||||
$seq .= '111010111';
|
||||
$this->processBinarySequence($this->getRawCodeRows($seq));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* UpcA.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\UpcA;
|
||||
*
|
||||
* UpcA Barcode type class
|
||||
* UPC-A
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class UpcA extends \Com\Tecnick\Barcode\Type\Linear\EanOneThree
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'UPCA';
|
||||
|
||||
/**
|
||||
* Fixed code length
|
||||
*/
|
||||
protected int $code_length = 12;
|
||||
|
||||
/**
|
||||
* Format the code
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$code = \str_pad($this->code, $this->code_length - 1, '0', STR_PAD_LEFT);
|
||||
$code .= $this->getChecksum($code);
|
||||
++$this->code_length;
|
||||
$this->extcode = '0' . $code;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,203 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* UpcE.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Linear;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Linear\UpcE;
|
||||
*
|
||||
* UpcE Barcode type class
|
||||
* UPC-E
|
||||
*
|
||||
* UPC-E is a variation of UPC-A which allows for a more compact barcode by eliminating "extra" zeros.
|
||||
* Since the resulting UPC-E barcode is about half the size as an UPC-A barcode, UPC-E is generally used on products
|
||||
* with very small packaging where a full UPC-A barcode couldn't reasonably fit.
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class UpcE extends \Com\Tecnick\Barcode\Type\Linear\UpcA
|
||||
{
|
||||
protected function getCharAt(string $value, int $index): string
|
||||
{
|
||||
return $value[$index] ?? '0';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, string>
|
||||
*/
|
||||
protected function getUpceParityPattern(string $digit, int $check): array
|
||||
{
|
||||
$pattern = $this::PARITIES_UPCE[$digit][$check] ?? ['A', 'A', 'A', 'A', 'A', 'A'];
|
||||
return \array_values($pattern);
|
||||
}
|
||||
|
||||
protected function getBarPattern(string $parity, string $digit): string
|
||||
{
|
||||
return $this::CHBAR[$parity][$digit] ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'UPCE';
|
||||
|
||||
/**
|
||||
* Fixed code length
|
||||
*/
|
||||
protected int $code_length = 12;
|
||||
|
||||
/**
|
||||
* Map parities
|
||||
*
|
||||
* @var array<int|string, array<int|string, array<string>>>
|
||||
*/
|
||||
protected const PARITIES_UPCE = [
|
||||
0 => [
|
||||
'0' => ['B', 'B', 'B', 'A', 'A', 'A'],
|
||||
'1' => ['B', 'B', 'A', 'B', 'A', 'A'],
|
||||
'2' => ['B', 'B', 'A', 'A', 'B', 'A'],
|
||||
'3' => ['B', 'B', 'A', 'A', 'A', 'B'],
|
||||
'4' => ['B', 'A', 'B', 'B', 'A', 'A'],
|
||||
'5' => ['B', 'A', 'A', 'B', 'B', 'A'],
|
||||
'6' => ['B', 'A', 'A', 'A', 'B', 'B'],
|
||||
'7' => ['B', 'A', 'B', 'A', 'B', 'A'],
|
||||
'8' => ['B', 'A', 'B', 'A', 'A', 'B'],
|
||||
'9' => ['B', 'A', 'A', 'B', 'A', 'B'],
|
||||
],
|
||||
1 => [
|
||||
'0' => ['A', 'A', 'A', 'B', 'B', 'B'],
|
||||
'1' => ['A', 'A', 'B', 'A', 'B', 'B'],
|
||||
'2' => ['A', 'A', 'B', 'B', 'A', 'B'],
|
||||
'3' => ['A', 'A', 'B', 'B', 'B', 'A'],
|
||||
'4' => ['A', 'B', 'A', 'A', 'B', 'B'],
|
||||
'5' => ['A', 'B', 'B', 'A', 'A', 'B'],
|
||||
'6' => ['A', 'B', 'B', 'B', 'A', 'A'],
|
||||
'7' => ['A', 'B', 'A', 'B', 'A', 'B'],
|
||||
'8' => ['A', 'B', 'A', 'B', 'B', 'A'],
|
||||
'9' => ['A', 'B', 'B', 'A', 'B', 'A'],
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* Convert UPC-E code to UPC-A
|
||||
*
|
||||
* @param string $code Code to convert.
|
||||
*/
|
||||
protected function convertUpceToUpca(string $code): string
|
||||
{
|
||||
if ($code[5] < '3') {
|
||||
return '0' . $code[0] . $code[1] . $code[5] . '0000' . $code[2] . $code[3] . $code[4];
|
||||
}
|
||||
|
||||
if ($code[5] === '3') {
|
||||
return '0' . $code[0] . $code[1] . $code[2] . '00000' . $code[3] . $code[4];
|
||||
}
|
||||
|
||||
if ($code[5] === '4') {
|
||||
return '0' . $code[0] . $code[1] . $code[2] . $code[3] . '00000' . $code[4];
|
||||
}
|
||||
|
||||
return '0' . $code[0] . $code[1] . $code[2] . $code[3] . $code[4] . '0000' . $code[5];
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert UPC-A code to UPC-E
|
||||
*
|
||||
* @param string $code Code to convert.
|
||||
*/
|
||||
protected function convertUpcaToUpce(string $code): string
|
||||
{
|
||||
$tmp = \substr($code, 4, 3);
|
||||
if ($tmp === '000' || $tmp === '100' || $tmp === '200') {
|
||||
// manufacturer code ends in 000, 100, or 200
|
||||
return \substr($code, 2, 2) . \substr($code, 9, 3) . \substr($code, 4, 1);
|
||||
}
|
||||
|
||||
$tmp = \substr($code, 5, 2);
|
||||
if ($tmp === '00') {
|
||||
// manufacturer code ends in 00
|
||||
return \substr($code, 2, 3) . \substr($code, 10, 2) . '3';
|
||||
}
|
||||
|
||||
$tmp = \substr($code, 6, 1);
|
||||
if ($tmp === '0') {
|
||||
// manufacturer code ends in 0
|
||||
return \substr($code, 2, 4) . \substr($code, 11, 1) . '4';
|
||||
}
|
||||
|
||||
// manufacturer code does not end in zero
|
||||
return \substr($code, 2, 5) . \substr($code, 11, 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Format the code
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function formatCode(): void
|
||||
{
|
||||
$code = $this->code;
|
||||
if (\strlen($code) === 6) {
|
||||
$code = $this->convertUpceToUpca($code);
|
||||
}
|
||||
|
||||
$code = \str_pad($code, $this->code_length - 1, '0', STR_PAD_LEFT);
|
||||
// append the computed check digit only when the input does not already carry it,
|
||||
// otherwise getChecksum() just validates it and returns 0 (avoid a spurious digit)
|
||||
$check = $this->getChecksum($code);
|
||||
if (\strlen($code) < $this->code_length) {
|
||||
$code .= $check;
|
||||
}
|
||||
|
||||
++$this->code_length;
|
||||
$this->extcode = '0' . $code;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the bars array.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
if (!\is_numeric($this->code)) {
|
||||
throw new BarcodeException('Input code must be a number');
|
||||
}
|
||||
|
||||
$this->formatCode();
|
||||
$upce_code = $this->convertUpcaToUpce($this->extcode);
|
||||
$seq = '101'; // left guard bar
|
||||
$parity = $this->getUpceParityPattern($this->getCharAt($this->extcode, 1), $this->check);
|
||||
for ($pos = 0; $pos < 6; ++$pos) {
|
||||
$seq .= $this->getBarPattern($this->getCharAt($parity[$pos] ?? 'A', 0), $this->getCharAt($upce_code, $pos));
|
||||
}
|
||||
|
||||
$seq .= '010101'; // right guard bar
|
||||
$this->processBinarySequence($this->getRawCodeRows($seq));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Raw.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Raw
|
||||
*
|
||||
* Raw Barcode type class
|
||||
* RAW MODE (comma-separated rows)
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Raw extends \Com\Tecnick\Barcode\Type
|
||||
{
|
||||
/**
|
||||
* Generate the bars array
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->processBinarySequence($this->getRawCodeRows($this->code));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Square.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square
|
||||
*
|
||||
* Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Square extends \Com\Tecnick\Barcode\Type
|
||||
{
|
||||
/**
|
||||
* Barcode type
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const TYPE = 'square';
|
||||
}
|
||||
@@ -0,0 +1,143 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Aztec.php
|
||||
*
|
||||
* @since 2023-10-12
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
use Com\Tecnick\Barcode\Type\Square\Aztec\AztecHint;
|
||||
use Com\Tecnick\Barcode\Type\Square\Aztec\AztecRange;
|
||||
use Com\Tecnick\Barcode\Type\Square\Aztec\Data;
|
||||
use Com\Tecnick\Barcode\Type\Square\Aztec\Encode;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec
|
||||
*
|
||||
* Aztec Barcode type class
|
||||
*
|
||||
* @since 2023-10-12
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Aztec extends \Com\Tecnick\Barcode\Type\Square
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'AZTEC';
|
||||
|
||||
/**
|
||||
* Error correction code percentage of error check words.
|
||||
* A minimum of 23% + 3 words is recommended by ISO/IEC 24778:2008a.
|
||||
*/
|
||||
protected int $ecc = 33;
|
||||
|
||||
/**
|
||||
* Encoding mode
|
||||
*/
|
||||
protected string $hint = 'A';
|
||||
|
||||
/**
|
||||
* Mode:
|
||||
* - A = Automatic selection between Compact (priority) and Full Range.
|
||||
* - F = Force Full Range mode.
|
||||
*/
|
||||
protected string $mode = 'A';
|
||||
|
||||
/**
|
||||
* Extended Channel Interpretation (ECI) code to be added at the beginning of the stream.
|
||||
* See Data:ECI for the list of supported codes.
|
||||
* NOTE: Even if special FNC1 or ECI flag characters could be inserted
|
||||
* at any points in the stream, this will only be added at the beginning of the stream.
|
||||
*/
|
||||
protected int $eci = -1;
|
||||
|
||||
/**
|
||||
* Set extra (optional) parameters:
|
||||
* 1: ECC : Error correction code percentage of error check words.
|
||||
* A minimum of 23% + 3 words is recommended by ISO/IEC 24778:2008a.
|
||||
* 2: HINT : Encoding mode: A=Automatic, B=Binary.
|
||||
* 3: LAYERS : Custom number of layers (0 = auto).
|
||||
* 4: ECI : Extended Channel Interpretation (ECI) code. Use -1 for FNC1. See $this->eci.
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
* @SuppressWarnings("PHPMD.NPathComplexity")
|
||||
*/
|
||||
protected function setParameters(): void
|
||||
{
|
||||
parent::setParameters();
|
||||
|
||||
// ecc percentage
|
||||
if (
|
||||
($this->params[0] ?? null) === null
|
||||
|| !\is_numeric($this->params[0])
|
||||
|| (int) $this->params[0] < 1
|
||||
|| (int) $this->params[0] > 100
|
||||
) {
|
||||
$this->params[0] = 33;
|
||||
}
|
||||
|
||||
$this->ecc = (int) $this->params[0];
|
||||
|
||||
// hint
|
||||
$aztecHint = AztecHint::fromLoose(\is_string($this->params[1] ?? null) ? $this->params[1] : '');
|
||||
$this->params[1] = $aztecHint->value;
|
||||
$this->hint = $aztecHint->value;
|
||||
|
||||
// mode
|
||||
$aztecRange = AztecRange::fromLoose(\is_string($this->params[2] ?? null) ? $this->params[2] : '');
|
||||
$this->params[2] = $aztecRange->value;
|
||||
$this->mode = $aztecRange->value;
|
||||
|
||||
// eci code. Used to set the charset encoding. See $this->eci.
|
||||
if (
|
||||
($this->params[3] ?? null) === null
|
||||
|| !\is_numeric($this->params[3])
|
||||
|| !\array_key_exists((int) $this->params[3], Data::ECI)
|
||||
) {
|
||||
$this->params[3] = -1;
|
||||
}
|
||||
|
||||
$this->eci = (int) $this->params[3];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the bars array
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
if (\strlen($this->code) === 0) {
|
||||
throw new BarcodeException('Empty input');
|
||||
}
|
||||
|
||||
try {
|
||||
$encode = new Encode($this->code, $this->ecc, $this->eci, $this->hint, $this->mode);
|
||||
$grid = $encode->getGrid();
|
||||
$this->processBinarySequence($grid);
|
||||
} catch (BarcodeException $barcodeException) {
|
||||
throw new BarcodeException('AZTEC: ' . $barcodeException->getMessage());
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* AztecHint.php
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Aztec;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec\AztecHint
|
||||
*
|
||||
* Backed enum for the Aztec Code encoding hint: A (automatic, default) or B
|
||||
* (binary).
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
enum AztecHint: string
|
||||
{
|
||||
/** Automatic encoding (default). */
|
||||
case Automatic = 'A';
|
||||
|
||||
/** Binary encoding. */
|
||||
case Binary = 'B';
|
||||
|
||||
/**
|
||||
* Resolve a loose Aztec hint value to the matching enum case.
|
||||
*
|
||||
* Accepts the canonical letter or an enum instance (returned unchanged).
|
||||
* Unknown values fall back to Automatic, matching the lenient behavior of
|
||||
* Aztec.
|
||||
*
|
||||
* @param string|self $value Hint letter or enum case.
|
||||
*/
|
||||
public static function fromLoose(string|self $value): self
|
||||
{
|
||||
if ($value instanceof self) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
return self::tryFrom($value) ?? self::Automatic;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* AztecRange.php
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Aztec;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec\AztecRange
|
||||
*
|
||||
* Backed enum for the Aztec Code symbol range mode: A (automatic selection
|
||||
* between Compact and Full Range, default) or F (force Full Range).
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
enum AztecRange: string
|
||||
{
|
||||
/** Automatic selection between Compact (priority) and Full Range (default). */
|
||||
case Automatic = 'A';
|
||||
|
||||
/** Force Full Range mode. */
|
||||
case FullRange = 'F';
|
||||
|
||||
/**
|
||||
* Resolve a loose Aztec range mode value to the matching enum case.
|
||||
*
|
||||
* Accepts the canonical letter or an enum instance (returned unchanged).
|
||||
* Unknown values fall back to Automatic, matching the lenient behavior of
|
||||
* Aztec.
|
||||
*
|
||||
* @param string|self $value Range mode letter or enum case.
|
||||
*/
|
||||
public static function fromLoose(string|self $value): self
|
||||
{
|
||||
if ($value instanceof self) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
return self::tryFrom($value) ?? self::Automatic;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,376 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Bitstream.php
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Aztec;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec\Bitstream
|
||||
*
|
||||
* Bitstream for Aztec Barcode type class
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
|
||||
*/
|
||||
abstract class Bitstream extends \Com\Tecnick\Barcode\Type\Square\Aztec\Layers
|
||||
{
|
||||
/**
|
||||
* Performs the high-level encoding for the given code and ECI mode.
|
||||
*
|
||||
* @param string $code The code to encode.
|
||||
* @param int $eci The ECI mode to use.
|
||||
* @param string $hint The mode to use.
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function highLevelEncoding(string $code, int $eci = 0, string $hint = 'A'): void
|
||||
{
|
||||
$this->addFLG($eci);
|
||||
$chrarr = \unpack('C*', $code);
|
||||
if ($chrarr === false) {
|
||||
throw new BarcodeException('Unable to unpack the code');
|
||||
}
|
||||
|
||||
$chars = \array_values($chrarr);
|
||||
$chrlen = \count($chars);
|
||||
if ($hint === 'B') {
|
||||
$this->binaryEncode($chars, $chrlen); // @phpstan-ignore argument.type
|
||||
return;
|
||||
}
|
||||
|
||||
$this->autoEncode($chars, $chrlen); // @phpstan-ignore argument.type
|
||||
}
|
||||
|
||||
/**
|
||||
* Forced binary encoding for the given characters.
|
||||
*
|
||||
* @param list<int> $chars Integer ASCII values of the characters to encode.
|
||||
* @param int $chrlen Length of the $chars array.
|
||||
*/
|
||||
protected function binaryEncode(array $chars, int $chrlen): void
|
||||
{
|
||||
$bits = Data::MODE_BITS[Data::MODE_BINARY] ?? 8;
|
||||
$this->addShift(Data::MODE_BINARY);
|
||||
if ($chrlen > 62) {
|
||||
$this->addRawCwd(5, 0);
|
||||
$this->addRawCwd(11, $chrlen - 31);
|
||||
for ($idx = 0; $idx < $chrlen; ++$idx) {
|
||||
$this->addRawCwd($bits, $chars[$idx] ?? 0);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if ($chrlen > 31) {
|
||||
$this->addRawCwd(5, 31);
|
||||
for ($idx = 0; $idx < 31; ++$idx) {
|
||||
$this->addRawCwd($bits, $chars[$idx] ?? 0);
|
||||
}
|
||||
|
||||
$this->addShift(Data::MODE_BINARY);
|
||||
$this->addRawCwd(5, $chrlen - 31);
|
||||
for ($idx = 31; $idx < $chrlen; ++$idx) {
|
||||
$this->addRawCwd($bits, $chars[$idx] ?? 0);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->addRawCwd(5, $chrlen);
|
||||
for ($idx = 0; $idx < $chrlen; ++$idx) {
|
||||
$this->addRawCwd($bits, $chars[$idx] ?? 0);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Automatic encoding for the given characters.
|
||||
*
|
||||
* @param list<int> $chars Integer ASCII values of the characters to encode.
|
||||
* @param int $chrlen Length of the $chars array.
|
||||
*/
|
||||
protected function autoEncode(array $chars, int $chrlen): void
|
||||
{
|
||||
$idx = 0;
|
||||
while ($idx < $chrlen) {
|
||||
if ($this->processBinaryChars($chars, $idx, $chrlen)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($this->processPunctPairs($chars, $idx, $chrlen)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->processModeChars($chars, $idx, $chrlen);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Process mode characters.
|
||||
*
|
||||
* @param list<int> $chars The array of characters.
|
||||
* @param int $idx The current character index.
|
||||
* @param int $chrlen The total number of characters to process.
|
||||
*/
|
||||
protected function processModeChars(array &$chars, int &$idx, int $chrlen): void
|
||||
{
|
||||
$ord = $chars[$idx] ?? 0;
|
||||
$mode = $this->isSameMode($this->encmode, $ord) ? $this->encmode : $this->charMode($ord);
|
||||
|
||||
$nchr = $this->countModeChars($chars, $idx, $chrlen, $mode);
|
||||
if ($this->encmode !== $mode) {
|
||||
$shiftMap = Data::SHIFT_MAP[$this->encmode] ?? [];
|
||||
$canShift = $nchr === 1 && (\array_key_exists($mode, $shiftMap) && $shiftMap[$mode] !== []);
|
||||
if ($canShift) {
|
||||
$this->addShift($mode);
|
||||
$this->mergeTmpCwd();
|
||||
$idx += $nchr;
|
||||
return;
|
||||
}
|
||||
|
||||
$this->addLatch($mode);
|
||||
}
|
||||
|
||||
$this->mergeTmpCwd();
|
||||
$idx += $nchr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Count consecutive characters in the same mode.
|
||||
*
|
||||
* @param list<int> $chars The array of characters.
|
||||
* @param int $idx The current character index.
|
||||
* @param int $chrlen The total number of characters to process.
|
||||
* @param int $mode The current mode.
|
||||
*/
|
||||
protected function countModeChars(array &$chars, int $idx, int $chrlen, int $mode): int
|
||||
{
|
||||
$this->tmpCdws = [];
|
||||
$nbits = Data::MODE_BITS[$mode] ?? 0;
|
||||
$count = 0;
|
||||
do {
|
||||
$ord = $chars[$idx] ?? 0;
|
||||
if (
|
||||
!$this->isSameMode($mode, $ord)
|
||||
|| $idx < ($chrlen - 1) && $this->punctPairMode($ord, $chars[$idx + 1] ?? 0) > 0
|
||||
) {
|
||||
return $count;
|
||||
}
|
||||
|
||||
$this->tmpCdws[] = [$nbits, $this->charEnc($mode, $ord)];
|
||||
++$count;
|
||||
++$idx;
|
||||
} while ($idx < $chrlen);
|
||||
|
||||
return $count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Process consecutive binary characters.
|
||||
*
|
||||
* @param list<int> $chars The array of characters.
|
||||
* @param int $idx The current character index.
|
||||
* @param int $chrlen The total number of characters to process.
|
||||
*
|
||||
* @return bool True if binary characters have been found and processed.
|
||||
*/
|
||||
protected function processBinaryChars(array &$chars, int &$idx, int $chrlen): bool
|
||||
{
|
||||
$binchrs = $this->countBinaryChars($chars, $idx, $chrlen);
|
||||
if ($binchrs === 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$encmode = $this->encmode;
|
||||
$this->addShift(Data::MODE_BINARY);
|
||||
if ($binchrs > 62) {
|
||||
$this->addRawCwd(5, 0);
|
||||
$this->addRawCwd(11, $binchrs - 31);
|
||||
$this->mergeTmpCwdRaw();
|
||||
$idx += $binchrs;
|
||||
$this->encmode = $encmode;
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($binchrs > 31) {
|
||||
$nbits = Data::MODE_BITS[Data::MODE_BINARY] ?? 8;
|
||||
$this->addRawCwd(5, 31);
|
||||
for ($bcw = 0; $bcw < 31; ++$bcw) {
|
||||
$tmpCdw = $this->tmpCdws[$bcw] ?? [0, 0];
|
||||
$this->addRawCwd($nbits, $tmpCdw[1]);
|
||||
}
|
||||
|
||||
$this->addShift(Data::MODE_BINARY);
|
||||
$this->addRawCwd(5, $binchrs - 31);
|
||||
for ($bcw = 31; $bcw < $binchrs; ++$bcw) {
|
||||
$tmpCdw = $this->tmpCdws[$bcw] ?? [0, 0];
|
||||
$this->addRawCwd($nbits, $tmpCdw[1]);
|
||||
}
|
||||
|
||||
$idx += $binchrs;
|
||||
$this->encmode = $encmode;
|
||||
return true;
|
||||
}
|
||||
|
||||
$this->addRawCwd(5, $binchrs);
|
||||
$this->mergeTmpCwdRaw();
|
||||
$idx += $binchrs;
|
||||
$this->encmode = $encmode;
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Count consecutive binary characters.
|
||||
*
|
||||
* @param list<int> $chars The array of characters.
|
||||
* @param int $idx The current character index.
|
||||
* @param int $chrlen The total number of characters to process.
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
*/
|
||||
protected function countBinaryChars(array &$chars, int $idx, int $chrlen): int
|
||||
{
|
||||
$this->tmpCdws = [];
|
||||
$count = 0;
|
||||
$nbits = Data::MODE_BITS[Data::MODE_BINARY] ?? 8;
|
||||
while ($idx < $chrlen && $count < 2048) {
|
||||
$ord = $chars[$idx] ?? 0;
|
||||
if ($this->charMode($ord) !== Data::MODE_BINARY) {
|
||||
return $count;
|
||||
}
|
||||
|
||||
$this->tmpCdws[] = [$nbits, $ord];
|
||||
++$count;
|
||||
++$idx;
|
||||
}
|
||||
|
||||
return $count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Process consecutive special Punctuation Pairs.
|
||||
*
|
||||
* @param list<int> $chars The array of characters.
|
||||
* @param int $idx The current character index.
|
||||
* @param int $chrlen The total number of characters to process.
|
||||
*
|
||||
* @return bool True if pair characters have been found and processed.
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
*/
|
||||
protected function processPunctPairs(array &$chars, int &$idx, int $chrlen): bool
|
||||
{
|
||||
$ppairs = $this->countPunctPairs($chars, $idx, $chrlen);
|
||||
if ($ppairs === 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
switch ($this->encmode) {
|
||||
case Data::MODE_PUNCT:
|
||||
break;
|
||||
case Data::MODE_MIXED:
|
||||
$this->addLatch(Data::MODE_PUNCT);
|
||||
break;
|
||||
case Data::MODE_UPPER:
|
||||
case Data::MODE_LOWER:
|
||||
if ($ppairs > 1) {
|
||||
$this->addLatch(Data::MODE_PUNCT);
|
||||
}
|
||||
|
||||
break;
|
||||
case Data::MODE_DIGIT:
|
||||
$common = $this->countPunctAndDigitChars($chars, $idx, $chrlen);
|
||||
$clen = \count($common);
|
||||
if ($clen > 0 && $clen < 6) {
|
||||
$this->tmpCdws = $common;
|
||||
$this->mergeTmpCwdRaw();
|
||||
$idx += $clen;
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($ppairs > 2) {
|
||||
$this->addLatch(Data::MODE_PUNCT);
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
$this->mergeTmpCwd(Data::MODE_PUNCT);
|
||||
$idx += $ppairs * 2;
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Count consecutive special Punctuation Pairs.
|
||||
*
|
||||
* @param list<int> $chars The array of characters.
|
||||
* @param int $idx The current character index.
|
||||
* @param int $chrlen The total number of characters to process.
|
||||
*/
|
||||
protected function countPunctPairs(array &$chars, int $idx, int $chrlen): int
|
||||
{
|
||||
$this->tmpCdws = [];
|
||||
$pairs = 0;
|
||||
$maxidx = $chrlen - 1;
|
||||
while ($idx < $maxidx) {
|
||||
$pmode = $this->punctPairMode($chars[$idx] ?? 0, $chars[$idx + 1] ?? 0);
|
||||
if ($pmode === 0) {
|
||||
return $pairs;
|
||||
}
|
||||
|
||||
$this->tmpCdws[] = [5, $pmode];
|
||||
++$pairs;
|
||||
$idx += 2;
|
||||
}
|
||||
|
||||
return $pairs;
|
||||
}
|
||||
|
||||
/**
|
||||
* Counts the number of consecutive charcters that are in both PUNCT or DIGIT modes.
|
||||
* Returns the array with the codewords.
|
||||
*
|
||||
* @param list<int> $chars The string to count the characters in.
|
||||
* @param int $idx The starting index to count from.
|
||||
* @param int $chrlen The length of the string to count.
|
||||
*
|
||||
* @return array<int, array{int, int}> The array of codewords.
|
||||
*/
|
||||
protected function countPunctAndDigitChars(array $chars, int $idx, int $chrlen): array
|
||||
{
|
||||
$words = [];
|
||||
while ($idx < $chrlen) {
|
||||
$ord = $chars[$idx] ?? 0;
|
||||
if (!$this->isPunctAndDigitChar($ord)) {
|
||||
return $words;
|
||||
}
|
||||
|
||||
$words[] = [4, $this->charEnc(Data::MODE_DIGIT, $ord)];
|
||||
++$idx;
|
||||
}
|
||||
|
||||
return $words;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,327 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Codeword.php
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Aztec;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec\Codeword
|
||||
*
|
||||
* Codeword utility methods for Aztec Barcode type class
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Codeword
|
||||
{
|
||||
/**
|
||||
* @param array<int> $bitstream
|
||||
*/
|
||||
protected function getBitstreamBit(array $bitstream, int $index): int
|
||||
{
|
||||
if (!\array_key_exists($index, $bitstream)) {
|
||||
return 1;
|
||||
}
|
||||
|
||||
return $bitstream[$index] === 0 ? 0 : 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, array{int, int}>
|
||||
*/
|
||||
protected function getLatchMap(int $fromMode, int $toMode): array
|
||||
{
|
||||
$map = Data::LATCH_MAP[$fromMode][$toMode] ?? [];
|
||||
return \array_values($map);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, array{int, int}>
|
||||
*/
|
||||
protected function getShiftMap(int $fromMode, int $toMode): array
|
||||
{
|
||||
$map = Data::SHIFT_MAP[$fromMode][$toMode] ?? [];
|
||||
return \array_values($map);
|
||||
}
|
||||
|
||||
/**
|
||||
* Current character encoding mode.
|
||||
*/
|
||||
protected int $encmode = Data::MODE_UPPER;
|
||||
|
||||
/**
|
||||
* Array containing the high-level encoding bitstream.
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected array $bitstream = [];
|
||||
|
||||
/**
|
||||
* Temporary array of codewords.
|
||||
*
|
||||
* @var array<int, array{int, int}>
|
||||
*/
|
||||
protected array $tmpCdws = [];
|
||||
|
||||
/**
|
||||
* Count the total number of bits in the bitstream.
|
||||
*/
|
||||
protected int $totbits = 0;
|
||||
|
||||
/**
|
||||
* Encodes a character using the specified mode and ordinal value.
|
||||
*
|
||||
* @param int $mode The encoding mode.
|
||||
* @param int $ord The ordinal value of the character to encode.
|
||||
*
|
||||
* @return int The encoded character.
|
||||
*/
|
||||
protected function charEnc(int $mode, int $ord): int
|
||||
{
|
||||
return Data::CHAR_ENC[$mode][$ord] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the character mode for a given ASCII code.
|
||||
*
|
||||
* @param int $ord The ASCII code of the character.
|
||||
*
|
||||
* @return int The character mode.
|
||||
*/
|
||||
protected function charMode(int $ord): int
|
||||
{
|
||||
return Data::CHAR_MODES[$ord] ?? Data::MODE_BINARY;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if current character is supported by the current code.
|
||||
*
|
||||
* @param int $mode The mode to check.
|
||||
* @param int $ord The character ASCII value to compare against.
|
||||
*
|
||||
* @return bool Returns true if the mode is the same as the ordinal value, false otherwise.
|
||||
*/
|
||||
protected function isSameMode(int $mode, int $ord): bool
|
||||
{
|
||||
return (
|
||||
$mode === $this->charMode($ord)
|
||||
|| $ord === 32
|
||||
&& $mode !== Data::MODE_PUNCT
|
||||
|| $mode === Data::MODE_PUNCT
|
||||
&& ($ord === 13 || $ord === 44 || $ord === 46)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the character is in common between the PUNCT and DIGIT modes.
|
||||
* Characters ' ' (32), '.' (46) and ',' (44) are in common between the PUNCT and DIGIT modes.
|
||||
*
|
||||
* @param int $ord Integer ASCII code of the character to check.
|
||||
*/
|
||||
protected function isPunctAndDigitChar(int $ord): bool
|
||||
{
|
||||
return $ord === 32 || $ord === 44 || $ord === 46;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the PUNCT two-bytes code if the given two characters are a punctuation pair.
|
||||
* Punct codes 2–5 encode two bytes each.
|
||||
*
|
||||
* @param int $ord The current character code.
|
||||
* @param int $next The next character code.
|
||||
*/
|
||||
protected function punctPairMode(int $ord, int $next): int
|
||||
{
|
||||
$key = ($ord << 8) + $next;
|
||||
return match ($key) {
|
||||
(13 << 8) + 10 => 2,
|
||||
(46 << 8) + 32 => 3,
|
||||
(44 << 8) + 32 => 4,
|
||||
(58 << 8) + 32 => 5,
|
||||
default => 0,
|
||||
}; // no punct pair
|
||||
}
|
||||
|
||||
/**
|
||||
* Append a new Codeword as a big-endian bit sequence.
|
||||
*
|
||||
* @param array<int> $bitstream Array of bits to append to.
|
||||
* @param int $totbits Number of bits in the bitstream.
|
||||
* @param int $wsize The number of bits in the codeword.
|
||||
* @param int $value The value of the codeword.
|
||||
*/
|
||||
protected function appendWordToBitstream(array &$bitstream, int &$totbits, int $wsize, int $value): void
|
||||
{
|
||||
for ($idx = $wsize - 1; $idx >= 0; --$idx) {
|
||||
$bitstream[] = ($value >> $idx) & 1;
|
||||
}
|
||||
|
||||
$totbits += $wsize;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert the bitstream to words.
|
||||
*
|
||||
* @param array<int> $bitstream Array of bits to convert.
|
||||
* @param int $totbits Number of bits in the bitstream.
|
||||
* @param int $wsize The word size.
|
||||
*
|
||||
* @return array<int> Array of words.
|
||||
*/
|
||||
protected function bitstreamToWords(array $bitstream, int $totbits, int $wsize): array
|
||||
{
|
||||
$words = [];
|
||||
$numwords = (int) \ceil($totbits / $wsize);
|
||||
for ($idx = 0; $idx < $numwords; ++$idx) {
|
||||
$wrd = 0;
|
||||
for ($bit = 0; $bit < $wsize; ++$bit) {
|
||||
$pos = ($idx * $wsize) + $bit;
|
||||
if ($this->getBitstreamBit($bitstream, $pos) === 1) {
|
||||
$wrd |= 1 << ($wsize - $bit - 1); // reverse order
|
||||
}
|
||||
}
|
||||
|
||||
$words[] = $wrd;
|
||||
}
|
||||
|
||||
return $words;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a new Codeword as a big-endian bit sequence.
|
||||
*
|
||||
* @param int $bits The number of bits in the codeword.
|
||||
* @param int $value The value of the codeword.
|
||||
*/
|
||||
protected function addRawCwd(int $bits, int $value): void
|
||||
{
|
||||
$this->appendWordToBitstream($this->bitstream, $this->totbits, $bits, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a Codeword.
|
||||
*
|
||||
* @param int $mode The encoding mode.
|
||||
* @param int $value The value to encode.
|
||||
*/
|
||||
protected function addCdw(int $mode, int $value): void
|
||||
{
|
||||
$this->addRawCwd(Data::MODE_BITS[$mode] ?? 0, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Latch to another mode.
|
||||
*
|
||||
* @param int $mode The new encoding mode.
|
||||
*/
|
||||
protected function addLatch(int $mode): void
|
||||
{
|
||||
$latch = $this->getLatchMap($this->encmode, $mode);
|
||||
foreach ($latch as $cdw) {
|
||||
$this->addRawCwd($cdw[0], $cdw[1]);
|
||||
}
|
||||
|
||||
$this->encmode = $mode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Shift to another mode.
|
||||
*/
|
||||
protected function addShift(int $mode): void
|
||||
{
|
||||
$shift = $this->getShiftMap($this->encmode, $mode);
|
||||
foreach ($shift as $cdw) {
|
||||
$this->addRawCwd($cdw[0], $cdw[1]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Merges the temporary codewords array with the current codewords array.
|
||||
* Shift to the specified mode.
|
||||
*
|
||||
* @param int $mode The encoding mode for the codewords.
|
||||
*/
|
||||
protected function mergeTmpCwdWithShift(int $mode): void
|
||||
{
|
||||
foreach ($this->tmpCdws as $tmpCdw) {
|
||||
$this->addShift($mode);
|
||||
$this->addRawCwd($tmpCdw[0], $tmpCdw[1]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Merges the temporary codewords array with the current codewords array.
|
||||
* No shift is performed.
|
||||
*/
|
||||
protected function mergeTmpCwdRaw(): void
|
||||
{
|
||||
foreach ($this->tmpCdws as $tmpCdw) {
|
||||
$this->addRawCwd($tmpCdw[0], $tmpCdw[1]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge temporary codewords with current codewords based on the encoding mode.
|
||||
*
|
||||
* @param int $mode The encoding mode to use for merging codewords.
|
||||
* If negative, the current encoding mode will be used.
|
||||
*/
|
||||
protected function mergeTmpCwd(int $mode = -1): void
|
||||
{
|
||||
if ($mode < 0 || $this->encmode === $mode) {
|
||||
$this->mergeTmpCwdRaw();
|
||||
$this->tmpCdws = [];
|
||||
return;
|
||||
}
|
||||
|
||||
$this->mergeTmpCwdWithShift($mode);
|
||||
$this->tmpCdws = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds the FLG (Function Length Group) codeword to the data codewords.
|
||||
*
|
||||
* @param int $eci Extended Channel Interpretation value. If negative, the function does nothing.
|
||||
*/
|
||||
protected function addFLG(int $eci): void
|
||||
{
|
||||
if ($eci < 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->encmode !== Data::MODE_PUNCT) {
|
||||
$this->addShift(Data::MODE_PUNCT);
|
||||
}
|
||||
|
||||
if ($eci === 0) {
|
||||
$this->addRawCwd(3, 0); // FNC1
|
||||
return;
|
||||
}
|
||||
|
||||
$seci = (string) $eci;
|
||||
$digits = \strlen($seci);
|
||||
$this->addRawCwd(3, $digits); // 1–6 digits
|
||||
for ($idx = 0; $idx < $digits; ++$idx) {
|
||||
$this->addCdw(Data::MODE_DIGIT, $this->charEnc(Data::MODE_DIGIT, \ord($seci[$idx])));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,559 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Data.php
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Aztec;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec\Data
|
||||
*
|
||||
* Data for Aztec Barcode type class
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Data
|
||||
{
|
||||
/**
|
||||
* Code character encoding mode for uppercase letters.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_UPPER = 0;
|
||||
|
||||
/**
|
||||
* Code character encoding mode for lowercase letters.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_LOWER = 1;
|
||||
|
||||
/**
|
||||
* Code character encoding mode for digits.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_DIGIT = 2;
|
||||
|
||||
/**
|
||||
* Code character encoding mode for mixed cases.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_MIXED = 3;
|
||||
|
||||
/**
|
||||
* Code character encoding mode for punctuation.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_PUNCT = 4;
|
||||
|
||||
/**
|
||||
* Code character encoding mode for binary.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_BINARY = 5;
|
||||
|
||||
/**
|
||||
* Number of bits for each character encoding mode.
|
||||
*
|
||||
* @var array{int, int, int, int, int, int}
|
||||
*/
|
||||
public const MODE_BITS = [
|
||||
5, // 0 = MODE_UPPER
|
||||
5, // 1 = MODE_LOWER
|
||||
4, // 2 = MODE_DIGIT
|
||||
5, // 3 = MODE_MIXED
|
||||
5, // 4 = MODE_PUNCT
|
||||
8, // 5 = MODE_BINARY
|
||||
];
|
||||
|
||||
/**
|
||||
* Code character encoding for each mode.
|
||||
*
|
||||
* @var array<int, array<int>>
|
||||
*/
|
||||
public const CHAR_ENC = [
|
||||
// MODE_UPPER (initial mode)
|
||||
0 => [
|
||||
32 => 1, // ' ' (SP)
|
||||
65 => 2, // 'A'
|
||||
66 => 3, // 'B'
|
||||
67 => 4, // 'C'
|
||||
68 => 5, // 'D'
|
||||
69 => 6, // 'E'
|
||||
70 => 7, // 'F'
|
||||
71 => 8, // 'G'
|
||||
72 => 9, // 'H'
|
||||
73 => 10, // 'I'
|
||||
74 => 11, // 'J'
|
||||
75 => 12, // 'K'
|
||||
76 => 13, // 'L'
|
||||
77 => 14, // 'M'
|
||||
78 => 15, // 'N'
|
||||
79 => 16, // 'O'
|
||||
80 => 17, // 'P'
|
||||
81 => 18, // 'Q'
|
||||
82 => 19, // 'R'
|
||||
83 => 20, // 'S'
|
||||
84 => 21, // 'T'
|
||||
85 => 22, // 'U'
|
||||
86 => 23, // 'V'
|
||||
87 => 24, // 'W'
|
||||
88 => 25, // 'X'
|
||||
89 => 26, // 'Y'
|
||||
90 => 27, // 'Z'
|
||||
],
|
||||
// MODE_LOWER
|
||||
1 => [
|
||||
32 => 1, // ' ' (SP)
|
||||
97 => 2, // 'a'
|
||||
98 => 3, // 'b'
|
||||
99 => 4, // 'c'
|
||||
100 => 5, // 'd'
|
||||
101 => 6, // 'e'
|
||||
102 => 7, // 'f'
|
||||
103 => 8, // 'g'
|
||||
104 => 9, // 'h'
|
||||
105 => 10, // 'i'
|
||||
106 => 11, // 'j'
|
||||
107 => 12, // 'k'
|
||||
108 => 13, // 'l'
|
||||
109 => 14, // 'm'
|
||||
110 => 15, // 'n'
|
||||
111 => 16, // 'o'
|
||||
112 => 17, // 'p'
|
||||
113 => 18, // 'q'
|
||||
114 => 19, // 'r'
|
||||
115 => 20, // 's'
|
||||
116 => 21, // 't'
|
||||
117 => 22, // 'u'
|
||||
118 => 23, // 'v'
|
||||
119 => 24, // 'w'
|
||||
120 => 25, // 'x'
|
||||
121 => 26, // 'y'
|
||||
122 => 27, // 'z'
|
||||
],
|
||||
// MODE_DIGIT
|
||||
2 => [
|
||||
32 => 1, // ' ' (SP)
|
||||
44 => 12, // ','
|
||||
46 => 13, // '.'
|
||||
48 => 2, // '0'
|
||||
49 => 3, // '1'
|
||||
50 => 4, // '2'
|
||||
51 => 5, // '3'
|
||||
52 => 6, // '4'
|
||||
53 => 7, // '5'
|
||||
54 => 8, // '6'
|
||||
55 => 9, // '7'
|
||||
56 => 10, // '8'
|
||||
57 => 11, // '9'
|
||||
],
|
||||
// MODE_MIXED
|
||||
3 => [
|
||||
32 => 1, // ' ' (SP)
|
||||
1 => 2, // '^A' (SOH)
|
||||
2 => 3, // '^B' (STX)
|
||||
3 => 4, // '^C' (ETX)
|
||||
4 => 5, // '^D' (EOT)
|
||||
5 => 6, // '^E' (ENQ)
|
||||
6 => 7, // '^F' (ACK)
|
||||
7 => 8, // '^G' (BEL)
|
||||
8 => 9, // '^H' (BS)
|
||||
9 => 10, // '^I' (HT)
|
||||
10 => 11, // '^J' (LF)
|
||||
11 => 12, // '^K' (VT)
|
||||
12 => 13, // '^L' (FF)
|
||||
13 => 14, // '^M' (CR)
|
||||
27 => 15, // '^[' (ESC)
|
||||
28 => 16, // '^\' (FS)
|
||||
29 => 17, // '^]' (GS)
|
||||
30 => 18, // '^^' (RS)
|
||||
31 => 19, // '^_' (US)
|
||||
64 => 20, // '@'
|
||||
92 => 21, // '\'
|
||||
94 => 22, // '^'
|
||||
95 => 23, // '_'
|
||||
96 => 24, // '`'
|
||||
124 => 25, // '|'
|
||||
126 => 26, // '~'
|
||||
127 => 27, // '^?' (DEL)
|
||||
],
|
||||
// MODE_PUNCT
|
||||
4 => [
|
||||
13 => 1, // '\r' (CR)
|
||||
33 => 6, // '!'
|
||||
34 => 7, // '"'
|
||||
35 => 8, // '#'
|
||||
36 => 9, // '$'
|
||||
37 => 10, // '%'
|
||||
38 => 11, // '&'
|
||||
39 => 12, // '''
|
||||
40 => 13, // '('
|
||||
41 => 14, // ')'
|
||||
42 => 15, // '*'
|
||||
43 => 16, // '+'
|
||||
44 => 17, // ','
|
||||
45 => 18, // '-'
|
||||
46 => 19, // '.'
|
||||
47 => 20, // '/'
|
||||
58 => 21, // ':'
|
||||
59 => 22, // ';'
|
||||
60 => 23, // '<'
|
||||
61 => 24, // '='
|
||||
62 => 25, // '>'
|
||||
63 => 26, // '?'
|
||||
91 => 27, // '['
|
||||
93 => 28, // ']'
|
||||
123 => 29, // '{'
|
||||
125 => 30, // '}'
|
||||
],
|
||||
// MODE_BINARY (all 8-bit values are valid)
|
||||
5 => [],
|
||||
];
|
||||
|
||||
/**
|
||||
* Map character ASCII codes to their non-binary mode.
|
||||
* Exceptions are:
|
||||
* - the space ' ' character (32) that maps for modes 0,1,2.
|
||||
* - the carriage return '\r' character (13) that maps for modes 3,4.
|
||||
* - the comma ',' and dot '.' characters (44,46) that map for modes 2,4.
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
public const CHAR_MODES = [
|
||||
1 => 3, // '^A' (SOH)
|
||||
2 => 3, // '^B' (STX)
|
||||
3 => 3, // '^C' (ETX)
|
||||
4 => 3, // '^D' (EOT)
|
||||
5 => 3, // '^E' (ENQ)
|
||||
6 => 3, // '^F' (ACK)
|
||||
7 => 3, // '^G' (BEL)
|
||||
8 => 3, // '^H' (BS)
|
||||
9 => 3, // '^I' (HT)
|
||||
10 => 3, // '^J' (LF)
|
||||
11 => 3, // '^K' (VT)
|
||||
12 => 3, // '^L' (FF)
|
||||
13 => 3, // '^M' (CR) [3,4]
|
||||
27 => 3, // '^[' (ESC)
|
||||
28 => 3, // '^\' (FS)
|
||||
29 => 3, // '^]' (GS)
|
||||
30 => 3, // '^^' (RS)
|
||||
31 => 3, // '^_' (US)
|
||||
32 => 0, // ' ' [0,1,2]
|
||||
33 => 4, // '!'
|
||||
34 => 4, // '"'
|
||||
35 => 4, // '#'
|
||||
36 => 4, // '$'
|
||||
37 => 4, // '%'
|
||||
38 => 4, // '&'
|
||||
39 => 4, // '''
|
||||
40 => 4, // '('
|
||||
41 => 4, // ')'
|
||||
42 => 4, // '*'
|
||||
43 => 4, // '+'f
|
||||
44 => 2, // ',' [2,4]
|
||||
45 => 4, // '-'
|
||||
46 => 2, // '.' [2,4]
|
||||
47 => 4, // '/'
|
||||
48 => 2, // '0'
|
||||
49 => 2, // '1'
|
||||
50 => 2, // '2'
|
||||
51 => 2, // '3'
|
||||
52 => 2, // '4'
|
||||
53 => 2, // '5'
|
||||
54 => 2, // '6'
|
||||
55 => 2, // '7'
|
||||
56 => 2, // '8'
|
||||
57 => 2, // '9'
|
||||
58 => 4, // ':'
|
||||
59 => 4, // ';'
|
||||
60 => 4, // '<'
|
||||
61 => 4, // '='
|
||||
62 => 4, // '>'
|
||||
63 => 4, // '?'
|
||||
64 => 3, // '@'
|
||||
65 => 0, // 'A'
|
||||
66 => 0, // 'B'
|
||||
67 => 0, // 'C'
|
||||
68 => 0, // 'D'
|
||||
69 => 0, // 'E'
|
||||
70 => 0, // 'F'
|
||||
71 => 0, // 'G'
|
||||
72 => 0, // 'H'
|
||||
73 => 0, // 'I'
|
||||
74 => 0, // 'J'
|
||||
75 => 0, // 'K'
|
||||
76 => 0, // 'L'
|
||||
77 => 0, // 'M'
|
||||
78 => 0, // 'N'
|
||||
79 => 0, // 'O'
|
||||
80 => 0, // 'P'
|
||||
81 => 0, // 'Q'
|
||||
82 => 0, // 'R'
|
||||
83 => 0, // 'S'
|
||||
84 => 0, // 'T'
|
||||
85 => 0, // 'U'
|
||||
86 => 0, // 'V'
|
||||
87 => 0, // 'W'
|
||||
88 => 0, // 'X'
|
||||
89 => 0, // 'Y'
|
||||
90 => 0, // 'Z'
|
||||
91 => 4, // '['
|
||||
92 => 3, // '\'
|
||||
93 => 4, // ']'
|
||||
94 => 3, // '^'
|
||||
95 => 3, // '_'
|
||||
96 => 3, // '`'
|
||||
97 => 1, // 'a'
|
||||
98 => 1, // 'b'
|
||||
99 => 1, // 'c'
|
||||
100 => 1, // 'd'
|
||||
101 => 1, // 'e'
|
||||
102 => 1, // 'f'
|
||||
103 => 1, // 'g'
|
||||
104 => 1, // 'h'
|
||||
105 => 1, // 'i'
|
||||
106 => 1, // 'j'
|
||||
107 => 1, // 'k'
|
||||
108 => 1, // 'l'
|
||||
109 => 1, // 'm'
|
||||
110 => 1, // 'n'
|
||||
111 => 1, // 'o'
|
||||
112 => 1, // 'p'
|
||||
113 => 1, // 'q'
|
||||
114 => 1, // 'r'
|
||||
115 => 1, // 's'
|
||||
116 => 1, // 't'
|
||||
117 => 1, // 'u'
|
||||
118 => 1, // 'v'
|
||||
119 => 1, // 'w'
|
||||
120 => 1, // 'x'
|
||||
121 => 1, // 'y'
|
||||
122 => 1, // 'z'
|
||||
123 => 4, // '{'
|
||||
124 => 3, // '|'
|
||||
125 => 4, // '}'
|
||||
126 => 3, // '~'
|
||||
127 => 3, // '^?' (DEL)
|
||||
];
|
||||
|
||||
/**
|
||||
* Latch map for changing character encoding mode.
|
||||
* Numbers represent: [number of bits to change, latch code value].
|
||||
*
|
||||
* @var array<int, array<int, array<array{int, int}>>>
|
||||
*/
|
||||
public const LATCH_MAP = [
|
||||
// MODE_UPPER
|
||||
0 => [
|
||||
1 => [[5, 28]], // -> LOWER
|
||||
2 => [[5, 30]], // -> DIGIT
|
||||
3 => [[5, 29]], // -> MIXED
|
||||
4 => [[5, 29], [5, 30]], // -> MIXED -> PUNCT
|
||||
],
|
||||
// MODE_LOWER
|
||||
1 => [
|
||||
0 => [[5, 30], [4, 14]], // -> DIGIT -> UPPER
|
||||
2 => [[5, 30]], // -> DIGIT
|
||||
3 => [[5, 29]], // -> MIXED
|
||||
4 => [[5, 29], [5, 30]], // -> MIXED -> PUNCT
|
||||
],
|
||||
// MODE_DIGIT
|
||||
2 => [
|
||||
0 => [[4, 14]], // -> UPPER
|
||||
1 => [[4, 14], [5, 28]], // -> UPPER -> LOWER
|
||||
3 => [[4, 14], [5, 29]], // -> UPPER -> MIXED
|
||||
4 => [[4, 14], [5, 29], [5, 30]], // -> UPPER -> MIXED -> PUNCT
|
||||
],
|
||||
// MODE_MIXED
|
||||
3 => [
|
||||
0 => [[5, 29]], // -> UPPER
|
||||
1 => [[5, 28]], // -> LOWER
|
||||
2 => [[5, 29], [5, 30]], // -> UPPER -> DIGIT
|
||||
4 => [[5, 30]], // -> PUNCT
|
||||
],
|
||||
// MODE_PUNCT
|
||||
4 => [
|
||||
0 => [[5, 31]], // -> UPPER
|
||||
1 => [[5, 31], [5, 28]], // -> UPPER -> LOWER
|
||||
2 => [[5, 31], [5, 30]], // -> UPPER -> DIGIT
|
||||
3 => [[5, 31], [5, 29]], // -> UPPER -> MIXED
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* Shift map for changing character encoding mode.
|
||||
* Numbers represent: [number of bits to change, shift code value].
|
||||
*
|
||||
* @var array<int, array<int, array<array{int, int}>>>
|
||||
*/
|
||||
public const SHIFT_MAP = [
|
||||
// MODE_UPPER
|
||||
0 => [
|
||||
1 => [],
|
||||
2 => [],
|
||||
3 => [],
|
||||
4 => [[5, 0]], // -> PUNCT
|
||||
5 => [[5, 31]], // -> BINARY
|
||||
],
|
||||
// MODE_LOWER
|
||||
1 => [
|
||||
0 => [[5, 28]], // -> UPPER
|
||||
2 => [],
|
||||
3 => [],
|
||||
4 => [[5, 0]], // -> PUNCT
|
||||
5 => [[5, 31]], // -> BINARY
|
||||
],
|
||||
// MODE_DIGIT
|
||||
2 => [
|
||||
0 => [[4, 15]], // -> UPPER
|
||||
1 => [],
|
||||
3 => [],
|
||||
4 => [[4, 0]], // -> PUNCT
|
||||
5 => [[4, 14], [5, 31]], // -> LATCH UPPER -> BINARY
|
||||
],
|
||||
// MODE_MIXED
|
||||
3 => [
|
||||
0 => [],
|
||||
1 => [],
|
||||
2 => [],
|
||||
4 => [[5, 0]], // -> PUNCT
|
||||
5 => [[5, 31]], // -> BINARY
|
||||
],
|
||||
// MODE_PUNCT
|
||||
4 => [
|
||||
0 => [],
|
||||
1 => [],
|
||||
2 => [],
|
||||
3 => [],
|
||||
5 => [[5, 31], [5, 31]], // -> LATCH UPPER -> BINARY
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* Extended Channel Interpretation (ECI) codes.
|
||||
*
|
||||
* @var array<int, string>
|
||||
*/
|
||||
public const ECI = [
|
||||
0 => 'FNC1', // Function 1 character
|
||||
2 => 'Cp437', // Code page 437
|
||||
3 => 'ISO-8859-1', // ISO/IEC 8859-1 - Latin-1 (Default encoding)
|
||||
4 => 'ISO-8859-2', // ISO/IEC 8859-2 - Latin-2
|
||||
5 => 'ISO-8859-3', // ISO/IEC 8859-3 - Latin-3
|
||||
6 => 'ISO-8859-4', // ISO/IEC 8859-4 - Latin-4
|
||||
7 => 'ISO-8859-5', // ISO/IEC 8859-5 - Latin/Cyrillic
|
||||
8 => 'ISO-8859-6', // ISO/IEC 8859-6 - Latin/Arabic
|
||||
9 => 'ISO-8859-7', // ISO/IEC 8859-7 - Latin/Greek
|
||||
10 => 'ISO-8859-8', // ISO/IEC 8859-8 - Latin/Hebrew
|
||||
11 => 'ISO-8859-9', // ISO/IEC 8859-9 - Latin-5
|
||||
12 => 'ISO-8859-10', // ISO/IEC 8859-10 - Latin-6
|
||||
13 => 'ISO-8859-11', // ISO/IEC 8859-11 - Latin/Thai
|
||||
15 => 'ISO-8859-13', // ISO/IEC 8859-13 - Latin-7
|
||||
16 => 'ISO-8859-14', // ISO/IEC 8859-14 - Latin-8 (Celtic)
|
||||
17 => 'ISO-8859-15', // ISO/IEC 8859-15 - Latin-9
|
||||
18 => 'ISO-8859-16', // ISO/IEC 8859-16 - Latin-10
|
||||
20 => 'Shift JIS',
|
||||
21 => 'Cp1250', // Windows-1250 - Superset of Latin-2
|
||||
22 => 'Cp1251', // Windows-1251 - Latin/Cyrillic
|
||||
23 => 'Cp1252', // Windows-1252 - Superset of Latin-1
|
||||
24 => 'Cp1256', // Windows-1256 - Arabic
|
||||
25 => 'UTF-16BE', // UnicodeBig, UnicodeBigUnmarked
|
||||
26 => 'UTF-8',
|
||||
27 => 'US-ASCII',
|
||||
28 => 'Big5',
|
||||
29 => 'GB18030', // GB2312, EUC_CN, GBK
|
||||
30 => 'EUC-KR',
|
||||
];
|
||||
|
||||
/**
|
||||
* Size and capacities of Aztec Compact Code symbols by number of layers.
|
||||
* The array entries are:
|
||||
* - 0: symbol x size;
|
||||
* - 1: codeword count;
|
||||
* - 2: codeword size;
|
||||
* - 3: symbol bit capacity;
|
||||
* - 4: symbol data digits capacity;
|
||||
* - 5: symbol data text capacity;
|
||||
* - 6: symbol data bytes capacity.
|
||||
*
|
||||
* @var array<int, array{int, int, int, int, int, int, int}>
|
||||
*/
|
||||
public const SIZE_COMPACT = [
|
||||
1 => [15, 17, 6, 102, 13, 12, 6],
|
||||
2 => [19, 40, 6, 240, 40, 33, 19],
|
||||
3 => [23, 51, 8, 408, 70, 57, 33],
|
||||
4 => [27, 76, 8, 608, 110, 89, 53],
|
||||
];
|
||||
|
||||
/**
|
||||
* Size and capacities of Aztec Full-range Code symbols by number of layers.
|
||||
* The array entries are:
|
||||
* - 0: symbol x size;
|
||||
* - 1: codeword count;
|
||||
* - 2: codeword size;
|
||||
* - 3: symbol bit capacity;
|
||||
* - 4: symbol data digits capacity;
|
||||
* - 5: symbol data text capacity;
|
||||
* - 6: symbol data bytes capacity.
|
||||
*
|
||||
* @var array<int, array{int, int, int, int, int, int, int}>
|
||||
*/
|
||||
public const SIZE_FULL = [
|
||||
1 => [19, 21, 6, 126, 18, 15, 8],
|
||||
2 => [23, 48, 6, 288, 49, 40, 24],
|
||||
3 => [27, 60, 8, 480, 84, 68, 40],
|
||||
4 => [31, 88, 8, 704, 128, 104, 62],
|
||||
5 => [37, 120, 8, 960, 178, 144, 87],
|
||||
6 => [41, 156, 8, 1248, 232, 187, 114],
|
||||
7 => [45, 196, 8, 1568, 294, 236, 145],
|
||||
8 => [49, 240, 8, 1920, 362, 291, 179],
|
||||
9 => [53, 230, 10, 2300, 433, 348, 214],
|
||||
10 => [57, 272, 10, 2720, 516, 414, 256],
|
||||
11 => [61, 316, 10, 3160, 601, 482, 298],
|
||||
12 => [67, 364, 10, 3640, 691, 554, 343],
|
||||
13 => [71, 416, 10, 4160, 793, 636, 394],
|
||||
14 => [75, 470, 10, 4700, 896, 718, 446],
|
||||
15 => [79, 528, 10, 5280, 1008, 808, 502],
|
||||
16 => [83, 588, 10, 5880, 1123, 900, 559],
|
||||
17 => [87, 652, 10, 6520, 1246, 998, 621],
|
||||
18 => [91, 720, 10, 7200, 1378, 1104, 687],
|
||||
19 => [95, 790, 10, 7900, 1511, 1210, 753],
|
||||
20 => [101, 864, 10, 8640, 1653, 1324, 824],
|
||||
21 => [105, 940, 10, 9400, 1801, 1442, 898],
|
||||
22 => [109, 1020, 10, 10_200, 1956, 1566, 976],
|
||||
23 => [113, 920, 12, 11_040, 2116, 1694, 1056],
|
||||
24 => [117, 992, 12, 11_904, 2281, 1826, 1138],
|
||||
25 => [121, 1066, 12, 12_792, 2452, 1963, 1224],
|
||||
26 => [125, 1144, 12, 13_728, 2632, 2107, 1314],
|
||||
27 => [131, 1224, 12, 14_688, 2818, 2256, 1407],
|
||||
28 => [135, 1306, 12, 15_672, 3007, 2407, 1501],
|
||||
29 => [139, 1392, 12, 16_704, 3205, 2565, 1600],
|
||||
30 => [143, 1480, 12, 17_760, 3409, 2728, 1702],
|
||||
31 => [147, 1570, 12, 18_840, 3616, 2894, 1806],
|
||||
32 => [151, 1664, 12, 19_968, 3832, 3067, 1914],
|
||||
];
|
||||
}
|
||||
@@ -0,0 +1,360 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Encode.php
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Aztec;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec\Encode
|
||||
*
|
||||
* Encode for Aztec Barcode type class
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Encode extends \Com\Tecnick\Barcode\Type\Square\Aztec\Bitstream
|
||||
{
|
||||
/**
|
||||
* Bidimensional grid containing the encoded data.
|
||||
*
|
||||
* @var array<int, array<int>>
|
||||
*/
|
||||
protected array $grid = [];
|
||||
|
||||
/**
|
||||
* Coordinate of the grid center.
|
||||
*/
|
||||
protected int $gridcenter = 0;
|
||||
|
||||
/**
|
||||
* Aztec main encoder.
|
||||
*
|
||||
* @param string $code The code to encode.
|
||||
* @param int $ecc The error correction code percentage of error check words.
|
||||
* @param int $eci The ECI mode to use.
|
||||
* @param string $hint The mode to use.
|
||||
* @param string $mode The mode to use (A = Automatic; F = Full Range mode).
|
||||
*
|
||||
* @throws BarcodeException
|
||||
*/
|
||||
public function __construct(string $code, int $ecc = 33, int $eci = 0, string $hint = 'A', string $mode = 'A')
|
||||
{
|
||||
$this->highLevelEncoding($code, $eci, $hint);
|
||||
if (!$this->sizeAndBitStuffing($ecc, $mode)) {
|
||||
throw new BarcodeException('Data too long');
|
||||
}
|
||||
|
||||
$wsize = $this->layer[2];
|
||||
$nbits = $this->layer[3];
|
||||
$numcdw = $this->addCheckWords($this->bitstream, $this->totbits, $nbits, $wsize);
|
||||
$this->setGrid();
|
||||
$this->drawMode($numcdw);
|
||||
$this->drawData();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the bidimensional grid containing the encoded data.
|
||||
*
|
||||
* @return array<int, array<int>>
|
||||
*/
|
||||
public function getGrid(): array
|
||||
{
|
||||
return $this->grid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Check Codewords array for the given data words.
|
||||
*
|
||||
* @param array<int> $bitstream Array of bits.
|
||||
* @param int $totbits Number of bits in the bitstream.
|
||||
* @param int $nbits Number of bits per layer.
|
||||
* @param int $wsize Word size.
|
||||
*
|
||||
* @return int The number of data codewords.
|
||||
*/
|
||||
protected function addCheckWords(array &$bitstream, int &$totbits, int $nbits, int $wsize): int
|
||||
{
|
||||
$cdw = $this->bitstreamToWords($bitstream, $totbits, $wsize);
|
||||
$numcdw = \count($cdw);
|
||||
$totwords = (int) ($nbits / $wsize);
|
||||
$eccwords = $totwords - $numcdw;
|
||||
$errorCorrection = new ErrorCorrection($wsize);
|
||||
$checkwords = $errorCorrection->checkwords($cdw, $eccwords);
|
||||
// append check codewords
|
||||
foreach ($checkwords as $checkword) {
|
||||
$this->appendWordToBitstream($bitstream, $totbits, $wsize, $checkword);
|
||||
}
|
||||
|
||||
return $numcdw;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the grid with all patterns.
|
||||
*/
|
||||
protected function setGrid(): void
|
||||
{
|
||||
// initialize grid
|
||||
$size = $this->layer[0];
|
||||
$size = \max(0, $size);
|
||||
$row = \array_fill(0, $size, 0);
|
||||
$this->grid = \array_fill(0, $size, $row);
|
||||
// draw center
|
||||
$center = (int) (($size - 1) / 2);
|
||||
$this->gridcenter = $center;
|
||||
$this->grid[$center][$center] = 1;
|
||||
// draw finder pattern (bulls-eye)
|
||||
$bewidth = $this->compact ? 11 : 15;
|
||||
$bemid = (int) (($bewidth - 1) / 2);
|
||||
for ($rng = 2; $rng < $bemid; $rng += 2) {
|
||||
// center cross points
|
||||
$this->grid[$center + $rng][$center] = 1;
|
||||
$this->grid[$center - $rng][$center] = 1;
|
||||
$this->grid[$center][$center + $rng] = 1;
|
||||
$this->grid[$center][$center - $rng] = 1;
|
||||
// corner points
|
||||
$this->grid[$center + $rng][$center + $rng] = 1;
|
||||
$this->grid[$center + $rng][$center - $rng] = 1;
|
||||
$this->grid[$center - $rng][$center + $rng] = 1;
|
||||
$this->grid[$center - $rng][$center - $rng] = 1;
|
||||
for ($pos = 1; $pos < $rng; ++$pos) {
|
||||
// horizontal points
|
||||
$this->grid[$center + $rng][$center + $pos] = 1;
|
||||
$this->grid[$center + $rng][$center - $pos] = 1;
|
||||
$this->grid[$center - $rng][$center + $pos] = 1;
|
||||
$this->grid[$center - $rng][$center - $pos] = 1;
|
||||
// vertical points
|
||||
$this->grid[$center + $pos][$center + $rng] = 1;
|
||||
$this->grid[$center + $pos][$center - $rng] = 1;
|
||||
$this->grid[$center - $pos][$center + $rng] = 1;
|
||||
$this->grid[$center - $pos][$center - $rng] = 1;
|
||||
}
|
||||
}
|
||||
|
||||
// draw orientation patterns
|
||||
$this->grid[$center - $bemid][$center - $bemid] = 1; // TL
|
||||
$this->grid[$center - $bemid][$center - $bemid + 1] = 1; // TL-R
|
||||
$this->grid[$center - $bemid + 1][$center - $bemid] = 1; // TL-B
|
||||
$this->grid[$center - $bemid][$center + $bemid] = 1; // TR-T
|
||||
$this->grid[$center - $bemid + 1][$center + $bemid] = 1; // TR-B
|
||||
$this->grid[$center + $bemid - 1][$center + $bemid] = 1; // BR
|
||||
if ($this->compact) {
|
||||
return;
|
||||
}
|
||||
|
||||
// draw reference grid for full mode
|
||||
$halfsize = (int) (($size - 1) / 2);
|
||||
// central cross
|
||||
for ($pos = 8; $pos <= $halfsize; $pos += 2) {
|
||||
// horizontal
|
||||
$this->grid[$center][$center - $pos] = 1;
|
||||
$this->grid[$center][$center + $pos] = 1;
|
||||
// vertical
|
||||
$this->grid[$center - $pos][$center] = 1;
|
||||
$this->grid[$center + $pos][$center] = 1;
|
||||
}
|
||||
|
||||
// grid lines
|
||||
for ($pos = 2; $pos <= $halfsize; $pos += 2) {
|
||||
for ($ref = 16; $ref <= $halfsize; $ref += 16) {
|
||||
// horizontal
|
||||
$this->grid[$center - $ref][$center - $pos] = 1;
|
||||
$this->grid[$center - $ref][$center + $pos] = 1;
|
||||
$this->grid[$center + $ref][$center - $pos] = 1;
|
||||
$this->grid[$center + $ref][$center + $pos] = 1;
|
||||
// vertical
|
||||
$this->grid[$center - $pos][$center - $ref] = 1;
|
||||
$this->grid[$center - $pos][$center + $ref] = 1;
|
||||
$this->grid[$center + $pos][$center - $ref] = 1;
|
||||
$this->grid[$center + $pos][$center + $ref] = 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the mode message to the grid.
|
||||
*
|
||||
* @param int $numcdw Number of data codewords.
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
* @SuppressWarnings("PHPMD.NPathComplexity")
|
||||
*/
|
||||
protected function drawMode(int $numcdw): void
|
||||
{
|
||||
$modebs = [];
|
||||
$nbits = 0;
|
||||
$center = $this->gridcenter;
|
||||
$modebits = 40;
|
||||
$layersbits = 5;
|
||||
$codewordsbits = 11;
|
||||
$sidelen = 10;
|
||||
$srow = -7;
|
||||
$scol = -5;
|
||||
if ($this->compact) {
|
||||
$modebits = 28;
|
||||
$layersbits = 2;
|
||||
$codewordsbits = 6;
|
||||
$sidelen = 7;
|
||||
$srow = -5;
|
||||
$scol = -3;
|
||||
}
|
||||
|
||||
$this->appendWordToBitstream($modebs, $nbits, $layersbits, $this->numlayers - 1);
|
||||
$this->appendWordToBitstream($modebs, $nbits, $codewordsbits, $numcdw - 1);
|
||||
$this->addCheckWords($modebs, $nbits, $modebits, 4);
|
||||
// draw the mode message in the grid clockwise starting from the top left corner
|
||||
$bit = 0;
|
||||
// top
|
||||
$ypos = $center + $srow;
|
||||
$xpos = $center + $scol;
|
||||
for ($pos = 0; $pos < $sidelen; ++$pos) {
|
||||
$xpos += $this->skipModeRefGrid($pos);
|
||||
$this->grid[$ypos][$xpos] = ($modebs[$bit++] ?? 0) === 0 ? 0 : 1;
|
||||
++$xpos;
|
||||
}
|
||||
|
||||
// right
|
||||
$ypos += 2;
|
||||
++$xpos;
|
||||
for ($pos = 0; $pos < $sidelen; ++$pos) {
|
||||
$ypos += $this->skipModeRefGrid($pos);
|
||||
$this->grid[$ypos][$xpos] = ($modebs[$bit++] ?? 0) === 0 ? 0 : 1;
|
||||
++$ypos;
|
||||
}
|
||||
|
||||
// bottom
|
||||
++$ypos;
|
||||
$xpos -= 2;
|
||||
for ($pos = 0; $pos < $sidelen; ++$pos) {
|
||||
$xpos -= $this->skipModeRefGrid($pos);
|
||||
$this->grid[$ypos][$xpos] = ($modebs[$bit++] ?? 0) === 0 ? 0 : 1;
|
||||
--$xpos;
|
||||
}
|
||||
|
||||
// left
|
||||
$ypos -= 2;
|
||||
--$xpos;
|
||||
for ($pos = 0; $pos < $sidelen; ++$pos) {
|
||||
$ypos -= $this->skipModeRefGrid($pos);
|
||||
$this->grid[$ypos][$xpos] = ($modebs[$bit++] ?? 0) === 0 ? 0 : 1;
|
||||
--$ypos;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a bit from the end of the bitstream and update the index.
|
||||
*
|
||||
* @param int $bit Index of the bit to pop.
|
||||
*/
|
||||
protected function popBit(int &$bit): int
|
||||
{
|
||||
return ($this->bitstream[$bit--] ?? 0) === 0 ? 0 : 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns 1 if the current position must be skipped in Full mode.
|
||||
*
|
||||
* @param int $pos Position in the grid.
|
||||
*/
|
||||
protected function skipModeRefGrid(int $pos): int
|
||||
{
|
||||
return (int) (!$this->compact && $pos === 5);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the offset for the specified position to skip the reference grid.
|
||||
*
|
||||
* @param int $pos Position in the grid.
|
||||
*/
|
||||
protected function skipRefGrid(int $pos): int
|
||||
{
|
||||
return (int) (!$this->compact && ($pos % 16) === 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Draw the data bitstream in the grid in Full mode.
|
||||
*/
|
||||
protected function drawData(): void
|
||||
{
|
||||
$center = $this->gridcenter;
|
||||
$llen = 16; // width of the first layer side
|
||||
$srow = -8; // start top row offset from the center (LSB)
|
||||
$scol = -7; // start top column offset from the center (LSB)
|
||||
if ($this->compact) {
|
||||
$llen = 13;
|
||||
$srow = -6;
|
||||
$scol = -5;
|
||||
}
|
||||
|
||||
$skip = 0; // skip reference grid while drawing dominoes
|
||||
$bit = $this->totbits - 1; // index of last bitstream bit (first to draw)
|
||||
for ($layer = 0; $layer < $this->numlayers; ++$layer) {
|
||||
// top
|
||||
$ypos = $center + $srow;
|
||||
$xpos = $center + $scol;
|
||||
for ($pos = 0; $pos < $llen; ++$pos) {
|
||||
$xpos += $this->skipRefGrid($xpos - $center); // skip reference grid
|
||||
$this->grid[$ypos][$xpos] = $this->popBit($bit);
|
||||
$this->grid[$ypos - 1 - $skip][$xpos] = $this->popBit($bit);
|
||||
++$xpos;
|
||||
}
|
||||
|
||||
// right
|
||||
++$ypos;
|
||||
$xpos -= 2 + $skip;
|
||||
for ($pos = 0; $pos < $llen; ++$pos) {
|
||||
$ypos += $this->skipRefGrid($ypos - $center); // skip reference grid
|
||||
$this->grid[$ypos][$xpos] = $this->popBit($bit);
|
||||
$this->grid[$ypos][$xpos + 1 + $skip] = $this->popBit($bit);
|
||||
++$ypos;
|
||||
}
|
||||
|
||||
// bottom
|
||||
$ypos -= 2 + $skip;
|
||||
--$xpos;
|
||||
for ($pos = 0; $pos < $llen; ++$pos) {
|
||||
$xpos -= $this->skipRefGrid($xpos - $center); // skip reference grid
|
||||
$this->grid[$ypos][$xpos] = $this->popBit($bit);
|
||||
$this->grid[$ypos + 1 + $skip][$xpos] = $this->popBit($bit);
|
||||
--$xpos;
|
||||
}
|
||||
|
||||
// left
|
||||
--$ypos;
|
||||
$xpos += 2 + $skip;
|
||||
for ($pos = 0; $pos < $llen; ++$pos) {
|
||||
$ypos -= $this->skipRefGrid($ypos - $center); // skip reference grid
|
||||
$this->grid[$ypos][$xpos] = $this->popBit($bit);
|
||||
$this->grid[$ypos][$xpos - 1 - $skip] = $this->popBit($bit);
|
||||
--$ypos;
|
||||
}
|
||||
|
||||
$llen += 4;
|
||||
$srow = $ypos - $center;
|
||||
$srow -= $this->skipRefGrid($srow);
|
||||
$scol = $xpos - 1 - $center;
|
||||
$scol -= $this->skipRefGrid($scol);
|
||||
$skip = $this->skipRefGrid($srow - 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,276 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* ErrorCorrection.php
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Aztec;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec\ErrorCorrection
|
||||
*
|
||||
* ErrorCorrection for Aztec Barcode type class
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class ErrorCorrection
|
||||
{
|
||||
/**
|
||||
* Galois Field primitive by word size.
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected const GF = [
|
||||
4 => 19, // 10011 GF(16) (x^4 + x + 1) Mode message
|
||||
6 => 67, // 1000011 GF(64) (x^6 + x + 1) 01–02 layers
|
||||
8 => 301, // 100101101 GF(256) (x^8 + x^5 + x^3 + x^2 + 1) 03–08 layers
|
||||
10 => 1033, // 10000001001 GF(1024) (x^10 + x^3 + 1) 09–22 layers
|
||||
12 => 4201, // 1000001101001 GF(4096) (x^12 + x^6 + x^5 + x^3 + 1) 23–32 layers
|
||||
];
|
||||
|
||||
/**
|
||||
* Map the log and exp (inverse log) tables by word size.
|
||||
* NOTE: It is equal to 2^word_size.
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected const TSIZE = [
|
||||
4 => 16,
|
||||
6 => 64,
|
||||
8 => 256,
|
||||
10 => 1024,
|
||||
12 => 4096,
|
||||
];
|
||||
|
||||
/**
|
||||
* Log table.
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected array $tlog = [];
|
||||
|
||||
/**
|
||||
* Exponential (inverse log) table.
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected array $texp = [];
|
||||
|
||||
/**
|
||||
* Size of the log and exp tables.
|
||||
*/
|
||||
protected int $tsize = 0;
|
||||
|
||||
/**
|
||||
* Initialize the Reed-Solomon Error Correction.
|
||||
*
|
||||
* @param int $wsize Size of a word in bits.
|
||||
*/
|
||||
public function __construct(int $wsize)
|
||||
{
|
||||
$this->genTables($wsize);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Reed-Solomon Error Correction Codewords added to the input data.
|
||||
*
|
||||
* @param array<int> $data Array of data codewords to process.
|
||||
* @param int $necc Number of error correction bytes.
|
||||
*
|
||||
* @return array<int>
|
||||
*/
|
||||
public function checkwords(array $data, int $necc): array
|
||||
{
|
||||
$coeff = $this->getCoefficients($data, $necc);
|
||||
return \array_pad($coeff, -$necc, 0); // @phpstan-ignore return.type
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates log and exp (inverse log) tables.
|
||||
*
|
||||
* @param int $wsize Size of the word in bits.
|
||||
*/
|
||||
protected function genTables(int $wsize): void
|
||||
{
|
||||
$this->tsize = self::TSIZE[$wsize] ?? 0;
|
||||
$this->tlog = \array_fill(0, \max(0, $this->tsize), 0);
|
||||
$this->texp = $this->tlog;
|
||||
$primitive = self::GF[$wsize] ?? 0;
|
||||
$val = 1;
|
||||
$sizeminusone = $this->tsize - 1;
|
||||
for ($idx = 0; $idx < $this->tsize; ++$idx) {
|
||||
$this->texp[$idx] = $val;
|
||||
$val <<= 1; // multiply by 2
|
||||
if ($val >= $this->tsize) {
|
||||
$val ^= $primitive;
|
||||
$val &= $sizeminusone;
|
||||
}
|
||||
}
|
||||
|
||||
for ($idx = 0; $idx < ($this->tsize - 1); ++$idx) {
|
||||
$exp = $this->texp[$idx] ?? 0;
|
||||
$this->tlog[$exp] = $idx;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the coefficients of the error correction polynomial.
|
||||
*
|
||||
* @param array<int> $data Array of data codewords to process.
|
||||
* @param int $necc Number of error correction bytes.
|
||||
*
|
||||
* @return array<int> Array of coefficients.
|
||||
*/
|
||||
protected function getCoefficients(array $data, int $necc): array
|
||||
{
|
||||
$gen = [1];
|
||||
for ($idx = 1; $idx <= $necc; ++$idx) {
|
||||
$gen = $this->multiplyCoeff([1, $this->texp[$idx] ?? 0], $gen);
|
||||
}
|
||||
|
||||
$deg = $necc + 1;
|
||||
$coeff = $this->multiplyByMonomial($data, 1, $necc);
|
||||
$len = \count($coeff);
|
||||
while ($len >= $deg && ($coeff[0] ?? 0) !== 0) {
|
||||
$scale = $this->multiply($coeff[0] ?? 0, 1);
|
||||
$largercoeffs = $this->multiplyByMonomial($gen, $scale, $len - $deg);
|
||||
$coeff = $this->addOrSubtract($coeff, $largercoeffs);
|
||||
$len = \count($coeff);
|
||||
}
|
||||
|
||||
return $coeff;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the product of two coefficient arrays.
|
||||
*
|
||||
* @param array<int> $acf First array of coefficients.
|
||||
* @param array<int> $bcf Second array of coefficients.
|
||||
*
|
||||
* @return array<int> Array of coefficients.
|
||||
*/
|
||||
protected function multiplyCoeff(array $acf, array $bcf): array
|
||||
{
|
||||
$alen = \count($acf);
|
||||
$blen = \count($bcf);
|
||||
$coeff = \array_fill(0, \max(0, $alen + $blen - 1), 0);
|
||||
for ($aid = 0; $aid < $alen; ++$aid) {
|
||||
for ($bid = 0; $bid < $blen; ++$bid) {
|
||||
$coeff[$aid + $bid] = ($coeff[$aid + $bid] ?? 0) ^ $this->multiply($acf[$aid] ?? 0, $bcf[$bid] ?? 0);
|
||||
}
|
||||
}
|
||||
|
||||
return $this->trimCoefficients($coeff);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the product of $aval and $bval in GF(size).
|
||||
*
|
||||
* @param int $aval First value.
|
||||
* @param int $bval Second value.
|
||||
*/
|
||||
protected function multiply(int $aval, int $bval): int
|
||||
{
|
||||
if ($aval === 0 || $bval === 0) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$sizeMinusOne = $this->tsize - 1;
|
||||
if ($sizeMinusOne <= 0) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$index = (($this->tlog[$aval] ?? 0) + ($this->tlog[$bval] ?? 0)) % $sizeMinusOne;
|
||||
|
||||
return $this->texp[$index] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Left-trim coefficients array.
|
||||
*
|
||||
* @param array<int> $coeff Array of coefficients.
|
||||
*
|
||||
* @return array<int> Array of coefficients.
|
||||
*/
|
||||
protected function trimCoefficients(array $coeff): array
|
||||
{
|
||||
while ($coeff !== [] && ($coeff[0] ?? 0) === 0) {
|
||||
\array_shift($coeff);
|
||||
}
|
||||
|
||||
return $coeff;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the product of a polynomial by a monomial.
|
||||
*
|
||||
* @param array<int> $coeff Array of polynomial coefficients.
|
||||
* @param int $mon Monomial.
|
||||
* @param int $deg Degree of the monomial.
|
||||
*
|
||||
* @return array<int> Array of coefficients.
|
||||
*/
|
||||
protected function multiplyByMonomial(array $coeff, int $mon, int $deg): array
|
||||
{
|
||||
// if ($mon == 0) {
|
||||
// return array(0);
|
||||
// }
|
||||
$ncf = \count($coeff);
|
||||
$prod = \array_fill(0, \max(0, $ncf + $deg), 0);
|
||||
for ($idx = 0; $idx < $ncf; ++$idx) {
|
||||
$prod[$idx] = $this->multiply($coeff[$idx] ?? 0, $mon);
|
||||
}
|
||||
|
||||
return $this->trimCoefficients($prod);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds or subtracts two coefficient arrays.
|
||||
*
|
||||
* @param array<int> $smaller The smaller array of coefficients.
|
||||
* @param array<int> $larger The larger array of coefficients.
|
||||
*
|
||||
* @return array<int> Array of coefficients.
|
||||
*/
|
||||
protected function addOrSubtract(array $smaller, array $larger): array
|
||||
{
|
||||
// if ($smaller[0] == 0) {
|
||||
// return $larger;
|
||||
// }
|
||||
// if ($larger[0] == 0) {
|
||||
// return $smaller;
|
||||
// }
|
||||
$slen = \count($smaller);
|
||||
$llen = \count($larger);
|
||||
// if ($slen > $llen) {
|
||||
// // swap arrays
|
||||
// list($smaller, $larger) = array($larger, $smaller);
|
||||
// list($slen, $llen) = array($llen, $slen);
|
||||
// }
|
||||
$lendiff = $llen - $slen;
|
||||
$coeff = \array_slice($larger, 0, $lendiff);
|
||||
for ($idx = $lendiff; $idx < $llen; ++$idx) {
|
||||
$coeff[$idx] = ($smaller[$idx - $lendiff] ?? 0) ^ ($larger[$idx] ?? 0);
|
||||
}
|
||||
|
||||
return $this->trimCoefficients($coeff);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,190 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Layers.php
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Aztec;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Aztec\Layers
|
||||
*
|
||||
* Layers for Aztec Barcode type class
|
||||
*
|
||||
* @since 2023-10-13
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2023-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Layers extends \Com\Tecnick\Barcode\Type\Square\Aztec\Codeword
|
||||
{
|
||||
/**
|
||||
* @param array<int, array{0: int, 1: int, 2: int, 3: int, 4: int, 5: int, 6: int}> $data
|
||||
*/
|
||||
protected function getLayerMaxBits(array $data): int
|
||||
{
|
||||
if ($data === []) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$last = \array_values($data)[\count($data) - 1] ?? [0, 0, 0, 0, 0, 0, 0];
|
||||
return $last[3] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* True for compact mode (up to 4 layers), false for full-range mode (up to 32 layers).
|
||||
*/
|
||||
protected bool $compact = true;
|
||||
|
||||
/**
|
||||
* Number of data layers.
|
||||
*/
|
||||
protected int $numlayers = 0;
|
||||
|
||||
/**
|
||||
* Size data for the selected layer.
|
||||
*
|
||||
* @var array{int, int, int, int, int, int, int}
|
||||
*/
|
||||
protected array $layer = [0, 0, 0, 0, 0, 0, 0];
|
||||
|
||||
/**
|
||||
* Returns the minimum number of layers required.
|
||||
*
|
||||
* @param array<int, array{int, int, int, int, int, int, int}> $data
|
||||
* Either the Data::SIZE_COMPACT or Data::SIZE_FULL array.
|
||||
* @param int $numbits The number of bits to encode.
|
||||
*/
|
||||
protected function getMinLayers(array $data, int $numbits): int
|
||||
{
|
||||
if ($numbits <= $this->getLayerMaxBits($data)) {
|
||||
foreach ($data as $numlayers => $size) {
|
||||
if ($numbits <= $size[3]) {
|
||||
return $numlayers;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Select the layer by the number of bits to encode.
|
||||
*
|
||||
* @param int $numbits The number of bits to encode.
|
||||
* @param string $mode The mode to use (A = Automatic; F = Full Range mode).
|
||||
*
|
||||
* @return bool Returns true if the size computation was successful, false otherwise.
|
||||
*/
|
||||
protected function setLayerByBits(int $numbits, string $mode = 'A'): bool
|
||||
{
|
||||
$this->numlayers = 0;
|
||||
if ($mode === 'A') {
|
||||
$this->compact = true;
|
||||
$this->numlayers = $this->getMinLayers(Data::SIZE_COMPACT, $numbits);
|
||||
}
|
||||
|
||||
if ($this->numlayers === 0) {
|
||||
$this->compact = false;
|
||||
$this->numlayers = $this->getMinLayers(Data::SIZE_FULL, $numbits);
|
||||
}
|
||||
|
||||
if ($this->numlayers === 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($this->compact) {
|
||||
$compactLayer = Data::SIZE_COMPACT[$this->numlayers] ?? null;
|
||||
if ($compactLayer === null) {
|
||||
return false;
|
||||
}
|
||||
$this->layer = $compactLayer;
|
||||
return true;
|
||||
}
|
||||
|
||||
$fullLayer = Data::SIZE_FULL[$this->numlayers] ?? null;
|
||||
if ($fullLayer === null) {
|
||||
return false;
|
||||
}
|
||||
$this->layer = $fullLayer;
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes the type and number of required layers and performs bit stuffing
|
||||
*
|
||||
* @param int $ecc The error correction level.
|
||||
* @param string $mode The mode to use (A = Automatic; F = Full Range mode).
|
||||
*
|
||||
* @return bool Returns true if the size computation was successful, false otherwise.
|
||||
*/
|
||||
protected function sizeAndBitStuffing(int $ecc, string $mode = 'A'): bool
|
||||
{
|
||||
$nsbits = 0;
|
||||
$eccbits = 11 + (int) (($this->totbits * $ecc) / 100);
|
||||
do {
|
||||
if (!$this->setLayerByBits($this->totbits + $nsbits + $eccbits, $mode)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$nsbits = $this->bitStuffing();
|
||||
} while (($nsbits + $eccbits) > $this->layer[3]);
|
||||
|
||||
$this->bitstream = [];
|
||||
$this->totbits = 0;
|
||||
$this->mergeTmpCwdRaw();
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Bit-stuffing the bitstream into Reed–Solomon codewords.
|
||||
* The resulting codewords are stored in the temporary tmpCdws array.
|
||||
*
|
||||
* @return int The number of bits in the bitstream after bit stuffing.
|
||||
*/
|
||||
protected function bitStuffing(): int
|
||||
{
|
||||
$nsbits = 0;
|
||||
$wsize = $this->layer[2];
|
||||
$mask = (1 << $wsize) - 2; // b-1 bits at 1 and last bit at 0
|
||||
$this->tmpCdws = [];
|
||||
for ($wid = 0; $wid < $this->totbits; $wid += $wsize) {
|
||||
$word = 0;
|
||||
for ($idx = 0; $idx < $wsize; ++$idx) {
|
||||
$bid = $wid + $idx;
|
||||
if ($this->getBitstreamBit($this->bitstream, $bid) === 1) {
|
||||
$word |= 1 << ($wsize - 1 - $idx); // the first bit is MSB
|
||||
}
|
||||
}
|
||||
|
||||
// If the first b−1 bits of a code word have the same value,
|
||||
// an extra bit with the complementary value is inserted into the data stream.
|
||||
$maskedWord = $word & $mask;
|
||||
[$word, $wid] = match (true) {
|
||||
$maskedWord === $mask => [$word & $mask, $wid - 1],
|
||||
$maskedWord === 0 => [$word | 1, $wid - 1],
|
||||
default => [$word, $wid],
|
||||
};
|
||||
|
||||
$this->tmpCdws[] = [$wsize, $word];
|
||||
$nsbits += $wsize;
|
||||
}
|
||||
|
||||
return $nsbits;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,348 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Datamatrix.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
use Com\Tecnick\Barcode\Type\Square\Datamatrix\Data;
|
||||
use Com\Tecnick\Barcode\Type\Square\Datamatrix\DatamatrixEncoding;
|
||||
use Com\Tecnick\Barcode\Type\Square\Datamatrix\DatamatrixShape;
|
||||
use Com\Tecnick\Barcode\Type\Square\Datamatrix\Encode;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix
|
||||
*
|
||||
* Datamatrix Barcode type class
|
||||
* DATAMATRIX (ISO/IEC 16022)
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Datamatrix extends \Com\Tecnick\Barcode\Type\Square
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'DATAMATRIX';
|
||||
|
||||
/**
|
||||
* Array of codewords.
|
||||
*
|
||||
* @var array<int, int>
|
||||
*/
|
||||
protected array $cdw = [];
|
||||
|
||||
/**
|
||||
* Binary grid
|
||||
*
|
||||
* @var array<int, array<int, int>>
|
||||
*/
|
||||
protected array $grid = [];
|
||||
|
||||
/**
|
||||
* Datamatrix Encoding object
|
||||
*/
|
||||
protected Encode $dmx;
|
||||
|
||||
/**
|
||||
* Datamatrix shape key (S=square, R=rectangular)
|
||||
*/
|
||||
protected string $shape = 'S';
|
||||
|
||||
/**
|
||||
* Datamatrix variant (N=default, GS1=FNC1 codeword in first place)
|
||||
*/
|
||||
protected bool $gsonemode = false;
|
||||
|
||||
/**
|
||||
* Datamatrix default encoding.
|
||||
* See Data::SWITCHCDW for valid values.
|
||||
*/
|
||||
protected int $defenc = Data::ENC_ASCII;
|
||||
|
||||
/**
|
||||
* Set extra (optional) parameters:
|
||||
* 1: SHAPE: S=square (default), R=rectangular.
|
||||
* 2: MODE: N=default, GS1 = the FNC1 codeword is added in the first position of Data Matrix ECC 200 version.
|
||||
* 3: ENCODING: ASCII (default), C40, TXT, X12, EDIFACT, BASE256.
|
||||
*/
|
||||
protected function setParameters(): void
|
||||
{
|
||||
parent::setParameters();
|
||||
|
||||
// shape
|
||||
$this->shape = DatamatrixShape::fromLoose(\strval($this->params[0] ?? ''))->value;
|
||||
|
||||
// mode
|
||||
$this->gsonemode = ($this->params[1] ?? null) === 'GS1';
|
||||
|
||||
// encoding
|
||||
if (($this->params[2] ?? null) !== null) {
|
||||
$this->defenc =
|
||||
Data::ENCOPTS[DatamatrixEncoding::fromLoose(\strval($this->params[2]))->value] ?? Data::ENC_ASCII;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add padding codewords
|
||||
*
|
||||
* @param int $size Max barcode size in codewords
|
||||
* @param int $ncw Number of codewords
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function addPadding(int $size, int $ncw): void
|
||||
{
|
||||
if ($size <= $ncw) {
|
||||
return;
|
||||
}
|
||||
|
||||
$lastEnc = (int) $this->dmx->last_enc;
|
||||
if ($lastEnc !== Data::ENC_ASCII && $lastEnc !== Data::ENC_BASE256) {
|
||||
// return to ASCII encodation before padding
|
||||
$this->cdw[] = $lastEnc === Data::ENC_EDF ? 124 : 254;
|
||||
|
||||
++$ncw;
|
||||
}
|
||||
|
||||
if ($size > $ncw) {
|
||||
// add first pad
|
||||
$this->cdw[] = 129;
|
||||
++$ncw;
|
||||
// add remaining pads
|
||||
for ($i = $ncw; $i < $size; ++$i) {
|
||||
$this->cdw[] = $this->dmx->get253StateCodeword(129, $i);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the codewords
|
||||
*
|
||||
* @return array{int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int} params
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function getCodewords(): array
|
||||
{
|
||||
if (\strlen($this->code) === 0) {
|
||||
throw new BarcodeException('Empty input');
|
||||
}
|
||||
|
||||
// get data codewords
|
||||
$this->cdw = $this->getHighLevelEncoding($this->code);
|
||||
|
||||
// number of data codewords
|
||||
$ncw = \count($this->cdw);
|
||||
|
||||
// check size
|
||||
if ($ncw > 1560) {
|
||||
throw new BarcodeException('the input is too large to fit the barcode');
|
||||
}
|
||||
|
||||
// get minimum required matrix size.
|
||||
$params = Data::getPaddingSize($this->shape, $ncw);
|
||||
$this->addPadding($params[11], $ncw);
|
||||
|
||||
$errorCorrection = new \Com\Tecnick\Barcode\Type\Square\Datamatrix\ErrorCorrection();
|
||||
$this->cdw = $errorCorrection->getErrorCorrection($this->cdw, $params[13], $params[14], $params[15]);
|
||||
|
||||
return $params;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the grid
|
||||
*
|
||||
* @param int $idx Index
|
||||
* @param array<int, int> $places Places
|
||||
* @param int $row Row
|
||||
* @param int $col Column
|
||||
* @param int $rdx Region data row index
|
||||
* @param int $cdx Region data column index
|
||||
* @param int $rdri Region data row max index
|
||||
* @param int $rdci Region data column max index
|
||||
*/
|
||||
protected function setGrid(
|
||||
int &$idx,
|
||||
array &$places,
|
||||
int &$row,
|
||||
int &$col,
|
||||
int &$rdx,
|
||||
int &$cdx,
|
||||
int &$rdri,
|
||||
int &$rdci,
|
||||
): void {
|
||||
// draw bits by case
|
||||
if ($rdx === 0) {
|
||||
// top finder pattern
|
||||
$this->grid[$row][$col] = (int) (($cdx % 2) === 0);
|
||||
return;
|
||||
}
|
||||
|
||||
if ($rdx === $rdri) {
|
||||
// bottom finder pattern
|
||||
$this->grid[$row][$col] = 1;
|
||||
return;
|
||||
}
|
||||
|
||||
if ($cdx === 0) {
|
||||
// left finder pattern
|
||||
$this->grid[$row][$col] = 1;
|
||||
return;
|
||||
}
|
||||
|
||||
if ($cdx === $rdci) {
|
||||
// right finder pattern
|
||||
$this->grid[$row][$col] = (int) (($rdx % 2) > 0);
|
||||
return;
|
||||
}
|
||||
|
||||
// data bit
|
||||
$place = $places[$idx] ?? 0;
|
||||
if ($place < 2) {
|
||||
$this->grid[$row][$col] = $place;
|
||||
++$idx;
|
||||
return;
|
||||
}
|
||||
|
||||
// codeword ID
|
||||
$cdw_id = \floor($place / 10) - 1;
|
||||
// codeword BIT mask
|
||||
$cdw_bit = 2 ** (8 - ($place % 10));
|
||||
$cdw_val = $this->cdw[\intval($cdw_id)] ?? 0;
|
||||
$this->grid[$row][$col] = ($cdw_val & $cdw_bit) === 0 ? 0 : 1;
|
||||
|
||||
++$idx;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get high level encoding using the minimum symbol data characters for ECC 200
|
||||
*
|
||||
* @param string $data data to encode
|
||||
*
|
||||
* @return array<int, int> Codewords
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
*/
|
||||
protected function getHighLevelEncoding(string $data): array
|
||||
{
|
||||
// STEP A. Start in predefined encodation.
|
||||
$enc = $this->defenc; // current encoding mode
|
||||
$this->dmx->last_enc = $enc; // last used encoding
|
||||
$pos = 0; // current position
|
||||
$cdw = []; // array of codewords to be returned
|
||||
$cdw_num = 0; // number of data codewords
|
||||
$data_length = \strlen($data); // number of chars
|
||||
$field_length = 0; // number of chars in current field
|
||||
|
||||
// Switch to predefined encoding (no action needed if ASCII because it's the default encoding)
|
||||
if ($this->defenc !== Data::ENC_ASCII) {
|
||||
$cdw[] = $this->dmx->getSwitchEncodingCodeword($this->defenc);
|
||||
++$cdw_num;
|
||||
}
|
||||
|
||||
while ($pos < $data_length) {
|
||||
if ($this->gsonemode) {
|
||||
// check for control characters
|
||||
$cco = \ord($data[$pos]);
|
||||
if (
|
||||
$cco === 232 // FNC1 (ASCII 232 - HEX \xE8)
|
||||
|| $cco === 29 // <GS> (ASCII 29 - HEX \x1D)
|
||||
) {
|
||||
$cdw[] = 232; // FNC1
|
||||
++$pos;
|
||||
++$cdw_num;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
switch ($enc) {
|
||||
case Data::ENC_ASCII:
|
||||
// STEP B. While in ASCII encodation
|
||||
$this->dmx->encodeASCII($cdw, $cdw_num, $pos, $data_length, $data, $enc);
|
||||
break;
|
||||
case Data::ENC_C40:
|
||||
// Upper-case alphanumeric
|
||||
case Data::ENC_TXT:
|
||||
// Lower-case alphanumeric
|
||||
case Data::ENC_X12:
|
||||
// ANSI X12
|
||||
$this->dmx->encodeTXT($cdw, $cdw_num, $pos, $data_length, $data, $enc);
|
||||
break;
|
||||
case Data::ENC_EDF:
|
||||
// F. While in EDIFACT (EDF) encodation
|
||||
$this->dmx->encodeEDF($cdw, $cdw_num, $pos, $data_length, $field_length, $data, $enc);
|
||||
break;
|
||||
case Data::ENC_BASE256:
|
||||
// G. While in Base 256 (B256) encodation
|
||||
$this->dmx->encodeBase256($cdw, $cdw_num, $pos, $data_length, $field_length, $data, $enc);
|
||||
break;
|
||||
}
|
||||
|
||||
$this->dmx->last_enc = $enc;
|
||||
}
|
||||
|
||||
return $cdw;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the bars array
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
$this->dmx = new Encode($this->shape);
|
||||
$params = $this->getCodewords();
|
||||
// get placement map
|
||||
$places = $this->dmx->getPlacementMap($params[2], $params[3]);
|
||||
// fill the grid with data
|
||||
$this->grid = [];
|
||||
$idx = 0;
|
||||
// region data row max index
|
||||
$rdri = $params[4] - 1;
|
||||
// region data column max index
|
||||
$rdci = $params[5] - 1;
|
||||
// for each horizontal region
|
||||
for ($hr = 0; $hr < $params[8]; ++$hr) {
|
||||
// for each row on region
|
||||
for ($rdx = 0; $rdx < $params[4]; ++$rdx) {
|
||||
$row = ($hr * $params[4]) + $rdx;
|
||||
// for each vertical region
|
||||
for ($vr = 0; $vr < $params[9]; ++$vr) {
|
||||
// for each column on region
|
||||
for ($cdx = 0; $cdx < $params[5]; ++$cdx) {
|
||||
$col = ($vr * $params[5]) + $cdx;
|
||||
$this->setGrid($idx, $places, $row, $col, $rdx, $cdx, $rdri, $rdci);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$this->processBinarySequence($this->grid);
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
+67
@@ -0,0 +1,67 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* DatamatrixEncoding.php
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Datamatrix;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix\DatamatrixEncoding
|
||||
*
|
||||
* Backed enum for the Data Matrix default encoding scheme. The backing value of
|
||||
* each case is a public key of Data::ENCOPTS (the internal encoding
|
||||
* states are intentionally not exposed here).
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
enum DatamatrixEncoding: string
|
||||
{
|
||||
case ASCII = 'ASCII';
|
||||
|
||||
case C40 = 'C40';
|
||||
|
||||
case TXT = 'TXT';
|
||||
|
||||
case X12 = 'X12';
|
||||
|
||||
case EDF = 'EDF';
|
||||
|
||||
case BASE256 = 'BASE256';
|
||||
|
||||
/**
|
||||
* Resolve a loose Data Matrix encoding value to the matching enum case.
|
||||
*
|
||||
* Accepts the canonical scheme name or an enum instance (returned
|
||||
* unchanged). Unknown values fall back to ASCII, matching the lenient
|
||||
* behavior of Datamatrix.
|
||||
*
|
||||
* @param string|self $value Encoding scheme name or enum case.
|
||||
*/
|
||||
public static function fromLoose(string|self $value): self
|
||||
{
|
||||
if ($value instanceof self) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
return self::tryFrom($value) ?? self::ASCII;
|
||||
}
|
||||
}
|
||||
+60
@@ -0,0 +1,60 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* DatamatrixShape.php
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Datamatrix;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix\DatamatrixShape
|
||||
*
|
||||
* Backed enum for the Data Matrix symbol shape: S (square, default) or R
|
||||
* (rectangular).
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
enum DatamatrixShape: string
|
||||
{
|
||||
/** Square (default). */
|
||||
case Square = 'S';
|
||||
|
||||
/** Rectangular. */
|
||||
case Rectangular = 'R';
|
||||
|
||||
/**
|
||||
* Resolve a loose Data Matrix shape value to the matching enum case.
|
||||
*
|
||||
* Accepts the canonical letter or an enum instance (returned unchanged).
|
||||
* Unknown values fall back to Square, matching the lenient behavior of
|
||||
* Datamatrix.
|
||||
*
|
||||
* @param string|self $value Shape letter or enum case.
|
||||
*/
|
||||
public static function fromLoose(string|self $value): self
|
||||
{
|
||||
if ($value instanceof self) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
return self::tryFrom($value) ?? self::Square;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,296 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Encode.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Datamatrix;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix\Encode
|
||||
*
|
||||
* Encode methods for Datamatrix Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Encode extends \Com\Tecnick\Barcode\Type\Square\Datamatrix\EncodeTxt
|
||||
{
|
||||
/**
|
||||
* @param array<int, int> $temp_cw
|
||||
*/
|
||||
protected function getTempCodeword(array $temp_cw, int $index): int
|
||||
{
|
||||
return $temp_cw[$index] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize a new encode object
|
||||
*
|
||||
* @param string $shape Datamatrix shape key (S=square, R=rectangular)
|
||||
*/
|
||||
public function __construct(string $shape = 'S')
|
||||
{
|
||||
$this->shape = $shape;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode ASCII
|
||||
*
|
||||
* @param array<int, int> $cdw Codewords array
|
||||
* @param int $cdw_num Codewords number
|
||||
* @param int $pos Current position
|
||||
* @param int $data_length Data length
|
||||
* @param string $data Data string
|
||||
* @param int $enc Current encoding
|
||||
*/
|
||||
public function encodeASCII(
|
||||
array &$cdw,
|
||||
int &$cdw_num,
|
||||
int &$pos,
|
||||
int &$data_length,
|
||||
string &$data,
|
||||
int &$enc,
|
||||
): void {
|
||||
if (
|
||||
$data_length > 1
|
||||
&& $pos < ($data_length - 1)
|
||||
&& (
|
||||
$this->isCharMode(\ord($data[$pos]), Data::ENC_ASCII_NUM)
|
||||
&& $this->isCharMode(\ord($data[$pos + 1]), Data::ENC_ASCII_NUM)
|
||||
)
|
||||
) {
|
||||
// 1. If the next data sequence is at least 2 consecutive digits,
|
||||
// encode the next two digits as a double digit in ASCII mode.
|
||||
$cdw[] = (int) \substr($data, $pos, 2) + 130;
|
||||
++$cdw_num;
|
||||
$pos += 2;
|
||||
return;
|
||||
}
|
||||
|
||||
// 2. If the look-ahead test (starting at step J) indicates another mode, switch to that mode.
|
||||
$newenc = $this->lookAheadTest($data, $pos, $enc);
|
||||
if ($newenc !== $enc) {
|
||||
// switch to new encoding
|
||||
$enc = $newenc;
|
||||
$cdw[] = $this->getSwitchEncodingCodeword($enc);
|
||||
++$cdw_num;
|
||||
return;
|
||||
}
|
||||
|
||||
// get new byte
|
||||
$chr = \ord($data[$pos]);
|
||||
++$pos;
|
||||
if ($this->isCharMode($chr, Data::ENC_ASCII_EXT)) {
|
||||
// 3. If the next data character is extended ASCII (greater than 127)
|
||||
// encode it in ASCII mode first using the Upper Shift (value 235) character.
|
||||
$cdw[] = 235;
|
||||
$cdw[] = $chr - 127;
|
||||
$cdw_num += 2;
|
||||
return;
|
||||
}
|
||||
|
||||
// 4. Otherwise process the next data character in ASCII encodation.
|
||||
$cdw[] = $chr + 1;
|
||||
++$cdw_num;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode EDF4
|
||||
*
|
||||
* @param int $epos Current position
|
||||
* @param array<int, int> $cdw Codewords array
|
||||
* @param int $cdw_num Codewords number
|
||||
* @param int $pos Current position
|
||||
* @param int $data_length Data length
|
||||
* @param int $field_length Field length
|
||||
* @param int $enc Current encoding
|
||||
* @param array<int, int> $temp_cw Temporary codewords array
|
||||
*
|
||||
* @return bool true to break the loop
|
||||
*
|
||||
* @throws \Com\Tecnick\Barcode\Exception in case of error
|
||||
*/
|
||||
public function encodeEDFfour(
|
||||
int $epos,
|
||||
array &$cdw,
|
||||
int &$cdw_num,
|
||||
int &$pos,
|
||||
int &$data_length,
|
||||
int &$field_length,
|
||||
int &$enc,
|
||||
array &$temp_cw,
|
||||
): bool {
|
||||
if ($epos === $data_length) {
|
||||
$enc = Data::ENC_ASCII;
|
||||
$params = Data::getPaddingSize($this->shape, $cdw_num + $field_length);
|
||||
if (($params[11] - $cdw_num) > 2) {
|
||||
$cdw[] = $this->getSwitchEncodingCodeword($enc);
|
||||
++$cdw_num;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($field_length < 4) {
|
||||
$enc = Data::ENC_ASCII;
|
||||
$this->last_enc = $enc;
|
||||
$params = Data::getPaddingSize($this->shape, $cdw_num + $field_length + ($data_length - $epos));
|
||||
if (($params[11] - $cdw_num) <= 2) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// set unlatch character
|
||||
$temp_cw[] = 0x1f;
|
||||
++$field_length;
|
||||
// fill empty characters
|
||||
for ($i = $field_length; $i < 4; ++$i) {
|
||||
$temp_cw[] = 0;
|
||||
}
|
||||
}
|
||||
|
||||
// encodes four data characters in three codewords
|
||||
$cw0 = $this->getTempCodeword($temp_cw, 0);
|
||||
$cw1 = $this->getTempCodeword($temp_cw, 1);
|
||||
$cw2 = $this->getTempCodeword($temp_cw, 2);
|
||||
$cw3 = $this->getTempCodeword($temp_cw, 3);
|
||||
|
||||
$cdw[] = (($cw0 & 0x3F) << 2) + (($cw1 & 0x30) >> 4);
|
||||
++$cdw_num;
|
||||
if ($field_length > 1) {
|
||||
$cdw[] = (($cw1 & 0x0F) << 4) + (($cw2 & 0x3C) >> 2);
|
||||
++$cdw_num;
|
||||
}
|
||||
|
||||
if ($field_length > 2) {
|
||||
$cdw[] = (($cw2 & 0x03) << 6) + ($cw3 & 0x3F);
|
||||
++$cdw_num;
|
||||
}
|
||||
|
||||
$temp_cw = [];
|
||||
$pos = $epos;
|
||||
$field_length = 0;
|
||||
if ($enc === Data::ENC_ASCII) {
|
||||
return true; // exit from EDIFACT mode
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode EDF
|
||||
*
|
||||
* @param array<int, int> $cdw Codewords array
|
||||
* @param int $cdw_num Codewords number
|
||||
* @param int $pos Current position
|
||||
* @param int $data_length Data length
|
||||
* @param int $field_length Field length
|
||||
* @param string $data Data string
|
||||
* @param int $enc Current encoding
|
||||
*/
|
||||
public function encodeEDF(
|
||||
array &$cdw,
|
||||
int &$cdw_num,
|
||||
int &$pos,
|
||||
int &$data_length,
|
||||
int &$field_length,
|
||||
string &$data,
|
||||
int &$enc,
|
||||
): void {
|
||||
// initialize temporary array with 0 length
|
||||
$temp_cw = [];
|
||||
$epos = $pos;
|
||||
$field_length = 0;
|
||||
do {
|
||||
// 2. process the next character in EDIFACT encodation.
|
||||
$chr = \ord($data[$epos]);
|
||||
if ($this->isCharMode($chr, Data::ENC_EDF)) {
|
||||
++$epos;
|
||||
$temp_cw[] = $chr;
|
||||
++$field_length;
|
||||
}
|
||||
|
||||
if (
|
||||
($field_length === 4 || $epos === $data_length || !$this->isCharMode($chr, Data::ENC_EDF))
|
||||
&& $this->encodeEDFfour($epos, $cdw, $cdw_num, $pos, $data_length, $field_length, $enc, $temp_cw)
|
||||
) {
|
||||
break;
|
||||
}
|
||||
} while ($epos < $data_length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode Base256
|
||||
*
|
||||
* @param array<int, int> $cdw Codewords array
|
||||
* @param int $cdw_num Codewords number
|
||||
* @param int $pos Current position
|
||||
* @param int $data_length Data length
|
||||
* @param int $field_length Field length
|
||||
* @param string $data Data string
|
||||
* @param int $enc Current encoding
|
||||
*/
|
||||
public function encodeBase256(
|
||||
array &$cdw,
|
||||
int &$cdw_num,
|
||||
int &$pos,
|
||||
int &$data_length,
|
||||
int &$field_length,
|
||||
string &$data,
|
||||
int &$enc,
|
||||
): void {
|
||||
// initialize temporary array with 0 length
|
||||
$temp_cw = [];
|
||||
$field_length = 0;
|
||||
while ($pos < $data_length && $field_length <= 1555) {
|
||||
$newenc = $this->lookAheadTest($data, $pos, $enc);
|
||||
if ($newenc !== $enc) {
|
||||
// 1. If the look-ahead test (starting at step J)
|
||||
// indicates another mode, switch to that mode.
|
||||
$enc = $newenc;
|
||||
break; // exit from B256 mode
|
||||
}
|
||||
|
||||
// 2. Otherwise, process the next character in Base 256 encodation.
|
||||
$chr = \ord($data[$pos]);
|
||||
++$pos;
|
||||
$temp_cw[] = $chr;
|
||||
++$field_length;
|
||||
}
|
||||
|
||||
// set field length
|
||||
if ($field_length <= 249) {
|
||||
$cdw[] = $this->get255StateCodeword($field_length, $cdw_num + 1);
|
||||
++$cdw_num;
|
||||
}
|
||||
|
||||
if ($field_length > 249) {
|
||||
$cdw[] = $this->get255StateCodeword((int) \floor($field_length / 250) + 249, $cdw_num + 1);
|
||||
$cdw[] = $this->get255StateCodeword($field_length % 250, $cdw_num + 2);
|
||||
$cdw_num += 2;
|
||||
}
|
||||
|
||||
// add B256 field
|
||||
foreach ($temp_cw as $cht) {
|
||||
$cdw[] = $this->get255StateCodeword($cht, $cdw_num + 1);
|
||||
++$cdw_num;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,292 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* EncodeTxt.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Datamatrix;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix\EncodeTxt
|
||||
*
|
||||
* Encode TXT/C40 methods for Datamatrix Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class EncodeTxt extends \Com\Tecnick\Barcode\Type\Square\Datamatrix\Steps
|
||||
{
|
||||
/**
|
||||
* @return array<int|string, int>
|
||||
*/
|
||||
protected function getCharset(string $key): array
|
||||
{
|
||||
return Data::CHSET[$key] ?? [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int|string, int> $charset
|
||||
*/
|
||||
protected function getCharsetValue(array $charset, int $chr): int
|
||||
{
|
||||
return $charset[$chr] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, int> $temp_cw
|
||||
*/
|
||||
protected function shiftTempCw(array &$temp_cw): int
|
||||
{
|
||||
if (!\array_key_exists(0, $temp_cw)) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$val = $temp_cw[0];
|
||||
\array_splice($temp_cw, 0, 1);
|
||||
return $val;
|
||||
}
|
||||
|
||||
protected function getCharsetId(int $enc): string
|
||||
{
|
||||
return Data::CHSET_ID[$enc] ?? 'BAS';
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode TXTC40 shift
|
||||
*
|
||||
* @param int $chr Character code
|
||||
* @param int $enc Current encoding
|
||||
* @param array<int, int> $temp_cw Temporary codewords array
|
||||
* @param int $ptr Pointer
|
||||
*
|
||||
* @throws BarcodeException in case of shift encoding errors
|
||||
*/
|
||||
public function encodeTXTC40shift(int &$chr, int &$enc, array &$temp_cw, int &$ptr): void
|
||||
{
|
||||
$shiftset = $this->getCharset('SH1');
|
||||
if (\array_key_exists($chr, $shiftset)) {
|
||||
$temp_cw[] = 0; // shift 1
|
||||
$temp_cw[] = $this->getCharsetValue($shiftset, $chr);
|
||||
$ptr += 2;
|
||||
return;
|
||||
}
|
||||
|
||||
$shiftset = $this->getCharset('SH2');
|
||||
if (\array_key_exists($chr, $shiftset)) {
|
||||
$temp_cw[] = 1; // shift 2
|
||||
$temp_cw[] = $this->getCharsetValue($shiftset, $chr);
|
||||
$ptr += 2;
|
||||
return;
|
||||
}
|
||||
|
||||
$shiftset = $this->getCharset('S3C');
|
||||
if ($enc === Data::ENC_C40 && \array_key_exists($chr, $shiftset)) {
|
||||
$temp_cw[] = 2; // shift 3
|
||||
$temp_cw[] = $this->getCharsetValue($shiftset, $chr);
|
||||
$ptr += 2;
|
||||
return;
|
||||
}
|
||||
|
||||
$shiftset = $this->getCharset('S3T');
|
||||
if ($enc === Data::ENC_TXT && \array_key_exists($chr, $shiftset)) {
|
||||
$temp_cw[] = 2; // shift 3
|
||||
$temp_cw[] = $this->getCharsetValue($shiftset, $chr);
|
||||
$ptr += 2;
|
||||
return;
|
||||
}
|
||||
|
||||
throw new BarcodeException('Error');
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode TXTC40
|
||||
*
|
||||
* @param string $data Data string
|
||||
* @param int $enc Current encoding
|
||||
* @param array<int, int> $temp_cw Temporary codewords array
|
||||
* @param int $ptr Pointer
|
||||
* @param int $epos End position
|
||||
* @param array<int|string, int> $charset Charset array
|
||||
*
|
||||
* @return int Curent character code
|
||||
*
|
||||
* @throws BarcodeException in case of TXT/C40 encoding errors
|
||||
*/
|
||||
public function encodeTXTC40(string &$data, int &$enc, array &$temp_cw, int &$ptr, int &$epos, array &$charset): int
|
||||
{
|
||||
// 2. process the next character in C40 encodation.
|
||||
$chr = \ord($data[$epos]);
|
||||
++$epos;
|
||||
// check for extended character
|
||||
if (($chr & 0x80) !== 0) {
|
||||
if ($enc === Data::ENC_X12) {
|
||||
throw new BarcodeException('TXTC40 Error');
|
||||
}
|
||||
|
||||
$chr &= 0x7f;
|
||||
$temp_cw[] = 1; // shift 2
|
||||
$temp_cw[] = 30; // upper shift
|
||||
$ptr += 2;
|
||||
}
|
||||
|
||||
if (\array_key_exists($chr, $charset)) {
|
||||
$temp_cw[] = $this->getCharsetValue($charset, $chr);
|
||||
++$ptr;
|
||||
return $chr;
|
||||
}
|
||||
|
||||
$this->encodeTXTC40shift($chr, $enc, $temp_cw, $ptr);
|
||||
|
||||
return $chr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode TXTC40 last
|
||||
* The following rules apply when only one or two symbol characters remain in the symbol
|
||||
* before the start of the error correction codewords.
|
||||
*
|
||||
* @param int $chr Character code
|
||||
* @param array<int, int> $cdw Codewords array
|
||||
* @param int $cdw_num Codewords number
|
||||
* @param int $enc Current encoding
|
||||
* @param array<int, int> $temp_cw Temporary codewords array
|
||||
* @param int $ptr Pointer
|
||||
* @param int $epos End position
|
||||
*/
|
||||
public function encodeTXTC40last(
|
||||
int $chr,
|
||||
array &$cdw,
|
||||
int &$cdw_num,
|
||||
int &$enc,
|
||||
array &$temp_cw,
|
||||
int &$ptr,
|
||||
int &$epos,
|
||||
): void {
|
||||
// get remaining number of data symbols
|
||||
$cdwr = $this->getMaxDataCodewords($cdw_num + $ptr) - $cdw_num;
|
||||
if ($cdwr === 1 && $ptr === 1) {
|
||||
// d. If one symbol character remains and one
|
||||
// C40 value (data character) remains to be encoded
|
||||
$cdw[] = $chr + 1;
|
||||
++$cdw_num;
|
||||
$enc = Data::ENC_ASCII;
|
||||
$this->last_enc = $enc;
|
||||
return;
|
||||
}
|
||||
|
||||
if ($cdwr === 2 && $ptr === 1) {
|
||||
// c. If two symbol characters remain and only one
|
||||
// C40 value (data character) remains to be encoded
|
||||
$cdw[] = 254;
|
||||
$cdw[] = $chr + 1;
|
||||
$cdw_num += 2;
|
||||
$enc = Data::ENC_ASCII;
|
||||
$this->last_enc = $enc;
|
||||
return;
|
||||
}
|
||||
|
||||
if ($cdwr === 2 && $ptr === 2) {
|
||||
// b. If two symbol characters remain and two C40 values remain to be encoded
|
||||
$ch1 = $this->shiftTempCw($temp_cw);
|
||||
$ch2 = $this->shiftTempCw($temp_cw);
|
||||
$ptr -= 2;
|
||||
$tmp = (1600 * $ch1) + (40 * $ch2) + 1;
|
||||
$cdw[] = $tmp >> 8;
|
||||
$cdw[] = $tmp % 256;
|
||||
$cdw_num += 2;
|
||||
$enc = Data::ENC_ASCII;
|
||||
$this->last_enc = $enc;
|
||||
return;
|
||||
}
|
||||
|
||||
if ($enc !== Data::ENC_ASCII) {
|
||||
// switch to ASCII encoding
|
||||
$enc = Data::ENC_ASCII;
|
||||
$this->last_enc = $enc;
|
||||
$cdw[] = $this->getSwitchEncodingCodeword($enc);
|
||||
++$cdw_num;
|
||||
$epos -= $ptr;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode TXT
|
||||
*
|
||||
* @param array<int, int> $cdw Codewords array
|
||||
* @param int $cdw_num Codewords number
|
||||
* @param int $pos Current position
|
||||
* @param int $data_length Data length
|
||||
* @param string $data Data string
|
||||
* @param int $enc Current encoding
|
||||
*
|
||||
* @throws BarcodeException in case of TXT/C40 encoding errors
|
||||
*/
|
||||
public function encodeTXT(array &$cdw, int &$cdw_num, int &$pos, int &$data_length, string &$data, int &$enc): void
|
||||
{
|
||||
/** @var array<int, int> $temp_cw */
|
||||
$temp_cw = [];
|
||||
$ptr = 0;
|
||||
$epos = $pos;
|
||||
// get charset ID
|
||||
$set_id = $this->getCharsetId($enc);
|
||||
// get basic charset for current encoding
|
||||
$charset = $this->getCharset($set_id);
|
||||
do {
|
||||
$chr = $this->encodeTXTC40($data, $enc, $temp_cw, $ptr, $epos, $charset);
|
||||
if ($ptr >= 3) {
|
||||
$ch1 = $this->shiftTempCw($temp_cw);
|
||||
$ch2 = $this->shiftTempCw($temp_cw);
|
||||
$ch3 = $this->shiftTempCw($temp_cw);
|
||||
$ptr -= 3;
|
||||
$tmp = (1600 * $ch1) + (40 * $ch2) + $ch3 + 1;
|
||||
$cdw[] = $tmp >> 8;
|
||||
$cdw[] = $tmp % 256;
|
||||
$cdw_num += 2;
|
||||
$pos = $epos;
|
||||
// 1. If the C40 encoding is at the point of starting a new double symbol character and
|
||||
// if the look-ahead test (starting at step J) indicates another mode, switch to that mode.
|
||||
$newenc = $this->lookAheadTest($data, $pos, $enc);
|
||||
if ($newenc !== $enc) {
|
||||
// switch to new encoding
|
||||
$enc = $newenc;
|
||||
if ($enc !== Data::ENC_ASCII) {
|
||||
// set unlatch character
|
||||
$cdw[] = $this->getSwitchEncodingCodeword(Data::ENC_ASCII);
|
||||
++$cdw_num;
|
||||
}
|
||||
|
||||
$cdw[] = $this->getSwitchEncodingCodeword($enc);
|
||||
++$cdw_num;
|
||||
$pos -= $ptr;
|
||||
$ptr = 0;
|
||||
break;
|
||||
}
|
||||
}
|
||||
} while ($ptr > 0 && $epos < $data_length);
|
||||
|
||||
// process last data (if any)
|
||||
if ($ptr > 0) {
|
||||
$this->encodeTXTC40last($chr, $cdw, $cdw_num, $enc, $temp_cw, $ptr, $epos);
|
||||
$pos = $epos;
|
||||
}
|
||||
}
|
||||
}
|
||||
+173
@@ -0,0 +1,173 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* ErrorCorrection.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Datamatrix;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix\ErrorCorrection
|
||||
*
|
||||
* Error correction methods and other utilities for Datamatrix Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class ErrorCorrection
|
||||
{
|
||||
/**
|
||||
* @param array<int, int> $values
|
||||
*/
|
||||
protected function getArrayInt(array $values, int $idx): int
|
||||
{
|
||||
return $values[$idx] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Product of two numbers in a Power-of-Two Galois Field
|
||||
*
|
||||
* @param int $numa First number to multiply.
|
||||
* @param int $numb Second number to multiply.
|
||||
* @param array<int, int> $log Log table.
|
||||
* @param array<int, int> $alog Anti-Log table.
|
||||
* @param int $ngf Number of Factors of the Reed-Solomon polynomial.
|
||||
*
|
||||
* @return int product
|
||||
*/
|
||||
protected function getGFProduct(int $numa, int $numb, array $log, array $alog, int $ngf): int
|
||||
{
|
||||
if ($numa === 0 || $numb === 0) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$a = $this->getArrayInt($log, $numa);
|
||||
$b = $this->getArrayInt($log, $numb);
|
||||
$idx = ($a + $b) % ($ngf - 1);
|
||||
|
||||
return $this->getArrayInt($alog, $idx);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add error correction codewords to data codewords array (ANNEX E).
|
||||
*
|
||||
* @param array<int, int> $wdc Array of datacodewords.
|
||||
* @param int $nbk Number of blocks.
|
||||
* @param int $ncw Number of data codewords per block.
|
||||
* @param int $ncc Number of correction codewords per block.
|
||||
* @param int $ngf Number of fields on log/antilog table (power of 2).
|
||||
* @param int $vpp The value of its prime modulus polynomial (301 for ECC200).
|
||||
*
|
||||
* @return array<int, int> data codewords + error codewords
|
||||
*/
|
||||
public function getErrorCorrection(array $wdc, int $nbk, int $ncw, int $ncc, int $ngf = 256, int $vpp = 301): array
|
||||
{
|
||||
// generate the log ($log) and antilog ($alog) tables
|
||||
$log = [0];
|
||||
$alog = [1];
|
||||
$this->genLogs($log, $alog, $ngf, $vpp);
|
||||
|
||||
// generate the polynomial coefficients (c)
|
||||
$plc = \array_fill(0, \max(0, $ncc + 1), 0);
|
||||
$plc[0] = 1;
|
||||
for ($i = 1; $i <= $ncc; ++$i) {
|
||||
$plc[$i] = $this->getArrayInt($plc, $i - 1);
|
||||
for ($j = $i - 1; $j >= 1; --$j) {
|
||||
$plc[$j] =
|
||||
$this->getArrayInt($plc, $j - 1)
|
||||
^ $this->getGFProduct(
|
||||
$this->getArrayInt($plc, $j),
|
||||
$this->getArrayInt($alog, $i),
|
||||
$log,
|
||||
$alog,
|
||||
$ngf,
|
||||
);
|
||||
}
|
||||
|
||||
$plc[0] = $this->getGFProduct(
|
||||
$this->getArrayInt($plc, 0),
|
||||
$this->getArrayInt($alog, $i),
|
||||
$log,
|
||||
$alog,
|
||||
$ngf,
|
||||
);
|
||||
}
|
||||
|
||||
\ksort($plc);
|
||||
|
||||
// total number of data codewords
|
||||
$num_wd = $nbk * $ncw;
|
||||
// total number of error codewords
|
||||
$num_we = $nbk * $ncc;
|
||||
// for each block
|
||||
for ($b = 0; $b < $nbk; ++$b) {
|
||||
// create interleaved data block
|
||||
$block = [];
|
||||
for ($n = $b; $n < $num_wd; $n += $nbk) {
|
||||
$block[] = $this->getArrayInt($wdc, $n);
|
||||
}
|
||||
|
||||
// initialize error codewords
|
||||
$wec = \array_fill(0, \max(0, $ncc + 1), 0);
|
||||
// calculate error correction codewords for this block
|
||||
for ($i = 0; $i < $ncw; ++$i) {
|
||||
$ker = $this->getArrayInt($wec, 0) ^ $this->getArrayInt($block, $i);
|
||||
for ($j = 0; $j < $ncc; ++$j) {
|
||||
$wec[$j] =
|
||||
$this->getArrayInt($wec, $j + 1)
|
||||
^ $this->getGFProduct($ker, $this->getArrayInt($plc, $ncc - $j - 1), $log, $alog, $ngf);
|
||||
}
|
||||
}
|
||||
|
||||
// add error codewords at the end of data codewords
|
||||
$j = 0;
|
||||
for ($i = $b; $i < $num_we; $i += $nbk) {
|
||||
$wdc[$num_wd + $i] = $this->getArrayInt($wec, $j);
|
||||
++$j;
|
||||
}
|
||||
}
|
||||
|
||||
// reorder codewords
|
||||
\ksort($wdc);
|
||||
return $wdc;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate the log ($log) and antilog ($alog) tables
|
||||
*
|
||||
* @param array<int, int> $log Log table
|
||||
* @param array<int, int> $alog Anti-Log table
|
||||
* @param int $ngf Number of fields on log/antilog table (power of 2).
|
||||
* @param int $vpp The value of its prime modulus polynomial (301 for ECC200).
|
||||
*/
|
||||
protected function genLogs(array &$log, array &$alog, int $ngf, int $vpp): void
|
||||
{
|
||||
for ($i = 1; $i < $ngf; ++$i) {
|
||||
$alog[$i] = $this->getArrayInt($alog, $i - 1) * 2;
|
||||
if ($alog[$i] >= $ngf) {
|
||||
$alog[$i] ^= $vpp;
|
||||
}
|
||||
|
||||
$log[$alog[$i]] = $i;
|
||||
}
|
||||
|
||||
\ksort($log);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,244 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Modes.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Datamatrix;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix\Modes
|
||||
*
|
||||
* Modes for Datamatrix Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Modes extends \Com\Tecnick\Barcode\Type\Square\Datamatrix\Placement
|
||||
{
|
||||
/**
|
||||
* @return array<int, array{0: int, 1: int, 2: int, 3: int, 4: int, 5: int, 6: int, 7: int, 8: int, 9: int, 10: int, 11: int, 12: int, 13: int, 14: int, 15: int}>
|
||||
*/
|
||||
protected function getShapeMatrices(): array
|
||||
{
|
||||
$result = [];
|
||||
foreach (Data::SYMBATTR[$this->shape] ?? [] as $matrix) {
|
||||
$result[] = $matrix;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
protected function getSwitchCodeword(int $mode): int
|
||||
{
|
||||
return Data::SWITCHCDW[$mode] ?? 254;
|
||||
}
|
||||
|
||||
/**
|
||||
* Store last used encoding for data codewords.
|
||||
*/
|
||||
public int $last_enc = 0; // Data::ENC_ASCII
|
||||
|
||||
/**
|
||||
* Datamatrix shape key (S=square, R=rectangular)
|
||||
*/
|
||||
public string $shape;
|
||||
|
||||
/**
|
||||
* Return the 253-state codeword
|
||||
*
|
||||
* @param int $cdwpad Pad codeword.
|
||||
* @param int $cdwpos Number of data codewords from the beginning of encoded data.
|
||||
*/
|
||||
public function get253StateCodeword(int $cdwpad, int $cdwpos): int
|
||||
{
|
||||
$pad = $cdwpad + (((149 * $cdwpos) % 253) + 1);
|
||||
if ($pad > 254) {
|
||||
$pad -= 254;
|
||||
}
|
||||
|
||||
return $pad;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the 255-state codeword
|
||||
*
|
||||
* @param int $cdwpad Pad codeword.
|
||||
* @param int $cdwpos Number of data codewords from the beginning of encoded data.
|
||||
*
|
||||
* @return int pad codeword
|
||||
*/
|
||||
protected function get255StateCodeword(int $cdwpad, int $cdwpos): int
|
||||
{
|
||||
$pad = $cdwpad + (((149 * $cdwpos) % 255) + 1);
|
||||
if ($pad > 255) {
|
||||
$pad -= 256;
|
||||
}
|
||||
|
||||
return $pad;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the char belongs to the selected mode
|
||||
*
|
||||
* @param int $chr Character (byte) to check.
|
||||
* @param int $mode Current encoding mode.
|
||||
*
|
||||
* @return bool true if the char is of the selected mode.
|
||||
*/
|
||||
protected function isCharMode(int $chr, int $mode): bool
|
||||
{
|
||||
return match ($mode) {
|
||||
//Data::ENC_ASCII => 'isASCIIMode',
|
||||
Data::ENC_C40 => $this->isC40Mode($chr),
|
||||
Data::ENC_TXT => $this->isTXTMode($chr),
|
||||
Data::ENC_X12 => $this->isX12Mode($chr),
|
||||
Data::ENC_EDF => $this->isEDFMode($chr),
|
||||
Data::ENC_BASE256 => $this->isBASE256Mode($chr),
|
||||
Data::ENC_ASCII_EXT => $this->isASCIIEXTMode($chr),
|
||||
Data::ENC_ASCII_NUM => $this->isASCIINUMMode($chr),
|
||||
default => false,
|
||||
};
|
||||
}
|
||||
|
||||
///**
|
||||
// * Tell if char is ASCII character 0 to 127
|
||||
// *
|
||||
// * @param int $chr Character (byte) to check.
|
||||
// *
|
||||
// * @return bool
|
||||
// */
|
||||
//protected function isASCIIMode(int $chr): bool
|
||||
//{
|
||||
// return (($chr >= 0) && ($chr <= 127));
|
||||
//}
|
||||
/**
|
||||
* Tell if char is Upper-case alphanumeric
|
||||
*
|
||||
* @param int $chr Character (byte) to check.
|
||||
*/
|
||||
protected function isC40Mode(int $chr): bool
|
||||
{
|
||||
return $chr === 32 || $chr >= 48 && $chr <= 57 || $chr >= 65 && $chr <= 90;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if char is Lower-case alphanumeric
|
||||
*
|
||||
* @param int $chr Character (byte) to check.
|
||||
*/
|
||||
protected function isTXTMode(int $chr): bool
|
||||
{
|
||||
return $chr === 32 || $chr >= 48 && $chr <= 57 || $chr >= 97 && $chr <= 122;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if char is ANSI X12
|
||||
*
|
||||
* @param int $chr Character (byte) to check.
|
||||
*/
|
||||
protected function isX12Mode(int $chr): bool
|
||||
{
|
||||
return $chr === 13 || $chr === 42 || $chr === 62;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if char is ASCII character 32 to 94
|
||||
*
|
||||
* @param int $chr Character (byte) to check.
|
||||
*/
|
||||
protected function isEDFMode(int $chr): bool
|
||||
{
|
||||
return $chr >= 32 && $chr <= 94;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if char is Function character (FNC1, Structured Append, Reader Program, or Code Page)
|
||||
*
|
||||
* @param int $chr Character (byte) to check.
|
||||
*/
|
||||
protected function isBASE256Mode(int $chr): bool
|
||||
{
|
||||
return $chr === 232 || $chr === 233 || $chr === 234 || $chr === 241;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if char is ASCII character 128 to 255
|
||||
*
|
||||
* @param int $chr Character (byte) to check.
|
||||
*/
|
||||
protected function isASCIIEXTMode(int $chr): bool
|
||||
{
|
||||
return $chr >= 128 && $chr <= 255;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if char is ASCII digits
|
||||
*
|
||||
* @param int $chr Character (byte) to check.
|
||||
*/
|
||||
protected function isASCIINUMMode(int $chr): bool
|
||||
{
|
||||
return $chr >= 48 && $chr <= 57;
|
||||
}
|
||||
|
||||
/**
|
||||
* Choose the minimum matrix size and return the max number of data codewords.
|
||||
*
|
||||
* @param int $numcw Number of current codewords.
|
||||
*
|
||||
* @return int number of data codewords in matrix
|
||||
*/
|
||||
protected function getMaxDataCodewords(int $numcw): int
|
||||
{
|
||||
$mdc = 0;
|
||||
foreach ($this->getShapeMatrices() as $matrix) {
|
||||
if ($matrix[11] < $numcw) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$mdc = $matrix[11];
|
||||
break;
|
||||
}
|
||||
|
||||
return $mdc;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the switching codeword to a new encoding mode (latch codeword)
|
||||
*
|
||||
* @param int $mode New encoding mode.
|
||||
*
|
||||
* @return int Switch codeword.
|
||||
*/
|
||||
public function getSwitchEncodingCodeword(int $mode): int
|
||||
{
|
||||
$cdw = $this->getSwitchCodeword($mode);
|
||||
if ($cdw !== 254) {
|
||||
return $cdw;
|
||||
}
|
||||
|
||||
if ($this->last_enc !== Data::ENC_EDF) {
|
||||
return $cdw;
|
||||
}
|
||||
|
||||
return 124;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,314 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Placement.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Datamatrix;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix\Placement
|
||||
*
|
||||
* Placement methods for Datamatrix Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Placement
|
||||
{
|
||||
/**
|
||||
* Places "chr+bit" with appropriate wrapping within array[].
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param array<int, int> $marr Array of symbols.
|
||||
* @param int $nrow Number of rows.
|
||||
* @param int $ncol Number of columns.
|
||||
* @param int $row Row number.
|
||||
* @param int $col Column number.
|
||||
* @param int $chr Char byte.
|
||||
* @param int $bit Bit.
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function placeModule(array $marr, int $nrow, int $ncol, int $row, int $col, int $chr, int $bit): array
|
||||
{
|
||||
if ($row < 0) {
|
||||
$row += $nrow;
|
||||
$col += 4 - (($nrow + 4) % 8);
|
||||
}
|
||||
|
||||
if ($col < 0) {
|
||||
$col += $ncol;
|
||||
$row += 4 - (($ncol + 4) % 8);
|
||||
}
|
||||
|
||||
$marr[($row * $ncol) + $col] = (10 * $chr) + $bit;
|
||||
return $marr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Places the 8 bits of a utah-shaped symbol character.
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param array<int, int> $marr Array of symbols.
|
||||
* @param int $nrow Number of rows.
|
||||
* @param int $ncol Number of columns.
|
||||
* @param int $row Row number.
|
||||
* @param int $col Column number.
|
||||
* @param int $chr Char byte.
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function placeUtah(array $marr, int $nrow, int $ncol, int $row, int $col, int $chr): array
|
||||
{
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $row - 2, $col - 2, $chr, 1);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $row - 2, $col - 1, $chr, 2);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $row - 1, $col - 2, $chr, 3);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $row - 1, $col - 1, $chr, 4);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $row - 1, $col, $chr, 5);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $row, $col - 2, $chr, 6);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $row, $col - 1, $chr, 7);
|
||||
return $this->placeModule($marr, $nrow, $ncol, $row, $col, $chr, 8);
|
||||
}
|
||||
|
||||
/**
|
||||
* Places the 8 bits of the first special corner case.
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param array<int, int> $marr Array of symbols
|
||||
* @param int $nrow Number of rows
|
||||
* @param int $ncol Number of columns
|
||||
* @param int $chr Char byte
|
||||
* @param int $row Current row
|
||||
* @param int $col Current column
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function placeCornerA(array $marr, int $nrow, int $ncol, int &$chr, int $row, int $col): array
|
||||
{
|
||||
if ($row !== $nrow || $col !== 0) {
|
||||
return $marr;
|
||||
}
|
||||
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 1, 0, $chr, 1);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 1, 1, $chr, 2);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 1, 2, $chr, 3);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 2, $chr, 4);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 1, $chr, 5);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol - 1, $chr, 6);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 2, $ncol - 1, $chr, 7);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 3, $ncol - 1, $chr, 8);
|
||||
++$chr;
|
||||
return $marr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Places the 8 bits of the second special corner case.
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param array<int, int> $marr Array of symbols
|
||||
* @param int $nrow Number of rows
|
||||
* @param int $ncol Number of columns
|
||||
* @param int $chr Char byte
|
||||
* @param int $row Current row
|
||||
* @param int $col Current column
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function placeCornerB(array $marr, int $nrow, int $ncol, int &$chr, int $row, int $col): array
|
||||
{
|
||||
if ($row !== ($nrow - 2) || $col !== 0 || ($ncol % 4) === 0) {
|
||||
return $marr;
|
||||
}
|
||||
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 3, 0, $chr, 1);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 2, 0, $chr, 2);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 1, 0, $chr, 3);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 4, $chr, 4);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 3, $chr, 5);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 2, $chr, 6);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 1, $chr, 7);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol - 1, $chr, 8);
|
||||
++$chr;
|
||||
return $marr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Places the 8 bits of the third special corner case.
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param array<int, int> $marr Array of symbols
|
||||
* @param int $nrow Number of rows
|
||||
* @param int $ncol Number of columns
|
||||
* @param int $chr Char byte
|
||||
* @param int $row Current row
|
||||
* @param int $col Current column
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function placeCornerC(array $marr, int $nrow, int $ncol, int &$chr, int $row, int $col): array
|
||||
{
|
||||
if ($row !== ($nrow - 2) || $col !== 0 || ($ncol % 8) !== 4) {
|
||||
return $marr;
|
||||
}
|
||||
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 3, 0, $chr, 1);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 2, 0, $chr, 2);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 1, 0, $chr, 3);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 2, $chr, 4);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 1, $chr, 5);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol - 1, $chr, 6);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 2, $ncol - 1, $chr, 7);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 3, $ncol - 1, $chr, 8);
|
||||
++$chr;
|
||||
return $marr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Places the 8 bits of the fourth special corner case.
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param array<int, int> $marr Array of symbols
|
||||
* @param int $nrow Number of rows
|
||||
* @param int $ncol Number of columns
|
||||
* @param int $chr Char byte
|
||||
* @param int $row Current row
|
||||
* @param int $col Current column
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function placeCornerD(array $marr, int $nrow, int $ncol, int &$chr, int $row, int $col): array
|
||||
{
|
||||
if ($row !== ($nrow + 4) || $col !== 2 || ($ncol % 8)) {
|
||||
return $marr;
|
||||
}
|
||||
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 1, 0, $chr, 1);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow - 1, $ncol - 1, $chr, 2);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 3, $chr, 3);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 2, $chr, 4);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol - 1, $chr, 5);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol - 3, $chr, 6);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol - 2, $chr, 7);
|
||||
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol - 1, $chr, 8);
|
||||
++$chr;
|
||||
return $marr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sweep upward diagonally, inserting successive characters,
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param array<int, int> $marr Array of symbols
|
||||
* @param int $nrow Number of rows
|
||||
* @param int $ncol Number of columns
|
||||
* @param int $chr Char byte
|
||||
* @param int $row Current row
|
||||
* @param int $col Current column
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function placeSweepUpward(array $marr, int $nrow, int $ncol, int &$chr, int &$row, int &$col): array
|
||||
{
|
||||
do {
|
||||
if ($row < $nrow && $col >= 0 && !($marr[($row * $ncol) + $col] ?? 0)) {
|
||||
$marr = $this->placeUtah($marr, $nrow, $ncol, $row, $col, $chr);
|
||||
++$chr;
|
||||
}
|
||||
|
||||
$row -= 2;
|
||||
$col += 2;
|
||||
} while ($row >= 0 && $col < $ncol);
|
||||
|
||||
++$row;
|
||||
$col += 3;
|
||||
return $marr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sweep downward diagonally, inserting successive characters,
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param array<int, int> $marr Array of symbols
|
||||
* @param int $nrow Number of rows
|
||||
* @param int $ncol Number of columns
|
||||
* @param int $chr Char byte
|
||||
* @param int $row Current row
|
||||
* @param int $col Current column
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function placeSweepDownward(array $marr, int $nrow, int $ncol, int &$chr, int &$row, int &$col): array
|
||||
{
|
||||
do {
|
||||
if ($row >= 0 && $col < $ncol && !($marr[($row * $ncol) + $col] ?? 0)) {
|
||||
$marr = $this->placeUtah($marr, $nrow, $ncol, $row, $col, $chr);
|
||||
++$chr;
|
||||
}
|
||||
|
||||
$row += 2;
|
||||
$col -= 2;
|
||||
} while ($row < $nrow && $col >= 0);
|
||||
|
||||
$row += 3;
|
||||
++$col;
|
||||
return $marr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a placement map.
|
||||
* (Annex F - ECC 200 symbol character placement)
|
||||
*
|
||||
* @param int $nrow Number of rows.
|
||||
* @param int $ncol Number of columns.
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
public function getPlacementMap(int $nrow, int $ncol): array
|
||||
{
|
||||
// initialize array with zeros
|
||||
$marr = \array_fill(0, \max(0, $nrow * $ncol), 0);
|
||||
// set starting values
|
||||
$chr = 1;
|
||||
$row = 4;
|
||||
$col = 0;
|
||||
do {
|
||||
// repeatedly first check for one of the special corner cases, then
|
||||
$marr = $this->placeCornerA($marr, $nrow, $ncol, $chr, $row, $col);
|
||||
$marr = $this->placeCornerB($marr, $nrow, $ncol, $chr, $row, $col);
|
||||
$marr = $this->placeCornerC($marr, $nrow, $ncol, $chr, $row, $col);
|
||||
$marr = $this->placeCornerD($marr, $nrow, $ncol, $chr, $row, $col);
|
||||
// sweep upward diagonally, inserting successive characters,
|
||||
$marr = $this->placeSweepUpward($marr, $nrow, $ncol, $chr, $row, $col);
|
||||
// & then sweep downward diagonally, inserting successive characters,...
|
||||
$marr = $this->placeSweepDownward($marr, $nrow, $ncol, $chr, $row, $col);
|
||||
|
||||
// ... until the entire array is scanned
|
||||
} while ($row < $nrow || $col < $ncol);
|
||||
|
||||
// lastly, if the lower righthand corner is untouched, fill in fixed pattern
|
||||
if (!($marr[($nrow * $ncol) - 1] ?? 0)) {
|
||||
$marr[($nrow * $ncol) - 1] = 1;
|
||||
$marr[($nrow * $ncol) - $ncol - 2] = 1;
|
||||
}
|
||||
|
||||
return $marr;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,458 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Steps.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\Datamatrix;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\Datamatrix\Steps
|
||||
*
|
||||
* Steps methods for Datamatrix Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Steps extends \Com\Tecnick\Barcode\Type\Square\Datamatrix\Modes
|
||||
{
|
||||
/**
|
||||
* The look-ahead test scans the data to be encoded to find the best mode (Annex P - steps from J to S).
|
||||
*
|
||||
* @param string $data Data to encode
|
||||
* @param int $pos Current position
|
||||
* @param int $mode Current encoding mode
|
||||
*
|
||||
* @return int encoding mode
|
||||
*/
|
||||
public function lookAheadTest(string $data, int $pos, int $mode): int
|
||||
{
|
||||
$data_length = \strlen($data);
|
||||
if ($pos >= $data_length) {
|
||||
return $mode;
|
||||
}
|
||||
|
||||
$charscount = 0; // count processed chars
|
||||
// STEP J
|
||||
$numch = match ($mode) {
|
||||
Data::ENC_C40 => [1.0, 0.0, 2.0, 2.0, 2.0, 2.25],
|
||||
Data::ENC_TXT => [1.0, 2.0, 0.0, 2.0, 2.0, 2.25],
|
||||
Data::ENC_X12 => [1.0, 2.0, 2.0, 0.0, 2.0, 2.25],
|
||||
Data::ENC_EDF => [1.0, 2.0, 2.0, 2.0, 0.0, 2.25],
|
||||
Data::ENC_BASE256 => [1.0, 2.0, 2.0, 2.0, 2.0, 0.0],
|
||||
default => [0.0, 1.0, 1.0, 1.0, 1.0, 1.25],
|
||||
};
|
||||
|
||||
while (true) {
|
||||
if (($pos + $charscount) === $data_length) {
|
||||
return $this->stepK($numch);
|
||||
}
|
||||
|
||||
$chr = \ord($data[$pos + $charscount]);
|
||||
++$charscount;
|
||||
$this->stepL($chr, $numch);
|
||||
$this->stepM($chr, $numch);
|
||||
$this->stepN($chr, $numch);
|
||||
$this->stepO($chr, $numch);
|
||||
$this->stepP($chr, $numch);
|
||||
$this->stepQ($chr, $numch);
|
||||
if ($charscount >= 4) {
|
||||
$ret = $this->stepR($numch, $pos, $data_length, $charscount, $data);
|
||||
if ($ret >= 0) {
|
||||
return $ret;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Step K
|
||||
*
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
*
|
||||
* @return int encoding mode
|
||||
*/
|
||||
protected function stepK(array $numch): int
|
||||
{
|
||||
if (
|
||||
($numch[Data::ENC_ASCII] ?? 0.0) <= \ceil(\min(
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_X12] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
))
|
||||
) {
|
||||
return Data::ENC_ASCII;
|
||||
}
|
||||
|
||||
if (
|
||||
($numch[Data::ENC_BASE256] ?? 0.0) < \ceil(\min(
|
||||
$numch[Data::ENC_ASCII] ?? 0.0,
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_X12] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
))
|
||||
) {
|
||||
return Data::ENC_BASE256;
|
||||
}
|
||||
|
||||
if (
|
||||
($numch[Data::ENC_EDF] ?? 0.0) < \ceil(\min(
|
||||
$numch[Data::ENC_ASCII] ?? 0.0,
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_X12] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
))
|
||||
) {
|
||||
return Data::ENC_EDF;
|
||||
}
|
||||
|
||||
if (
|
||||
($numch[Data::ENC_TXT] ?? 0.0) < \ceil(\min(
|
||||
$numch[Data::ENC_ASCII] ?? 0.0,
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_X12] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
))
|
||||
) {
|
||||
return Data::ENC_TXT;
|
||||
}
|
||||
|
||||
if (
|
||||
($numch[Data::ENC_X12] ?? 0.0) < \ceil(\min(
|
||||
$numch[Data::ENC_ASCII] ?? 0.0,
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
))
|
||||
) {
|
||||
return Data::ENC_X12;
|
||||
}
|
||||
|
||||
return Data::ENC_C40;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch
|
||||
*/
|
||||
protected function getNumch(array $numch, int $mode): float
|
||||
{
|
||||
return match ($mode) {
|
||||
Data::ENC_ASCII => $numch[0],
|
||||
Data::ENC_C40 => $numch[1],
|
||||
Data::ENC_TXT => $numch[2],
|
||||
Data::ENC_X12 => $numch[3],
|
||||
Data::ENC_EDF => $numch[4],
|
||||
Data::ENC_BASE256 => $numch[5],
|
||||
default => 0.0,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch
|
||||
*/
|
||||
protected function setNumch(array &$numch, int $mode, float $value): void
|
||||
{
|
||||
switch ($mode) {
|
||||
case Data::ENC_ASCII:
|
||||
$numch[0] = $value;
|
||||
return;
|
||||
|
||||
case Data::ENC_C40:
|
||||
$numch[1] = $value;
|
||||
return;
|
||||
|
||||
case Data::ENC_TXT:
|
||||
$numch[2] = $value;
|
||||
return;
|
||||
|
||||
case Data::ENC_X12:
|
||||
$numch[3] = $value;
|
||||
return;
|
||||
|
||||
case Data::ENC_EDF:
|
||||
$numch[4] = $value;
|
||||
return;
|
||||
|
||||
case Data::ENC_BASE256:
|
||||
$numch[5] = $value;
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch
|
||||
*/
|
||||
protected function addNumch(array &$numch, int $mode, float $value): void
|
||||
{
|
||||
$this->setNumch($numch, $mode, $this->getNumch($numch, $mode) + $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Step L
|
||||
*
|
||||
* @param int $chr Character code
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
*/
|
||||
protected function stepL(int $chr, array &$numch): void
|
||||
{
|
||||
if ($this->isCharMode($chr, Data::ENC_ASCII_NUM)) {
|
||||
$this->addNumch($numch, Data::ENC_ASCII, 0.5);
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->isCharMode($chr, Data::ENC_ASCII_EXT)) {
|
||||
$this->setNumch($numch, Data::ENC_ASCII, \ceil($this->getNumch($numch, Data::ENC_ASCII)));
|
||||
$this->addNumch($numch, Data::ENC_ASCII, 2.0);
|
||||
return;
|
||||
}
|
||||
|
||||
$this->setNumch($numch, Data::ENC_ASCII, \ceil($this->getNumch($numch, Data::ENC_ASCII)));
|
||||
$this->addNumch($numch, Data::ENC_ASCII, 1.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Step M
|
||||
*
|
||||
* @param int $chr Character code
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
*/
|
||||
protected function stepM(int $chr, array &$numch): void
|
||||
{
|
||||
if ($this->isCharMode($chr, Data::ENC_C40)) {
|
||||
$this->addNumch($numch, Data::ENC_C40, 2.0 / 3.0);
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->isCharMode($chr, Data::ENC_ASCII_EXT)) {
|
||||
$this->addNumch($numch, Data::ENC_C40, 8.0 / 3.0);
|
||||
return;
|
||||
}
|
||||
|
||||
$this->addNumch($numch, Data::ENC_C40, 4.0 / 3.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Step N
|
||||
*
|
||||
* @param int $chr Character code
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
*/
|
||||
protected function stepN(int $chr, array &$numch): void
|
||||
{
|
||||
if ($this->isCharMode($chr, Data::ENC_TXT)) {
|
||||
$this->addNumch($numch, Data::ENC_TXT, 2.0 / 3.0);
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->isCharMode($chr, Data::ENC_ASCII_EXT)) {
|
||||
$this->addNumch($numch, Data::ENC_TXT, 8.0 / 3.0);
|
||||
return;
|
||||
}
|
||||
|
||||
$this->addNumch($numch, Data::ENC_TXT, 4.0 / 3.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Step O
|
||||
*
|
||||
* @param int $chr Character code
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
*/
|
||||
protected function stepO(int $chr, array &$numch): void
|
||||
{
|
||||
if ($this->isCharMode($chr, Data::ENC_X12) || $this->isCharMode($chr, Data::ENC_C40)) {
|
||||
$this->addNumch($numch, Data::ENC_X12, 2.0 / 3.0);
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->isCharMode($chr, Data::ENC_ASCII_EXT)) {
|
||||
$this->addNumch($numch, Data::ENC_X12, 13.0 / 3.0);
|
||||
return;
|
||||
}
|
||||
|
||||
$this->addNumch($numch, Data::ENC_X12, 10.0 / 3.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Step P
|
||||
*
|
||||
* @param int $chr Character code
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
*/
|
||||
protected function stepP(int $chr, array &$numch): void
|
||||
{
|
||||
if ($this->isCharMode($chr, Data::ENC_EDF)) {
|
||||
$this->addNumch($numch, Data::ENC_EDF, 3.0 / 4.0);
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->isCharMode($chr, Data::ENC_ASCII_EXT)) {
|
||||
$this->addNumch($numch, Data::ENC_EDF, 17.0 / 4.0);
|
||||
return;
|
||||
}
|
||||
|
||||
$this->addNumch($numch, Data::ENC_EDF, 13.0 / 4.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Step Q
|
||||
*
|
||||
* @param int $chr Character code
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
*/
|
||||
protected function stepQ(int $chr, array &$numch): void
|
||||
{
|
||||
if ($this->isCharMode($chr, Data::ENC_BASE256)) {
|
||||
$this->addNumch($numch, Data::ENC_BASE256, 4.0);
|
||||
return;
|
||||
}
|
||||
|
||||
$this->addNumch($numch, Data::ENC_BASE256, 1.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Step R-f
|
||||
*
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
* @param int $pos Current position
|
||||
* @param int $data_length Data length
|
||||
* @param int $charscount Number of processed characters
|
||||
* @param string $data Data to encode
|
||||
*
|
||||
* @return int Encoding mode
|
||||
*/
|
||||
protected function stepRf(array $numch, int $pos, int $data_length, int $charscount, string $data): int
|
||||
{
|
||||
if (
|
||||
(($numch[Data::ENC_C40] ?? 0.0) + 1) < \min(
|
||||
$numch[Data::ENC_ASCII] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
)
|
||||
) {
|
||||
if (($numch[Data::ENC_C40] ?? 0.0) < ($numch[Data::ENC_X12] ?? 0.0)) {
|
||||
return Data::ENC_C40;
|
||||
}
|
||||
|
||||
if (($numch[Data::ENC_C40] ?? 0.0) === ($numch[Data::ENC_X12] ?? 0.0)) {
|
||||
$ker = $pos + $charscount + 1;
|
||||
while ($ker < $data_length) {
|
||||
$tmpchr = \ord($data[$ker]);
|
||||
if ($this->isCharMode($tmpchr, Data::ENC_X12)) {
|
||||
return Data::ENC_X12;
|
||||
}
|
||||
|
||||
if ($this->isCharMode($tmpchr, Data::ENC_C40)) {
|
||||
break;
|
||||
}
|
||||
|
||||
++$ker;
|
||||
}
|
||||
|
||||
return Data::ENC_C40;
|
||||
}
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Step R
|
||||
*
|
||||
* @param array{0: float, 1: float, 2: float, 3: float, 4: float, 5: float} $numch Number of characters
|
||||
* @param int $pos Current position
|
||||
* @param int $data_length Data length
|
||||
* @param int $charscount Number of processed characters
|
||||
* @param string $data Data to encode
|
||||
*
|
||||
* @return int Encoding mode
|
||||
*/
|
||||
protected function stepR(array $numch, int $pos, int $data_length, int $charscount, string $data): int
|
||||
{
|
||||
if (
|
||||
(($numch[Data::ENC_ASCII] ?? 0.0) + 1) <= \min(
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_X12] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
)
|
||||
) {
|
||||
return Data::ENC_ASCII;
|
||||
}
|
||||
|
||||
if (
|
||||
(($numch[Data::ENC_BASE256] ?? 0.0) + 1) <= ($numch[Data::ENC_ASCII] ?? 0.0)
|
||||
|| (($numch[Data::ENC_BASE256] ?? 0.0) + 1) < \min(
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_X12] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
)
|
||||
) {
|
||||
return Data::ENC_BASE256;
|
||||
}
|
||||
|
||||
if (
|
||||
(($numch[Data::ENC_EDF] ?? 0.0) + 1) < \min(
|
||||
$numch[Data::ENC_ASCII] ?? 0.0,
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_X12] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
)
|
||||
) {
|
||||
return Data::ENC_EDF;
|
||||
}
|
||||
|
||||
if (
|
||||
(($numch[Data::ENC_TXT] ?? 0.0) + 1) < \min(
|
||||
$numch[Data::ENC_ASCII] ?? 0.0,
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_X12] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
)
|
||||
) {
|
||||
return Data::ENC_TXT;
|
||||
}
|
||||
|
||||
if (
|
||||
(($numch[Data::ENC_X12] ?? 0.0) + 1) < \min(
|
||||
$numch[Data::ENC_ASCII] ?? 0.0,
|
||||
$numch[Data::ENC_C40] ?? 0.0,
|
||||
$numch[Data::ENC_TXT] ?? 0.0,
|
||||
$numch[Data::ENC_EDF] ?? 0.0,
|
||||
$numch[Data::ENC_BASE256] ?? 0.0,
|
||||
)
|
||||
) {
|
||||
return Data::ENC_X12;
|
||||
}
|
||||
|
||||
return $this->stepRf($numch, $pos, $data_length, $charscount, $data);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,380 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* PdfFourOneSeven.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
use Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven\Data;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven
|
||||
*
|
||||
* PdfFourOneSeven Barcode type class
|
||||
* PDF417 (ISO/IEC 15438:2006)
|
||||
*
|
||||
* PDF417 (ISO/IEC 15438:2006) is a 2-dimensional stacked bar code created by Symbol Technologies in 1991.
|
||||
* It is one of the most popular 2D codes because of its ability to be read with slightly modified handheld
|
||||
* laser or linear CCD scanners.
|
||||
* TECHNICAL DATA / FEATURES OF PDF417:
|
||||
* Encodable Character Set: All 128 ASCII Characters (including extended)
|
||||
* Code Type: Continuous, Multi-Row
|
||||
* Symbol Height: 3 - 90 Rows
|
||||
* Symbol Width: 90X - 583X
|
||||
* Bidirectional Decoding: Yes
|
||||
* Error Correction Characters: 2 - 512
|
||||
* Maximum Data Characters: 1850 text, 2710 digits, 1108 bytes
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class PdfFourOneSeven extends \Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven\Compaction
|
||||
{
|
||||
/**
|
||||
* @param array<int, int> $codewords
|
||||
*/
|
||||
protected function getCodewordValue(array $codewords, int $index): int
|
||||
{
|
||||
return $codewords[$index] ?? 0;
|
||||
}
|
||||
|
||||
protected function getClusterCodewordValue(int $clusterId, int $codeword): int
|
||||
{
|
||||
return Data::CLUSTERS[$clusterId][$codeword] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'PDF417';
|
||||
|
||||
/**
|
||||
* Row height respect X dimension of single module
|
||||
*/
|
||||
protected int $row_height = 2;
|
||||
|
||||
/**
|
||||
* Vertical quiet zone in modules
|
||||
*/
|
||||
protected int $quiet_vertical = 2;
|
||||
|
||||
/**
|
||||
* Horizontal quiet zone in modules
|
||||
*/
|
||||
protected int $quiet_horizontal = 2;
|
||||
|
||||
/**
|
||||
* Aspect ratio (width / height)
|
||||
*/
|
||||
protected float $aspectratio = 2;
|
||||
|
||||
/**
|
||||
* Error correction level (0-8);
|
||||
* Default -1 = automatic correction level
|
||||
*/
|
||||
protected int $ecl = -1;
|
||||
|
||||
/**
|
||||
* Information for macro block
|
||||
*
|
||||
* @var array<string, int|string>
|
||||
*/
|
||||
protected array $macro = [];
|
||||
|
||||
/**
|
||||
* Set extra (optional) parameters
|
||||
*/
|
||||
protected function setParameters(): void
|
||||
{
|
||||
parent::setParameters();
|
||||
|
||||
// aspect ratio
|
||||
if (
|
||||
($this->params[0] ?? null) !== null
|
||||
&& $this->params[0] !== ''
|
||||
&& ($aspectratio = (float) $this->params[0]) >= 1
|
||||
) {
|
||||
$this->aspectratio = $aspectratio;
|
||||
}
|
||||
|
||||
// error correction level (auto)
|
||||
if (($this->params[1] ?? null) !== null && ($ecl = (int) $this->params[1]) >= 0 && $ecl <= 8) {
|
||||
$this->ecl = $ecl;
|
||||
}
|
||||
|
||||
// macro block
|
||||
$this->setMacroBlockParam();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set macro block parameter
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
*/
|
||||
protected function setMacroBlockParam(): void
|
||||
{
|
||||
if (
|
||||
($this->params[4] ?? null) !== null
|
||||
&& \is_string($this->params[4])
|
||||
&& ($this->params[2] ?? '') !== ''
|
||||
&& ($this->params[3] ?? '') !== ''
|
||||
&& $this->params[4] !== ''
|
||||
) {
|
||||
$this->macro['segment_total'] = (int) $this->params[2];
|
||||
$this->macro['segment_index'] = (int) $this->params[3];
|
||||
$this->macro['file_id'] = \strtr($this->params[4], "\xff", ',');
|
||||
for ($idx = 0; $idx < 7; ++$idx) {
|
||||
$opt = $idx + 5;
|
||||
if (
|
||||
($this->params[$opt] ?? null) !== null
|
||||
&& \is_string($this->params[$opt])
|
||||
&& $this->params[$opt] !== ''
|
||||
) {
|
||||
/* @phpstan-ignore-next-line */
|
||||
$this->macro['option_' . $idx] = \strtr($this->params[$opt], "\xff", ',');
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the bars array
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
if (\strlen($this->code) === 0) {
|
||||
throw new BarcodeException('Empty input');
|
||||
}
|
||||
|
||||
$seq = $this->getBinSequence();
|
||||
$this->processBinarySequence($this->getRawCodeRows($seq));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get macro control block codewords
|
||||
*
|
||||
* @param int $numcw Number of codewords
|
||||
*
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function getMacroBlock(int &$numcw): array
|
||||
{
|
||||
if ($this->macro === []) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$macrocw = [];
|
||||
$segmentIndex = (int) ($this->macro['segment_index'] ?? 0);
|
||||
$segmentTotal = (int) ($this->macro['segment_total'] ?? 0);
|
||||
$fileId = (string) ($this->macro['file_id'] ?? '');
|
||||
// beginning of macro control block
|
||||
$macrocw[] = 928;
|
||||
// segment index
|
||||
$cdw = $this->getCompaction(902, \sprintf('%05d', $segmentIndex), false);
|
||||
$macrocw = \array_merge($macrocw, $cdw);
|
||||
// file ID
|
||||
$cdw = $this->getCompaction(900, $fileId, false);
|
||||
$macrocw = \array_merge($macrocw, $cdw);
|
||||
// optional fields
|
||||
$optmodes = [900, 902, 902, 900, 900, 902, 902];
|
||||
$optsize = [-1, 2, 4, -1, -1, -1, 2];
|
||||
foreach ($optmodes as $key => $omode) {
|
||||
$optionKey = 'option_' . $key;
|
||||
if (($this->macro[$optionKey] ?? null) !== null) {
|
||||
$option = (string) $this->macro[$optionKey];
|
||||
$macrocw[] = 923;
|
||||
$macrocw[] = $key;
|
||||
$option = match ($optsize[$key] ?? -1) {
|
||||
2 => \sprintf('%05d', $option),
|
||||
4 => \sprintf('%010d', $option),
|
||||
default => $option,
|
||||
};
|
||||
|
||||
$cdw = $this->getCompaction($omode, $option, false);
|
||||
$macrocw = \array_merge($macrocw, $cdw);
|
||||
}
|
||||
}
|
||||
|
||||
if ($segmentIndex === ($segmentTotal - 1)) {
|
||||
// end of control block
|
||||
$macrocw[] = 922;
|
||||
}
|
||||
|
||||
// update total codewords
|
||||
$numcw += \count($macrocw);
|
||||
return $macrocw;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get codewords
|
||||
*
|
||||
* @param int $rows number of rows
|
||||
* @param int $cols number of columns
|
||||
* @param int $ecl error correction level
|
||||
*
|
||||
* @return array<int, int>
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
public function getCodewords(int &$rows, int &$cols, int &$ecl): array
|
||||
{
|
||||
$codewords = []; // array of code-words
|
||||
// get the input sequence array
|
||||
$sequence = $this->getInputSequences($this->code);
|
||||
foreach ($sequence as $seq) {
|
||||
$cws = $this->getCompaction($seq[0], $seq[1], true);
|
||||
$codewords = \array_merge($codewords, $cws);
|
||||
}
|
||||
|
||||
if (($codewords[0] ?? 0) === 900) {
|
||||
// Text Alpha is the default mode, so remove the first code
|
||||
\array_shift($codewords);
|
||||
}
|
||||
|
||||
// count number of codewords
|
||||
$numcw = \count($codewords);
|
||||
if ($numcw > 925) {
|
||||
throw new BarcodeException('The maximum codeword capacity has been reached: ' . $numcw . ' > 925');
|
||||
}
|
||||
|
||||
$macrocw = $this->getMacroBlock($numcw);
|
||||
// set error correction level
|
||||
$ecl = $this->getErrorCorrectionLevel($this->ecl, $numcw);
|
||||
// number of codewords for error correction
|
||||
$errsize = 2 << $ecl;
|
||||
// calculate number of columns (number of codewords per row) and rows
|
||||
$nce = $numcw + $errsize + 1;
|
||||
$cols = (int) \min(30, \max(
|
||||
1,
|
||||
\round((\sqrt(4761 + (68 * $this->aspectratio * $this->row_height * $nce)) - 69) / 34),
|
||||
));
|
||||
$rows = (int) \min(90, \max(3, \ceil($nce / $cols)));
|
||||
$size = $cols * $rows;
|
||||
if ($size > 928) {
|
||||
// set dimensions to get maximum capacity
|
||||
$cols = 16;
|
||||
$rows = 58;
|
||||
if (\abs($this->aspectratio - ((17 * 29) / 32)) < \abs($this->aspectratio - ((17 * 16) / 58))) {
|
||||
$cols = 29;
|
||||
$rows = 32;
|
||||
}
|
||||
|
||||
$size = 928;
|
||||
}
|
||||
|
||||
// calculate padding
|
||||
$pad = (int) ($size - $nce);
|
||||
if ($pad > 0) {
|
||||
// add padding
|
||||
$codewords = \array_merge($codewords, \array_fill(0, $pad, 900));
|
||||
}
|
||||
|
||||
if ($macrocw !== []) {
|
||||
// add macro section
|
||||
$codewords = \array_merge($codewords, $macrocw);
|
||||
}
|
||||
|
||||
// Symbol Length Descriptor (number of data codewords including Symbol Length Descriptor and pad codewords)
|
||||
$sld = (int) ($size - $errsize);
|
||||
// add symbol length description
|
||||
\array_unshift($codewords, $sld);
|
||||
// calculate error correction
|
||||
$ecw = $this->getErrorCorrection($codewords, $ecl);
|
||||
// add error correction codewords
|
||||
return \array_merge($codewords, $ecw);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a PDF417 object as binary string
|
||||
*
|
||||
* @return string barcode as binary string
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
*/
|
||||
public function getBinSequence(): string
|
||||
{
|
||||
$rows = 0;
|
||||
$cols = 0;
|
||||
$ecl = 0;
|
||||
$codewords = $this->getCodewords($rows, $cols, $ecl);
|
||||
$barcode = '';
|
||||
// add horizontal quiet zones to start and stop patterns
|
||||
$pstart = \str_repeat('0', \max(0, $this->quiet_horizontal)) . Data::START_PATTERN;
|
||||
$this->nrows = ($rows * $this->row_height) + (2 * $this->quiet_vertical);
|
||||
$this->ncols = (($cols + 2) * 17) + 35 + (2 * $this->quiet_horizontal);
|
||||
// build rows for vertical quiet zone
|
||||
$empty_row = ',' . \str_repeat('0', \max(0, $this->ncols));
|
||||
$empty_rows = \str_repeat($empty_row, \max(0, $this->quiet_vertical));
|
||||
$barcode .= $empty_rows;
|
||||
$kcw = 0; // codeword index
|
||||
$cid = 0; // initial cluster
|
||||
// for each row
|
||||
for ($rix = 0; $rix < $rows; ++$rix) {
|
||||
// row start code
|
||||
$row = $pstart;
|
||||
$rval = 0;
|
||||
$cval = 0;
|
||||
switch ($cid) {
|
||||
case 0:
|
||||
$rval = (30 * (int) ($rix / 3)) + (int) (($rows - 1) / 3);
|
||||
$cval = (30 * (int) ($rix / 3)) + ($cols - 1);
|
||||
break;
|
||||
case 1:
|
||||
$rval = (30 * (int) ($rix / 3)) + ($ecl * 3) + (($rows - 1) % 3);
|
||||
$cval = (30 * (int) ($rix / 3)) + (int) (($rows - 1) / 3);
|
||||
break;
|
||||
case 2:
|
||||
$rval = (30 * (int) ($rix / 3)) + ($cols - 1);
|
||||
$cval = (30 * (int) ($rix / 3)) + ($ecl * 3) + (($rows - 1) % 3);
|
||||
break;
|
||||
}
|
||||
|
||||
// left row indicator
|
||||
$row .= \sprintf('%17b', $this->getClusterCodewordValue($cid, $rval));
|
||||
// for each column
|
||||
for ($cix = 0; $cix < $cols; ++$cix) {
|
||||
$row .= \sprintf('%17b', $this->getClusterCodewordValue($cid, $this->getCodewordValue(
|
||||
$codewords,
|
||||
$kcw,
|
||||
)));
|
||||
++$kcw;
|
||||
}
|
||||
|
||||
// right row indicator
|
||||
$row .= \sprintf('%17b', $this->getClusterCodewordValue($cid, $cval));
|
||||
// row stop code
|
||||
$row .= Data::STOP_PATTERN . \str_repeat('0', \max(0, $this->quiet_horizontal));
|
||||
$brow = ',' . \str_repeat($row, \max(0, $this->row_height));
|
||||
$barcode .= $brow;
|
||||
++$cid;
|
||||
if ($cid > 2) {
|
||||
$cid = 0;
|
||||
}
|
||||
}
|
||||
|
||||
return $barcode . $empty_rows;
|
||||
}
|
||||
}
|
||||
+314
@@ -0,0 +1,314 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Compaction.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven\Compaction
|
||||
*
|
||||
* Compaction methods for PdfFourOneSeven Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Compaction extends \Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven\Sequence
|
||||
{
|
||||
/**
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function getTextSubModeValues(int $submode): array
|
||||
{
|
||||
$result = [];
|
||||
foreach (Data::TEXT_SUB_MODES[$submode] ?? [] as $value) {
|
||||
$result[] = $value;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function getTextLatchValues(int $submode, int $sub): array
|
||||
{
|
||||
$result = [];
|
||||
foreach (Data::TEXT_LATCH['' . $submode . $sub] ?? [] as $value) {
|
||||
$result[] = $value;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
protected function findTextSubModeKey(int $submode, int $chval): ?int
|
||||
{
|
||||
$key = \array_search($chval, $this->getTextSubModeValues($submode), true);
|
||||
if (\is_int($key)) {
|
||||
return $key;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
protected function getCodeOrd(string $code, int $idx): int
|
||||
{
|
||||
return \ord($code[$idx] ?? "\x00");
|
||||
}
|
||||
|
||||
/**
|
||||
* @return numeric-string
|
||||
*/
|
||||
protected function getByteNumericString(string $code, int $idx): string
|
||||
{
|
||||
return (string) $this->getCodeOrd($code, $idx);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, int> $txtarr
|
||||
*/
|
||||
protected function getTxtArrayValue(array $txtarr, int $idx): int
|
||||
{
|
||||
return $txtarr[$idx] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $value
|
||||
*
|
||||
* @return numeric-string
|
||||
*/
|
||||
protected function normalizeNumericString(string $value): string
|
||||
{
|
||||
if (\ctype_digit($value)) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
return '0';
|
||||
}
|
||||
|
||||
/**
|
||||
* Process Sub Text Compaction
|
||||
*
|
||||
* @param array<int, int> $txtarr Array of characters and sub-mode switching characters
|
||||
* @param int $submode Current submode
|
||||
* @param int $sub New submode
|
||||
* @param string $code Data to compact
|
||||
* @param int $key Character code
|
||||
* @param int $idx Current index
|
||||
* @param int $codelen Code length
|
||||
*/
|
||||
protected function processTextCompactionSub(
|
||||
array &$txtarr,
|
||||
int &$submode,
|
||||
int $sub,
|
||||
string $code,
|
||||
int $key,
|
||||
int $idx,
|
||||
int $codelen,
|
||||
): void {
|
||||
// $sub is the new submode
|
||||
$useShift =
|
||||
(
|
||||
($idx + 1) === $codelen
|
||||
|| ($idx + 1) < $codelen
|
||||
&& \in_array($this->getCodeOrd($code, $idx + 1), $this->getTextSubModeValues($submode), true)
|
||||
)
|
||||
&& ($sub === 3 || $sub === 0 && $submode === 1);
|
||||
|
||||
if ($useShift) {
|
||||
// shift (temporary change only for this char)
|
||||
$txtarr[] = $sub === 3 ? 29 : 27;
|
||||
// add character code to array
|
||||
$txtarr[] = $key;
|
||||
return;
|
||||
}
|
||||
|
||||
// latch
|
||||
foreach ($this->getTextLatchValues($submode, $sub) as $latch) {
|
||||
$txtarr[] = $latch;
|
||||
}
|
||||
|
||||
// set new submode
|
||||
$submode = $sub;
|
||||
|
||||
// add character code to array
|
||||
$txtarr[] = $key;
|
||||
}
|
||||
|
||||
/**
|
||||
* Process Text Compaction
|
||||
*
|
||||
* @param string $code Data to compact
|
||||
* @param array<int, int> $codewords Codewords
|
||||
*/
|
||||
protected function processTextCompaction(string $code, array &$codewords): void
|
||||
{
|
||||
$submode = 0; // default Alpha sub-mode
|
||||
/** @var array<int, int> $txtarr */
|
||||
$txtarr = []; // array of characters and sub-mode switching characters
|
||||
$codelen = \strlen($code);
|
||||
for ($idx = 0; $idx < $codelen; ++$idx) {
|
||||
$chval = $this->getCodeOrd($code, $idx);
|
||||
$current_key = $this->findTextSubModeKey($submode, $chval);
|
||||
if ($current_key !== null) {
|
||||
// we are on the same sub-mode
|
||||
$txtarr[] = $current_key;
|
||||
continue;
|
||||
}
|
||||
|
||||
// the sub-mode is changed
|
||||
for ($sub = 0; $sub < 4; ++$sub) {
|
||||
// search new sub-mode
|
||||
$sub_key = $this->findTextSubModeKey($sub, $chval);
|
||||
if ($sub !== $submode && $sub_key !== null) {
|
||||
$this->processTextCompactionSub($txtarr, $submode, $sub, $code, $sub_key, $idx, $codelen);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$txtarrlen = \count($txtarr);
|
||||
if (($txtarrlen % 2) !== 0) {
|
||||
// add padding
|
||||
$txtarr[] = 29;
|
||||
++$txtarrlen;
|
||||
}
|
||||
|
||||
// calculate codewords
|
||||
for ($idx = 0; $idx < $txtarrlen; $idx += 2) {
|
||||
$codewords[] = (30 * $this->getTxtArrayValue($txtarr, $idx)) + $this->getTxtArrayValue($txtarr, $idx + 1);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Process Byte Compaction
|
||||
*
|
||||
* @param string $code Data to compact
|
||||
* @param array<int, int> $codewords Codewords
|
||||
*/
|
||||
protected function processByteCompaction(string $code, array &$codewords): void
|
||||
{
|
||||
while (($codelen = \strlen($code)) > 0) {
|
||||
$rest = '';
|
||||
$sublen = \strlen($code);
|
||||
if ($codelen > 6) {
|
||||
$rest = \substr($code, 6);
|
||||
$code = \substr($code, 0, 6);
|
||||
$sublen = 6;
|
||||
}
|
||||
|
||||
if ($sublen === 6) {
|
||||
$tdg = $this->mulNumeric($this->getByteNumericString($code, 0), '1099511627776');
|
||||
$tdg = $this->addNumeric($tdg, $this->mulNumeric($this->getByteNumericString($code, 1), '4294967296'));
|
||||
$tdg = $this->addNumeric($tdg, $this->mulNumeric($this->getByteNumericString($code, 2), '16777216'));
|
||||
$tdg = $this->addNumeric($tdg, $this->mulNumeric($this->getByteNumericString($code, 3), '65536'));
|
||||
$tdg = $this->addNumeric($tdg, $this->mulNumeric($this->getByteNumericString($code, 4), '256'));
|
||||
$tdg = $this->addNumeric($tdg, $this->getByteNumericString($code, 5));
|
||||
// tmp array for the 6 bytes block
|
||||
/** @var array<int, int> $cw6 */
|
||||
$cw6 = [];
|
||||
for ($idx = 0; $idx < 5; ++$idx) {
|
||||
$ddg = $this->modNumeric($tdg, '900');
|
||||
$tdg = $this->divNumeric($tdg, '900');
|
||||
// prepend the value to the beginning of the array
|
||||
\array_unshift($cw6, $ddg);
|
||||
}
|
||||
|
||||
// append the result array at the end
|
||||
foreach ($cw6 as $cw) {
|
||||
$codewords[] = $cw;
|
||||
}
|
||||
}
|
||||
|
||||
if ($sublen !== 6) {
|
||||
for ($idx = 0; $idx < $sublen; ++$idx) {
|
||||
$codewords[] = $this->getCodeOrd($code, $idx);
|
||||
}
|
||||
}
|
||||
|
||||
$code = $rest;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Process Numeric Compaction
|
||||
*
|
||||
* @param string $code Data to compact
|
||||
* @param array<int, int> $codewords Codewords
|
||||
*/
|
||||
protected function processNumericCompaction(string $code, array &$codewords): void
|
||||
{
|
||||
$len = \strlen($code);
|
||||
// numbers are encoded in groups of up to 44 digits, emitted in left-to-right order
|
||||
for ($start = 0; $start < $len; $start += 44) {
|
||||
$tdg = $this->normalizeNumericString('1' . \substr($code, $start, 44));
|
||||
$group = [];
|
||||
do {
|
||||
// remainders come out least-significant first
|
||||
$group[] = $this->modNumeric($tdg, '900');
|
||||
$tdg = $this->divNumeric($tdg, '900');
|
||||
} while ($tdg !== '0');
|
||||
|
||||
// reverse to big-endian, then append this group after the previous ones
|
||||
$codewords = \array_merge($codewords, \array_reverse($group));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Compact data by mode
|
||||
*
|
||||
* @param int $mode Compaction mode number
|
||||
* @param string $code Data to compact
|
||||
* @param bool $addmode If true add the mode codeword in the first position
|
||||
*
|
||||
* @return array<int, int> of codewords
|
||||
*/
|
||||
protected function getCompaction(int $mode, string $code, bool $addmode = true): array
|
||||
{
|
||||
$codewords = []; // array of codewords to return
|
||||
switch ($mode) {
|
||||
case 900:
|
||||
// Text Compaction mode latch
|
||||
$this->processTextCompaction($code, $codewords);
|
||||
break;
|
||||
case 901:
|
||||
case 924:
|
||||
// Byte Compaction mode latch
|
||||
$this->processByteCompaction($code, $codewords);
|
||||
break;
|
||||
case 902:
|
||||
// Numeric Compaction mode latch
|
||||
$this->processNumericCompaction($code, $codewords);
|
||||
break;
|
||||
case 913:
|
||||
// Byte Compaction mode shift
|
||||
$codewords[] = \ord($code);
|
||||
break;
|
||||
}
|
||||
|
||||
if ($addmode) {
|
||||
// add the compaction mode codeword at the beginning
|
||||
\array_unshift($codewords, $mode);
|
||||
}
|
||||
|
||||
return $codewords;
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
+215
@@ -0,0 +1,215 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Sequence.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven\Sequence
|
||||
*
|
||||
* Sequence methods for PdfFourOneSeven Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Sequence extends \Com\Tecnick\Barcode\Type\Square
|
||||
{
|
||||
/**
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function getRsFactors(int $ecl): array
|
||||
{
|
||||
$values = Data::RS_FACTORS[$ecl] ?? [];
|
||||
return \array_values($values);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, int> $data
|
||||
*/
|
||||
protected function getArrayInt(array $data, int $index): int
|
||||
{
|
||||
return $data[$index] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, array{int, string}> $sequence_array
|
||||
*/
|
||||
protected function getLastSequenceMode(array $sequence_array): int
|
||||
{
|
||||
if ($sequence_array === []) {
|
||||
return -1;
|
||||
}
|
||||
|
||||
return $sequence_array[\count($sequence_array) - 1][0] ?? -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the error correction level (0-8) to be used
|
||||
*
|
||||
* @param int $ecl Error correction level
|
||||
* @param int $numcw Number of data codewords
|
||||
*
|
||||
* @return int error correction level
|
||||
*/
|
||||
protected function getErrorCorrectionLevel(int $ecl, int $numcw): int
|
||||
{
|
||||
$maxecl = 8; // maximum error level
|
||||
$maxerrsize = 928 - $numcw; // available codewords for error
|
||||
while ($maxecl > 0 && $maxerrsize < (2 << $maxecl)) {
|
||||
--$maxecl;
|
||||
}
|
||||
|
||||
if ($ecl < 0 || $ecl > 8) {
|
||||
$ecl = $maxecl;
|
||||
$ecl = match (true) {
|
||||
$numcw < 41 => 2,
|
||||
$numcw < 161 => 3,
|
||||
$numcw < 321 => 4,
|
||||
$numcw < 864 => 5,
|
||||
default => $ecl,
|
||||
};
|
||||
}
|
||||
|
||||
return (int) \min($maxecl, $ecl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the error correction codewords
|
||||
*
|
||||
* @param array<int, int> $codewords Array of codewords including Symbol Length Descriptor and pad
|
||||
* @param int $ecl Error correction level 0-8
|
||||
*
|
||||
* @return array<int, int> of error correction codewords
|
||||
*/
|
||||
protected function getErrorCorrection(array $codewords, int $ecl): array
|
||||
{
|
||||
// get error correction coefficients
|
||||
$ecc = $this->getRsFactors($ecl);
|
||||
// number of error correction factors
|
||||
$eclsize = \max(0, 2 << $ecl);
|
||||
// maximum index for RS_FACTORS[$ecl]
|
||||
$eclmaxid = $eclsize - 1;
|
||||
// initialize array of error correction codewords
|
||||
$ecw = \array_fill(0, $eclsize, 0);
|
||||
// for each data codeword
|
||||
foreach ($codewords as $codeword) {
|
||||
$tk1 = ($codeword + $this->getArrayInt($ecw, $eclmaxid)) % 929;
|
||||
for ($idx = $eclmaxid; $idx > 0; --$idx) {
|
||||
$tk2 = ($tk1 * $this->getArrayInt($ecc, $idx)) % 929;
|
||||
$tk3 = 929 - $tk2;
|
||||
$ecw[$idx] = (int) (($this->getArrayInt($ecw, $idx - 1) + $tk3) % 929);
|
||||
}
|
||||
|
||||
$tk2 = ($tk1 * $this->getArrayInt($ecc, 0)) % 929;
|
||||
$tk3 = 929 - $tk2;
|
||||
$ecw[0] = (int) ($tk3 % 929);
|
||||
}
|
||||
|
||||
foreach ($ecw as $idx => $err) {
|
||||
if ($err === 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$ecw[$idx] = (int) (929 - $err);
|
||||
}
|
||||
|
||||
return \array_reverse($ecw);
|
||||
}
|
||||
|
||||
/**
|
||||
* Process a single sequence
|
||||
*
|
||||
* @param array<int, array{int, string}> $sequence_array Sequence to process
|
||||
* @param string $code Data to process
|
||||
* @param int $seq Current sequence
|
||||
* @param int $offset Current code offset
|
||||
*/
|
||||
protected function processSequence(array &$sequence_array, string $code, int $seq, int $offset): void
|
||||
{
|
||||
// extract text sequence before the number sequence
|
||||
$prevseq = \substr($code, $offset, $seq - $offset);
|
||||
$textseq = [];
|
||||
// get text sequences
|
||||
\preg_match_all('/([\x09\x0a\x0d\x20-\x7e]{5,})/', $prevseq, $textseq, PREG_OFFSET_CAPTURE);
|
||||
$textseq[1][] = ['', \strlen($prevseq)];
|
||||
$txtoffset = 0;
|
||||
foreach ($textseq[1] as $txtseq) {
|
||||
$txtSeqOffset = (int) $txtseq[1];
|
||||
$txtseqlen = \strlen($txtseq[0]);
|
||||
if ($txtSeqOffset > 0) {
|
||||
// extract byte sequence before the text sequence
|
||||
$prevtxtseq = \substr($prevseq, $txtoffset, $txtSeqOffset - $txtoffset);
|
||||
if (\strlen($prevtxtseq) > 0) {
|
||||
// add BYTE sequence
|
||||
$mode = 901;
|
||||
$mode = match (true) {
|
||||
\strlen($prevtxtseq) === 1 && $this->getLastSequenceMode($sequence_array) === 900 => 913,
|
||||
(\strlen($prevtxtseq) % 6) === 0 => 924,
|
||||
default => $mode,
|
||||
};
|
||||
|
||||
$sequence_array[] = [$mode, $prevtxtseq];
|
||||
}
|
||||
}
|
||||
|
||||
if ($txtseqlen > 0) {
|
||||
// add numeric sequence
|
||||
$sequence_array[] = [900, $txtseq[0]];
|
||||
}
|
||||
|
||||
$txtoffset = $txtSeqOffset + $txtseqlen;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array of sequences from input
|
||||
*
|
||||
* @param string $code Data to process
|
||||
*
|
||||
* @return array<int, array{int, string}>
|
||||
*/
|
||||
protected function getInputSequences(string $code): array
|
||||
{
|
||||
$sequence_array = []; // array to be returned
|
||||
$numseq = [];
|
||||
// get numeric sequences
|
||||
\preg_match_all('/(\d{13,})/', $code, $numseq, PREG_OFFSET_CAPTURE);
|
||||
$numseq[1][] = ['', \strlen($code)];
|
||||
$offset = 0;
|
||||
foreach ($numseq[1] as $seq) {
|
||||
$seqlen = \strlen($seq[0]);
|
||||
$seqOffset = (int) $seq[1];
|
||||
if ($seqOffset > 0) {
|
||||
$this->processSequence($sequence_array, $code, $seqOffset, $offset);
|
||||
}
|
||||
|
||||
if ($seqlen > 0) {
|
||||
// add numeric sequence
|
||||
$sequence_array[] = [902, $seq[0]];
|
||||
}
|
||||
|
||||
$offset = $seqOffset + $seqlen;
|
||||
}
|
||||
|
||||
return $sequence_array;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,272 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* QrCode.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
use Com\Tecnick\Barcode\Type\Square\QrCode\ByteStream;
|
||||
use Com\Tecnick\Barcode\Type\Square\QrCode\Data;
|
||||
use Com\Tecnick\Barcode\Type\Square\QrCode\Encoder;
|
||||
use Com\Tecnick\Barcode\Type\Square\QrCode\QrEccLevel;
|
||||
use Com\Tecnick\Barcode\Type\Square\QrCode\QrEncodingMode;
|
||||
use Com\Tecnick\Barcode\Type\Square\QrCode\Split;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\QrCode
|
||||
*
|
||||
* QrCode Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class QrCode extends \Com\Tecnick\Barcode\Type\Square
|
||||
{
|
||||
/**
|
||||
* Barcode format
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const FORMAT = 'QRCODE';
|
||||
|
||||
/**
|
||||
* QR code version.
|
||||
* The Size of QRcode is defined as version. Version is an integer value from 1 to 40.
|
||||
* Version 1 is 21*21 matrix. And 4 modules increases whenever 1 version increases.
|
||||
* So version 40 is 177*177 matrix.
|
||||
*/
|
||||
protected int $version = 0;
|
||||
|
||||
/**
|
||||
* Error correction level
|
||||
*/
|
||||
protected int $level = 0;
|
||||
|
||||
/**
|
||||
* Encoding mode
|
||||
*/
|
||||
protected int $hint = 2;
|
||||
|
||||
/**
|
||||
* Boolean flag, if false the input string will be converted to uppercase.
|
||||
*/
|
||||
protected bool $case_sensitive = true;
|
||||
|
||||
/**
|
||||
* If negative, checks all masks available,
|
||||
* otherwise the value indicates the number of masks to be checked,
|
||||
* mask ids are random.
|
||||
*/
|
||||
protected int $random_mask = -1;
|
||||
|
||||
/**
|
||||
* If true, estimates the best mask (spec default, but slower);
|
||||
* set to false for a significant performance boost but (probably) lower quality code.
|
||||
*/
|
||||
protected bool $best_mask = true;
|
||||
|
||||
/**
|
||||
* Default mask used when $this->best_mask === false
|
||||
*/
|
||||
protected int $default_mask = 2;
|
||||
|
||||
/**
|
||||
* ByteStream class object
|
||||
*/
|
||||
protected ByteStream $bsObj;
|
||||
|
||||
protected function getEccLevel(string $level): int
|
||||
{
|
||||
return match ($level) {
|
||||
'L' => 0,
|
||||
'M' => 1,
|
||||
'Q' => 2,
|
||||
'H' => 3,
|
||||
default => 0,
|
||||
};
|
||||
}
|
||||
|
||||
protected function getHintMode(string $mode): int
|
||||
{
|
||||
return match ($mode) {
|
||||
'NL' => -1,
|
||||
'NM' => 0,
|
||||
'AN' => 1,
|
||||
'8B' => 2,
|
||||
'KJ' => 3,
|
||||
'ST' => 4,
|
||||
default => 2,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Set extra (optional) parameters:
|
||||
* 1: LEVEL - error correction level: L, M, Q, H
|
||||
* 2: HINT - encoding mode: NL=variable, NM=numeric, AN=alphanumeric, 8B=8bit, KJ=KANJI, ST=STRUCTURED
|
||||
* 3: VERSION - integer value from 1 to 40
|
||||
* 4: CASE SENSITIVE - if 0 the input string will be converted to uppercase
|
||||
* 5: RANDOM MASK - false or number of masks to be checked
|
||||
* 6: BEST MASK - true to find the best mask (slow)
|
||||
* 7: DEFAULT MASK - mask to use when the best mask option is false
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
* @SuppressWarnings("PHPMD.NPathComplexity")
|
||||
*/
|
||||
protected function setParameters(): void
|
||||
{
|
||||
parent::setParameters();
|
||||
|
||||
// level
|
||||
$eccLevel = QrEccLevel::fromLoose(\strval($this->params[0] ?? ''));
|
||||
$this->params[0] = $eccLevel->value;
|
||||
$this->level = $this->getEccLevel($eccLevel->value);
|
||||
|
||||
// hint
|
||||
$encMode = QrEncodingMode::fromLoose(\strval($this->params[1] ?? ''));
|
||||
$this->params[1] = $encMode->value;
|
||||
$this->hint = $this->getHintMode($encMode->value);
|
||||
|
||||
// version
|
||||
if (
|
||||
($this->params[2] ?? null) === null
|
||||
|| $this->params[2] < 0
|
||||
|| $this->params[2] > Data::QRSPEC_VERSION_MAX
|
||||
) {
|
||||
$this->params[2] = 0;
|
||||
}
|
||||
|
||||
$this->version = (int) $this->params[2];
|
||||
|
||||
// case sensitive
|
||||
if (($this->params[3] ?? null) === null) {
|
||||
$this->params[3] = 1;
|
||||
}
|
||||
|
||||
$this->case_sensitive = (bool) $this->params[3];
|
||||
|
||||
// random mask mode - number of masks to be checked
|
||||
if (($this->params[4] ?? null) !== null && $this->params[4] !== '' && (int) $this->params[4] !== 0) {
|
||||
$this->random_mask = (int) $this->params[4];
|
||||
}
|
||||
|
||||
// find best mask
|
||||
if (($this->params[5] ?? null) === null) {
|
||||
$this->params[5] = 1;
|
||||
}
|
||||
|
||||
$this->best_mask = (bool) $this->params[5];
|
||||
|
||||
// default mask
|
||||
if (($this->params[6] ?? null) === null) {
|
||||
$this->params[6] = 2;
|
||||
}
|
||||
|
||||
$this->default_mask = (int) $this->params[6];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the bars array
|
||||
*
|
||||
* @throws BarcodeException in case of error
|
||||
* @throws \Random\RandomException in case of random generation error
|
||||
*/
|
||||
protected function setBars(): void
|
||||
{
|
||||
if (\strlen($this->code) === 0) {
|
||||
throw new BarcodeException('Empty input');
|
||||
}
|
||||
|
||||
$this->bsObj = new ByteStream($this->hint, $this->version, $this->level);
|
||||
// generate the qrcode
|
||||
$this->processBinarySequence($this->binarize($this->encodeString($this->code)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert the frame in binary form
|
||||
*
|
||||
* @param array<int, string> $frame Array to binarize
|
||||
*
|
||||
* @return array<int, string> frame in binary form
|
||||
*/
|
||||
protected function binarize(array $frame): array
|
||||
{
|
||||
$len = \count($frame);
|
||||
// the frame is square (width = height)
|
||||
foreach ($frame as &$frameLine) {
|
||||
for ($idx = 0; $idx < $len; ++$idx) {
|
||||
$frameLine[$idx] = (\ord($frameLine[$idx]) & 1) !== 0 ? '1' : '0';
|
||||
}
|
||||
}
|
||||
|
||||
return $frame;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode the input string
|
||||
*
|
||||
* @param string $data input string to encode
|
||||
*
|
||||
* @return array<int, string> Encoded data
|
||||
*
|
||||
* @throws BarcodeException in case of split/encoding errors
|
||||
* @throws \Random\RandomException in case of random generation error
|
||||
*/
|
||||
protected function encodeString(string $data): array
|
||||
{
|
||||
if (!$this->case_sensitive) {
|
||||
$data = $this->toUpper($data);
|
||||
}
|
||||
|
||||
$split = new Split($this->bsObj, $this->hint, $this->version);
|
||||
$datacode = $this->bsObj->getByteStream($split->getSplittedString($data));
|
||||
$this->version = $this->bsObj->version;
|
||||
$encoder = new Encoder($this->version, $this->level, $this->random_mask, $this->best_mask, $this->default_mask);
|
||||
return $encoder->encodeMask(-1, $datacode);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert input string into upper case mode
|
||||
*
|
||||
* @param string $data Data
|
||||
*/
|
||||
protected function toUpper(string $data): string
|
||||
{
|
||||
$len = \strlen($data);
|
||||
$pos = 0;
|
||||
|
||||
while ($pos < $len) {
|
||||
$mode = $this->bsObj->getEncodingMode($data, $pos);
|
||||
if ($mode === $this->getHintMode('KJ')) {
|
||||
$pos += 2;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (\ord($data[$pos]) >= \ord('a') && \ord($data[$pos]) <= \ord('z')) {
|
||||
$data[$pos] = \chr((\ord($data[$pos]) - 32) & 0xFF);
|
||||
}
|
||||
|
||||
++$pos;
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,280 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* ByteStream.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\QrCode;
|
||||
|
||||
use Com\Tecnick\Barcode\Exception as BarcodeException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\QrCode\ByteStream
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* @phpstan-import-type Item from \Com\Tecnick\Barcode\Type\Square\QrCode\Estimate
|
||||
*/
|
||||
class ByteStream extends \Com\Tecnick\Barcode\Type\Square\QrCode\Encode
|
||||
{
|
||||
/**
|
||||
* @param array<int, int> $bstream
|
||||
*/
|
||||
protected function getBitValue(array $bstream, int $pos): int
|
||||
{
|
||||
return $bstream[$pos] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize
|
||||
*
|
||||
* @param int $hint Encoding mode
|
||||
* @param int $version Code version
|
||||
* @param int $level Error Correction Level
|
||||
*/
|
||||
public function __construct(int $hint, int $version, int $level)
|
||||
{
|
||||
$this->hint = $hint;
|
||||
$this->version = $version;
|
||||
$this->level = $level;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pack all bit streams padding bits into a byte array
|
||||
*
|
||||
* @param array<int, Item> $items Items
|
||||
*
|
||||
* @return array<int, int> padded merged byte stream
|
||||
*
|
||||
* @throws BarcodeException
|
||||
*/
|
||||
public function getByteStream(array $items): array
|
||||
{
|
||||
return $this->bitstreamToByte($this->appendPaddingBit($this->mergeBitStream($items)));
|
||||
}
|
||||
|
||||
/**
|
||||
* merge the bit stream
|
||||
*
|
||||
* @param array<int, Item> $items Items
|
||||
*
|
||||
* @return array<int, int> bitstream
|
||||
*
|
||||
* @throws BarcodeException
|
||||
*/
|
||||
protected function mergeBitStream(array $items): array
|
||||
{
|
||||
$items = $this->convertData($items);
|
||||
$bstream = [];
|
||||
foreach ($items as $item) {
|
||||
$bstream = $this->appendBitstream($bstream, $item['bstream']);
|
||||
}
|
||||
|
||||
return $bstream;
|
||||
}
|
||||
|
||||
/**
|
||||
* Append Padding Bit to bitstream
|
||||
*
|
||||
* @param array<int, int> $bstream Bit stream
|
||||
*
|
||||
* @return array<int, int> bitstream
|
||||
*/
|
||||
protected function appendPaddingBit(array $bstream): array
|
||||
{
|
||||
if ($bstream === []) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$bits = \count($bstream);
|
||||
$spec = new Spec();
|
||||
$maxwords = $spec->getDataLength($this->version, $this->level);
|
||||
$maxbits = $maxwords * 8;
|
||||
if ($maxbits === $bits) {
|
||||
return $bstream;
|
||||
}
|
||||
|
||||
if (($maxbits - $bits) < 5) {
|
||||
return $this->appendNum($bstream, $maxbits - $bits, 0);
|
||||
}
|
||||
|
||||
$bits += 4;
|
||||
$words = (int) (($bits + 7) / 8);
|
||||
$padding = [];
|
||||
$padding = $this->appendNum($padding, ($words * 8) - $bits + 4, 0);
|
||||
|
||||
$padlen = $maxwords - $words;
|
||||
if ($padlen > 0) {
|
||||
$padbuf = [];
|
||||
for ($idx = 0; $idx < $padlen; ++$idx) {
|
||||
$padbuf[$idx] = ($idx & 1) !== 0 ? 0x11 : 0xec;
|
||||
}
|
||||
|
||||
$padding = $this->appendBytes($padding, $padlen, $padbuf);
|
||||
}
|
||||
|
||||
return $this->appendBitstream($bstream, $padding);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert bitstream to bytes
|
||||
*
|
||||
* @param array<int, int> $bstream Original bitstream
|
||||
*
|
||||
* @return array<int, int> of bytes
|
||||
*/
|
||||
protected function bitstreamToByte(array $bstream): array
|
||||
{
|
||||
$size = \count($bstream);
|
||||
if ($size === 0) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$data = \array_fill(0, \max(0, (int) (($size + 7) / 8)), 0);
|
||||
$bytes = (int) ($size / 8);
|
||||
$pos = 0;
|
||||
for ($idx = 0; $idx < $bytes; ++$idx) {
|
||||
$val = 0;
|
||||
for ($jdx = 0; $jdx < 8; ++$jdx) {
|
||||
$val <<= 1;
|
||||
$val |= $this->getBitValue($bstream, $pos);
|
||||
++$pos;
|
||||
}
|
||||
|
||||
$data[$idx] = $val;
|
||||
}
|
||||
|
||||
if (($size & 7) !== 0) {
|
||||
$val = 0;
|
||||
for ($jdx = 0; $jdx < ($size & 7); ++$jdx) {
|
||||
$val <<= 1;
|
||||
$val |= $this->getBitValue($bstream, $pos);
|
||||
++$pos;
|
||||
}
|
||||
|
||||
$data[$bytes] = $val;
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* convertData
|
||||
*
|
||||
* @param array<int, Item> $items Items
|
||||
*
|
||||
* @return array<int, Item>
|
||||
*
|
||||
* @throws BarcodeException
|
||||
*/
|
||||
protected function convertData(array $items): array
|
||||
{
|
||||
$ver = $this->estimateVersion($items, $this->level);
|
||||
if ($ver > $this->version) {
|
||||
$this->version = $ver;
|
||||
}
|
||||
|
||||
while (true) {
|
||||
$cbs = $this->createBitStream($items);
|
||||
$items = $cbs[0];
|
||||
$bits = $cbs[1];
|
||||
if ($bits < 0) {
|
||||
throw new BarcodeException('Negative Bits value');
|
||||
}
|
||||
|
||||
$ver = $this->getMinimumVersion((int) (($bits + 7) / 8), $this->level);
|
||||
if ($ver > $this->version) {
|
||||
$this->version = $ver;
|
||||
continue;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
return $items;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create BitStream
|
||||
*
|
||||
* @param array<int, Item> $items Items
|
||||
*
|
||||
* @return array{
|
||||
* 0: array<int, Item>,
|
||||
* 1: int,
|
||||
* }
|
||||
*
|
||||
* @throws BarcodeException
|
||||
*/
|
||||
protected function createBitStream(array $items): array
|
||||
{
|
||||
$total = 0;
|
||||
foreach ($items as $key => $item) {
|
||||
$items[$key] = $this->encodeBitStream($item, $this->version);
|
||||
$bits = \count($items[$key]['bstream']);
|
||||
$total += $bits;
|
||||
}
|
||||
|
||||
return [$items, $total];
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode BitStream
|
||||
*
|
||||
* @param Item $inputitem Input item
|
||||
* @param int $version Code version
|
||||
*
|
||||
* @return Item
|
||||
*
|
||||
* @throws BarcodeException
|
||||
*/
|
||||
public function encodeBitStream(array $inputitem, int $version): array
|
||||
{
|
||||
$inputitem['bstream'] = [];
|
||||
$spec = new Spec();
|
||||
$words = $spec->maximumWords($inputitem['mode'], $version);
|
||||
|
||||
if ($inputitem['size'] <= $words) {
|
||||
return match ($inputitem['mode']) {
|
||||
$this->getEncModeValue('NM') => $this->encodeModeNum($inputitem, $version),
|
||||
$this->getEncModeValue('AN') => $this->encodeModeAn($inputitem, $version),
|
||||
$this->getEncModeValue('8B') => $this->encodeMode8($inputitem, $version),
|
||||
$this->getEncModeValue('KJ') => $this->encodeModeKanji($inputitem, $version),
|
||||
$this->getEncModeValue('ST') => $this->encodeModeStructure($inputitem),
|
||||
default => throw new BarcodeException('Invalid mode'),
|
||||
};
|
||||
}
|
||||
|
||||
$st1 = $this->newInputItem($inputitem['mode'], $words, $inputitem['data']);
|
||||
$st2 = $this->newInputItem(
|
||||
$inputitem['mode'],
|
||||
$inputitem['size'] - $words,
|
||||
\array_slice($inputitem['data'], $words),
|
||||
);
|
||||
$st1 = $this->encodeBitStream($st1, $version);
|
||||
$st2 = $this->encodeBitStream($st2, $version);
|
||||
$inputitem['bstream'] = [];
|
||||
$inputitem['bstream'] = $this->appendBitstream($inputitem['bstream'], $st1['bstream']);
|
||||
$inputitem['bstream'] = $this->appendBitstream($inputitem['bstream'], $st2['bstream']);
|
||||
|
||||
return $inputitem;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,576 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Data.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\QrCode;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\QrCode\Data
|
||||
*
|
||||
* Data for QrCode Barcode type class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
class Data
|
||||
{
|
||||
/**
|
||||
* Maximum QR Code version.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const QRSPEC_VERSION_MAX = 40;
|
||||
|
||||
/**
|
||||
* Maximum matrix size for maximum version (version 40 is 177*177 matrix).
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const QRSPEC_WIDTH_MAX = 177;
|
||||
|
||||
// -----------------------------------------------------
|
||||
|
||||
/**
|
||||
* Encoding mode: variable.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_NL = -1;
|
||||
|
||||
/**
|
||||
* Encoding mode: numeric.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_NM = 0;
|
||||
|
||||
/**
|
||||
* Encoding mode: alphanumeric.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_AN = 1;
|
||||
|
||||
/**
|
||||
* Encoding mode: 8-bit byte.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_8B = 2;
|
||||
|
||||
/**
|
||||
* Encoding mode: kanji.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_KJ = 3;
|
||||
|
||||
/**
|
||||
* Encoding mode: structured append.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MODE_ST = 4;
|
||||
|
||||
// -----------------------------------------------------
|
||||
|
||||
/**
|
||||
* Matrix index to get width from CAPACITY array.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const QRCAP_WIDTH = 0;
|
||||
|
||||
/**
|
||||
* Matrix index to get number of words from CAPACITY array.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const QRCAP_WORDS = 1;
|
||||
|
||||
/**
|
||||
* Matrix index to get remainder from CAPACITY array.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const QRCAP_REMINDER = 2;
|
||||
|
||||
/**
|
||||
* Matrix index to get error correction level from CAPACITY array.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const QRCAP_EC = 3;
|
||||
|
||||
// -----------------------------------------------------
|
||||
|
||||
// Structure (currently unsupported)
|
||||
|
||||
/**
|
||||
* Number of header bits for structured mode
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const STRUCTURE_HEADER_BITS = 20;
|
||||
|
||||
/**
|
||||
* Max number of symbols for structured mode
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const MAX_STRUCTURED_SYMBOLS = 16;
|
||||
|
||||
// -----------------------------------------------------
|
||||
|
||||
// Masks
|
||||
|
||||
/**
|
||||
* Down point base value for case 1 mask pattern (concatenation of same color in a line or a column)
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const N1 = 3;
|
||||
|
||||
/**
|
||||
* Down point base value for case 2 mask pattern (module block of same color)
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const N2 = 3;
|
||||
|
||||
/**
|
||||
* Down point base value for case 3 mask pattern
|
||||
* (1:1:3:1:1 (dark:bright:dark:bright:dark) pattern in a line or a column)
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const N3 = 40;
|
||||
|
||||
/**
|
||||
* Down point base value for case 4 mask pattern (ration of dark modules in whole)
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const N4 = 10;
|
||||
|
||||
/**
|
||||
* Encoding modes (characters which can be encoded in QRcode)
|
||||
*
|
||||
* NL : variable
|
||||
* NM : Encoding mode numeric (0-9). 3 characters are encoded to 10bit length.
|
||||
* AN : Encoding mode alphanumeric (0-9A-Z $%*+-./:) 45characters. 2 characters are encoded to 11bit length.
|
||||
* 8B : Encoding mode 8bit byte data. In theory, 2953 characters or less can be stored in a QRcode.
|
||||
* KJ : Encoding mode KANJI. A KANJI character (multibyte character) is encoded to 13bit length.
|
||||
* ST : Encoding mode STRUCTURED
|
||||
*
|
||||
* @var array<string, int>
|
||||
*/
|
||||
public const ENC_MODES = [
|
||||
'NL' => self::MODE_NL,
|
||||
'NM' => self::MODE_NM,
|
||||
'AN' => self::MODE_AN,
|
||||
'8B' => self::MODE_8B,
|
||||
'KJ' => self::MODE_KJ,
|
||||
'ST' => self::MODE_ST,
|
||||
];
|
||||
|
||||
/**
|
||||
* Array of valid error correction levels
|
||||
* QRcode has a function of an error correcting for miss reading that white is black.
|
||||
* Error correcting is defined in 4 level as below.
|
||||
* L : About 7% or less errors can be corrected.
|
||||
* M : About 15% or less errors can be corrected.
|
||||
* Q : About 25% or less errors can be corrected.
|
||||
* H : About 30% or less errors can be corrected.
|
||||
*
|
||||
* @var array<string, int>
|
||||
*/
|
||||
public const ECC_LEVELS = [
|
||||
'L' => 0,
|
||||
'M' => 1,
|
||||
'Q' => 2,
|
||||
'H' => 3,
|
||||
];
|
||||
|
||||
/**
|
||||
* Alphabet-numeric conversion table.
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
public const AN_TABLE = [
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
|
||||
36,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
37,
|
||||
38,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
39,
|
||||
40,
|
||||
-1,
|
||||
41,
|
||||
42,
|
||||
43,
|
||||
|
||||
0,
|
||||
1,
|
||||
2,
|
||||
3,
|
||||
4,
|
||||
5,
|
||||
6,
|
||||
7,
|
||||
8,
|
||||
9,
|
||||
44,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
|
||||
-1,
|
||||
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,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
-1,
|
||||
];
|
||||
|
||||
/**
|
||||
* Array Table of the capacity of symbols.
|
||||
* See Table 1 (pp.13) and Table 12-16 (pp.30-36), JIS X0510:2004.
|
||||
*
|
||||
* @var array<array{int, int, int, array{int, int, int, int}}>
|
||||
*/
|
||||
public const CAPACITY = [
|
||||
[0, 0, 0, [0, 0, 0, 0]],
|
||||
[21, 26, 0, [7, 10, 13, 17]],
|
||||
[25, 44, 7, [10, 16, 22, 28]],
|
||||
[29, 70, 7, [15, 26, 36, 44]],
|
||||
[33, 100, 7, [20, 36, 52, 64]],
|
||||
[37, 134, 7, [26, 48, 72, 88]],
|
||||
[41, 172, 7, [36, 64, 96, 112]],
|
||||
[45, 196, 0, [40, 72, 108, 130]],
|
||||
[49, 242, 0, [48, 88, 132, 156]],
|
||||
[53, 292, 0, [60, 110, 160, 192]],
|
||||
[57, 346, 0, [72, 130, 192, 224]],
|
||||
[61, 404, 0, [80, 150, 224, 264]],
|
||||
[65, 466, 0, [96, 176, 260, 308]],
|
||||
[69, 532, 0, [104, 198, 288, 352]],
|
||||
[73, 581, 3, [120, 216, 320, 384]],
|
||||
[77, 655, 3, [132, 240, 360, 432]],
|
||||
[81, 733, 3, [144, 280, 408, 480]],
|
||||
[85, 815, 3, [168, 308, 448, 532]],
|
||||
[89, 901, 3, [180, 338, 504, 588]],
|
||||
[93, 991, 3, [196, 364, 546, 650]],
|
||||
[97, 1085, 3, [224, 416, 600, 700]],
|
||||
[101, 1156, 4, [224, 442, 644, 750]],
|
||||
[105, 1258, 4, [252, 476, 690, 816]],
|
||||
[109, 1364, 4, [270, 504, 750, 900]],
|
||||
[113, 1474, 4, [300, 560, 810, 960]],
|
||||
[117, 1588, 4, [312, 588, 870, 1050]],
|
||||
[121, 1706, 4, [336, 644, 952, 1110]],
|
||||
[125, 1828, 4, [360, 700, 1020, 1200]],
|
||||
[129, 1921, 3, [390, 728, 1050, 1260]],
|
||||
[133, 2051, 3, [420, 784, 1140, 1350]],
|
||||
[137, 2185, 3, [450, 812, 1200, 1440]],
|
||||
[141, 2323, 3, [480, 868, 1290, 1530]],
|
||||
[145, 2465, 3, [510, 924, 1350, 1620]],
|
||||
[149, 2611, 3, [540, 980, 1440, 1710]],
|
||||
[153, 2761, 3, [570, 1036, 1530, 1800]],
|
||||
[157, 2876, 0, [570, 1064, 1590, 1890]],
|
||||
[161, 3034, 0, [600, 1120, 1680, 1980]],
|
||||
[165, 3196, 0, [630, 1204, 1770, 2100]],
|
||||
[169, 3362, 0, [660, 1260, 1860, 2220]],
|
||||
[173, 3532, 0, [720, 1316, 1950, 2310]],
|
||||
[177, 3706, 0, [750, 1372, 2040, 2430]],
|
||||
];
|
||||
|
||||
/**
|
||||
* Array Length indicator.
|
||||
*
|
||||
* @var array<array{int, int, int}>
|
||||
*/
|
||||
public const LEN_TABLE_BITS = [
|
||||
[10, 12, 14],
|
||||
[9, 11, 13],
|
||||
[8, 16, 16],
|
||||
[8, 10, 12],
|
||||
];
|
||||
|
||||
/**
|
||||
* Array Table of the error correction code (Reed-Solomon block).
|
||||
* See Table 12-16 (pp.30-36), JIS X0510:2004.
|
||||
*
|
||||
* @var array<array{array{int, int}, array{int, int}, array{int, int}, array{int, int}}>
|
||||
*/
|
||||
public const ECC_TABLE = [
|
||||
[[0, 0], [0, 0], [0, 0], [0, 0]],
|
||||
[[1, 0], [1, 0], [1, 0], [1, 0]],
|
||||
[[1, 0], [1, 0], [1, 0], [1, 0]],
|
||||
[[1, 0], [1, 0], [2, 0], [2, 0]],
|
||||
[[1, 0], [2, 0], [2, 0], [4, 0]],
|
||||
[[1, 0], [2, 0], [2, 2], [2, 2]],
|
||||
[[2, 0], [4, 0], [4, 0], [4, 0]],
|
||||
[[2, 0], [4, 0], [2, 4], [4, 1]],
|
||||
[[2, 0], [2, 2], [4, 2], [4, 2]],
|
||||
[[2, 0], [3, 2], [4, 4], [4, 4]],
|
||||
[[2, 2], [4, 1], [6, 2], [6, 2]],
|
||||
[[4, 0], [1, 4], [4, 4], [3, 8]],
|
||||
[[2, 2], [6, 2], [4, 6], [7, 4]],
|
||||
[[4, 0], [8, 1], [8, 4], [12, 4]],
|
||||
[[3, 1], [4, 5], [11, 5], [11, 5]],
|
||||
[[5, 1], [5, 5], [5, 7], [11, 7]],
|
||||
[[5, 1], [7, 3], [15, 2], [3, 13]],
|
||||
[[1, 5], [10, 1], [1, 15], [2, 17]],
|
||||
[[5, 1], [9, 4], [17, 1], [2, 19]],
|
||||
[[3, 4], [3, 11], [17, 4], [9, 16]],
|
||||
[[3, 5], [3, 13], [15, 5], [15, 10]],
|
||||
[[4, 4], [17, 0], [17, 6], [19, 6]],
|
||||
[[2, 7], [17, 0], [7, 16], [34, 0]],
|
||||
[[4, 5], [4, 14], [11, 14], [16, 14]],
|
||||
[[6, 4], [6, 14], [11, 16], [30, 2]],
|
||||
[[8, 4], [8, 13], [7, 22], [22, 13]],
|
||||
[[10, 2], [19, 4], [28, 6], [33, 4]],
|
||||
[[8, 4], [22, 3], [8, 26], [12, 28]],
|
||||
[[3, 10], [3, 23], [4, 31], [11, 31]],
|
||||
[[7, 7], [21, 7], [1, 37], [19, 26]],
|
||||
[[5, 10], [19, 10], [15, 25], [23, 25]],
|
||||
[[13, 3], [2, 29], [42, 1], [23, 28]],
|
||||
[[17, 0], [10, 23], [10, 35], [19, 35]],
|
||||
[[17, 1], [14, 21], [29, 19], [11, 46]],
|
||||
[[13, 6], [14, 23], [44, 7], [59, 1]],
|
||||
[[12, 7], [12, 26], [39, 14], [22, 41]],
|
||||
[[6, 14], [6, 34], [46, 10], [2, 64]],
|
||||
[[17, 4], [29, 14], [49, 10], [24, 46]],
|
||||
[[4, 18], [13, 32], [48, 14], [42, 32]],
|
||||
[[20, 4], [40, 7], [43, 22], [10, 67]],
|
||||
[[19, 6], [18, 31], [34, 34], [20, 61]],
|
||||
];
|
||||
|
||||
/**
|
||||
* Array Positions of alignment patterns.
|
||||
* This array includes only the second and the third position of the alignment patterns.
|
||||
* Rest of them can be calculated from the distance between them.
|
||||
* See Table 1 in Appendix E (pp.71) of JIS X0510:2004.
|
||||
*
|
||||
* @var array<array{int, int}>
|
||||
*/
|
||||
public const ALIGN_PATTERN = [
|
||||
[0, 0],
|
||||
[0, 0],
|
||||
[18, 0],
|
||||
[22, 0],
|
||||
[26, 0],
|
||||
[30, 0],
|
||||
[34, 0],
|
||||
[22, 38],
|
||||
[24, 42],
|
||||
[26, 46],
|
||||
[28, 50],
|
||||
[30, 54],
|
||||
[32, 58],
|
||||
[34, 62],
|
||||
[26, 46],
|
||||
[26, 48],
|
||||
[26, 50],
|
||||
[30, 54],
|
||||
[30, 56],
|
||||
[30, 58],
|
||||
[34, 62],
|
||||
[28, 50],
|
||||
[26, 50],
|
||||
[30, 54],
|
||||
[28, 54],
|
||||
[32, 58],
|
||||
[30, 58],
|
||||
[34, 62],
|
||||
[26, 50],
|
||||
[30, 54],
|
||||
[26, 52],
|
||||
[30, 56],
|
||||
[34, 60],
|
||||
[30, 58],
|
||||
[34, 62],
|
||||
[30, 54],
|
||||
[24, 50],
|
||||
[28, 54],
|
||||
[32, 58],
|
||||
[26, 54],
|
||||
[30, 58],
|
||||
];
|
||||
|
||||
/**
|
||||
* Array Version information pattern (BCH coded).
|
||||
* See Table 1 in Appendix D (pp.68) of JIS X0510:2004.
|
||||
* size: [QRSPEC_VERSION_MAX - 6]
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
public const VERSION_PATTERN = [
|
||||
0x0_7c94,
|
||||
0x0_85bc,
|
||||
0x0_9a99,
|
||||
0x0_a4d3,
|
||||
0x0_bbf6,
|
||||
0x0_c762,
|
||||
0x0_d847,
|
||||
0x0_e60d,
|
||||
0x0_f928,
|
||||
0x1_0b78,
|
||||
0x1_145d,
|
||||
0x1_2a17,
|
||||
0x1_3532,
|
||||
0x1_49a6,
|
||||
0x1_5683,
|
||||
0x1_68c9,
|
||||
0x1_77ec,
|
||||
0x1_8ec4,
|
||||
0x1_91e1,
|
||||
0x1_afab,
|
||||
0x1_b08e,
|
||||
0x1_cc1a,
|
||||
0x1_d33f,
|
||||
0x1_ed75,
|
||||
0x1_f250,
|
||||
0x2_09d5,
|
||||
0x2_16f0,
|
||||
0x2_28ba,
|
||||
0x2_379f,
|
||||
0x2_4b0b,
|
||||
0x2_542e,
|
||||
0x2_6a64,
|
||||
0x2_7541,
|
||||
0x2_8c69,
|
||||
];
|
||||
|
||||
/**
|
||||
* Array Format information
|
||||
*
|
||||
* @var array<array{int, int, int, int, int, int, int, int}>
|
||||
*/
|
||||
public const FORMAT_INFO = [
|
||||
[0x77c4, 0x72f3, 0x7daa, 0x789d, 0x662f, 0x6318, 0x6c41, 0x6976],
|
||||
[0x5412, 0x5125, 0x5e7c, 0x5b4b, 0x45f9, 0x40ce, 0x4f97, 0x4aa0],
|
||||
[0x355f, 0x3068, 0x3f31, 0x3a06, 0x24b4, 0x2183, 0x2eda, 0x2bed],
|
||||
[0x1689, 0x13be, 0x1ce7, 0x19d0, 0x0762, 0x0255, 0x0d0c, 0x083b],
|
||||
];
|
||||
}
|
||||
@@ -0,0 +1,249 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Encode.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*
|
||||
* This file is part of tc-lib-barcode software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Barcode\Type\Square\QrCode;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Barcode\Type\Square\QrCode\Encode
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Barcode
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2010-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-barcode
|
||||
*/
|
||||
abstract class Encode extends \Com\Tecnick\Barcode\Type\Square\QrCode\EncodingMode
|
||||
{
|
||||
protected function getEncModeValue(string $mode): int
|
||||
{
|
||||
return Data::ENC_MODES[$mode] ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } $inputitem
|
||||
*/
|
||||
protected function getDataOrd(array $inputitem, int $idx): int
|
||||
{
|
||||
return \ord($inputitem['data'][$idx] ?? "\x00");
|
||||
}
|
||||
|
||||
/**
|
||||
* encode Mode Num
|
||||
*
|
||||
* @param array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } $inputitem input item
|
||||
* @param int $version Code version
|
||||
*
|
||||
* @return array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } input item
|
||||
*/
|
||||
protected function encodeModeNum(array $inputitem, int $version): array
|
||||
{
|
||||
$words = (int) ($inputitem['size'] / 3);
|
||||
$inputitem['bstream'] = [];
|
||||
$val = 0x1;
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $val);
|
||||
$inputitem['bstream'] = $this->appendNum(
|
||||
$inputitem['bstream'],
|
||||
$this->getLengthIndicator($this->getEncModeValue('NM'), $version),
|
||||
$inputitem['size'],
|
||||
);
|
||||
for ($i = 0; $i < $words; ++$i) {
|
||||
$val = ($this->getDataOrd($inputitem, $i * 3) - \ord('0')) * 100;
|
||||
$val += ($this->getDataOrd($inputitem, ($i * 3) + 1) - \ord('0')) * 10;
|
||||
$val += $this->getDataOrd($inputitem, ($i * 3) + 2) - \ord('0');
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 10, $val);
|
||||
}
|
||||
|
||||
$remaining = $inputitem['size'] - ($words * 3);
|
||||
if ($remaining === 1) {
|
||||
$val = $this->getDataOrd($inputitem, $words * 3) - \ord('0');
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $val);
|
||||
return $inputitem;
|
||||
}
|
||||
|
||||
if ($remaining === 2) {
|
||||
$val = ($this->getDataOrd($inputitem, $words * 3) - \ord('0')) * 10;
|
||||
$val += $this->getDataOrd($inputitem, ($words * 3) + 1) - \ord('0');
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 7, $val);
|
||||
}
|
||||
|
||||
return $inputitem;
|
||||
}
|
||||
|
||||
/**
|
||||
* encode Mode An
|
||||
*
|
||||
* @param array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } $inputitem input item
|
||||
* @param int $version Code version
|
||||
*
|
||||
* @return array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } input item
|
||||
*/
|
||||
protected function encodeModeAn(array $inputitem, int $version): array
|
||||
{
|
||||
$words = (int) ($inputitem['size'] / 2);
|
||||
$inputitem['bstream'] = [];
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x02);
|
||||
$inputitem['bstream'] = $this->appendNum(
|
||||
$inputitem['bstream'],
|
||||
$this->getLengthIndicator($this->getEncModeValue('AN'), $version),
|
||||
$inputitem['size'],
|
||||
);
|
||||
for ($idx = 0; $idx < $words; ++$idx) {
|
||||
$val = $this->lookAnTable($this->getDataOrd($inputitem, $idx * 2)) * 45;
|
||||
$val += $this->lookAnTable($this->getDataOrd($inputitem, ($idx * 2) + 1));
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 11, $val);
|
||||
}
|
||||
|
||||
if (($inputitem['size'] & 1) !== 0) {
|
||||
$val = $this->lookAnTable($this->getDataOrd($inputitem, $words * 2));
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 6, $val);
|
||||
}
|
||||
|
||||
return $inputitem;
|
||||
}
|
||||
|
||||
/**
|
||||
* encode Mode 8
|
||||
*
|
||||
* @param array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } $inputitem input item
|
||||
* @param int $version Code version
|
||||
*
|
||||
* @return array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } input item
|
||||
*/
|
||||
protected function encodeMode8(array $inputitem, int $version): array
|
||||
{
|
||||
$inputitem['bstream'] = [];
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x4);
|
||||
$inputitem['bstream'] = $this->appendNum(
|
||||
$inputitem['bstream'],
|
||||
$this->getLengthIndicator($this->getEncModeValue('8B'), $version),
|
||||
$inputitem['size'],
|
||||
);
|
||||
for ($idx = 0; $idx < $inputitem['size']; ++$idx) {
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 8, $this->getDataOrd($inputitem, $idx));
|
||||
}
|
||||
|
||||
return $inputitem;
|
||||
}
|
||||
|
||||
/**
|
||||
* encode Mode Kanji
|
||||
*
|
||||
* @param array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } $inputitem input item
|
||||
* @param int $version Code version
|
||||
*
|
||||
* @return array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } input item
|
||||
*/
|
||||
protected function encodeModeKanji(array $inputitem, int $version): array
|
||||
{
|
||||
$inputitem['bstream'] = [];
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x8);
|
||||
$inputitem['bstream'] = $this->appendNum(
|
||||
$inputitem['bstream'],
|
||||
$this->getLengthIndicator($this->getEncModeValue('KJ'), $version),
|
||||
(int) ($inputitem['size'] / 2),
|
||||
);
|
||||
for ($idx = 0; $idx < $inputitem['size']; $idx += 2) {
|
||||
$val = ($this->getDataOrd($inputitem, $idx) << 8) | $this->getDataOrd($inputitem, $idx + 1);
|
||||
$valOffset = 0xc140;
|
||||
if ($val <= 0x9ffc) {
|
||||
$valOffset = 0x8140;
|
||||
}
|
||||
|
||||
$val -= $valOffset;
|
||||
|
||||
$val = ($val & 0xff) + (($val >> 8) * 0xc0);
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 13, $val);
|
||||
}
|
||||
|
||||
return $inputitem;
|
||||
}
|
||||
|
||||
/**
|
||||
* encode Mode Structure
|
||||
*
|
||||
* @param array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } $inputitem input item
|
||||
*
|
||||
* @return array{
|
||||
* 'mode': int,
|
||||
* 'size': int,
|
||||
* 'data': array<int, string>,
|
||||
* 'bstream': array<int, int>,
|
||||
* } input item
|
||||
*/
|
||||
protected function encodeModeStructure(array $inputitem): array
|
||||
{
|
||||
$inputitem['bstream'] = [];
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x03);
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $this->getDataOrd($inputitem, 1) - 1);
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $this->getDataOrd($inputitem, 0) - 1);
|
||||
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 8, $this->getDataOrd($inputitem, 2));
|
||||
return $inputitem;
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user