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,22 @@
|
||||
# Normalize text sources to LF in the repository and on checkout everywhere.
|
||||
# Critical for a byte-level library: keeps source and fixtures byte-identical
|
||||
# across Windows/macOS/Linux checkouts regardless of core.autocrlf.
|
||||
*.php text eol=lf
|
||||
*.md text eol=lf
|
||||
*.xml text eol=lf
|
||||
*.xml.dist text eol=lf
|
||||
*.json text eol=lf
|
||||
*.toml text eol=lf
|
||||
*.yml text eol=lf
|
||||
*.yaml text eol=lf
|
||||
*.txt text eol=lf
|
||||
Makefile text eol=lf
|
||||
|
||||
# Byte-exact fixtures must never be transformed (CRLF/auto-detection off).
|
||||
test/**/*.bin -text
|
||||
*.png binary
|
||||
*.jpg binary
|
||||
*.gif binary
|
||||
*.pdf binary
|
||||
*.ttf binary
|
||||
*.otf binary
|
||||
@@ -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,59 @@
|
||||
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: [pcov]
|
||||
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: 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: Run all tests
|
||||
run: make qa
|
||||
- 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-color
|
||||
|
||||
Thank you for your interest in contributing to **tc-lib-color**.
|
||||
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-color.git
|
||||
cd tc-lib-color
|
||||
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-color/issues)** to avoid duplicates.
|
||||
|
||||
If no existing issue matches, [open a new one](https://github.com/tecnickcom/tc-lib-color/issues/new) and include:
|
||||
|
||||
- A **clear title and description** of the problem.
|
||||
- The **library version** (`composer show tecnickcom/tc-lib-color`) 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-color/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-color/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-color/discussions) or contact the maintainer at [info@tecnick.com](mailto:info@tecnick.com).
|
||||
+862
@@ -0,0 +1,862 @@
|
||||
**********************************************************************
|
||||
* LICENSE
|
||||
*
|
||||
* SOFTWARE : tc-lib-color
|
||||
* AUTHOR : Nicola Asuni <info@tecnick.com>
|
||||
* COPYRIGHT : 2015-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>.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
+279
@@ -0,0 +1,279 @@
|
||||
# Makefile
|
||||
#
|
||||
# @since 2015-02-21
|
||||
# @category Library
|
||||
# @package Color
|
||||
# @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-color
|
||||
#
|
||||
# This file is part of tc-lib-color software library.
|
||||
# ----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
SHELL=/bin/bash
|
||||
.SHELLFLAGS=-o pipefail -c
|
||||
|
||||
# Project owner
|
||||
OWNER=tecnickcom
|
||||
|
||||
# Project vendor
|
||||
VENDOR=${OWNER}
|
||||
|
||||
# Project name
|
||||
PROJECT=tc-lib-color
|
||||
|
||||
# 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}/Color/
|
||||
|
||||
# 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
|
||||
|
||||
# Local rpmdb 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)"
|
||||
|
||||
## 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) --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)" \
|
||||
-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
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
# tc-lib-color
|
||||
|
||||
> PHP color toolkit for conversion and normalization across common color models.
|
||||
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-color)
|
||||
[](https://github.com/tecnickcom/tc-lib-color/actions/workflows/check.yml)
|
||||
[](https://codecov.io/gh/tecnickcom/tc-lib-color)
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-color)
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-color)
|
||||
|
||||
[](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-color` provides utilities for parsing, converting, and formatting color values used in web and PDF rendering pipelines.
|
||||
|
||||
The library is designed to centralize color logic so applications avoid ad-hoc conversion code and rounding drift across modules. It provides a consistent normalization layer that helps keep visual output aligned between browser previews and final PDF rendering.
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Namespace** | `\Com\Tecnick\Color` |
|
||||
| **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-color> |
|
||||
| **Packagist** | <https://packagist.org/packages/tecnickcom/tc-lib-color> |
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
### Color Models
|
||||
- Grayscale (GRAY)
|
||||
- RGB/RGBA and hexadecimal color handling (RGB)
|
||||
- HSL/HSLA conversion workflows (HSL)
|
||||
- CMYK conversion workflows (CMYK)
|
||||
- CIE Lab color handling and conversion workflows (LAB)
|
||||
- Spot colors (Separation), with DeviceCMYK and Lab alternate color-space support for PDF output
|
||||
|
||||
### Integration Helpers
|
||||
- CSS-ready color output
|
||||
- PDF-oriented color conversion helpers
|
||||
- Cross-model conversion helpers on all color models
|
||||
- Named web color lookup and normalization
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
- PHP 8.2 or later
|
||||
- Composer
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
composer require tecnickcom/tc-lib-color
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
require_once __DIR__ . '/vendor/autoload.php';
|
||||
|
||||
$web = new \Com\Tecnick\Color\Web();
|
||||
$rgb = $web->getRgbObjFromHex('#336699');
|
||||
|
||||
echo $rgb->getCssColor();
|
||||
```
|
||||
|
||||
See `example/index.php` for a complete conversion showcase.
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
make deps
|
||||
make help
|
||||
make qa
|
||||
make server
|
||||
```
|
||||
|
||||
Run `make server` and open <http://127.0.0.1:8000/example/index.php> to check the example in a browser.
|
||||
|
||||
---
|
||||
|
||||
## Packaging
|
||||
|
||||
```bash
|
||||
make rpm
|
||||
make deb
|
||||
```
|
||||
|
||||
For system packages, bootstrap with:
|
||||
|
||||
```php
|
||||
require_once '/usr/share/php/Com/Tecnick/Color/autoload.php';
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome. Please review [CONTRIBUTING.md](CONTRIBUTING.md), [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and [SECURITY.md](SECURITY.md).
|
||||
|
||||
+1
@@ -0,0 +1 @@
|
||||
1
|
||||
+62
@@ -0,0 +1,62 @@
|
||||
# Security Policy
|
||||
|
||||
This document describes the security policy for **tc-lib-color**.
|
||||
|
||||
---
|
||||
|
||||
## 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-color – <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-color`).
|
||||
- **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-color) 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-color> |
|
||||
| Packagist | <https://packagist.org/packages/tecnickcom/tc-lib-color> |
|
||||
+1
@@ -0,0 +1 @@
|
||||
2.13.3
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
{
|
||||
"name": "tecnickcom/tc-lib-color",
|
||||
"description": "PHP library to manipulate various color representations",
|
||||
"type": "library",
|
||||
"homepage": "https://tcpdf.org",
|
||||
"license": "LGPL-3.0-or-later",
|
||||
"keywords": [
|
||||
"tc-lib-color",
|
||||
"color",
|
||||
"colors",
|
||||
"colour",
|
||||
"colours",
|
||||
"javascript",
|
||||
"web",
|
||||
"rgb",
|
||||
"rgba",
|
||||
"cmyk",
|
||||
"hsl",
|
||||
"hsla"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Nicola Asuni",
|
||||
"email": "info@tecnick.com",
|
||||
"role": "lead"
|
||||
}
|
||||
],
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/tecnickcom"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=8.2",
|
||||
"ext-pcre": "*"
|
||||
},
|
||||
"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\\Color\\": "src"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": { "Test\\": "test" }
|
||||
},
|
||||
"support": {
|
||||
"issues": "https://github.com/tecnickcom/tc-lib-color/issues",
|
||||
"source": "https://github.com/tecnickcom/tc-lib-color"
|
||||
},
|
||||
"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"]
|
||||
}
|
||||
}
|
||||
+144
@@ -0,0 +1,144 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* index.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color 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/Color/autoload.php');
|
||||
|
||||
$colobj = new \Com\Tecnick\Color\Web();
|
||||
|
||||
$colmap = $colobj::WEBHEX;
|
||||
|
||||
$tablerows = '';
|
||||
$invtablerows = '';
|
||||
foreach ($colmap as $name => $hex) {
|
||||
$rgbcolor = $colobj->getRgbObjFromHex($hex);
|
||||
$hslcolor = new \Com\Tecnick\Color\Model\Hsl($rgbcolor->toHslArray());
|
||||
$comp = $rgbcolor->getNormalizedArray(255);
|
||||
// web colors
|
||||
$tablerows .=
|
||||
'<tr><td style="background-color:'
|
||||
. $rgbcolor->getCssColor()
|
||||
. ';"> </td>'
|
||||
. '<td>'
|
||||
. $name
|
||||
. '</td>'
|
||||
. '<td>'
|
||||
. $rgbcolor->getRgbHexColor()
|
||||
. '</td>'
|
||||
. '<td style="text-align:right;">'
|
||||
. $comp['R']
|
||||
. '</td>'
|
||||
. '<td style="text-align:right;">'
|
||||
. $comp['G']
|
||||
. '</td>'
|
||||
. '<td style="text-align:right;">'
|
||||
. $comp['B']
|
||||
. '</td>'
|
||||
. '<td>'
|
||||
. $rgbcolor->getCssColor()
|
||||
. '</td>'
|
||||
. '<td>'
|
||||
. $hslcolor->getCssColor()
|
||||
. '</td>'
|
||||
. '<td>'
|
||||
. $rgbcolor->getJsPdfColor()
|
||||
. '</td>'
|
||||
. '</tr>'
|
||||
. "\n";
|
||||
// normalised inverted web colors
|
||||
$invcolor = clone $rgbcolor;
|
||||
$invcolor->invertColor();
|
||||
$invcolname = $colobj->getClosestWebColor($invcolor->toRgbArray());
|
||||
$invrgbcolor = $colobj->getRgbObjFromName($invcolname);
|
||||
$invtablerows .=
|
||||
'<tr><td style="text-align:right;">'
|
||||
. $name
|
||||
. '</td>'
|
||||
. '<td style="background-color:'
|
||||
. $rgbcolor->getCssColor()
|
||||
. ';"> </td>'
|
||||
. '<td style="background-color:'
|
||||
. $invrgbcolor->getCssColor()
|
||||
. ';"> </td>'
|
||||
. '<td>'
|
||||
. $invcolname
|
||||
. '</td>'
|
||||
. '</tr>'
|
||||
. "\n";
|
||||
}
|
||||
|
||||
echo '
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Usage example of tc-lib-color library</title>
|
||||
<meta charset="utf-8">
|
||||
<style>
|
||||
body {font-family:Arial, Helvetica, sans-serif;}
|
||||
table {border: 1px solid black;font-family: "Courier New", Courier, monospace}
|
||||
th {border: 1px solid black;padding:4px;background-color:cornsilk;}
|
||||
td {border: 1px solid black;padding:4px;}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Usage example of tc-lib-color library</h1>
|
||||
<p>This is an usage example of <a href="https://github.com/tecnickcom/tc-lib-color" title="tc-lib-color: PHP library to manipulate various color representations">tc-lib-color</a> library.</p>
|
||||
<h2>Web Colors Table</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>COLOR</th>
|
||||
<th>NAME</th>
|
||||
<th>HEX</th>
|
||||
<th>RED</th>
|
||||
<th>GREEN</th>
|
||||
<th>BLUE</th>
|
||||
<th>CSS-RGBA</th>
|
||||
<th>CSS-HSLA</th>
|
||||
<th>PDF-JS</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
' . $tablerows . '
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Normalized Inverted Web Colors Table</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th colspan="2">A</th>
|
||||
<th colspan="2">B</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>NAME</th>
|
||||
<th>COLOR</th>
|
||||
<th>COLOR</th>
|
||||
<th>NAME</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
' . $invtablerows . '
|
||||
</tbody>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
';
|
||||
+56
@@ -0,0 +1,56 @@
|
||||
#: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 = true }
|
||||
halstead = { enabled = true, effort-threshold = 7000 }
|
||||
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-methods = { 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
|
||||
+66
@@ -0,0 +1,66 @@
|
||||
#: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-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,15 @@
|
||||
{
|
||||
"source-providers": [
|
||||
{
|
||||
"in": "src as source",
|
||||
"exclude": "vendor",
|
||||
"name": "/\\.(php)$/"
|
||||
}
|
||||
],
|
||||
"plugins": [
|
||||
],
|
||||
"analysers": [
|
||||
],
|
||||
"services": [
|
||||
]
|
||||
}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
<?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"
|
||||
processIsolation="false"
|
||||
stopOnFailure="false">
|
||||
<testsuites>
|
||||
<testsuite name="tc-lib-color 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 Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color 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,17 @@
|
||||
Source: ~#PKGNAME#~
|
||||
Maintainer: Nicola Asuni <info@tecnick.com>
|
||||
Section: php
|
||||
Priority: optional
|
||||
Build-Depends: debhelper-compat (= 13)
|
||||
Standards-Version: 4.7.0
|
||||
Rules-Requires-Root: no
|
||||
Homepage: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
Vcs-Git: https://github.com/~#VENDOR#~/~#PROJECT#~.git
|
||||
|
||||
Package: ~#PKGNAME#~
|
||||
Provides: php-~#PROJECT#~
|
||||
Architecture: all
|
||||
Depends: php (>= 8.2.0), ${misc:Depends}
|
||||
Description: PHP Color library
|
||||
This library includes PHP classes to parse and manipulate
|
||||
various colors representations GRAY, RGB, HSL, CMYK.
|
||||
@@ -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,43 @@
|
||||
# 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 manipulate various color representations
|
||||
|
||||
License: LGPLv3+
|
||||
URL: https://github.com/%{gh_owner}/%{gh_project}
|
||||
|
||||
BuildArch: noarch
|
||||
|
||||
Requires: php(language) >= 8.2.0
|
||||
Requires: php-pcre
|
||||
|
||||
Provides: php-composer(%{c_vendor}/%{gh_project}) = %{version}
|
||||
Provides: php-%{gh_project} = %{version}
|
||||
|
||||
%description
|
||||
PHP library to manipulate various color representations (GRAY, RGB, HSL, CMYK) and parse Web colors.
|
||||
|
||||
%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.5.0-1
|
||||
- Changed package name, add provides section
|
||||
* Tue Feb 24 2026 Nicola Asuni <info@tecnick.com> 1.0.0-1
|
||||
- Initial Commit
|
||||
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* ColorModelType.php
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color;
|
||||
|
||||
use Com\Tecnick\Color\Exception as ColorException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\ColorModelType
|
||||
*
|
||||
* Backed enum for the color model type.
|
||||
* The backing value of each case is the canonical string returned by
|
||||
* Com\Tecnick\Color\Model::getType() (GRAY, RGB, HSL, CMYK, LAB).
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
enum ColorModelType: string
|
||||
{
|
||||
case Gray = 'GRAY';
|
||||
|
||||
case Rgb = 'RGB';
|
||||
|
||||
case Hsl = 'HSL';
|
||||
|
||||
case Cmyk = 'CMYK';
|
||||
|
||||
case Lab = 'LAB';
|
||||
|
||||
/**
|
||||
* Resolve a loose color model type value to the matching enum case.
|
||||
*
|
||||
* Accepts the canonical string returned by Model::getType() (case-insensitive)
|
||||
* or an enum instance (returned unchanged). Unknown values throw, matching the
|
||||
* closed set enforced by the Model subclasses.
|
||||
*
|
||||
* @param string|self $value Canonical color model type or enum case.
|
||||
*
|
||||
* @throws ColorException if the value does not match a known color model type.
|
||||
*/
|
||||
public static function fromLoose(string|self $value): self
|
||||
{
|
||||
if ($value instanceof self) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
return match (\strtoupper($value)) {
|
||||
'GRAY' => self::Gray,
|
||||
'RGB' => self::Rgb,
|
||||
'HSL' => self::Hsl,
|
||||
'CMYK' => self::Cmyk,
|
||||
'LAB' => self::Lab,
|
||||
default => throw new ColorException('unknown color model type: ' . $value),
|
||||
};
|
||||
}
|
||||
}
|
||||
+272
@@ -0,0 +1,272 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Css.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color;
|
||||
|
||||
use Com\Tecnick\Color\Exception as ColorException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Css
|
||||
*
|
||||
* Css Color class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
abstract class Css
|
||||
{
|
||||
abstract public function normalizeValue(mixed $value, int $max): float;
|
||||
|
||||
/**
|
||||
* Get the color object from acrobat Javascript syntax
|
||||
*
|
||||
* @param string $color color specification (e.g.: ["RGB",0.1,0.3,1])
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
protected function getColorObjFromJs(string $color): ?\Com\Tecnick\Color\Model
|
||||
{
|
||||
$col = [];
|
||||
$colorType = $color[2] ?? null;
|
||||
if ($colorType === null || !str_contains('tgrc', $colorType)) {
|
||||
throw new ColorException('invalid javascript color: ' . $color);
|
||||
}
|
||||
|
||||
switch ($color[2]) {
|
||||
case 'g':
|
||||
$rex = '/[\[][\"\']g[\"\'][\,]([0-9\.]+)[\]]/';
|
||||
if (\preg_match($rex, $color, $col) !== 1) {
|
||||
throw new ColorException('invalid javascript color: ' . $color);
|
||||
}
|
||||
|
||||
return new \Com\Tecnick\Color\Model\Gray([
|
||||
'gray' => $col[1] ?? '0',
|
||||
'alpha' => 1,
|
||||
]);
|
||||
case 'r':
|
||||
$rex = '/[\[][\"\']rgb[\"\'][\,]([0-9\.]+)[\,]([0-9\.]+)[\,]([0-9\.]+)[\]]/';
|
||||
if (\preg_match($rex, $color, $col) !== 1) {
|
||||
throw new ColorException('invalid javascript color: ' . $color);
|
||||
}
|
||||
|
||||
return new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => $col[1] ?? '0',
|
||||
'green' => $col[2] ?? '0',
|
||||
'blue' => $col[3] ?? '0',
|
||||
'alpha' => 1,
|
||||
]);
|
||||
case 'c':
|
||||
$rex = '/[\[][\"\']cmyk[\"\'][\,]([0-9\.]+)[\,]([0-9\.]+)[\,]([0-9\.]+)[\,]([0-9\.]+)[\]]/';
|
||||
if (\preg_match($rex, $color, $col) !== 1) {
|
||||
throw new ColorException('invalid javascript color: ' . $color);
|
||||
}
|
||||
|
||||
return new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => $col[1] ?? '0',
|
||||
'magenta' => $col[2] ?? '0',
|
||||
'yellow' => $col[3] ?? '0',
|
||||
'key' => $col[4] ?? '0',
|
||||
'alpha' => 1,
|
||||
]);
|
||||
}
|
||||
|
||||
// case 't'
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color object from a CSS color string
|
||||
*
|
||||
* @param string $type color type: t, g, rgb, rgba, hsl, hsla, cmyk, cmyka, lab
|
||||
* @param string $color color specification (e.g.: rgb(255,128,64))
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
protected function getColorObjFromCss(string $type, string $color): ?\Com\Tecnick\Color\Model
|
||||
{
|
||||
switch ($type) {
|
||||
case 'g':
|
||||
return $this->getColorObjFromCssGray($color);
|
||||
case 'rgb':
|
||||
case 'rgba':
|
||||
return $this->getColorObjFromCssRgb($color);
|
||||
case 'hsl':
|
||||
case 'hsla':
|
||||
return $this->getColorObjFromCssHsl($color);
|
||||
case 'cmyk':
|
||||
case 'cmyka':
|
||||
return $this->getColorObjFromCssCmyk($color);
|
||||
case 'lab':
|
||||
return $this->getColorObjFromCssLab($color);
|
||||
}
|
||||
|
||||
// case 't'
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color object from a CSS Gray color string
|
||||
*
|
||||
* @param string $color color specification (e.g.: g(128))
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
private function getColorObjFromCssGray(string $color): \Com\Tecnick\Color\Model\Gray
|
||||
{
|
||||
$col = [];
|
||||
$rex = '/[\(]\s*([0-9.]+%?)\s*[\)]/';
|
||||
if (\preg_match($rex, $color, $col) !== 1) {
|
||||
throw new ColorException('invalid css color: ' . $color);
|
||||
}
|
||||
|
||||
return new \Com\Tecnick\Color\Model\Gray([
|
||||
'gray' => $this->normalizeValue($col[1] ?? '0', 255),
|
||||
'alpha' => 1,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color object from a CSS RGB/RGBA color string
|
||||
*
|
||||
* @param string $color color specification (e.g.: rgb(255,128,64))
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
private function getColorObjFromCssRgb(string $color): \Com\Tecnick\Color\Model\Rgb
|
||||
{
|
||||
$col = [];
|
||||
$rex =
|
||||
'/[\(]\s*([0-9.]+%?)\s*(?:[\s,]+)\s*([0-9.]+%?)\s*(?:[\s,]+)'
|
||||
. '\s*([0-9.]+%?)\s*(?:[\/,]\s*([0-9.]+%?)\s*)?[\)]/';
|
||||
if (\preg_match($rex, $color, $col) !== 1) {
|
||||
throw new ColorException('invalid css color: ' . $color);
|
||||
}
|
||||
|
||||
return new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => $this->normalizeValue($col[1] ?? '0', 255),
|
||||
'green' => $this->normalizeValue($col[2] ?? '0', 255),
|
||||
'blue' => $this->normalizeValue($col[3] ?? '0', 255),
|
||||
'alpha' => $this->normalizeAlpha($col[4] ?? ''),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color object from a CSS HSL/HSLA color string
|
||||
*
|
||||
* @param string $color color specification (e.g.: hsl(120,100%,50%))
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
private function getColorObjFromCssHsl(string $color): \Com\Tecnick\Color\Model\Hsl
|
||||
{
|
||||
$col = [];
|
||||
$rex =
|
||||
'/[\(]\s*([0-9.]+%?)\s*(?:[\s,]+)\s*([0-9.]+%?)\s*(?:[\s,]+)'
|
||||
. '\s*([0-9.]+%?)\s*(?:[\/,]\s*([0-9.]+%?)\s*)?[\)]/';
|
||||
if (\preg_match($rex, $color, $col) !== 1) {
|
||||
throw new ColorException('invalid css color: ' . $color);
|
||||
}
|
||||
|
||||
// Saturation and lightness are CSS percentages: a bare number (e.g. "50")
|
||||
// is treated the same as "50%", i.e. divided by 100, not by the max.
|
||||
return new \Com\Tecnick\Color\Model\Hsl([
|
||||
'hue' => $this->normalizeValue($col[1] ?? '0', 360),
|
||||
'saturation' => $this->normalizeValue($col[2] ?? '0', 100),
|
||||
'lightness' => $this->normalizeValue($col[3] ?? '0', 100),
|
||||
'alpha' => $this->normalizeAlpha($col[4] ?? ''),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color object from a CSS CMYK color string
|
||||
*
|
||||
* @param string $color color specification (e.g.: cmyk(100,0,50,0))
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
private function getColorObjFromCssCmyk(string $color): \Com\Tecnick\Color\Model\Cmyk
|
||||
{
|
||||
$col = [];
|
||||
$rex =
|
||||
'/[\(]\s*([0-9.]+%?)\s*(?:[\s,]+)\s*([0-9.]+%?)\s*(?:[\s,]+)\s*([0-9.]+%?)'
|
||||
. '\s*(?:[\s,]+)\s*([0-9.]+%?)\s*(?:[\/,]\s*([0-9.]+%?)\s*)?[\)]/';
|
||||
if (\preg_match($rex, $color, $col) !== 1) {
|
||||
throw new ColorException('invalid css color: ' . $color);
|
||||
}
|
||||
|
||||
return new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => $this->normalizeValue($col[1] ?? '0', 100),
|
||||
'magenta' => $this->normalizeValue($col[2] ?? '0', 100),
|
||||
'yellow' => $this->normalizeValue($col[3] ?? '0', 100),
|
||||
'key' => $this->normalizeValue($col[4] ?? '0', 100),
|
||||
'alpha' => $this->normalizeAlpha($col[5] ?? ''),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color object from a CSS Lab color string.
|
||||
*
|
||||
* Supports forms such as: lab(52% 0 -39), lab(52% 0 -39 / 0.85), lab(52,0,-39,0.85)
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
private function getColorObjFromCssLab(string $color): \Com\Tecnick\Color\Model\Lab
|
||||
{
|
||||
$col = [];
|
||||
$rex = '/[\(]\s*([0-9\.]+%?)\s*(?:[\s,]+)\s*([\+\-]?[0-9\.]+)\s*(?:[\s,]+)\s*([\+\-]?[0-9\.]+)\s*(?:[\/,]\s*([0-9\.]+%?)\s*)?[\)]/';
|
||||
if (\preg_match($rex, $color, $col) !== 1) {
|
||||
throw new ColorException('invalid css color: ' . $color);
|
||||
}
|
||||
|
||||
$lstarRaw = $col[1] ?? '0';
|
||||
$lstarVal = str_ends_with($lstarRaw, '%') ? \str_replace('%', '', $lstarRaw) : $lstarRaw;
|
||||
$lstar = \is_numeric($lstarVal) ? (float) $lstarVal : 0.0;
|
||||
|
||||
return new \Com\Tecnick\Color\Model\Lab([
|
||||
'lstar' => $lstar,
|
||||
'astar' => $col[2] ?? '0',
|
||||
'bstar' => $col[3] ?? '0',
|
||||
'alpha' => $this->normalizeAlpha($col[4] ?? ''),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalize a CSS alpha value to a float in the [0..1] range.
|
||||
*
|
||||
* Accepts a fraction (e.g. "0.85") or a percentage (e.g. "85%"). An empty
|
||||
* string yields 1.0 (fully opaque).
|
||||
*/
|
||||
private function normalizeAlpha(string $alpha): float
|
||||
{
|
||||
if ($alpha === '') {
|
||||
return 1.0;
|
||||
}
|
||||
|
||||
if (str_ends_with($alpha, '%')) {
|
||||
$value = \str_replace('%', '', $alpha);
|
||||
return \is_numeric($value) ? \max(0.0, \min(1.0, (float) $value / 100.0)) : 1.0;
|
||||
}
|
||||
|
||||
return \is_numeric($alpha) ? \max(0.0, \min(1.0, (float) $alpha)) : 1.0;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Exception.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Exception
|
||||
*
|
||||
* Custom Exception class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class Exception extends \Exception {}
|
||||
+232
@@ -0,0 +1,232 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Model.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Model
|
||||
*
|
||||
* Color Model class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
abstract class Model implements \Com\Tecnick\Color\Model\Template
|
||||
{
|
||||
/**
|
||||
* Color Model type (GRAY, RGB, HSL, CMYK, LAB)
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $type;
|
||||
|
||||
/**
|
||||
* Value of the Alpha channel component.
|
||||
* Values range between 0.0 (fully transparent) and 1.0 (fully opaque)
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_alpha = 1.0;
|
||||
|
||||
/**
|
||||
* Initialize a new color object.
|
||||
*
|
||||
* @param array<string, int|float|string> $components color components.
|
||||
*/
|
||||
public function __construct(array $components)
|
||||
{
|
||||
foreach ($components as $color => $value) {
|
||||
$this->setComponentValue($color, \max(0, \min(1, (float) $value)));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a known component value while keeping dynamic property writes analyzable.
|
||||
*/
|
||||
private function setComponentValue(string $color, float $value): void
|
||||
{
|
||||
switch ($color) {
|
||||
case 'alpha':
|
||||
$this->cmp_alpha = $value;
|
||||
break;
|
||||
case 'gray':
|
||||
if (\property_exists($this, 'cmp_gray')) {
|
||||
$this->cmp_gray = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'red':
|
||||
if (\property_exists($this, 'cmp_red')) {
|
||||
$this->cmp_red = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'green':
|
||||
if (\property_exists($this, 'cmp_green')) {
|
||||
$this->cmp_green = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'blue':
|
||||
if (\property_exists($this, 'cmp_blue')) {
|
||||
$this->cmp_blue = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'hue':
|
||||
if (\property_exists($this, 'cmp_hue')) {
|
||||
$this->cmp_hue = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'saturation':
|
||||
if (\property_exists($this, 'cmp_saturation')) {
|
||||
$this->cmp_saturation = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'lightness':
|
||||
if (\property_exists($this, 'cmp_lightness')) {
|
||||
$this->cmp_lightness = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'cyan':
|
||||
if (\property_exists($this, 'cmp_cyan')) {
|
||||
$this->cmp_cyan = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'magenta':
|
||||
if (\property_exists($this, 'cmp_magenta')) {
|
||||
$this->cmp_magenta = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'yellow':
|
||||
if (\property_exists($this, 'cmp_yellow')) {
|
||||
$this->cmp_yellow = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'key':
|
||||
if (\property_exists($this, 'cmp_key')) {
|
||||
$this->cmp_key = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'lstar':
|
||||
if (\property_exists($this, 'cmp_lstar')) {
|
||||
$this->cmp_lstar = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'astar':
|
||||
if (\property_exists($this, 'cmp_astar')) {
|
||||
$this->cmp_astar = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
case 'bstar':
|
||||
if (\property_exists($this, 'cmp_bstar')) {
|
||||
$this->cmp_bstar = $value;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color model type (GRAY, RGB, HSL, CMYK, LAB)
|
||||
*/
|
||||
public function getType(): string
|
||||
{
|
||||
return $this->type;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color model type as a backed enum case.
|
||||
*
|
||||
* Typed counterpart of getType(); the string returned by getType() is always
|
||||
* one of the canonical ColorModelType backing values.
|
||||
*/
|
||||
public function getTypeEnum(): ColorModelType
|
||||
{
|
||||
return ColorModelType::from($this->type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the normalized integer value of the specified float fraction
|
||||
*
|
||||
* @param float $value Fraction value to convert [0..1]
|
||||
* @param int $max Maximum value to return (reference value)
|
||||
*
|
||||
* @return float value [0..$max]
|
||||
*/
|
||||
public function getNormalizedValue(float $value, int $max): float
|
||||
{
|
||||
// NOTE: The last round has been added for backward compatibility because of:
|
||||
// https://github.com/php/php-src/issues/14332
|
||||
return \round(\max(0, \min($max, $max * \round($value, 14))));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the normalized hexadecimal value of the specified float fraction
|
||||
*
|
||||
* @param float $value Fraction value to convert [0..1]
|
||||
* @param int $max Maximum value to return (reference value)
|
||||
*/
|
||||
public function getHexValue(float $value, int $max): string
|
||||
{
|
||||
return \sprintf('%02x', $this->getNormalizedValue($value, $max));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Hexadecimal representation of the color with alpha channel: #RRGGBBAA
|
||||
*/
|
||||
public function getRgbaHexColor(): string
|
||||
{
|
||||
$rgba = $this->toRgbArray();
|
||||
return (
|
||||
'#'
|
||||
. $this->getHexValue($rgba['red'] ?? 0.0, 255)
|
||||
. $this->getHexValue($rgba['green'] ?? 0.0, 255)
|
||||
. $this->getHexValue($rgba['blue'] ?? 0.0, 255)
|
||||
. $this->getHexValue($rgba['alpha'] ?? 1.0, 255)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Hexadecimal representation of the color: #RRGGBB
|
||||
*/
|
||||
public function getRgbHexColor(): string
|
||||
{
|
||||
$rgba = $this->toRgbArray();
|
||||
return (
|
||||
'#'
|
||||
. $this->getHexValue($rgba['red'] ?? 0.0, 255)
|
||||
. $this->getHexValue($rgba['green'] ?? 0.0, 255)
|
||||
. $this->getHexValue($rgba['blue'] ?? 0.0, 255)
|
||||
);
|
||||
}
|
||||
}
|
||||
+267
@@ -0,0 +1,267 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Cmyk.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color\Model;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Model\Cmyk
|
||||
*
|
||||
* CMYK Color Model class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class Cmyk extends \Com\Tecnick\Color\Model
|
||||
{
|
||||
/**
|
||||
* Color Model type
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $type = 'CMYK';
|
||||
|
||||
/**
|
||||
* Value of the Cyan color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_cyan = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Magenta color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_magenta = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Yellow color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_yellow = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Key (Black) color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_key = 0.0;
|
||||
|
||||
/**
|
||||
* Get an array with all color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('C', 'M', 'Y', 'K', 'A')
|
||||
*/
|
||||
public function getArray(): array
|
||||
{
|
||||
return [
|
||||
'C' => $this->cmp_cyan,
|
||||
'M' => $this->cmp_magenta,
|
||||
'Y' => $this->cmp_yellow,
|
||||
'K' => $this->cmp_key,
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with all color components for
|
||||
* the PDF appearance characteristics dictionary.
|
||||
*
|
||||
* The numbers that shall be in the range 0.0 to 1.0.
|
||||
* The number of array elements determines the colour space
|
||||
* in which the colour shall be defined:
|
||||
* 4 = DeviceCMYK
|
||||
*
|
||||
* @return array<float> DeviceCMYK color components ('C', 'M', 'Y', 'K')
|
||||
*/
|
||||
public function getPDFacArray(): array
|
||||
{
|
||||
return [
|
||||
$this->cmp_cyan,
|
||||
$this->cmp_magenta,
|
||||
$this->cmp_yellow,
|
||||
$this->cmp_key,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with color components values normalized between 0 and $max.
|
||||
* NOTE: the alpha and other fraction component values are kept in the [0..1] range.
|
||||
*
|
||||
* @param int $max Maximum value to return (reference value - it should be 100)
|
||||
*
|
||||
* @return array<string, float> with keys ('C', 'M', 'Y', 'K', 'A')
|
||||
*/
|
||||
public function getNormalizedArray(int $max): array
|
||||
{
|
||||
return [
|
||||
'C' => $this->getNormalizedValue($this->cmp_cyan, $max),
|
||||
'M' => $this->getNormalizedValue($this->cmp_magenta, $max),
|
||||
'Y' => $this->getNormalizedValue($this->cmp_yellow, $max),
|
||||
'K' => $this->getNormalizedValue($this->cmp_key, $max),
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the CSS representation of the color: cmyk(C, M, Y, K) or cmyka(C, M, Y, K, A)
|
||||
*/
|
||||
public function getCssColor(): string
|
||||
{
|
||||
$colorType = 'cmyk';
|
||||
$alpha = '';
|
||||
if ($this->cmp_alpha < 1.0) {
|
||||
$colorType = 'cmyka';
|
||||
$alpha = ',' . $this->cmp_alpha;
|
||||
}
|
||||
|
||||
return (
|
||||
$colorType
|
||||
. '('
|
||||
. $this->getNormalizedValue($this->cmp_cyan, 100)
|
||||
. '%,'
|
||||
. $this->getNormalizedValue($this->cmp_magenta, 100)
|
||||
. '%,'
|
||||
. $this->getNormalizedValue($this->cmp_yellow, 100)
|
||||
. '%,'
|
||||
. $this->getNormalizedValue($this->cmp_key, 100)
|
||||
. '%'
|
||||
. $alpha
|
||||
. ')'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color format used in Acrobat JavaScript
|
||||
* NOTE: the alpha channel is omitted from this representation unless it is 0 = transparent
|
||||
*/
|
||||
public function getJsPdfColor(): string
|
||||
{
|
||||
if ($this->cmp_alpha === 0.0) {
|
||||
return '["T"]'; // transparent color
|
||||
}
|
||||
|
||||
return \sprintf('["CMYK",%F,%F,%F,%F]', $this->cmp_cyan, $this->cmp_magenta, $this->cmp_yellow, $this->cmp_key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a space separated string with color component values.
|
||||
*/
|
||||
public function getComponentsString(): string
|
||||
{
|
||||
return \sprintf('%F %F %F %F', $this->cmp_cyan, $this->cmp_magenta, $this->cmp_yellow, $this->cmp_key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color components format used in PDF documents (CMYK)
|
||||
* NOTE: the alpha channel is omitted
|
||||
*
|
||||
* @param bool $stroke True for stroking (lines, drawing) and false for non-stroking (text and area filling).
|
||||
*/
|
||||
public function getPdfColor(bool $stroke = false): string
|
||||
{
|
||||
$mode = 'k';
|
||||
if ($stroke) {
|
||||
$mode = \strtoupper($mode);
|
||||
}
|
||||
|
||||
return $this->getComponentsString() . ' ' . $mode . "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Gray color components
|
||||
*
|
||||
* @return array<string, float> with keys ('gray', 'alpha')
|
||||
*/
|
||||
public function toGrayArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toGrayArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with RGB color components
|
||||
*
|
||||
* @return array<string, float> with keys ('red', 'green', 'blue', 'alpha')
|
||||
*/
|
||||
public function toRgbArray(): array
|
||||
{
|
||||
return [
|
||||
'red' => \max(0, \min(1, 1 - (($this->cmp_cyan * (1 - $this->cmp_key)) + $this->cmp_key))),
|
||||
'green' => \max(0, \min(1, 1 - (($this->cmp_magenta * (1 - $this->cmp_key)) + $this->cmp_key))),
|
||||
'blue' => \max(0, \min(1, 1 - (($this->cmp_yellow * (1 - $this->cmp_key)) + $this->cmp_key))),
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with HSL color components
|
||||
*
|
||||
* @return array<string, float> with keys ('hue', 'saturation', 'lightness', 'alpha')
|
||||
*/
|
||||
public function toHslArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toHslArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with CMYK color components
|
||||
*
|
||||
* @return array<string, float> with keys ('cyan', 'magenta', 'yellow', 'key', 'alpha')
|
||||
*/
|
||||
public function toCmykArray(): array
|
||||
{
|
||||
return [
|
||||
'cyan' => $this->cmp_cyan,
|
||||
'magenta' => $this->cmp_magenta,
|
||||
'yellow' => $this->cmp_yellow,
|
||||
'key' => $this->cmp_key,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Lab color components
|
||||
*
|
||||
* @return array<string, float> with keys ('lstar', 'astar', 'bstar', 'alpha')
|
||||
*/
|
||||
public function toLabArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toLabArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Invert the color
|
||||
*/
|
||||
public function invertColor(): self
|
||||
{
|
||||
$this->cmp_cyan = 1 - $this->cmp_cyan;
|
||||
$this->cmp_magenta = 1 - $this->cmp_magenta;
|
||||
$this->cmp_yellow = 1 - $this->cmp_yellow;
|
||||
$this->cmp_key = 1 - $this->cmp_key;
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
+229
@@ -0,0 +1,229 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Gray.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color\Model;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Model\Gray
|
||||
*
|
||||
* Gray Color Model class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class Gray extends \Com\Tecnick\Color\Model
|
||||
{
|
||||
/**
|
||||
* Color Model type
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $type = 'GRAY';
|
||||
|
||||
/**
|
||||
* Value of the Gray color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_gray = 0.0;
|
||||
|
||||
/**
|
||||
* Get an array with all color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('G', 'A')
|
||||
*/
|
||||
public function getArray(): array
|
||||
{
|
||||
return [
|
||||
'G' => $this->cmp_gray,
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with all color components for
|
||||
* the PDF appearance characteristics dictionary.
|
||||
*
|
||||
* The numbers that shall be in the range 0.0 to 1.0.
|
||||
* The number of array elements determines the colour space
|
||||
* in which the colour shall be defined:
|
||||
* 1 = DeviceGray
|
||||
*
|
||||
* @return array<float> DeviceGray color component ('G')
|
||||
*/
|
||||
public function getPDFacArray(): array
|
||||
{
|
||||
return [
|
||||
$this->cmp_gray,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with color components values normalized between 0 and $max.
|
||||
* NOTE: the alpha and other fraction component values are kept in the [0..1] range.
|
||||
*
|
||||
* @param int $max Maximum value to return (reference value)
|
||||
*
|
||||
* @return array<string, float> with keys ('G', 'A')
|
||||
*/
|
||||
public function getNormalizedArray(int $max): array
|
||||
{
|
||||
return [
|
||||
'G' => $this->getNormalizedValue($this->cmp_gray, $max),
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the CSS representation of the color: g(G) or rgba(R, G, B, A).
|
||||
*/
|
||||
public function getCssColor(): string
|
||||
{
|
||||
if ($this->cmp_alpha === 1.0) {
|
||||
return 'g(' . $this->getNormalizedValue($this->cmp_gray, 100) . '%)';
|
||||
}
|
||||
|
||||
return (
|
||||
'rgba('
|
||||
. $this->getNormalizedValue($this->cmp_gray, 100)
|
||||
. '%,'
|
||||
. $this->getNormalizedValue($this->cmp_gray, 100)
|
||||
. '%,'
|
||||
. $this->getNormalizedValue($this->cmp_gray, 100)
|
||||
. '%,'
|
||||
. $this->cmp_alpha
|
||||
. ')'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color format used in Acrobat JavaScript
|
||||
* NOTE: the alpha channel is omitted from this representation unless it is 0 = transparent
|
||||
*/
|
||||
public function getJsPdfColor(): string
|
||||
{
|
||||
if ($this->cmp_alpha === 0.0) {
|
||||
return '["T"]'; // transparent color
|
||||
}
|
||||
|
||||
return \sprintf('["G",%F]', $this->cmp_gray);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a space separated string with color component values.
|
||||
*/
|
||||
public function getComponentsString(): string
|
||||
{
|
||||
return \sprintf('%F', $this->cmp_gray);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color components format used in PDF documents (G)
|
||||
* NOTE: the alpha channel is omitted
|
||||
*
|
||||
* @param bool $stroke True for stroking (lines, drawing) and false for non-stroking (text and area filling).
|
||||
*/
|
||||
public function getPdfColor(bool $stroke = false): string
|
||||
{
|
||||
$mode = 'g';
|
||||
if ($stroke) {
|
||||
$mode = \strtoupper($mode);
|
||||
}
|
||||
|
||||
return $this->getComponentsString() . ' ' . $mode . "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Gray color components
|
||||
*
|
||||
* @return array<string, float> with keys ('gray', 'alpha')
|
||||
*/
|
||||
public function toGrayArray(): array
|
||||
{
|
||||
return [
|
||||
'gray' => $this->cmp_gray,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with RGB color components
|
||||
*
|
||||
* @return array<string, float> with keys ('red', 'green', 'blue', 'alpha')
|
||||
*/
|
||||
public function toRgbArray(): array
|
||||
{
|
||||
return [
|
||||
'red' => $this->cmp_gray,
|
||||
'green' => $this->cmp_gray,
|
||||
'blue' => $this->cmp_gray,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with HSL color components
|
||||
*
|
||||
* @return array<string, float> with keys ('hue', 'saturation', 'lightness', 'alpha')
|
||||
*/
|
||||
public function toHslArray(): array
|
||||
{
|
||||
return [
|
||||
'hue' => 0.0,
|
||||
'saturation' => 0.0,
|
||||
'lightness' => $this->cmp_gray,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with CMYK color components
|
||||
*
|
||||
* @return array<string, float> with keys ('cyan', 'magenta', 'yellow', 'key', 'alpha')
|
||||
*/
|
||||
public function toCmykArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toCmykArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Lab color components
|
||||
*
|
||||
* @return array<string, float> with keys ('lstar', 'astar', 'bstar', 'alpha')
|
||||
*/
|
||||
public function toLabArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toLabArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Invert the color
|
||||
*/
|
||||
public function invertColor(): self
|
||||
{
|
||||
$this->cmp_gray = 1 - $this->cmp_gray;
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
+304
@@ -0,0 +1,304 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Hsl.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color\Model;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Model\Hsl
|
||||
*
|
||||
* HSL Color Model class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class Hsl extends \Com\Tecnick\Color\Model
|
||||
{
|
||||
/**
|
||||
* Color Model type
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $type = 'HSL';
|
||||
|
||||
/**
|
||||
* Value of the Hue color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_hue = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Saturation color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_saturation = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Lightness color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_lightness = 0.0;
|
||||
|
||||
/**
|
||||
* Get an array with all color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('H', 'S', 'L', 'A')
|
||||
*/
|
||||
public function getArray(): array
|
||||
{
|
||||
return [
|
||||
'H' => $this->cmp_hue,
|
||||
'S' => $this->cmp_saturation,
|
||||
'L' => $this->cmp_lightness,
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with all color components for
|
||||
* the PDF appearance characteristics dictionary.
|
||||
*
|
||||
* The numbers that shall be in the range 0.0 to 1.0.
|
||||
* The number of array elements determines the colour space
|
||||
* in which the colour shall be defined:
|
||||
* 3 = DeviceRGB
|
||||
*
|
||||
* @return array<float> DeviceRGB color components ('R', 'G', 'B')
|
||||
*/
|
||||
public function getPDFacArray(): array
|
||||
{
|
||||
$rgb = $this->toRgbArray();
|
||||
return [
|
||||
$rgb['red'] ?? 0.0,
|
||||
$rgb['green'] ?? 0.0,
|
||||
$rgb['blue'] ?? 0.0,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with color components values normalized.
|
||||
*
|
||||
* NOTE: the $max argument is intentionally not applied here. Hue is an angle
|
||||
* and is always returned in degrees [0..360], while saturation, lightness and
|
||||
* alpha are fraction components kept in the [0..1] range.
|
||||
*
|
||||
* @param int $max Unused; kept for interface compatibility.
|
||||
*
|
||||
* @return array<string, float> with keys ('H', 'S', 'L', 'A')
|
||||
*/
|
||||
public function getNormalizedArray(int $max): array
|
||||
{
|
||||
return [
|
||||
'H' => $this->getNormalizedValue($this->cmp_hue, 360),
|
||||
'S' => $this->cmp_saturation,
|
||||
'L' => $this->cmp_lightness,
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the CSS representation of the color: hsl(H, S, L) or hsla(H, S, L, A)
|
||||
*/
|
||||
public function getCssColor(): string
|
||||
{
|
||||
$colorType = 'hsl';
|
||||
$alpha = '';
|
||||
if ($this->cmp_alpha < 1.0) {
|
||||
$colorType = 'hsla';
|
||||
$alpha = ',' . $this->cmp_alpha;
|
||||
}
|
||||
|
||||
return (
|
||||
$colorType
|
||||
. '('
|
||||
. $this->getNormalizedValue($this->cmp_hue, 360)
|
||||
. ','
|
||||
. $this->getNormalizedValue($this->cmp_saturation, 100)
|
||||
. '%,'
|
||||
. $this->getNormalizedValue($this->cmp_lightness, 100)
|
||||
. '%'
|
||||
. $alpha
|
||||
. ')'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color format used in Acrobat JavaScript
|
||||
* NOTE: the alpha channel is omitted from this representation unless it is 0 = transparent
|
||||
*/
|
||||
public function getJsPdfColor(): string
|
||||
{
|
||||
$rgb = $this->toRgbArray();
|
||||
if ($this->cmp_alpha === 0.0) {
|
||||
return '["T"]'; // transparent color
|
||||
}
|
||||
|
||||
return \sprintf('["RGB",%F,%F,%F]', $rgb['red'] ?? 0.0, $rgb['green'] ?? 0.0, $rgb['blue'] ?? 0.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a space separated string with color component values.
|
||||
*/
|
||||
public function getComponentsString(): string
|
||||
{
|
||||
$rgb = $this->toRgbArray();
|
||||
return \sprintf('%F %F %F', $rgb['red'] ?? 0.0, $rgb['green'] ?? 0.0, $rgb['blue'] ?? 0.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color components format used in PDF documents (RGB)
|
||||
* NOTE: the alpha channel is omitted
|
||||
*
|
||||
* @param bool $stroke True for stroking (lines, drawing) and false for non-stroking (text and area filling).
|
||||
*/
|
||||
public function getPdfColor(bool $stroke = false): string
|
||||
{
|
||||
$mode = 'rg';
|
||||
if ($stroke) {
|
||||
$mode = \strtoupper($mode);
|
||||
}
|
||||
|
||||
return $this->getComponentsString() . ' ' . $mode . "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Gray color components
|
||||
*
|
||||
* @return array<string, float> with keys ('gray', 'alpha')
|
||||
*/
|
||||
public function toGrayArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toGrayArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with RGB color components
|
||||
*
|
||||
* @return array<string, float> with keys ('red', 'green', 'blue', 'alpha')
|
||||
*/
|
||||
public function toRgbArray(): array
|
||||
{
|
||||
if ($this->cmp_saturation === 0.0) {
|
||||
return [
|
||||
'red' => $this->cmp_lightness,
|
||||
'green' => $this->cmp_lightness,
|
||||
'blue' => $this->cmp_lightness,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
$valb = $this->cmp_lightness * (1 + $this->cmp_saturation);
|
||||
if ($this->cmp_lightness >= 0.5) {
|
||||
$valb = $this->cmp_lightness + $this->cmp_saturation - ($this->cmp_lightness * $this->cmp_saturation);
|
||||
}
|
||||
|
||||
$vala = (2 * $this->cmp_lightness) - $valb;
|
||||
return [
|
||||
'red' => $this->convertHuetoRgb($vala, $valb, $this->cmp_hue + (1 / 3)),
|
||||
'green' => $this->convertHuetoRgb($vala, $valb, $this->cmp_hue),
|
||||
'blue' => $this->convertHuetoRgb($vala, $valb, $this->cmp_hue - (1 / 3)),
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert Hue to RGB
|
||||
*
|
||||
* @param float $vala Temporary value A
|
||||
* @param float $valb Temporary value B
|
||||
* @param float $hue Hue value
|
||||
*/
|
||||
private function convertHuetoRgb(float $vala, float $valb, float $hue): float
|
||||
{
|
||||
if ($hue < 0) {
|
||||
++$hue;
|
||||
}
|
||||
|
||||
if ($hue > 1) {
|
||||
--$hue;
|
||||
}
|
||||
|
||||
if ((6 * $hue) < 1) {
|
||||
return \max(0, \min(1, $vala + (($valb - $vala) * 6 * $hue)));
|
||||
}
|
||||
|
||||
if ((2 * $hue) < 1) {
|
||||
return \max(0, \min(1, $valb));
|
||||
}
|
||||
|
||||
if ((3 * $hue) < 2) {
|
||||
return \max(0, \min(1, $vala + (($valb - $vala) * ((2 / 3) - $hue) * 6)));
|
||||
}
|
||||
|
||||
return \max(0, \min(1, $vala));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with HSL color components
|
||||
*
|
||||
* @return array<string, float> with keys ('hue', 'saturation', 'lightness', 'alpha')
|
||||
*/
|
||||
public function toHslArray(): array
|
||||
{
|
||||
return [
|
||||
'hue' => $this->cmp_hue,
|
||||
'saturation' => $this->cmp_saturation,
|
||||
'lightness' => $this->cmp_lightness,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with CMYK color components
|
||||
*
|
||||
* @return array<string, float> with keys ('cyan', 'magenta', 'yellow', 'key', 'alpha')
|
||||
*/
|
||||
public function toCmykArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toCmykArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Lab color components
|
||||
*
|
||||
* @return array<string, float> with keys ('lstar', 'astar', 'bstar', 'alpha')
|
||||
*/
|
||||
public function toLabArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toLabArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Invert the color
|
||||
*/
|
||||
public function invertColor(): self
|
||||
{
|
||||
$this->cmp_hue = $this->cmp_hue >= 0.5 ? $this->cmp_hue - 0.5 : $this->cmp_hue + 0.5;
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
+291
@@ -0,0 +1,291 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Lab.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color\Model;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Model\Lab
|
||||
*
|
||||
* CIE Lab Color Model class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class Lab extends \Com\Tecnick\Color\Model
|
||||
{
|
||||
/**
|
||||
* Color Model type
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $type = 'LAB';
|
||||
|
||||
/**
|
||||
* Value of the Lab L* component [0..100]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_lstar = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Lab a* component [-128..127]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_astar = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Lab b* component [-128..127]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_bstar = 0.0;
|
||||
|
||||
/**
|
||||
* Initialize a new Lab color object.
|
||||
*
|
||||
* @param array<string, int|float|string> $components Color components.
|
||||
*/
|
||||
public function __construct(array $components)
|
||||
{
|
||||
$this->cmp_alpha = \max(0.0, \min(1.0, (float) ($components['alpha'] ?? 1.0)));
|
||||
$this->cmp_lstar = \max(0.0, \min(100.0, (float) ($components['lstar'] ?? 0.0)));
|
||||
$this->cmp_astar = \max(-128.0, \min(127.0, (float) ($components['astar'] ?? 0.0)));
|
||||
$this->cmp_bstar = \max(-128.0, \min(127.0, (float) ($components['bstar'] ?? 0.0)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with all color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('L', 'a', 'b', 'A')
|
||||
*/
|
||||
public function getArray(): array
|
||||
{
|
||||
return [
|
||||
'L' => $this->cmp_lstar,
|
||||
'a' => $this->cmp_astar,
|
||||
'b' => $this->cmp_bstar,
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with all color components for
|
||||
* the PDF appearance characteristics dictionary.
|
||||
*
|
||||
* @return array<float> DeviceRGB color components ('R', 'G', 'B')
|
||||
*/
|
||||
public function getPDFacArray(): array
|
||||
{
|
||||
$rgb = $this->toRgbArray();
|
||||
return [
|
||||
$rgb['red'] ?? 0.0,
|
||||
$rgb['green'] ?? 0.0,
|
||||
$rgb['blue'] ?? 0.0,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with color components values normalized.
|
||||
*
|
||||
* @param int $max Unused parameter for interface compatibility.
|
||||
*
|
||||
* @return array<string, float> with keys ('L', 'a', 'b', 'A')
|
||||
*/
|
||||
public function getNormalizedArray(int $max): array
|
||||
{
|
||||
return [
|
||||
'L' => \round($this->cmp_lstar),
|
||||
'a' => \round($this->cmp_astar),
|
||||
'b' => \round($this->cmp_bstar),
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the CSS representation of the color: lab(L a b) or lab(L a b / A)
|
||||
*/
|
||||
public function getCssColor(): string
|
||||
{
|
||||
$color = 'lab(' . $this->cmp_lstar . '% ' . $this->cmp_astar . ' ' . $this->cmp_bstar;
|
||||
if ($this->cmp_alpha < 1.0) {
|
||||
$color .= ' / ' . $this->cmp_alpha;
|
||||
}
|
||||
|
||||
return $color . ')';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color format used in Acrobat JavaScript.
|
||||
* NOTE: the alpha channel is omitted from this representation unless it is 0 = transparent
|
||||
*/
|
||||
public function getJsPdfColor(): string
|
||||
{
|
||||
if ($this->cmp_alpha === 0.0) {
|
||||
return '["T"]'; // transparent color
|
||||
}
|
||||
|
||||
$rgb = $this->toRgbArray();
|
||||
return \sprintf('["RGB",%F,%F,%F]', $rgb['red'] ?? 0.0, $rgb['green'] ?? 0.0, $rgb['blue'] ?? 0.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a space separated string with Lab component values.
|
||||
*/
|
||||
public function getComponentsString(): string
|
||||
{
|
||||
return \sprintf('%F %F %F', $this->cmp_lstar, $this->cmp_astar, $this->cmp_bstar);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color components format used in PDF documents (RGB)
|
||||
* NOTE: the alpha channel is omitted.
|
||||
*
|
||||
* @param bool $stroke True for stroking (lines, drawing) and false for non-stroking (text and area filling).
|
||||
*/
|
||||
public function getPdfColor(bool $stroke = false): string
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->getPdfColor($stroke);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Gray color components
|
||||
*
|
||||
* @return array<string, float> with keys ('gray', 'alpha')
|
||||
*/
|
||||
public function toGrayArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toGrayArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with RGB color components
|
||||
*
|
||||
* @return array<string, float> with keys ('red', 'green', 'blue', 'alpha')
|
||||
*/
|
||||
public function toRgbArray(): array
|
||||
{
|
||||
$fyn = ($this->cmp_lstar + 16.0) / 116.0;
|
||||
$fxn = $fyn + ($this->cmp_astar / 500.0);
|
||||
$fzn = $fyn - ($this->cmp_bstar / 200.0);
|
||||
|
||||
$xRel = $this->pivotLabToXyz($fxn);
|
||||
$yRel = (float) (
|
||||
$this->cmp_lstar > 8.0 ? \pow(($this->cmp_lstar + 16.0) / 116.0, 3.0) : $this->cmp_lstar / 903.3
|
||||
);
|
||||
$zRel = $this->pivotLabToXyz($fzn);
|
||||
|
||||
$xTri = ($xRel * 95.047) / 100.0;
|
||||
$yTri = ($yRel * 100.000) / 100.0;
|
||||
$zTri = ($zRel * 108.883) / 100.0;
|
||||
|
||||
$red = (3.240_454_2 * $xTri) + (-1.537_138_5 * $yTri) + (-0.498_531_4 * $zTri);
|
||||
$green = (-0.969_266_0 * $xTri) + (1.876_010_8 * $yTri) + (0.041_556_0 * $zTri);
|
||||
$blue = (0.055_643_4 * $xTri) + (-0.204_025_9 * $yTri) + (1.057_225_2 * $zTri);
|
||||
|
||||
return [
|
||||
'red' => \max(0.0, \min(1.0, $this->linearToSrgb($red))),
|
||||
'green' => \max(0.0, \min(1.0, $this->linearToSrgb($green))),
|
||||
'blue' => \max(0.0, \min(1.0, $this->linearToSrgb($blue))),
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with HSL color components
|
||||
*
|
||||
* @return array<string, float> with keys ('hue', 'saturation', 'lightness', 'alpha')
|
||||
*/
|
||||
public function toHslArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toHslArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with CMYK color components
|
||||
*
|
||||
* @return array<string, float> with keys ('cyan', 'magenta', 'yellow', 'key', 'alpha')
|
||||
*/
|
||||
public function toCmykArray(): array
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
return $rgb->toCmykArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Lab color components
|
||||
*
|
||||
* @return array<string, float> with keys ('lstar', 'astar', 'bstar', 'alpha')
|
||||
*/
|
||||
public function toLabArray(): array
|
||||
{
|
||||
return [
|
||||
'lstar' => $this->cmp_lstar,
|
||||
'astar' => $this->cmp_astar,
|
||||
'bstar' => $this->cmp_bstar,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Invert the color.
|
||||
*/
|
||||
public function invertColor(): self
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb($this->toRgbArray());
|
||||
$rgb->invertColor();
|
||||
$lab = new self($rgb->toLabArray());
|
||||
$this->cmp_lstar = $lab->cmp_lstar;
|
||||
$this->cmp_astar = $lab->cmp_astar;
|
||||
$this->cmp_bstar = $lab->cmp_bstar;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply the CIE Lab inverse pivot function.
|
||||
*/
|
||||
private function pivotLabToXyz(float $value): float
|
||||
{
|
||||
$cubed = (float) \pow($value, 3.0);
|
||||
if ($cubed > 0.008_856_451_679_035_631) {
|
||||
return $cubed;
|
||||
}
|
||||
|
||||
return ($value - (16.0 / 116.0)) / 7.787_037_037_037_037;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert linear RGB component to sRGB in [0..1].
|
||||
*/
|
||||
private function linearToSrgb(float $component): float
|
||||
{
|
||||
if ($component <= 0.003_130_8) {
|
||||
return 12.92 * $component;
|
||||
}
|
||||
|
||||
return (1.055 * (float) \pow($component, 1.0 / 2.4)) - 0.055;
|
||||
}
|
||||
}
|
||||
+358
@@ -0,0 +1,358 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Rgb.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color\Model;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Model\Rgb
|
||||
*
|
||||
* RGB Color Model class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class Rgb extends \Com\Tecnick\Color\Model
|
||||
{
|
||||
/**
|
||||
* Color Model type
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $type = 'RGB';
|
||||
|
||||
/**
|
||||
* Value of the Red color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_red = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Green color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_green = 0.0;
|
||||
|
||||
/**
|
||||
* Value of the Blue color component [0..1]
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $cmp_blue = 0.0;
|
||||
|
||||
/**
|
||||
* Get an array with all color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('R', 'G', 'B', 'A')
|
||||
*/
|
||||
public function getArray(): array
|
||||
{
|
||||
return [
|
||||
'R' => $this->cmp_red,
|
||||
'G' => $this->cmp_green,
|
||||
'B' => $this->cmp_blue,
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with all color components for
|
||||
* the PDF appearance characteristics dictionary.
|
||||
*
|
||||
* The numbers that shall be in the range 0.0 to 1.0.
|
||||
* The number of array elements determines the colour space
|
||||
* in which the colour shall be defined:
|
||||
* 3 = DeviceRGB
|
||||
*
|
||||
* @return array<float> DeviceRGB color components ('R', 'G', 'B')
|
||||
*/
|
||||
public function getPDFacArray(): array
|
||||
{
|
||||
return [
|
||||
$this->cmp_red,
|
||||
$this->cmp_green,
|
||||
$this->cmp_blue,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with color components values normalized between 0 and $max.
|
||||
* NOTE: the alpha and other fraction component values are kept in the [0..1] range.
|
||||
*
|
||||
* @param int $max Maximum value to return (reference value)
|
||||
*
|
||||
* @return array<string, float> with keys ('R', 'G', 'B', 'A')
|
||||
*/
|
||||
public function getNormalizedArray(int $max): array
|
||||
{
|
||||
return [
|
||||
'R' => $this->getNormalizedValue($this->cmp_red, $max),
|
||||
'G' => $this->getNormalizedValue($this->cmp_green, $max),
|
||||
'B' => $this->getNormalizedValue($this->cmp_blue, $max),
|
||||
'A' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the CSS representation of the color: rgb(R, G, B) or rgba(R, G, B, A)
|
||||
*/
|
||||
public function getCssColor(): string
|
||||
{
|
||||
$colorType = 'rgb';
|
||||
$alpha = '';
|
||||
if ($this->cmp_alpha < 1.0) {
|
||||
$colorType = 'rgba';
|
||||
$alpha = ',' . $this->cmp_alpha;
|
||||
}
|
||||
|
||||
return (
|
||||
$colorType
|
||||
. '('
|
||||
. $this->getNormalizedValue($this->cmp_red, 100)
|
||||
. '%,'
|
||||
. $this->getNormalizedValue($this->cmp_green, 100)
|
||||
. '%,'
|
||||
. $this->getNormalizedValue($this->cmp_blue, 100)
|
||||
. '%'
|
||||
. $alpha
|
||||
. ')'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color format used in Acrobat JavaScript
|
||||
* NOTE: the alpha channel is omitted from this representation unless it is 0 = transparent
|
||||
*/
|
||||
public function getJsPdfColor(): string
|
||||
{
|
||||
if ($this->cmp_alpha === 0.0) {
|
||||
return '["T"]'; // transparent color
|
||||
}
|
||||
|
||||
return \sprintf('["RGB",%F,%F,%F]', $this->cmp_red, $this->cmp_green, $this->cmp_blue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a space separated string with color component values.
|
||||
*/
|
||||
public function getComponentsString(): string
|
||||
{
|
||||
return \sprintf('%F %F %F', $this->cmp_red, $this->cmp_green, $this->cmp_blue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color components format used in PDF documents (RGB)
|
||||
* NOTE: the alpha channel is omitted
|
||||
*
|
||||
* @param bool $stroke True for stroking (lines, drawing) and false for non-stroking (text and area filling).
|
||||
*/
|
||||
public function getPdfColor(bool $stroke = false): string
|
||||
{
|
||||
$mode = 'rg';
|
||||
if ($stroke) {
|
||||
$mode = \strtoupper($mode);
|
||||
}
|
||||
|
||||
return $this->getComponentsString() . ' ' . $mode . "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Gray color components
|
||||
*
|
||||
* @return array<string, float> with keys ('gray', 'alpha')
|
||||
*/
|
||||
public function toGrayArray(): array
|
||||
{
|
||||
// convert using the ITU-R BT.709 (Rec. 709) luma coefficients
|
||||
return [
|
||||
'gray' => \max(0, \min(
|
||||
1,
|
||||
(0.2126 * $this->cmp_red) + (0.7152 * $this->cmp_green) + (0.0722 * $this->cmp_blue),
|
||||
)),
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with RGB color components
|
||||
*
|
||||
* @return array<string, float> with keys ('red', 'green', 'blue', 'alpha')
|
||||
*/
|
||||
public function toRgbArray(): array
|
||||
{
|
||||
return [
|
||||
'red' => $this->cmp_red,
|
||||
'green' => $this->cmp_green,
|
||||
'blue' => $this->cmp_blue,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with HSL color components
|
||||
*
|
||||
* @return array<string, float> with keys ('hue', 'saturation', 'lightness', 'alpha')
|
||||
*/
|
||||
public function toHslArray(): array
|
||||
{
|
||||
$min = \min($this->cmp_red, $this->cmp_green, $this->cmp_blue);
|
||||
$max = \max($this->cmp_red, $this->cmp_green, $this->cmp_blue);
|
||||
$lightness = ($min + $max) / 2;
|
||||
$saturation = 0;
|
||||
$hue = 0;
|
||||
if ($min !== $max) {
|
||||
$diff = $max - $min;
|
||||
$saturation = $lightness < 0.5 ? $diff / ($max + $min) : $diff / (2.0 - $max - $min);
|
||||
|
||||
switch ($max) {
|
||||
case $this->cmp_red:
|
||||
$dgb = $this->cmp_green - $this->cmp_blue;
|
||||
$hue = ($dgb / $diff) + ($dgb < 0 ? 6 : 0);
|
||||
break;
|
||||
case $this->cmp_green:
|
||||
$hue = 2.0 + (($this->cmp_blue - $this->cmp_red) / $diff);
|
||||
break;
|
||||
case $this->cmp_blue:
|
||||
$hue = 4.0 + (($this->cmp_red - $this->cmp_green) / $diff);
|
||||
break;
|
||||
}
|
||||
|
||||
$hue /= 6; // 6 = 360 / 60
|
||||
}
|
||||
|
||||
return [
|
||||
'hue' => \max(0, \min(1, $hue)),
|
||||
'saturation' => \max(0, \min(1, $saturation)),
|
||||
'lightness' => \max(0, \min(1, $lightness)),
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with CMYK color components
|
||||
*
|
||||
* @return array<string, float> with keys ('cyan', 'magenta', 'yellow', 'key', 'alpha')
|
||||
*/
|
||||
public function toCmykArray(): array
|
||||
{
|
||||
$cyan = 1 - $this->cmp_red;
|
||||
$magenta = 1 - $this->cmp_green;
|
||||
$yellow = 1 - $this->cmp_blue;
|
||||
$key = 1.0;
|
||||
if ($cyan < $key) {
|
||||
$key = $cyan;
|
||||
}
|
||||
|
||||
if ($magenta < $key) {
|
||||
$key = $magenta;
|
||||
}
|
||||
|
||||
if ($yellow < $key) {
|
||||
$key = $yellow;
|
||||
}
|
||||
|
||||
if ($key === 1.0) {
|
||||
// black
|
||||
$cyan = 0;
|
||||
$magenta = 0;
|
||||
$yellow = 0;
|
||||
}
|
||||
|
||||
if ($key < 1.0) {
|
||||
$cyan = ($cyan - $key) / (1 - $key);
|
||||
$magenta = ($magenta - $key) / (1 - $key);
|
||||
$yellow = ($yellow - $key) / (1 - $key);
|
||||
}
|
||||
|
||||
return [
|
||||
'cyan' => \max(0, \min(1, $cyan)),
|
||||
'magenta' => \max(0, \min(1, $magenta)),
|
||||
'yellow' => \max(0, \min(1, $yellow)),
|
||||
'key' => \max(0, \min(1, $key)),
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array with Lab color components
|
||||
*
|
||||
* @return array<string, float> with keys ('lstar', 'astar', 'bstar', 'alpha')
|
||||
*/
|
||||
public function toLabArray(): array
|
||||
{
|
||||
$red = $this->srgbToLinear($this->cmp_red);
|
||||
$green = $this->srgbToLinear($this->cmp_green);
|
||||
$blue = $this->srgbToLinear($this->cmp_blue);
|
||||
|
||||
$xTri = ((0.412_456_4 * $red) + (0.357_576_1 * $green) + (0.180_437_5 * $blue)) * 100.0;
|
||||
$yTri = ((0.212_672_9 * $red) + (0.715_152_2 * $green) + (0.072_175_0 * $blue)) * 100.0;
|
||||
$zTri = ((0.019_333_9 * $red) + (0.119_192_0 * $green) + (0.950_304_1 * $blue)) * 100.0;
|
||||
|
||||
$fxn = $this->pivotXyzToLab($xTri / 95.047);
|
||||
$fyn = $this->pivotXyzToLab($yTri / 100.000);
|
||||
$fzn = $this->pivotXyzToLab($zTri / 108.883);
|
||||
|
||||
return [
|
||||
'lstar' => \max(0.0, \min(100.0, (116.0 * $fyn) - 16.0)),
|
||||
'astar' => \max(-128.0, \min(127.0, 500.0 * ($fxn - $fyn))),
|
||||
'bstar' => \max(-128.0, \min(127.0, 200.0 * ($fyn - $fzn))),
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert sRGB component in [0..1] to linear RGB.
|
||||
*/
|
||||
private function srgbToLinear(float $component): float
|
||||
{
|
||||
if ($component <= 0.040_45) {
|
||||
return $component / 12.92;
|
||||
}
|
||||
|
||||
return (float) \pow(($component + 0.055) / 1.055, 2.4);
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply the CIE Lab forward pivot function.
|
||||
*/
|
||||
private function pivotXyzToLab(float $value): float
|
||||
{
|
||||
if ($value > 0.008_856_451_679_035_631) {
|
||||
return (float) \pow($value, 1.0 / 3.0);
|
||||
}
|
||||
|
||||
return (7.787_037_037_037_037 * $value) + (16.0 / 116.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Invert the color
|
||||
*/
|
||||
public function invertColor(): self
|
||||
{
|
||||
$this->cmp_red = 1 - $this->cmp_red;
|
||||
$this->cmp_green = 1 - $this->cmp_green;
|
||||
$this->cmp_blue = 1 - $this->cmp_blue;
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Template.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color\Model;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Model\Template
|
||||
*
|
||||
* Color Model Interface
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
interface Template
|
||||
{
|
||||
/**
|
||||
* Get an array with all color components.
|
||||
*
|
||||
* @return array<string, float>
|
||||
*/
|
||||
public function getArray(): array;
|
||||
|
||||
/**
|
||||
* Get an array with all color components for
|
||||
* the PDF appearance characteristics dictionary.
|
||||
*
|
||||
* The numbers that shall be in the range 0.0 to 1.0.
|
||||
* The number of array elements determines the colour space
|
||||
* in which the colour shall be defined:
|
||||
* 0 = No colour; transparent
|
||||
* 1 = DeviceGray
|
||||
* 3 = DeviceRGB
|
||||
* 4 = DeviceCMYK
|
||||
*
|
||||
* @return array<float>
|
||||
*/
|
||||
public function getPDFacArray(): array;
|
||||
|
||||
/**
|
||||
* Get an array with color components values normalized between 0 and $max.
|
||||
* NOTE: the alpha and other fraction component values are kept in the [0..1] range.
|
||||
*
|
||||
* @param int $max Maximum value to return (reference value)
|
||||
*
|
||||
* @return array<string, float>
|
||||
*/
|
||||
public function getNormalizedArray(int $max): array;
|
||||
|
||||
/**
|
||||
* Get the CSS representation of the color
|
||||
*/
|
||||
public function getCssColor(): string;
|
||||
|
||||
/**
|
||||
* Get the color format used in Acrobat JavaScript.
|
||||
* NOTE: the alpha channel is omitted from this representation unless it is 0 = transparent
|
||||
*/
|
||||
public function getJsPdfColor(): string;
|
||||
|
||||
/**
|
||||
* Get a space separated string with color component values.
|
||||
*/
|
||||
public function getComponentsString(): string;
|
||||
|
||||
/**
|
||||
* Get the color components format used in PDF documents (RGB).
|
||||
* NOTE: the alpha channel is omitted.
|
||||
*
|
||||
* @param bool $stroke True for stroking (lines, drawing) and false for non-stroking (text and area filling).
|
||||
*/
|
||||
public function getPdfColor(bool $stroke = false): string;
|
||||
|
||||
/**
|
||||
* Get an array with Gray color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('gray', 'alpha').
|
||||
*/
|
||||
public function toGrayArray(): array;
|
||||
|
||||
/**
|
||||
* Get an array with RGB color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('red', 'green', 'blue', 'alpha').
|
||||
*/
|
||||
public function toRgbArray(): array;
|
||||
|
||||
/**
|
||||
* Get an array with HSL color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('hue', 'saturation', 'lightness', 'alpha').
|
||||
*/
|
||||
public function toHslArray(): array;
|
||||
|
||||
/**
|
||||
* Get an array with CMYK color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('cyan', 'magenta', 'yellow', 'key', 'alpha').
|
||||
*/
|
||||
public function toCmykArray(): array;
|
||||
|
||||
/**
|
||||
* Get an array with Lab color components.
|
||||
*
|
||||
* @return array<string, float> with keys ('lstar', 'astar', 'bstar', 'alpha').
|
||||
*/
|
||||
public function toLabArray(): array;
|
||||
|
||||
/**
|
||||
* Invert the color.
|
||||
*/
|
||||
public function invertColor(): self;
|
||||
}
|
||||
+199
@@ -0,0 +1,199 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Pdf.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color;
|
||||
|
||||
use Com\Tecnick\Color\Exception as ColorException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Pdf
|
||||
*
|
||||
* PDF Color class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class Pdf extends \Com\Tecnick\Color\Spot
|
||||
{
|
||||
/**
|
||||
* Array of valid JavaScript color names to be used in PDF documents
|
||||
*/
|
||||
public const JSCOLOR = [
|
||||
'transparent',
|
||||
'black',
|
||||
'white',
|
||||
'red',
|
||||
'green',
|
||||
'blue',
|
||||
'cyan',
|
||||
'magenta',
|
||||
'yellow',
|
||||
'dkGray',
|
||||
'gray',
|
||||
'ltGray',
|
||||
];
|
||||
|
||||
/**
|
||||
* Convert color to javascript string
|
||||
*
|
||||
* @param string $color color name or color object
|
||||
*/
|
||||
public function getJsColorString(string $color): string
|
||||
{
|
||||
if (\in_array($color, self::JSCOLOR, strict: true)) {
|
||||
return 'color.' . $color;
|
||||
}
|
||||
|
||||
try {
|
||||
if (($colobj = $this->getColorObj($color)) instanceof \Com\Tecnick\Color\Model) {
|
||||
return $colobj->getJsPdfColor();
|
||||
}
|
||||
} catch (ColorException $colorException) {
|
||||
unset($colorException);
|
||||
}
|
||||
|
||||
// default transparent color
|
||||
return 'color.' . self::JSCOLOR[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a color object from an HTML, CSS or Spot color representation.
|
||||
*
|
||||
* NOTE: this is a read-only lookup. A spot color referenced here is resolved
|
||||
* but NOT registered, so it does not affect the output of
|
||||
* getPdfSpotObjects()/getPdfSpotResources(). Use getPdfColor() (or
|
||||
* addSpotColor()) to actually register a spot color for emission.
|
||||
*
|
||||
* @param string $color HTML, CSS or Spot color to parse
|
||||
*/
|
||||
public function getColorObject(string $color): ?\Com\Tecnick\Color\Model
|
||||
{
|
||||
try {
|
||||
return $this->resolveSpotColorData($color)['color'];
|
||||
} catch (ColorException $colorException) {
|
||||
unset($colorException);
|
||||
}
|
||||
|
||||
try {
|
||||
return $this->getColorObj($color);
|
||||
} catch (ColorException $colorException) {
|
||||
unset($colorException);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color components format used in PDF documents
|
||||
* NOTE: the alpha channel is omitted
|
||||
*
|
||||
* @param string $color HTML, CSS or Spot color to parse
|
||||
* @param bool $stroke True for stroking (lines, drawing) and false for non-stroking (text and area filling).
|
||||
* @param float $tint Intensity of the color (from 0 to 1; 1 = full intensity).
|
||||
*/
|
||||
public function getPdfColor(string $color, bool $stroke = false, float $tint = 1): string
|
||||
{
|
||||
try {
|
||||
$col = $this->getSpotColor($color);
|
||||
$tint = \sprintf('cs %F scn', \max(0, \min(1, $tint)));
|
||||
if ($stroke) {
|
||||
$tint = \strtoupper($tint);
|
||||
}
|
||||
|
||||
return \sprintf('/CS%d %s' . "\n", $col['i'], $tint);
|
||||
} catch (ColorException $colorException) {
|
||||
unset($colorException);
|
||||
}
|
||||
|
||||
try {
|
||||
$col = $this->getColorObj($color);
|
||||
if ($col instanceof \Com\Tecnick\Color\Model) {
|
||||
return $col->getPdfColor($stroke);
|
||||
}
|
||||
} catch (ColorException $colorException) {
|
||||
unset($colorException);
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the stroked color components format used in PDF documents.
|
||||
*
|
||||
* @param string $color HTML, CSS or Spot color to parse
|
||||
* @param float $tint Intensity of the color (from 0 to 1; 1 = full intensity).
|
||||
*/
|
||||
public function getPdfStrokeColor(string $color, float $tint = 1): string
|
||||
{
|
||||
return $this->getPdfColor($color, true, $tint);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the fill color components format used in PDF documents.
|
||||
*
|
||||
* @param string $color HTML, CSS or Spot color to parse
|
||||
* @param float $tint Intensity of the color (from 0 to 1; 1 = full intensity).
|
||||
*/
|
||||
public function getPdfFillColor(string $color, float $tint = 1): string
|
||||
{
|
||||
return $this->getPdfColor($color, false, $tint);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the RGB color components format used in PDF documents
|
||||
*
|
||||
* @param string $color HTML, CSS or Spot color to parse
|
||||
*/
|
||||
public function getPdfRgbComponents(string $color): string
|
||||
{
|
||||
$model = $this->getColorObject($color);
|
||||
if (!$model instanceof \Com\Tecnick\Color\Model) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$cmp = $model->toRgbArray();
|
||||
return \sprintf('%F %F %F', $cmp['red'] ?? 0.0, $cmp['green'] ?? 0.0, $cmp['blue'] ?? 0.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the CMYK color components format used in PDF documents.
|
||||
*
|
||||
* @param string $color HTML, CSS or Spot color to parse
|
||||
*/
|
||||
public function getPdfCmykComponents(string $color): string
|
||||
{
|
||||
$model = $this->getColorObject($color);
|
||||
if (!$model instanceof \Com\Tecnick\Color\Model) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$cmp = $model->toCmykArray();
|
||||
return \sprintf(
|
||||
'%F %F %F %F',
|
||||
$cmp['cyan'] ?? 0.0,
|
||||
$cmp['magenta'] ?? 0.0,
|
||||
$cmp['yellow'] ?? 0.0,
|
||||
$cmp['key'] ?? 0.0,
|
||||
);
|
||||
}
|
||||
}
|
||||
+655
@@ -0,0 +1,655 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Spot.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color;
|
||||
|
||||
use Com\Tecnick\Color\Exception as ColorException;
|
||||
use Com\Tecnick\Color\Model\Cmyk;
|
||||
use Com\Tecnick\Color\Model\Lab;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Spot
|
||||
*
|
||||
* Spot Color class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* @phpstan-type TLabTriplet array{0: float, 1: float, 2: float}
|
||||
* @phpstan-type TLabRange array{0: float, 1: float, 2: float, 3: float}
|
||||
* @phpstan-type TSpotColor array{
|
||||
* 'i': int,
|
||||
* 'n': int,
|
||||
* 'name': string,
|
||||
* 'color': Cmyk,
|
||||
* 'space': 'DeviceCMYK'|'Lab',
|
||||
* 'lab': array{
|
||||
* 'whitepoint': TLabTriplet,
|
||||
* 'blackpoint': TLabTriplet,
|
||||
* 'range': TLabRange,
|
||||
* 'c0': TLabTriplet,
|
||||
* 'model': Lab,
|
||||
* }|null,
|
||||
* }
|
||||
*/
|
||||
class Spot extends \Com\Tecnick\Color\Web
|
||||
{
|
||||
/**
|
||||
* Array of default Spot colors
|
||||
* Color keys must be in lowercase and without spaces.
|
||||
*
|
||||
* @var array<string, array{
|
||||
* 'name': string,
|
||||
* 'color': array{
|
||||
* 'cyan': int|float,
|
||||
* 'magenta': int|float,
|
||||
* 'yellow': int|float,
|
||||
* 'key': int|float,
|
||||
* 'alpha': int|float,
|
||||
* }
|
||||
* }>
|
||||
*/
|
||||
public const DEFAULT_SPOT_COLORS = [
|
||||
'none' => [
|
||||
'name' => 'None',
|
||||
'color' => [
|
||||
'cyan' => 0,
|
||||
'magenta' => 0,
|
||||
'yellow' => 0,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'all' => [
|
||||
'name' => 'All',
|
||||
'color' => [
|
||||
'cyan' => 1,
|
||||
'magenta' => 1,
|
||||
'yellow' => 1,
|
||||
'key' => 1,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'cyan' => [
|
||||
'name' => 'Cyan',
|
||||
'color' => [
|
||||
'cyan' => 1,
|
||||
'magenta' => 0,
|
||||
'yellow' => 0,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'magenta' => [
|
||||
'name' => 'Magenta',
|
||||
'color' => [
|
||||
'cyan' => 0,
|
||||
'magenta' => 1,
|
||||
'yellow' => 0,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'yellow' => [
|
||||
'name' => 'Yellow',
|
||||
'color' => [
|
||||
'cyan' => 0,
|
||||
'magenta' => 0,
|
||||
'yellow' => 1,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'key' => [
|
||||
'name' => 'Key',
|
||||
'color' => [
|
||||
'cyan' => 0,
|
||||
'magenta' => 0,
|
||||
'yellow' => 0,
|
||||
'key' => 1,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'white' => [
|
||||
'name' => 'White',
|
||||
'color' => [
|
||||
'cyan' => 0,
|
||||
'magenta' => 0,
|
||||
'yellow' => 0,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'black' => [
|
||||
'name' => 'Black',
|
||||
'color' => [
|
||||
'cyan' => 0,
|
||||
'magenta' => 0,
|
||||
'yellow' => 0,
|
||||
'key' => 1,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'red' => [
|
||||
'name' => 'Red',
|
||||
'color' => [
|
||||
'cyan' => 0,
|
||||
'magenta' => 1,
|
||||
'yellow' => 1,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'green' => [
|
||||
'name' => 'Green',
|
||||
'color' => [
|
||||
'cyan' => 1,
|
||||
'magenta' => 0,
|
||||
'yellow' => 1,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
'blue' => [
|
||||
'name' => 'Blue',
|
||||
'color' => [
|
||||
'cyan' => 1,
|
||||
'magenta' => 1,
|
||||
'yellow' => 0,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* Array of Spot colors
|
||||
*
|
||||
* @var array<string, TSpotColor>
|
||||
*/
|
||||
protected array $spot_colors = [];
|
||||
|
||||
/**
|
||||
* Returns the array of spot colors.
|
||||
*
|
||||
* @return array<string, TSpotColor>
|
||||
*/
|
||||
public function getSpotColors(): array
|
||||
{
|
||||
return $this->spot_colors;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the normalized case-insensitive version of the spot color name to be used as key.
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
*/
|
||||
public function normalizeSpotColorName(string $name): string
|
||||
{
|
||||
$ret = \preg_replace('/[^a-z0-9]+/', '', \strtolower($name));
|
||||
return $ret ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode a spot color name as a PDF name object.
|
||||
*
|
||||
* The original name is preserved as-is, including spaces and uppercase
|
||||
* letters. Any byte that is not a regular PDF name character is escaped
|
||||
* using the "#" followed by a 2-digit uppercase hexadecimal code, as
|
||||
* required by the PDF name object syntax (ISO 32000-1:2008, 7.3.5).
|
||||
* For example "SPOTTYPE 279 C" becomes "SPOTTYPE#20279#20C".
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
*/
|
||||
public function encodeSpotColorName(string $name): string
|
||||
{
|
||||
$out = '';
|
||||
$len = \strlen($name);
|
||||
for ($i = 0; $i < $len; ++$i) {
|
||||
$char = $name[$i];
|
||||
$ord = \ord($char);
|
||||
// Regular characters are printable ASCII (0x21-0x7E),
|
||||
// excluding the number sign and the PDF delimiters.
|
||||
if ($ord < 0x21 || $ord > 0x7E || $char === '#' || \str_contains('()<>[]{}/%', $char)) {
|
||||
$out .= \sprintf('#%02X', $ord);
|
||||
continue;
|
||||
}
|
||||
|
||||
$out .= $char;
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the requested spot color data array, registering it on first use.
|
||||
*
|
||||
* If the name matches a default spot color that is not yet registered, it is
|
||||
* added to the internal registry so that it is emitted by
|
||||
* getPdfSpotObjects()/getPdfSpotResources(). Use resolveSpotColorData() for a
|
||||
* side-effect-free lookup.
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
*
|
||||
* @return TSpotColor
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
public function getSpotColor(string $name): array
|
||||
{
|
||||
$key = $this->normalizeSpotColorName($name);
|
||||
if (!\array_key_exists($key, $this->spot_colors)) {
|
||||
// resolve a default spot color and register it on first use
|
||||
$this->spot_colors[$key] = $this->resolveSpotColorData($name);
|
||||
}
|
||||
|
||||
return $this->spot_colors[$key];
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the requested spot color data array WITHOUT registering it.
|
||||
*
|
||||
* Returns the already-registered spot color if present, otherwise builds a
|
||||
* transient entry from the default spot colors. Unlike getSpotColor(), this
|
||||
* has no side effect on the internal registry and therefore does not alter
|
||||
* the output of getPdfSpotObjects()/getPdfSpotResources(). It backs the
|
||||
* read-only color accessors.
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
*
|
||||
* @return TSpotColor
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
protected function resolveSpotColorData(string $name): array
|
||||
{
|
||||
$key = $this->normalizeSpotColorName($name);
|
||||
$spotColor = $this->spot_colors[$key] ?? null;
|
||||
if (\is_array($spotColor)) {
|
||||
return $spotColor;
|
||||
}
|
||||
|
||||
$defaultSpotColor = self::DEFAULT_SPOT_COLORS[$key] ?? null;
|
||||
if ($defaultSpotColor === null) {
|
||||
throw new ColorException('unable to find the spot color: ' . $key);
|
||||
}
|
||||
|
||||
return [
|
||||
'i' => \count($this->spot_colors) + 1, // color index
|
||||
'n' => 0, // PDF object number
|
||||
'name' => $defaultSpotColor['name'], // color name
|
||||
'color' => new Cmyk($defaultSpotColor['color']), // CMYK color object
|
||||
'space' => 'DeviceCMYK', // alternate color space in PDF Separation
|
||||
'lab' => null, // optional Lab metadata
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the requested spot color CMYK object.
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
public function getSpotColorObj(string $name): Cmyk
|
||||
{
|
||||
return $this->getSpotColor($name)['color'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the requested spot color Lab object.
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
public function getSpotLabColorObj(string $name): Lab
|
||||
{
|
||||
$spot = $this->getSpotColor($name);
|
||||
if (\is_array($spot['lab'])) {
|
||||
return $spot['lab']['model'];
|
||||
}
|
||||
|
||||
return new Lab($spot['color']->toLabArray());
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a new spot color or overwrite an existing one with the same name.
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
* @param Cmyk $cmyk CMYK color object
|
||||
*
|
||||
* @return string Spot color key.
|
||||
*/
|
||||
public function addSpotColor(string $name, Cmyk $cmyk): string
|
||||
{
|
||||
$key = $this->normalizeSpotColorName($name);
|
||||
$num = $this->spot_colors[$key]['i'] ?? (\count($this->spot_colors) + 1);
|
||||
|
||||
$this->spot_colors[$key] = [
|
||||
'i' => $num, // color index
|
||||
'n' => 0, // PDF object number
|
||||
'name' => $name, // color name (key)
|
||||
'color' => $cmyk, // CMYK color object
|
||||
'space' => 'DeviceCMYK', // alternate color space in PDF Separation
|
||||
'lab' => null, // optional Lab metadata
|
||||
];
|
||||
|
||||
return $key;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a new spot color from an array of CMYK components.
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
* @param array<string, int|float|string> $components CMYK components.
|
||||
*
|
||||
* @return string Spot color key.
|
||||
*/
|
||||
public function addSpotColorFromArray(string $name, array $components): string
|
||||
{
|
||||
return $this->addSpotColor($name, new Cmyk($components));
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a new Lab-based spot color or overwrite an existing one with the same name.
|
||||
*
|
||||
* The optional Lab settings are passed as separate trailing array arguments,
|
||||
* in this order: whitepoint, blackpoint, range, col0. For example:
|
||||
* addSpotLabColor('My Color', 50.0, 10.0, -20.0, $whitepoint, $blackpoint, $range, $col0);
|
||||
* Any omitted option falls back to its default (D65 whitepoint [0.9505, 1.0, 1.089],
|
||||
* zero blackpoint, [-128, 127, -128, 127] range, [100, 0, 0] col0).
|
||||
*
|
||||
* NOTE: the stored CMYK equivalent is an approximation computed from the Lab
|
||||
* values using the D65 whitepoint; the whitepoint option only affects the PDF
|
||||
* Lab color space metadata emitted by getPdfSpotObjects(), not the CMYK fallback.
|
||||
*
|
||||
* @param string $name Full name of the spot color.
|
||||
* @param float $lstar Lab L* component in [0..100].
|
||||
* @param float $astar Lab a* component.
|
||||
* @param float $bstar Lab b* component.
|
||||
* @param TLabTriplet|TLabRange ...$labOptions Optional Lab settings: whitepoint, blackpoint, range, col0.
|
||||
*
|
||||
* @return string Spot color key.
|
||||
*/
|
||||
public function addSpotLabColor(
|
||||
string $name,
|
||||
float $lstar,
|
||||
float $astar,
|
||||
float $bstar,
|
||||
array ...$labOptions,
|
||||
): string {
|
||||
$whitepoint = $this->resolveTripletOption($labOptions, 0, [0.9505, 1.0000, 1.0890]);
|
||||
$blackpoint = $this->resolveTripletOption($labOptions, 1, [0.0, 0.0, 0.0]);
|
||||
$range = $this->resolveRangeOption($labOptions, 2, [-128.0, 127.0, -128.0, 127.0]);
|
||||
$col0 = $this->resolveTripletOption($labOptions, 3, [100.0, 0.0, 0.0]);
|
||||
|
||||
$key = $this->normalizeSpotColorName($name);
|
||||
$num = $this->spot_colors[$key]['i'] ?? (\count($this->spot_colors) + 1);
|
||||
$labModel = $this->buildLabModel($lstar, $astar, $bstar, $range);
|
||||
|
||||
$this->spot_colors[$key] = [
|
||||
'i' => $num, // color index
|
||||
'n' => 0, // PDF object number
|
||||
'name' => $name, // color name (key)
|
||||
'color' => new Cmyk($labModel->toCmykArray()), // CMYK equivalent
|
||||
'space' => 'Lab', // alternate color space in PDF Separation
|
||||
'lab' => $this->buildLabMetadata($whitepoint, $blackpoint, $range, $col0, $labModel),
|
||||
];
|
||||
|
||||
return $key;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<array-key, TLabTriplet|TLabRange> $labOptions
|
||||
* @param TLabTriplet $default
|
||||
*
|
||||
* @return TLabTriplet
|
||||
*/
|
||||
private function resolveTripletOption(array $labOptions, int $index, array $default): array
|
||||
{
|
||||
$option = $labOptions[$index] ?? $default;
|
||||
return [
|
||||
$option[0] ?? $default[0],
|
||||
$option[1] ?? $default[1],
|
||||
$option[2] ?? $default[2],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<array-key, TLabTriplet|TLabRange> $labOptions
|
||||
* @param TLabRange $default
|
||||
*
|
||||
* @return TLabRange
|
||||
*/
|
||||
private function resolveRangeOption(array $labOptions, int $index, array $default): array
|
||||
{
|
||||
$option = $labOptions[$index] ?? $default;
|
||||
return [
|
||||
$option[0] ?? $default[0],
|
||||
$option[1] ?? $default[1],
|
||||
$option[2] ?? $default[2],
|
||||
$option[3] ?? $default[3],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param TLabRange $labRange
|
||||
*/
|
||||
private function buildLabModel(float $lstar, float $astar, float $bstar, array $labRange): Lab
|
||||
{
|
||||
return new Lab([
|
||||
'lstar' => \max(0.0, \min(100.0, $lstar)),
|
||||
'astar' => \max($labRange[0], \min($labRange[1], $astar)),
|
||||
'bstar' => \max($labRange[2], \min($labRange[3], $bstar)),
|
||||
'alpha' => 1.0,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param TLabTriplet $whitepoint
|
||||
* @param TLabTriplet $blackpoint
|
||||
* @param TLabRange $range
|
||||
* @param TLabTriplet $col0
|
||||
*
|
||||
* @return array{
|
||||
* whitepoint: TLabTriplet,
|
||||
* blackpoint: TLabTriplet,
|
||||
* range: TLabRange,
|
||||
* c0: TLabTriplet,
|
||||
* model: Lab
|
||||
* }
|
||||
*/
|
||||
private function buildLabMetadata(
|
||||
array $whitepoint,
|
||||
array $blackpoint,
|
||||
array $range,
|
||||
array $col0,
|
||||
Lab $labModel,
|
||||
): array {
|
||||
return [
|
||||
'whitepoint' => $whitepoint,
|
||||
'blackpoint' => $blackpoint,
|
||||
'range' => $range,
|
||||
'c0' => [
|
||||
\max(0.0, \min(100.0, $col0[0])),
|
||||
\max($range[0], \min($range[1], $col0[1])),
|
||||
\max($range[2], \min($range[3], $col0[2])),
|
||||
],
|
||||
'model' => $labModel,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a PDF-formatted numeric array.
|
||||
*
|
||||
* @param array<int, float> $values
|
||||
*/
|
||||
private function getPdfNumArray(array $values): string
|
||||
{
|
||||
$out = [];
|
||||
foreach ($values as $value) {
|
||||
$out[] = \sprintf('%F', $value);
|
||||
}
|
||||
|
||||
return '[' . \implode(' ', $out) . ']';
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the PDF command to output Spot color objects.
|
||||
*
|
||||
* @param int $pon Current PDF object number
|
||||
*
|
||||
* @return string PDF command
|
||||
*/
|
||||
public function getPdfSpotObjects(int &$pon): string
|
||||
{
|
||||
$out = '';
|
||||
foreach ($this->spot_colors as $key => $color) {
|
||||
if ($color['space'] === 'Lab' && \is_array($color['lab'])) {
|
||||
$out .= ++$pon . ' 0 obj' . "\n";
|
||||
$this->spot_colors[$key]['n'] = $pon;
|
||||
$lab = $color['lab']['model']->toLabArray();
|
||||
$out .=
|
||||
'[/Separation /'
|
||||
. $this->encodeSpotColorName($color['name'])
|
||||
. ' [/Lab <<'
|
||||
. ' /WhitePoint '
|
||||
. $this->getPdfNumArray($color['lab']['whitepoint'])
|
||||
. ' /BlackPoint '
|
||||
. $this->getPdfNumArray($color['lab']['blackpoint'])
|
||||
. ' /Range '
|
||||
. $this->getPdfNumArray($color['lab']['range'])
|
||||
. '>>] <<'
|
||||
. ' /FunctionType 2'
|
||||
. ' /Domain [0 1]'
|
||||
. ' /C0 '
|
||||
. $this->getPdfNumArray($color['lab']['c0'])
|
||||
. ' /C1 '
|
||||
. $this->getPdfNumArray([
|
||||
$lab['lstar'] ?? 0.0,
|
||||
$lab['astar'] ?? 0.0,
|
||||
$lab['bstar'] ?? 0.0,
|
||||
])
|
||||
. ' /N 1'
|
||||
. '>>]'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n";
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!$this->isCmykSpotColor($color['color'])) {
|
||||
// Skip entries that are neither valid Lab nor CMYK spot colors
|
||||
// without consuming a PDF object number or emitting a partial object.
|
||||
continue;
|
||||
}
|
||||
|
||||
$out .= ++$pon . ' 0 obj' . "\n";
|
||||
$this->spot_colors[$key]['n'] = $pon;
|
||||
$out .=
|
||||
'[/Separation /'
|
||||
. $this->encodeSpotColorName($color['name'])
|
||||
. ' /DeviceCMYK <<'
|
||||
. '/Range [0 1 0 1 0 1 0 1]'
|
||||
. ' /C0 [0 0 0 0]'
|
||||
. ' /C1 ['
|
||||
. $color['color']->getComponentsString()
|
||||
. ']'
|
||||
. ' /FunctionType 2'
|
||||
. ' /Domain [0 1]'
|
||||
. ' /N 1'
|
||||
. '>>]'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n";
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether a value is a CMYK color model.
|
||||
*/
|
||||
private function isCmykSpotColor(mixed $color): bool
|
||||
{
|
||||
return $color instanceof Cmyk;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the PDF command to output the provided Spot color resources.
|
||||
*
|
||||
* @param array<string, array{'i': int, 'n': int}|TSpotColor> $data Spot color array.
|
||||
*
|
||||
* @return string PDF command
|
||||
*/
|
||||
private function getOutPdfSpotResources(array $data): string
|
||||
{
|
||||
if ($data === []) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$out = '/ColorSpace <<';
|
||||
|
||||
foreach ($data as $spot_color) {
|
||||
$out .= ' /CS' . $spot_color['i'] . ' ' . $spot_color['n'] . ' 0 R';
|
||||
}
|
||||
|
||||
return $out . ' >>' . "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the PDF command to output Spot color resources.
|
||||
*
|
||||
* @return string PDF command
|
||||
*/
|
||||
public function getPdfSpotResources(): string
|
||||
{
|
||||
return $this->getOutPdfSpotResources($this->spot_colors);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the PDF command to output Spot color resources.
|
||||
*
|
||||
* @param array<string> $keys Array of font keys.
|
||||
*
|
||||
* @return string PDF command
|
||||
*/
|
||||
public function getPdfSpotResourcesByKeys(array $keys): string
|
||||
{
|
||||
if ($keys === []) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$data = [];
|
||||
foreach ($keys as $key) {
|
||||
if (!\array_key_exists($key, $this->spot_colors)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$data[$key] = $this->spot_colors[$key];
|
||||
}
|
||||
|
||||
return $this->getOutPdfSpotResources($data);
|
||||
}
|
||||
}
|
||||
+456
@@ -0,0 +1,456 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Web.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Color;
|
||||
|
||||
use Com\Tecnick\Color\Exception as ColorException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Color\Web
|
||||
*
|
||||
* Web Color class
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class Web extends \Com\Tecnick\Color\Css
|
||||
{
|
||||
/**
|
||||
* Maps WEB safe color names with their hexadecimal representation (#RRGGBBAA).
|
||||
*
|
||||
* @var array<string, string>
|
||||
*/
|
||||
public const WEBHEX = [
|
||||
'aliceblue' => 'f0f8ffff',
|
||||
'antiquewhite' => 'faebd7ff',
|
||||
'aqua' => '00ffffff',
|
||||
'aquamarine' => '7fffd4ff',
|
||||
'azure' => 'f0ffffff',
|
||||
'beige' => 'f5f5dcff',
|
||||
'bisque' => 'ffe4c4ff',
|
||||
'black' => '000000ff',
|
||||
'blanchedalmond' => 'ffebcdff',
|
||||
'blue' => '0000ffff',
|
||||
'blueviolet' => '8a2be2ff',
|
||||
'brown' => 'a52a2aff',
|
||||
'burlywood' => 'deb887ff',
|
||||
'cadetblue' => '5f9ea0ff',
|
||||
'chartreuse' => '7fff00ff',
|
||||
'chocolate' => 'd2691eff',
|
||||
'coral' => 'ff7f50ff',
|
||||
'cornflowerblue' => '6495edff',
|
||||
'cornsilk' => 'fff8dcff',
|
||||
'crimson' => 'dc143cff',
|
||||
'cyan' => '00ffffff',
|
||||
'darkblue' => '00008bff',
|
||||
'darkcyan' => '008b8bff',
|
||||
'darkgoldenrod' => 'b8860bff',
|
||||
'dkgray' => 'a9a9a9ff',
|
||||
'darkgray' => 'a9a9a9ff',
|
||||
'darkgrey' => 'a9a9a9ff',
|
||||
'darkgreen' => '006400ff',
|
||||
'darkkhaki' => 'bdb76bff',
|
||||
'darkmagenta' => '8b008bff',
|
||||
'darkolivegreen' => '556b2fff',
|
||||
'darkorange' => 'ff8c00ff',
|
||||
'darkorchid' => '9932ccff',
|
||||
'darkred' => '8b0000ff',
|
||||
'darksalmon' => 'e9967aff',
|
||||
'darkseagreen' => '8fbc8fff',
|
||||
'darkslateblue' => '483d8bff',
|
||||
'darkslategray' => '2f4f4fff',
|
||||
'darkslategrey' => '2f4f4fff',
|
||||
'darkturquoise' => '00ced1ff',
|
||||
'darkviolet' => '9400d3ff',
|
||||
'deeppink' => 'ff1493ff',
|
||||
'deepskyblue' => '00bfffff',
|
||||
'dimgray' => '696969ff',
|
||||
'dimgrey' => '696969ff',
|
||||
'dodgerblue' => '1e90ffff',
|
||||
'firebrick' => 'b22222ff',
|
||||
'floralwhite' => 'fffaf0ff',
|
||||
'forestgreen' => '228b22ff',
|
||||
'fuchsia' => 'ff00ffff',
|
||||
'gainsboro' => 'dcdcdcff',
|
||||
'ghostwhite' => 'f8f8ffff',
|
||||
'gold' => 'ffd700ff',
|
||||
'goldenrod' => 'daa520ff',
|
||||
'gray' => '808080ff',
|
||||
'grey' => '808080ff',
|
||||
'green' => '008000ff',
|
||||
'greenyellow' => 'adff2fff',
|
||||
'honeydew' => 'f0fff0ff',
|
||||
'hotpink' => 'ff69b4ff',
|
||||
'indianred' => 'cd5c5cff',
|
||||
'indigo' => '4b0082ff',
|
||||
'ivory' => 'fffff0ff',
|
||||
'khaki' => 'f0e68cff',
|
||||
'lavender' => 'e6e6faff',
|
||||
'lavenderblush' => 'fff0f5ff',
|
||||
'lawngreen' => '7cfc00ff',
|
||||
'lemonchiffon' => 'fffacdff',
|
||||
'lightblue' => 'add8e6ff',
|
||||
'lightcoral' => 'f08080ff',
|
||||
'lightcyan' => 'e0ffffff',
|
||||
'lightgoldenrodyellow' => 'fafad2ff',
|
||||
'ltgray' => 'd3d3d3ff',
|
||||
'lightgray' => 'd3d3d3ff',
|
||||
'lightgrey' => 'd3d3d3ff',
|
||||
'lightgreen' => '90ee90ff',
|
||||
'lightpink' => 'ffb6c1ff',
|
||||
'lightsalmon' => 'ffa07aff',
|
||||
'lightseagreen' => '20b2aaff',
|
||||
'lightskyblue' => '87cefaff',
|
||||
'lightslategray' => '778899ff',
|
||||
'lightslategrey' => '778899ff',
|
||||
'lightsteelblue' => 'b0c4deff',
|
||||
'lightyellow' => 'ffffe0ff',
|
||||
'lime' => '00ff00ff',
|
||||
'limegreen' => '32cd32ff',
|
||||
'linen' => 'faf0e6ff',
|
||||
'magenta' => 'ff00ffff',
|
||||
'maroon' => '800000ff',
|
||||
'mediumaquamarine' => '66cdaaff',
|
||||
'mediumblue' => '0000cdff',
|
||||
'mediumorchid' => 'ba55d3ff',
|
||||
'mediumpurple' => '9370d8ff',
|
||||
'mediumseagreen' => '3cb371ff',
|
||||
'mediumslateblue' => '7b68eeff',
|
||||
'mediumspringgreen' => '00fa9aff',
|
||||
'mediumturquoise' => '48d1ccff',
|
||||
'mediumvioletred' => 'c71585ff',
|
||||
'midnightblue' => '191970ff',
|
||||
'mintcream' => 'f5fffaff',
|
||||
'mistyrose' => 'ffe4e1ff',
|
||||
'moccasin' => 'ffe4b5ff',
|
||||
'navajowhite' => 'ffdeadff',
|
||||
'navy' => '000080ff',
|
||||
'oldlace' => 'fdf5e6ff',
|
||||
'olive' => '808000ff',
|
||||
'olivedrab' => '6b8e23ff',
|
||||
'orange' => 'ffa500ff',
|
||||
'orangered' => 'ff4500ff',
|
||||
'orchid' => 'da70d6ff',
|
||||
'palegoldenrod' => 'eee8aaff',
|
||||
'palegreen' => '98fb98ff',
|
||||
'paleturquoise' => 'afeeeeff',
|
||||
'palevioletred' => 'd87093ff',
|
||||
'papayawhip' => 'ffefd5ff',
|
||||
'peachpuff' => 'ffdab9ff',
|
||||
'peru' => 'cd853fff',
|
||||
'pink' => 'ffc0cbff',
|
||||
'plum' => 'dda0ddff',
|
||||
'powderblue' => 'b0e0e6ff',
|
||||
'purple' => '800080ff',
|
||||
'red' => 'ff0000ff',
|
||||
'rosybrown' => 'bc8f8fff',
|
||||
'royalblue' => '4169e1ff',
|
||||
'saddlebrown' => '8b4513ff',
|
||||
'salmon' => 'fa8072ff',
|
||||
'sandybrown' => 'f4a460ff',
|
||||
'seagreen' => '2e8b57ff',
|
||||
'seashell' => 'fff5eeff',
|
||||
'sienna' => 'a0522dff',
|
||||
'silver' => 'c0c0c0ff',
|
||||
'skyblue' => '87ceebff',
|
||||
'slateblue' => '6a5acdff',
|
||||
'slategray' => '708090ff',
|
||||
'slategrey' => '708090ff',
|
||||
'snow' => 'fffafaff',
|
||||
'springgreen' => '00ff7fff',
|
||||
'steelblue' => '4682b4ff',
|
||||
'tan' => 'd2b48cff',
|
||||
'teal' => '008080ff',
|
||||
'thistle' => 'd8bfd8ff',
|
||||
'tomato' => 'ff6347ff',
|
||||
'turquoise' => '40e0d0ff',
|
||||
'violet' => 'ee82eeff',
|
||||
'wheat' => 'f5deb3ff',
|
||||
'white' => 'ffffffff',
|
||||
'whitesmoke' => 'f5f5f5ff',
|
||||
'yellow' => 'ffff00ff',
|
||||
'yellowgreen' => '9acd32ff',
|
||||
];
|
||||
|
||||
/**
|
||||
* Get the color hexadecimal hash code from name
|
||||
*
|
||||
* @param string $name Name of the color to search (e.g.: 'turquoise')
|
||||
*
|
||||
* @return string color hexadecimal code (e.g.: '40e0d0ff')
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
public function getHexFromName(string $name): string
|
||||
{
|
||||
$name = \strtolower($name);
|
||||
if (($dotpos = \strpos($name, '.')) !== false) {
|
||||
// remove parent name (i.e.: color.green)
|
||||
$name = \substr($name, $dotpos + 1);
|
||||
}
|
||||
|
||||
$hex = self::WEBHEX[$name] ?? null;
|
||||
if (!\is_string($hex)) {
|
||||
throw new ColorException('unable to find the color hex for the name: ' . $name);
|
||||
}
|
||||
|
||||
return $hex;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the color name code from hexadecimal hash
|
||||
*
|
||||
* @param string $hex hexadecimal color hash (i.e. #RRGGBBAA)
|
||||
*
|
||||
* @return string color name
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
public function getNameFromHex(string $hex): string
|
||||
{
|
||||
$name = \array_search($this->extractHexCode($hex), self::WEBHEX, true);
|
||||
if (!\is_string($name)) {
|
||||
throw new ColorException('unable to find the color name for the hex code: ' . $hex);
|
||||
}
|
||||
|
||||
return $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the hexadecimal code from the input string and add the alpha channel if missing
|
||||
*
|
||||
* @param string $hex string containing the hexadecimal color hash (i.e. #RGB, #RGBA, #RRGGBB, #RRGGBBAA)
|
||||
*
|
||||
* @return string the hash code (e.g.: '40e0d0')
|
||||
*
|
||||
* @throws ColorException if the hash is not found or has an invalid format
|
||||
*/
|
||||
public function extractHexCode(string $hex): string
|
||||
{
|
||||
$match = [];
|
||||
if (\preg_match('/^[#]?([0-9a-f]{3,8})$/', \strtolower($hex), $match) !== 1) {
|
||||
throw new ColorException('unable to extract the color hash: ' . $hex);
|
||||
}
|
||||
|
||||
$hash = $match[1] ?? '';
|
||||
if (\strlen($hash) === 3 || \strlen($hash) === 4) {
|
||||
$hash = $this->expandHexHash($hash);
|
||||
}
|
||||
|
||||
if (\strlen($hash) === 6) {
|
||||
return $hash . 'ff';
|
||||
}
|
||||
|
||||
if (\strlen($hash) === 8) {
|
||||
return $hash;
|
||||
}
|
||||
|
||||
throw new ColorException('unable to extract the color hash: ' . $hash);
|
||||
}
|
||||
|
||||
/**
|
||||
* Expand shorthand hex digits (RGB/RGBA) to full-length form.
|
||||
*/
|
||||
private function expandHexHash(string $hash): string
|
||||
{
|
||||
$expanded = '';
|
||||
foreach (\str_split($hash) as $digit) {
|
||||
$expanded .= $digit . $digit;
|
||||
}
|
||||
|
||||
return $expanded;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the RGB color object from hexadecimal hash
|
||||
*
|
||||
* @param string $hex hexadecimal color hash (i.e. #RGB, #RGBA, #RRGGBB, #RRGGBBAA)
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
public function getRgbObjFromHex(string $hex): \Com\Tecnick\Color\Model\Rgb
|
||||
{
|
||||
return new \Com\Tecnick\Color\Model\Rgb($this->getHexArray($this->extractHexCode($hex)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the RGB color object from color name
|
||||
*
|
||||
* @param string $name Color name
|
||||
*
|
||||
* @return \Com\Tecnick\Color\Model\Rgb object
|
||||
*
|
||||
* @throws ColorException if the color is not found
|
||||
*/
|
||||
public function getRgbObjFromName(string $name): \Com\Tecnick\Color\Model\Rgb
|
||||
{
|
||||
return new \Com\Tecnick\Color\Model\Rgb($this->getHexArray($this->getHexFromName($name)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the RGB array from hexadecimal hash
|
||||
*
|
||||
* @param string $hex hexadecimal color hash (i.e. RRGGBBAA)
|
||||
*
|
||||
* @return array<string, float> with keys ('red', 'green', 'blue', 'alpha')
|
||||
*/
|
||||
private function getHexArray(string $hex): array
|
||||
{
|
||||
return [
|
||||
'red' => \hexdec(\substr($hex, 0, 2)) / 255,
|
||||
'green' => \hexdec(\substr($hex, 2, 2)) / 255,
|
||||
'blue' => \hexdec(\substr($hex, 4, 2)) / 255,
|
||||
'alpha' => \hexdec(\substr($hex, 6, 2)) / 255,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the normalized integer value from [0..$max] to [0..1]
|
||||
*
|
||||
* @param mixed $value Value to convert
|
||||
* @param int $max Max input value
|
||||
*
|
||||
* @return float value [0..1]
|
||||
*/
|
||||
public function normalizeValue(mixed $value, int $max): float
|
||||
{
|
||||
if (\is_string($value) && str_contains($value, '%')) {
|
||||
$percent = \str_replace('%', '', $value);
|
||||
if (!\is_numeric($percent)) {
|
||||
return 0.0;
|
||||
}
|
||||
|
||||
return \max(0, \min(1, (float) $percent / 100));
|
||||
}
|
||||
|
||||
if (\is_int($value) || \is_float($value)) {
|
||||
return \max(0, \min(1, (float) $value / $max));
|
||||
}
|
||||
|
||||
if (\is_string($value) && \is_numeric($value)) {
|
||||
return \max(0, \min(1, (float) $value / $max));
|
||||
}
|
||||
|
||||
return 0.0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse the input color string and return the corresponding color object
|
||||
*
|
||||
* @param string $color String containing web color definition
|
||||
*
|
||||
* @throws ColorException in case of error
|
||||
*/
|
||||
public function getColorObj(string $color): ?\Com\Tecnick\Color\Model
|
||||
{
|
||||
$col = [];
|
||||
$color = \strtolower(\trim($color));
|
||||
if ($color === '' || str_contains($color, 'transparent')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if ($color[0] === '#') {
|
||||
return $this->getRgbObjFromHex($color);
|
||||
}
|
||||
|
||||
if ($color[0] === '[') {
|
||||
return $this->getColorObjFromJs($color);
|
||||
}
|
||||
|
||||
$rex = '/^(t|g|rgba|rgb|hsla|hsl|cmyka|cmyk|lab)\s*[\(]/';
|
||||
if (\preg_match($rex, $color, $col) === 1) {
|
||||
return $this->getColorObjFromCss($col[1] ?? '', $color);
|
||||
}
|
||||
|
||||
return $this->getRgbObjFromName($color);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse the input color string and return the corresponding color object.
|
||||
*
|
||||
* @param string $color String containing web color definition
|
||||
*/
|
||||
public function tryGetColorObj(string $color): ?\Com\Tecnick\Color\Model
|
||||
{
|
||||
try {
|
||||
return $this->getColorObj($color);
|
||||
} catch (ColorException $colorException) {
|
||||
unset($colorException);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the square of the distance between 2 RGB points
|
||||
*
|
||||
* @param array<string, float> $cola First color as RGB array
|
||||
* @param array<string, float> $colb Second color as RGB array
|
||||
*/
|
||||
public function getRgbSquareDistance(array $cola, array $colb): float
|
||||
{
|
||||
return (
|
||||
(($cola['red'] ?? 0.0) - ($colb['red'] ?? 0.0)) ** 2
|
||||
+ (($cola['green'] ?? 0.0) - ($colb['green'] ?? 0.0)) ** 2
|
||||
+ (($cola['blue'] ?? 0.0) - ($colb['blue'] ?? 0.0)) ** 2
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the name of the closest web color
|
||||
*
|
||||
* @param array<string, float> $col Color as RGB array (keys: 'red', 'green', 'blue')
|
||||
*/
|
||||
public function getClosestWebColor(array $col): string
|
||||
{
|
||||
$color = '';
|
||||
// Seed above the maximum possible squared distance in the RGB unit cube
|
||||
// (1^2 + 1^2 + 1^2 = 3) and use a strict "<" so the nearest match is
|
||||
// always returned and ties resolve to the first (canonical) color name.
|
||||
$mindist = \PHP_FLOAT_MAX;
|
||||
foreach (self::WEBHEX as $name => $hex) {
|
||||
$dist = $this->getRgbSquareDistance($col, $this->getHexArray($hex));
|
||||
if ($dist < $mindist) {
|
||||
$mindist = $dist;
|
||||
$color = $name;
|
||||
}
|
||||
}
|
||||
|
||||
return $color;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the name of the closest web color from a color definition string.
|
||||
*
|
||||
* @param string $color String containing web color definition
|
||||
*/
|
||||
public function getClosestWebColorFromString(string $color): string
|
||||
{
|
||||
$obj = $this->tryGetColorObj($color);
|
||||
if (!$obj instanceof \Com\Tecnick\Color\Model) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return $this->getClosestWebColor($obj->toRgbArray());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,122 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* ColorModelTypeTest.php
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use Com\Tecnick\Color\ColorModelType;
|
||||
|
||||
/**
|
||||
* ColorModelType enum test
|
||||
*
|
||||
* @since 2026-07-17
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class ColorModelTypeTest extends TestUtil
|
||||
{
|
||||
public function testCaseBackingValues(): void
|
||||
{
|
||||
$this->assertEquals('GRAY', ColorModelType::Gray->value);
|
||||
$this->assertEquals('RGB', ColorModelType::Rgb->value);
|
||||
$this->assertEquals('HSL', ColorModelType::Hsl->value);
|
||||
$this->assertEquals('CMYK', ColorModelType::Cmyk->value);
|
||||
$this->assertEquals('LAB', ColorModelType::Lab->value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testFromLooseCanonical(): void
|
||||
{
|
||||
$this->assertSame(ColorModelType::Gray, ColorModelType::fromLoose('GRAY'));
|
||||
$this->assertSame(ColorModelType::Rgb, ColorModelType::fromLoose('RGB'));
|
||||
$this->assertSame(ColorModelType::Hsl, ColorModelType::fromLoose('HSL'));
|
||||
$this->assertSame(ColorModelType::Cmyk, ColorModelType::fromLoose('CMYK'));
|
||||
$this->assertSame(ColorModelType::Lab, ColorModelType::fromLoose('LAB'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testFromLooseIsCaseInsensitive(): void
|
||||
{
|
||||
$this->assertSame(ColorModelType::Gray, ColorModelType::fromLoose('gray'));
|
||||
$this->assertSame(ColorModelType::Rgb, ColorModelType::fromLoose('rgb'));
|
||||
$this->assertSame(ColorModelType::Hsl, ColorModelType::fromLoose('Hsl'));
|
||||
$this->assertSame(ColorModelType::Cmyk, ColorModelType::fromLoose('cmyk'));
|
||||
$this->assertSame(ColorModelType::Lab, ColorModelType::fromLoose('Lab'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testFromLoosePassesThroughEnumInstance(): void
|
||||
{
|
||||
$this->assertSame(ColorModelType::Cmyk, ColorModelType::fromLoose(ColorModelType::Cmyk));
|
||||
}
|
||||
|
||||
/**
|
||||
* Round-trip invariant: every case resolves back from its own backing value.
|
||||
*
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testFromLooseRoundTrip(): void
|
||||
{
|
||||
foreach (ColorModelType::cases() as $case) {
|
||||
$this->assertSame($case, ColorModelType::fromLoose($case->value));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testFromLooseUnknownThrows(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
ColorModelType::fromLoose('unknown');
|
||||
}
|
||||
|
||||
public function testGetTypeEnum(): void
|
||||
{
|
||||
$gray = new \Com\Tecnick\Color\Model\Gray([]);
|
||||
$this->assertSame(ColorModelType::Gray, $gray->getTypeEnum());
|
||||
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb([]);
|
||||
$this->assertSame(ColorModelType::Rgb, $rgb->getTypeEnum());
|
||||
|
||||
$hsl = new \Com\Tecnick\Color\Model\Hsl([]);
|
||||
$this->assertSame(ColorModelType::Hsl, $hsl->getTypeEnum());
|
||||
|
||||
$cmyk = new \Com\Tecnick\Color\Model\Cmyk([]);
|
||||
$this->assertSame(ColorModelType::Cmyk, $cmyk->getTypeEnum());
|
||||
|
||||
$lab = new \Com\Tecnick\Color\Model\Lab([]);
|
||||
$this->assertSame(ColorModelType::Lab, $lab->getTypeEnum());
|
||||
}
|
||||
|
||||
/**
|
||||
* The typed accessor stays consistent with the legacy string accessor.
|
||||
*/
|
||||
public function testGetTypeEnumMatchesGetType(): void
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb([]);
|
||||
$this->assertSame($rgb->getType(), $rgb->getTypeEnum()->value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,257 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* CmykTest.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test\Model;
|
||||
|
||||
use Test\TestUtil;
|
||||
|
||||
/**
|
||||
* Cmyk Color class test
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class CmykTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Color\Model\Cmyk
|
||||
{
|
||||
return new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
}
|
||||
|
||||
public function testGetType(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$type = $cmyk->getType();
|
||||
$this->assertEquals('CMYK', $type);
|
||||
}
|
||||
|
||||
public function testGetNormalizedValue(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->getNormalizedValue(0.5, 255);
|
||||
$this->assertEquals(128, $res);
|
||||
}
|
||||
|
||||
public function testGetHexValue(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->getHexValue(0.5, 255);
|
||||
$this->assertEquals('80', $res);
|
||||
}
|
||||
|
||||
public function testGetRgbaHexColor(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$rgbaHexColor = $cmyk->getRgbaHexColor();
|
||||
$this->assertEquals('#4080bfd9', $rgbaHexColor);
|
||||
}
|
||||
|
||||
public function testGetRgbHexColor(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$rgbHexColor = $cmyk->getRgbHexColor();
|
||||
$this->assertEquals('#4080bf', $rgbHexColor);
|
||||
}
|
||||
|
||||
public function testGetArray(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->getArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'C' => 0.666,
|
||||
'M' => 0.333,
|
||||
'Y' => 0,
|
||||
'K' => 0.25,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testPDFacArray(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->getPDFacArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
0.666,
|
||||
0.333,
|
||||
0,
|
||||
0.25,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetNormalizedArray(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->getNormalizedArray(100);
|
||||
$this->assertEquals(
|
||||
[
|
||||
'C' => 67,
|
||||
'M' => 33,
|
||||
'Y' => 0,
|
||||
'K' => 25,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetCssColor(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$cssColor = $cmyk->getCssColor();
|
||||
$this->assertEquals('cmyka(67%,33%,0%,25%,0.85)', $cssColor);
|
||||
|
||||
$opaque = new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$this->assertEquals('cmyk(67%,33%,0%,25%)', $opaque->getCssColor());
|
||||
}
|
||||
|
||||
public function testGetJsPdfColor(): void
|
||||
{
|
||||
$testObj = $this->getTestObject();
|
||||
$res = $testObj->getJsPdfColor();
|
||||
$this->assertEquals('["CMYK",0.666000,0.333000,0.000000,0.250000]', $res);
|
||||
|
||||
$cmyk = new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0,
|
||||
]);
|
||||
$res = $cmyk->getJsPdfColor();
|
||||
$this->assertEquals('["T"]', $res);
|
||||
}
|
||||
|
||||
public function testGetComponentsString(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$componentsString = $cmyk->getComponentsString();
|
||||
$this->assertEquals('0.666000 0.333000 0.000000 0.250000', $componentsString);
|
||||
}
|
||||
|
||||
public function testGetPdfColor(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->getPdfColor();
|
||||
$this->assertEquals('0.666000 0.333000 0.000000 0.250000 k' . "\n", $res);
|
||||
|
||||
$res = $cmyk->getPdfColor(false);
|
||||
$this->assertEquals('0.666000 0.333000 0.000000 0.250000 k' . "\n", $res);
|
||||
|
||||
$res = $cmyk->getPdfColor(true);
|
||||
$this->assertEquals('0.666000 0.333000 0.000000 0.250000 K' . "\n", $res);
|
||||
}
|
||||
|
||||
public function testToGrayArray(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->toGrayArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'gray' => 0.46518510,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToRgbArray(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->toRgbArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'red' => 0.25,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToHslArray(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->toHslArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.5,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToCmykArray(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->toCmykArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToLabArray(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$res = $cmyk->toLabArray();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'lstar' => 52,
|
||||
'astar' => 0,
|
||||
'bstar' => -39,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
1.5,
|
||||
);
|
||||
}
|
||||
|
||||
public function testInvertColor(): void
|
||||
{
|
||||
$cmyk = $this->getTestObject();
|
||||
$cmyk->invertColor();
|
||||
|
||||
$res = $cmyk->toCmykArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'cyan' => 0.333,
|
||||
'magenta' => 0.666,
|
||||
'yellow' => 1,
|
||||
'key' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,251 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* GrayTest.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test\Model;
|
||||
|
||||
use Test\TestUtil;
|
||||
|
||||
/**
|
||||
* Gray Color class test
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class GrayTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Color\Model\Gray
|
||||
{
|
||||
return new \Com\Tecnick\Color\Model\Gray([
|
||||
'gray' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
}
|
||||
|
||||
public function testGetType(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$type = $gray->getType();
|
||||
$this->assertEquals('GRAY', $type);
|
||||
}
|
||||
|
||||
public function testGetNormalizedValue(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->getNormalizedValue(0.5, 255);
|
||||
$this->assertEquals(128, $res);
|
||||
}
|
||||
|
||||
public function testGetHexValue(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->getHexValue(0.5, 255);
|
||||
$this->assertEquals('80', $res);
|
||||
}
|
||||
|
||||
public function testGetRgbaHexColor(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$rgbaHexColor = $gray->getRgbaHexColor();
|
||||
$this->assertEquals('#bfbfbfd9', $rgbaHexColor);
|
||||
}
|
||||
|
||||
public function testGetRgbHexColor(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$rgbHexColor = $gray->getRgbHexColor();
|
||||
$this->assertEquals('#bfbfbf', $rgbHexColor);
|
||||
}
|
||||
|
||||
public function testGetArray(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->getArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'G' => 0.75,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetPDFacArray(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->getPDFacArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
0.75,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetNormalizedArray(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->getNormalizedArray(255);
|
||||
$this->assertEquals(
|
||||
[
|
||||
'G' => 191,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetCssColor(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$cssColor = $gray->getCssColor();
|
||||
$this->assertEquals('rgba(75%,75%,75%,0.85)', $cssColor);
|
||||
|
||||
$opaque = new \Com\Tecnick\Color\Model\Gray([
|
||||
'gray' => 0.75,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$this->assertEquals('g(75%)', $opaque->getCssColor());
|
||||
}
|
||||
|
||||
public function testGetJsPdfColor(): void
|
||||
{
|
||||
$testObj = $this->getTestObject();
|
||||
$res = $testObj->getJsPdfColor();
|
||||
$this->assertEquals('["G",0.750000]', $res);
|
||||
|
||||
$gray = new \Com\Tecnick\Color\Model\Gray([
|
||||
'gray' => 0.5,
|
||||
'alpha' => 0,
|
||||
]);
|
||||
$res = $gray->getJsPdfColor();
|
||||
$this->assertEquals('["T"]', $res);
|
||||
}
|
||||
|
||||
public function testGetComponentsString(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$componentsString = $gray->getComponentsString();
|
||||
$this->assertEquals('0.750000', $componentsString);
|
||||
}
|
||||
|
||||
public function testGetPdfColor(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->getPdfColor();
|
||||
$this->assertEquals('0.750000 g' . "\n", $res);
|
||||
|
||||
$res = $gray->getPdfColor(false);
|
||||
$this->assertEquals('0.750000 g' . "\n", $res);
|
||||
|
||||
$res = $gray->getPdfColor(true);
|
||||
$this->assertEquals('0.750000 G' . "\n", $res);
|
||||
}
|
||||
|
||||
public function testToGrayArray(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->toGrayArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'gray' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToRgbArray(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->toRgbArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'red' => 0.75,
|
||||
'green' => 0.75,
|
||||
'blue' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToHslArray(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->toHslArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'hue' => 0,
|
||||
'saturation' => 0,
|
||||
'lightness' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToCmykArray(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->toCmykArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'cyan' => 0,
|
||||
'magenta' => 0,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToLabArray(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$res = $gray->toLabArray();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'lstar' => 77,
|
||||
'astar' => 0,
|
||||
'bstar' => 0,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
1.5,
|
||||
);
|
||||
}
|
||||
|
||||
public function testInvertColor(): void
|
||||
{
|
||||
$gray = $this->getTestObject();
|
||||
$gray->invertColor();
|
||||
|
||||
$res = $gray->toGrayArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'gray' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,308 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* HslTest.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test\Model;
|
||||
|
||||
use Test\TestUtil;
|
||||
|
||||
/**
|
||||
* Hsl Color class test
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class HslTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Color\Model\Hsl
|
||||
{
|
||||
return new \Com\Tecnick\Color\Model\Hsl([
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.5,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
}
|
||||
|
||||
public function testGetType(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$type = $hsl->getType();
|
||||
$this->assertEquals('HSL', $type);
|
||||
}
|
||||
|
||||
public function testGetNormalizedValue(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->getNormalizedValue(0.5, 255);
|
||||
$this->assertEquals(128, $res);
|
||||
}
|
||||
|
||||
public function testGetHexValue(): void
|
||||
{
|
||||
$testObj = $this->getTestObject();
|
||||
$testObj = $this->getTestObject();
|
||||
|
||||
$res = $testObj->getHexValue(0.5, 255);
|
||||
$this->assertEquals('80', $res);
|
||||
}
|
||||
|
||||
public function testGetRgbaHexColor(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$rgbaHexColor = $hsl->getRgbaHexColor();
|
||||
$this->assertEquals('#4080bfd9', $rgbaHexColor);
|
||||
}
|
||||
|
||||
public function testGetRgbHexColor(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$rgbHexColor = $hsl->getRgbHexColor();
|
||||
$this->assertEquals('#4080bf', $rgbHexColor);
|
||||
}
|
||||
|
||||
public function testGetArray(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->getArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'H' => 0.583,
|
||||
'S' => 0.5,
|
||||
'L' => 0.5,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetPDFacArray(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->getPDFacArray();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
0.25,
|
||||
0.50,
|
||||
0.75,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetNormalizedArray(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->getNormalizedArray(255);
|
||||
$this->assertEquals(
|
||||
[
|
||||
'H' => 210,
|
||||
'S' => 0.5,
|
||||
'L' => 0.5,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetCssColor(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$cssColor = $hsl->getCssColor();
|
||||
$this->assertEquals('hsla(210,50%,50%,0.85)', $cssColor);
|
||||
|
||||
$opaque = new \Com\Tecnick\Color\Model\Hsl([
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.5,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$this->assertEquals('hsl(210,50%,50%)', $opaque->getCssColor());
|
||||
}
|
||||
|
||||
public function testGetJsPdfColor(): void
|
||||
{
|
||||
$testObj = $this->getTestObject();
|
||||
$res = $testObj->getJsPdfColor();
|
||||
$this->assertEquals('["RGB",0.250000,0.501000,0.750000]', $res);
|
||||
|
||||
$hsl = new \Com\Tecnick\Color\Model\Hsl([
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.5,
|
||||
'alpha' => 0,
|
||||
]);
|
||||
$res = $hsl->getJsPdfColor();
|
||||
$this->assertEquals('["T"]', $res);
|
||||
}
|
||||
|
||||
public function testGetComponentsString(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$componentsString = $hsl->getComponentsString();
|
||||
$this->assertEquals('0.250000 0.501000 0.750000', $componentsString);
|
||||
}
|
||||
|
||||
public function testGetPdfColor(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->getPdfColor();
|
||||
$this->assertEquals('0.250000 0.501000 0.750000 rg' . "\n", $res);
|
||||
|
||||
$res = $hsl->getPdfColor(false);
|
||||
$this->assertEquals('0.250000 0.501000 0.750000 rg' . "\n", $res);
|
||||
|
||||
$res = $hsl->getPdfColor(true);
|
||||
$this->assertEquals('0.250000 0.501000 0.750000 RG' . "\n", $res);
|
||||
}
|
||||
|
||||
public function testToGrayArray(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->toGrayArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'gray' => 0.46561520,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToRgbArray(): void
|
||||
{
|
||||
$testObj = $this->getTestObject();
|
||||
$res = $testObj->toRgbArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'red' => 0.25,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
|
||||
$col = new \Com\Tecnick\Color\Model\Hsl([
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.4,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $col->toRgbArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'red' => 0.199,
|
||||
'green' => 0.400,
|
||||
'blue' => 0.600,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
|
||||
$col = new \Com\Tecnick\Color\Model\Hsl([
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0,
|
||||
'lightness' => 0.4,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $col->toRgbArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'red' => 0.400,
|
||||
'green' => 0.400,
|
||||
'blue' => 0.400,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
|
||||
$col = new \Com\Tecnick\Color\Model\Hsl([
|
||||
'hue' => 0.01,
|
||||
'saturation' => 1,
|
||||
'lightness' => 0.4,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $col->toRgbArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'red' => 0.8,
|
||||
'green' => 0.048,
|
||||
'blue' => 0,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
|
||||
$col = new \Com\Tecnick\Color\Model\Hsl([
|
||||
'hue' => 1,
|
||||
'saturation' => 1,
|
||||
'lightness' => 0.4,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $col->toRgbArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'red' => 0.8,
|
||||
'green' => 0,
|
||||
'blue' => 0,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToHslArray(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->toHslArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.5,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToCmykArray(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->toCmykArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToLabArray(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$res = $hsl->toLabArray();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'lstar' => 52,
|
||||
'astar' => 0,
|
||||
'bstar' => -39,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
1.5,
|
||||
);
|
||||
}
|
||||
|
||||
public function testInvertColor(): void
|
||||
{
|
||||
$hsl = $this->getTestObject();
|
||||
$hsl->invertColor();
|
||||
|
||||
$res = $hsl->toHslArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'hue' => 0.083,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.5,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,341 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* LabTest.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test\Model;
|
||||
|
||||
use Test\TestUtil;
|
||||
|
||||
/**
|
||||
* Lab Color class test
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class LabTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Color\Model\Lab
|
||||
{
|
||||
return new \Com\Tecnick\Color\Model\Lab([
|
||||
'lstar' => 52,
|
||||
'astar' => 0,
|
||||
'bstar' => -39,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
}
|
||||
|
||||
public function testGetType(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->assertEquals('LAB', $lab->getType());
|
||||
}
|
||||
|
||||
public function testGetArray(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'L' => 52,
|
||||
'a' => 0,
|
||||
'b' => -39,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$lab->getArray(),
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetPDFacArray(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
0.25,
|
||||
0.50,
|
||||
0.75,
|
||||
],
|
||||
$lab->getPDFacArray(),
|
||||
0.03,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetNormalizedArray(): void
|
||||
{
|
||||
$lab = new \Com\Tecnick\Color\Model\Lab([
|
||||
'lstar' => 51.6,
|
||||
'astar' => 0.4,
|
||||
'bstar' => -38.7,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
|
||||
$this->assertEquals(
|
||||
[
|
||||
'L' => 52.0,
|
||||
'a' => 0.0,
|
||||
'b' => -39.0,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$lab->getNormalizedArray(255),
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetCssColor(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->assertSame('lab(52% 0 -39 / 0.85)', $lab->getCssColor());
|
||||
|
||||
$opaque = new \Com\Tecnick\Color\Model\Lab([
|
||||
'lstar' => 52,
|
||||
'astar' => 0,
|
||||
'bstar' => -39,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$this->assertSame('lab(52% 0 -39)', $opaque->getCssColor());
|
||||
}
|
||||
|
||||
public function testGetJsPdfColor(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->assertSame('["RGB",0.252784,0.499848,0.747328]', $lab->getJsPdfColor());
|
||||
}
|
||||
|
||||
public function testGetJsPdfTransparentColor(): void
|
||||
{
|
||||
$transparent = new \Com\Tecnick\Color\Model\Lab([
|
||||
'lstar' => 52,
|
||||
'astar' => 0,
|
||||
'bstar' => -39,
|
||||
'alpha' => 0,
|
||||
]);
|
||||
|
||||
$this->assertSame('["T"]', $transparent->getJsPdfColor());
|
||||
}
|
||||
|
||||
public function testGetComponentsString(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->assertSame('52.000000 0.000000 -39.000000', $lab->getComponentsString());
|
||||
}
|
||||
|
||||
public function testGetPdfColor(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->assertSame('0.252784 0.499848 0.747328 rg' . "\n", $lab->getPdfColor());
|
||||
$this->assertSame('0.252784 0.499848 0.747328 RG' . "\n", $lab->getPdfColor(true));
|
||||
}
|
||||
|
||||
public function testToGrayArray(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'gray' => 0.465,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$lab->toGrayArray(),
|
||||
0.02,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToRgbArray(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'red' => 0.25,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$lab->toRgbArray(),
|
||||
0.03,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToLabArray(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'lstar' => 52,
|
||||
'astar' => 0,
|
||||
'bstar' => -39,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$lab->toLabArray(),
|
||||
0.01,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToCmykArray(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$lab->toCmykArray(),
|
||||
0.05,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToHslArray(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.5,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$lab->toHslArray(),
|
||||
0.05,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToRgbArrayLowLightnessBranch(): void
|
||||
{
|
||||
$lab = new \Com\Tecnick\Color\Model\Lab([
|
||||
'lstar' => 2,
|
||||
'astar' => 0,
|
||||
'bstar' => 0,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
|
||||
$rgb = $lab->toRgbArray();
|
||||
$this->assertGreaterThan(0.0, $rgb['red'] ?? 0.0);
|
||||
$this->assertLessThan(0.03, $rgb['red'] ?? 0.0);
|
||||
$this->assertEqualsWithDelta($rgb['red'] ?? 0.0, $rgb['green'] ?? 0.0, 0.0001);
|
||||
$this->assertEqualsWithDelta($rgb['green'] ?? 0.0, $rgb['blue'] ?? 0.0, 0.0001);
|
||||
$this->assertSame(1.0, $rgb['alpha'] ?? 0.0);
|
||||
}
|
||||
|
||||
public function testInvertColor(): void
|
||||
{
|
||||
$lab = $this->getTestObject();
|
||||
$lab->invertColor();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'red' => 0.75,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$lab->toRgbArray(),
|
||||
0.05,
|
||||
);
|
||||
}
|
||||
|
||||
public function testSetComponentValueForLabSpecificComponents(): void
|
||||
{
|
||||
$model = new class(['lstar' => 0.425, 'astar' => -0.1225, 'bstar' => 0.3375, 'alpha' => 1]) extends
|
||||
\Com\Tecnick\Color\Model {
|
||||
protected $type = 'TEST';
|
||||
protected float $cmp_lstar = 0.0;
|
||||
protected float $cmp_astar = 0.0;
|
||||
protected float $cmp_bstar = 0.0;
|
||||
|
||||
public function getArray(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function getPDFacArray(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function getNormalizedArray(int $max): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function getCssColor(): string
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
public function getJsPdfColor(): string
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
public function getComponentsString(): string
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
public function getPdfColor(bool $stroke = false): string
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
public function toGrayArray(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function toRgbArray(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function toHslArray(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function toCmykArray(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function toLabArray(): array
|
||||
{
|
||||
return [
|
||||
'lstar' => $this->cmp_lstar,
|
||||
'astar' => $this->cmp_astar,
|
||||
'bstar' => $this->cmp_bstar,
|
||||
'alpha' => $this->cmp_alpha,
|
||||
];
|
||||
}
|
||||
|
||||
public function invertColor(): self
|
||||
{
|
||||
return $this;
|
||||
}
|
||||
};
|
||||
|
||||
$this->assertEqualsWithDelta(
|
||||
[
|
||||
'lstar' => 0.425,
|
||||
'astar' => 0.0,
|
||||
'bstar' => 0.3375,
|
||||
'alpha' => 1.0,
|
||||
],
|
||||
$model->toLabArray(),
|
||||
0.0001,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,337 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* RgbTest.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test\Model;
|
||||
|
||||
use Test\TestUtil;
|
||||
|
||||
/**
|
||||
* Rgb Color class test
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class RgbTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Color\Model\Rgb
|
||||
{
|
||||
return new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 0.25,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
}
|
||||
|
||||
public function testGetType(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$type = $rgb->getType();
|
||||
$this->assertEquals('RGB', $type);
|
||||
}
|
||||
|
||||
public function testGetNormalizedValue(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->getNormalizedValue(0.5, 255);
|
||||
$this->assertEquals(128, $res);
|
||||
}
|
||||
|
||||
public function testGetHexValue(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->getHexValue(0.5, 255);
|
||||
$this->assertEquals('80', $res);
|
||||
}
|
||||
|
||||
public function testGetRgbaHexColor(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$rgbaHexColor = $rgb->getRgbaHexColor();
|
||||
$this->assertEquals('#4080bfd9', $rgbaHexColor);
|
||||
}
|
||||
|
||||
public function testGetRgbHexColor(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$rgbHexColor = $rgb->getRgbHexColor();
|
||||
$this->assertEquals('#4080bf', $rgbHexColor);
|
||||
}
|
||||
|
||||
public function testGetArray(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->getArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
'R' => 0.25,
|
||||
'G' => 0.50,
|
||||
'B' => 0.75,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetPDFacArray(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->getPDFacArray();
|
||||
$this->assertEquals(
|
||||
[
|
||||
0.25,
|
||||
0.50,
|
||||
0.75,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetNormalizedArray(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->getNormalizedArray(255);
|
||||
$this->assertEquals(
|
||||
[
|
||||
'R' => 64,
|
||||
'G' => 128,
|
||||
'B' => 191,
|
||||
'A' => 0.85,
|
||||
],
|
||||
$res,
|
||||
);
|
||||
}
|
||||
|
||||
public function testGetCssColor(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$cssColor = $rgb->getCssColor();
|
||||
$this->assertEquals('rgba(25%,50%,75%,0.85)', $cssColor);
|
||||
|
||||
$opaque = new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 0.25,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.75,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$this->assertEquals('rgb(25%,50%,75%)', $opaque->getCssColor());
|
||||
}
|
||||
|
||||
public function testGetJsPdfColor(): void
|
||||
{
|
||||
$testObj = $this->getTestObject();
|
||||
$res = $testObj->getJsPdfColor();
|
||||
$this->assertEquals('["RGB",0.250000,0.500000,0.750000]', $res);
|
||||
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 0.25,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.75,
|
||||
'alpha' => 0,
|
||||
]);
|
||||
$res = $rgb->getJsPdfColor();
|
||||
$this->assertEquals('["T"]', $res);
|
||||
}
|
||||
|
||||
public function testGetComponentsString(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$componentsString = $rgb->getComponentsString();
|
||||
$this->assertEquals('0.250000 0.500000 0.750000', $componentsString);
|
||||
}
|
||||
|
||||
public function testGetPdfColor(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->getPdfColor();
|
||||
$this->assertEquals('0.250000 0.500000 0.750000 rg' . "\n", $res);
|
||||
|
||||
$res = $rgb->getPdfColor(false);
|
||||
$this->assertEquals('0.250000 0.500000 0.750000 rg' . "\n", $res);
|
||||
|
||||
$res = $rgb->getPdfColor(true);
|
||||
$this->assertEquals('0.250000 0.500000 0.750000 RG' . "\n", $res);
|
||||
}
|
||||
|
||||
public function testToGrayArray(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->toGrayArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'gray' => 0.465,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToRgbArray(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->toRgbArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'red' => 0.25,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.75,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToHslArray(): void
|
||||
{
|
||||
$testObj = $this->getTestObject();
|
||||
$res = $testObj->toHslArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'hue' => 0.583,
|
||||
'saturation' => 0.5,
|
||||
'lightness' => 0.5,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
|
||||
$col = new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 0,
|
||||
'green' => 0,
|
||||
'blue' => 0,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $col->toHslArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'hue' => 0,
|
||||
'saturation' => 0,
|
||||
'lightness' => 0,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
|
||||
$col = new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 0.1,
|
||||
'green' => 0.3,
|
||||
'blue' => 0.2,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $col->toHslArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'hue' => 0.416,
|
||||
'saturation' => 0.500,
|
||||
'lightness' => 0.200,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
|
||||
$col = new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 0.3,
|
||||
'green' => 0.2,
|
||||
'blue' => 0.1,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $col->toHslArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'hue' => 0.0833,
|
||||
'saturation' => 0.500,
|
||||
'lightness' => 0.200,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
|
||||
$col = new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 1,
|
||||
'green' => 0.1,
|
||||
'blue' => 0.9,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $col->toHslArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'hue' => 0.852,
|
||||
'saturation' => 1,
|
||||
'lightness' => 0.55,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToCmykArray(): void
|
||||
{
|
||||
$testObj = $this->getTestObject();
|
||||
$res = $testObj->toCmykArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 0,
|
||||
'green' => 0,
|
||||
'blue' => 0,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
$res = $rgb->toCmykArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'cyan' => 0,
|
||||
'magenta' => 0,
|
||||
'yellow' => 0,
|
||||
'key' => 1,
|
||||
'alpha' => 1,
|
||||
], $res);
|
||||
}
|
||||
|
||||
public function testToLabArray(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$res = $rgb->toLabArray();
|
||||
$this->bcAssertEqualsWithDelta(
|
||||
[
|
||||
'lstar' => 52,
|
||||
'astar' => 0,
|
||||
'bstar' => -39,
|
||||
'alpha' => 0.85,
|
||||
],
|
||||
$res,
|
||||
1.5,
|
||||
);
|
||||
}
|
||||
|
||||
public function testToLabArrayLowValueBranch(): void
|
||||
{
|
||||
$rgb = new \Com\Tecnick\Color\Model\Rgb([
|
||||
'red' => 0,
|
||||
'green' => 0,
|
||||
'blue' => 0,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
|
||||
$lab = $rgb->toLabArray();
|
||||
$this->assertSame(0.0, $lab['lstar'] ?? 0.0);
|
||||
$this->assertEqualsWithDelta(0.0, $lab['astar'] ?? 0.0, 0.05);
|
||||
$this->assertEqualsWithDelta(0.0, $lab['bstar'] ?? 0.0, 0.05);
|
||||
$this->assertEquals(1.0, $lab['alpha'] ?? 0.0);
|
||||
}
|
||||
|
||||
public function testInvertColor(): void
|
||||
{
|
||||
$rgb = $this->getTestObject();
|
||||
$rgb->invertColor();
|
||||
|
||||
$res = $rgb->toRgbArray();
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'red' => 0.75,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
], $res);
|
||||
}
|
||||
}
|
||||
+385
@@ -0,0 +1,385 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* PdfTest.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* Pdf Color class test
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class PdfTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Color\Pdf
|
||||
{
|
||||
return new \Com\Tecnick\Color\Pdf();
|
||||
}
|
||||
|
||||
public function testGetJsColorString(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
$res = $pdf->getJsColorString('t()');
|
||||
$this->assertEquals('color.transparent', $res);
|
||||
$res = $pdf->getJsColorString('["T"]');
|
||||
$this->assertEquals('color.transparent', $res);
|
||||
$res = $pdf->getJsColorString('transparent');
|
||||
$this->assertEquals('color.transparent', $res);
|
||||
$res = $pdf->getJsColorString('color.transparent');
|
||||
$this->assertEquals('color.transparent', $res);
|
||||
$res = $pdf->getJsColorString('magenta');
|
||||
$this->assertEquals('color.magenta', $res);
|
||||
$res = $pdf->getJsColorString('#1a2b3c4d');
|
||||
$this->assertEquals('["RGB",0.101961,0.168627,0.235294]', $res);
|
||||
$res = $pdf->getJsColorString('#1a2b3c');
|
||||
$this->assertEquals('["RGB",0.101961,0.168627,0.235294]', $res);
|
||||
$res = $pdf->getJsColorString('#1234');
|
||||
$this->assertEquals('["RGB",0.066667,0.133333,0.200000]', $res);
|
||||
$res = $pdf->getJsColorString('#123');
|
||||
$this->assertEquals('["RGB",0.066667,0.133333,0.200000]', $res);
|
||||
$res = $pdf->getJsColorString('["G",0.5]');
|
||||
$this->assertEquals('["G",0.500000]', $res);
|
||||
$res = $pdf->getJsColorString('["RGB",0.25,0.50,0.75]');
|
||||
$this->assertEquals('["RGB",0.250000,0.500000,0.750000]', $res);
|
||||
$res = $pdf->getJsColorString('["CMYK",0.666,0.333,0,0.25]');
|
||||
$this->assertEquals('["CMYK",0.666000,0.333000,0.000000,0.250000]', $res);
|
||||
$res = $pdf->getJsColorString('g(50%)');
|
||||
$this->assertEquals('["G",0.500000]', $res);
|
||||
$res = $pdf->getJsColorString('g(128)');
|
||||
$this->assertEquals('["G",0.501961]', $res);
|
||||
$res = $pdf->getJsColorString('rgb(25%,50%,75%)');
|
||||
$this->assertEquals('["RGB",0.250000,0.500000,0.750000]', $res);
|
||||
$res = $pdf->getJsColorString('rgb(64,128,191)');
|
||||
$this->assertEquals('["RGB",0.250980,0.501961,0.749020]', $res);
|
||||
$res = $pdf->getJsColorString('rgba(25%,50%,75%,0.85)');
|
||||
$this->assertEquals('["RGB",0.250000,0.500000,0.750000]', $res);
|
||||
$res = $pdf->getJsColorString('rgba(64,128,191,0.85)');
|
||||
$this->assertEquals('["RGB",0.250980,0.501961,0.749020]', $res);
|
||||
$res = $pdf->getJsColorString('hsl(210,50%,50%)');
|
||||
$this->assertEquals('["RGB",0.250000,0.500000,0.750000]', $res);
|
||||
$res = $pdf->getJsColorString('hsla(210,50%,50%,0.85)');
|
||||
$this->assertEquals('["RGB",0.250000,0.500000,0.750000]', $res);
|
||||
$res = $pdf->getJsColorString('cmyk(67%,33%,0,25%)');
|
||||
$this->assertEquals('["CMYK",0.670000,0.330000,0.000000,0.250000]', $res);
|
||||
$res = $pdf->getJsColorString('cmyk(67,33,0,25)');
|
||||
$this->assertEquals('["CMYK",0.670000,0.330000,0.000000,0.250000]', $res);
|
||||
$res = $pdf->getJsColorString('cmyka(67,33,0,25,0.85)');
|
||||
$this->assertEquals('["CMYK",0.670000,0.330000,0.000000,0.250000]', $res);
|
||||
$res = $pdf->getJsColorString('cmyka(67%,33%,0,25%,0.85)');
|
||||
$this->assertEquals('["CMYK",0.670000,0.330000,0.000000,0.250000]', $res);
|
||||
$res = $pdf->getJsColorString('lab(52% 0 -39)');
|
||||
$this->assertEquals('["RGB",0.252784,0.499848,0.747328]', $res);
|
||||
$res = $pdf->getJsColorString('lab(52% 0 -39 / 0.85)');
|
||||
$this->assertEquals('["RGB",0.252784,0.499848,0.747328]', $res);
|
||||
$res = $pdf->getJsColorString('g(-)');
|
||||
$this->assertEquals('color.transparent', $res);
|
||||
$res = $pdf->getJsColorString('rgb(-)');
|
||||
$this->assertEquals('color.transparent', $res);
|
||||
$res = $pdf->getJsColorString('hsl(-)');
|
||||
$this->assertEquals('color.transparent', $res);
|
||||
$res = $pdf->getJsColorString('cmyk(-)');
|
||||
$this->assertEquals('color.transparent', $res);
|
||||
}
|
||||
|
||||
public function testGetColorObject(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
$res = $pdf->getColorObject('');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('[*');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('t()');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('["T"]');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('transparent');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('color.transparent');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('#1a2b3c4d');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#1a2b3c4d', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('#1a2b3c');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#1a2b3cff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('#1234');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#11223344', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('#123');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#112233ff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('["G",0.5]');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#808080ff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('["RGB",0.25,0.50,0.75]');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('["CMYK",0.666,0.333,0,0.25]');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('g(50%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#808080ff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('g(128)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#808080ff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('rgb(25%,50%,75%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('rgb(64,128,191)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('rgba(25%,50%,75%,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfd9', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('rgba(64,128,191,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfd9', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('hsl(210,50%,50%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('hsla(210,50%,50%,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfd9', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('cmyk(67%,33%,0,25%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('cmyk(67,33,0,25)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('cmyka(67,33,0,25,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfd9', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('cmyka(67%,33%,0,25%,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfd9', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('lab(52% 0 -39)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#407fbfff', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('lab(52% 0 -39 / 0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#407fbfd9', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('lab(52 0 -39 / 85%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#407fbfd9', $res->getRgbaHexColor());
|
||||
$res = $pdf->getColorObject('none');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('0.000000 0.000000 0.000000 0.000000 k' . "\n", $res->getPdfColor());
|
||||
$res = $pdf->getColorObject('all');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('1.000000 1.000000 1.000000 1.000000 k' . "\n", $res->getPdfColor());
|
||||
$res = $pdf->getColorObject('["G"]');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('["RGB"]');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('["CMYK"]');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('g(-)');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('rgb(-)');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('hsl(-)');
|
||||
$this->assertNull($res);
|
||||
$res = $pdf->getColorObject('cmyk(-)');
|
||||
$this->assertNull($res);
|
||||
}
|
||||
|
||||
public function testGetPdfColor(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
$res = $pdf->getPdfColor('magenta', false, 1);
|
||||
$this->assertEquals('/CS1 cs 1.000000 scn' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('magenta', true, 1);
|
||||
$this->assertEquals('/CS1 CS 1.000000 SCN' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('magenta', false, 0.5);
|
||||
$this->assertEquals('/CS1 cs 0.500000 scn' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('magenta', true, 0.5);
|
||||
$this->assertEquals('/CS1 CS 0.500000 SCN' . "\n", $res);
|
||||
|
||||
$res = $pdf->getPdfColor('t()', false, 1);
|
||||
$this->assertEquals('', $res);
|
||||
$res = $pdf->getPdfColor('["T"]', false, 1);
|
||||
$this->assertEquals('', $res);
|
||||
$res = $pdf->getPdfColor('transparent', false, 1);
|
||||
$this->assertEquals('', $res);
|
||||
$res = $pdf->getPdfColor('color.transparent', false, 1);
|
||||
$this->assertEquals('', $res);
|
||||
$res = $pdf->getPdfColor('magenta', false, 1);
|
||||
$this->assertEquals('/CS1 cs 1.000000 scn' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('#1a2b3c4d', false, 1);
|
||||
$this->assertEquals('0.101961 0.168627 0.235294 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('#1a2b3c', false, 1);
|
||||
$this->assertEquals('0.101961 0.168627 0.235294 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('#1234', false, 1);
|
||||
$this->assertEquals('0.066667 0.133333 0.200000 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('#123', false, 1);
|
||||
$this->assertEquals('0.066667 0.133333 0.200000 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('["G",0.5]', false, 1);
|
||||
$this->assertEquals('0.500000 g' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('["RGB",0.25,0.50,0.75]', false, 1);
|
||||
$this->assertEquals('0.250000 0.500000 0.750000 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('["CMYK",0.666,0.333,0,0.25]', false, 1);
|
||||
$this->assertEquals('0.666000 0.333000 0.000000 0.250000 k' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('g(50%)', false, 1);
|
||||
$this->assertEquals('0.500000 g' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('g(128)', false, 1);
|
||||
$this->assertEquals('0.501961 g' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('rgb(25%,50%,75%)', false, 1);
|
||||
$this->assertEquals('0.250000 0.500000 0.750000 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('rgb(64,128,191)', false, 1);
|
||||
$this->assertEquals('0.250980 0.501961 0.749020 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('rgba(25%,50%,75%,0.85)', false, 1);
|
||||
$this->assertEquals('0.250000 0.500000 0.750000 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('rgba(64,128,191,0.85)', false, 1);
|
||||
$this->assertEquals('0.250980 0.501961 0.749020 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('hsl(210,50%,50%)', false, 1);
|
||||
$this->assertEquals('0.250000 0.500000 0.750000 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('hsla(210,50%,50%,0.85)', false, 1);
|
||||
$this->assertEquals('0.250000 0.500000 0.750000 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('cmyk(67%,33%,0,25%)', false, 1);
|
||||
$this->assertEquals('0.670000 0.330000 0.000000 0.250000 k' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('cmyk(67,33,0,25)', false, 1);
|
||||
$this->assertEquals('0.670000 0.330000 0.000000 0.250000 k' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('cmyka(67,33,0,25,0.85)', false, 1);
|
||||
$this->assertEquals('0.670000 0.330000 0.000000 0.250000 k' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('cmyka(67%,33%,0,25%,0.85)', false, 1);
|
||||
$this->assertEquals('0.670000 0.330000 0.000000 0.250000 k' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('lab(52% 0 -39)', false, 1);
|
||||
$this->assertEquals('0.252784 0.499848 0.747328 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('lab(52% 0 -39 / 0.85)', false, 1);
|
||||
$this->assertEquals('0.252784 0.499848 0.747328 rg' . "\n", $res);
|
||||
$res = $pdf->getPdfColor('g(-)');
|
||||
$this->assertEquals('', $res);
|
||||
$res = $pdf->getPdfColor('rgb(-)');
|
||||
$this->assertEquals('', $res);
|
||||
$res = $pdf->getPdfColor('hsl(-)');
|
||||
$this->assertEquals('', $res);
|
||||
$res = $pdf->getPdfColor('cmyk(-)');
|
||||
$this->assertEquals('', $res);
|
||||
}
|
||||
|
||||
public function testGetPdfRgbComponents(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
$res = $pdf->getPdfRgbComponents('');
|
||||
$this->assertEquals('', $res);
|
||||
|
||||
$res = $pdf->getPdfRgbComponents('red');
|
||||
$this->assertEquals('1.000000 0.000000 0.000000', $res);
|
||||
|
||||
$res = $pdf->getPdfRgbComponents('#00ff00');
|
||||
$this->assertEquals('0.000000 1.000000 0.000000', $res);
|
||||
|
||||
$res = $pdf->getPdfRgbComponents('rgb(0,0,255)');
|
||||
$this->assertEquals('0.000000 0.000000 1.000000', $res);
|
||||
}
|
||||
|
||||
public function testGetPdfStrokeColor(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
|
||||
$res = $pdf->getPdfStrokeColor('magenta', 0.5);
|
||||
$this->assertEquals('/CS1 CS 0.500000 SCN' . "\n", $res);
|
||||
|
||||
$res = $pdf->getPdfStrokeColor('rgb(64,128,191)');
|
||||
$this->assertEquals('0.250980 0.501961 0.749020 RG' . "\n", $res);
|
||||
|
||||
$res = $pdf->getPdfStrokeColor('g(-)');
|
||||
$this->assertEquals('', $res);
|
||||
}
|
||||
|
||||
public function testGetPdfFillColor(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
|
||||
$res = $pdf->getPdfFillColor('magenta', 0.5);
|
||||
$this->assertEquals('/CS1 cs 0.500000 scn' . "\n", $res);
|
||||
|
||||
$res = $pdf->getPdfFillColor('rgb(64,128,191)');
|
||||
$this->assertEquals('0.250980 0.501961 0.749020 rg' . "\n", $res);
|
||||
|
||||
$res = $pdf->getPdfFillColor('g(-)');
|
||||
$this->assertEquals('', $res);
|
||||
}
|
||||
|
||||
public function testGetPdfCmykComponents(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
$res = $pdf->getPdfCmykComponents('');
|
||||
$this->assertEquals('', $res);
|
||||
|
||||
$res = $pdf->getPdfCmykComponents('red');
|
||||
$this->assertEquals('0.000000 1.000000 1.000000 0.000000', $res);
|
||||
|
||||
$res = $pdf->getPdfCmykComponents('rgb(64,128,191)');
|
||||
$this->assertEquals('0.664921 0.329843 0.000000 0.250980', $res);
|
||||
|
||||
$res = $pdf->getPdfCmykComponents('cyan');
|
||||
$this->assertEquals('1.000000 0.000000 0.000000 0.000000', $res);
|
||||
}
|
||||
|
||||
public function testReadAccessorsDoNotRegisterSpotColors(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
|
||||
// Querying components for a default spot-color name must NOT register a
|
||||
// spot color (which would otherwise leak into the PDF spot resources).
|
||||
$pdf->getColorObject('red');
|
||||
$pdf->getPdfRgbComponents('green');
|
||||
$pdf->getPdfCmykComponents('cyan');
|
||||
$this->assertSame([], $pdf->getSpotColors());
|
||||
|
||||
$pon = 0;
|
||||
$this->assertSame('', $pdf->getPdfSpotObjects($pon));
|
||||
$this->assertSame(0, $pon);
|
||||
$this->assertSame('', $pdf->getPdfSpotResources());
|
||||
|
||||
// getPdfColor() is the explicit "emit a separation" path and DOES register.
|
||||
$pdf->getPdfColor('magenta');
|
||||
$this->assertArrayHasKey('magenta', $pdf->getSpotColors());
|
||||
}
|
||||
|
||||
public function testGetColorObjectResolvesRegisteredSpotColor(): void
|
||||
{
|
||||
$pdf = $this->getTestObject();
|
||||
|
||||
// A custom spot color is not part of the default spot color table, so the
|
||||
// read-only accessor can only resolve it from the internal registry. This
|
||||
// exercises the "already registered" early return of resolveSpotColorData().
|
||||
$cmyk = new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => 0.1,
|
||||
'magenta' => 0.2,
|
||||
'yellow' => 0.3,
|
||||
'key' => 0.4,
|
||||
'alpha' => 1.0,
|
||||
]);
|
||||
$pdf->addSpotColor('My Custom Spot', $cmyk);
|
||||
|
||||
$res = $pdf->getColorObject('My Custom Spot');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertSame($cmyk, $res);
|
||||
|
||||
// The read-only lookup must not have added or duplicated any registration.
|
||||
$spotColors = $pdf->getSpotColors();
|
||||
$this->assertCount(1, $spotColors);
|
||||
$this->assertArrayHasKey('mycustomspot', $spotColors);
|
||||
}
|
||||
}
|
||||
+399
@@ -0,0 +1,399 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* SpotTest.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use Com\Tecnick\Color\Model\Lab;
|
||||
use ReflectionProperty;
|
||||
|
||||
/**
|
||||
* Spot Color class test
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class SpotTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Color\Spot
|
||||
{
|
||||
return new \Com\Tecnick\Color\Spot();
|
||||
}
|
||||
|
||||
public function testGetSpotColors(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$res = $spot->getSpotColors();
|
||||
$this->assertEquals(0, \count($res));
|
||||
}
|
||||
|
||||
public function testNormalizeSpotColorName(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$res = $spot->normalizeSpotColorName('abc.FG12!-345');
|
||||
$this->assertEquals('abcfg12345', $res);
|
||||
}
|
||||
|
||||
public function testEncodeSpotColorName(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
// spaces and uppercase letters are preserved/encoded, not stripped
|
||||
$this->assertEquals('SPOTTYPE#20279#20C', $spot->encodeSpotColorName('SPOTTYPE 279 C'));
|
||||
// plain ASCII names are returned unchanged
|
||||
$this->assertEquals('Reflex#20Blue', $spot->encodeSpotColorName('Reflex Blue'));
|
||||
// the number sign and the PDF delimiters are escaped
|
||||
$this->assertEquals('a#23b#28c#29#2Fd', $spot->encodeSpotColorName('a#b(c)/d'));
|
||||
// tabs and other control/whitespace bytes are escaped
|
||||
$this->assertEquals('x#09y', $spot->encodeSpotColorName("x\ty"));
|
||||
// bytes outside printable ASCII (e.g. UTF-8 "é") are escaped per byte
|
||||
$this->assertEquals('caf#C3#A9', $spot->encodeSpotColorName('café'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetPdfSpotObjectsEncodesName(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$spot->addSpotColorFromArray('SPOTTYPE 279 C', [
|
||||
'cyan' => 0.66,
|
||||
'magenta' => 0.28,
|
||||
'yellow' => 0,
|
||||
'key' => 0,
|
||||
'alpha' => 1,
|
||||
]);
|
||||
|
||||
$obj = 1;
|
||||
$res = $spot->getPdfSpotObjects($obj);
|
||||
$this->assertStringContainsString('[/Separation /SPOTTYPE#20279#20C /DeviceCMYK', $res);
|
||||
$this->assertStringNotContainsString('SPOTTYPE279c', $res);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetSpotColor(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$res = $spot->getSpotColor('none');
|
||||
$this->assertEquals('0.000000 0.000000 0.000000 0.000000 k' . "\n", $res['color']->getPdfColor());
|
||||
$res = $spot->getSpotColor('all');
|
||||
$this->assertEquals('1.000000 1.000000 1.000000 1.000000 k' . "\n", $res['color']->getPdfColor());
|
||||
$res = $spot->getSpotColor('red');
|
||||
$this->assertEquals('0.000000 1.000000 1.000000 0.000000 K' . "\n", $res['color']->getPdfColor(true));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetSpotColorNotFound(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$spot->getSpotColor('missing-color');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetSpotColorObj(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$res = $spot->getSpotColorObj('none');
|
||||
$this->assertEquals('0.000000 0.000000 0.000000 0.000000 k' . "\n", $res->getPdfColor());
|
||||
$res = $spot->getSpotColorObj('all');
|
||||
$this->assertEquals('1.000000 1.000000 1.000000 1.000000 k' . "\n", $res->getPdfColor());
|
||||
$res = $spot->getSpotColorObj('red');
|
||||
$this->assertEquals('0.000000 1.000000 1.000000 0.000000 K' . "\n", $res->getPdfColor(true));
|
||||
}
|
||||
|
||||
public function testAddSpotColor(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$cmyk = new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
$spot->addSpotColor('test', $cmyk);
|
||||
$res = $spot->getSpotColors();
|
||||
$this->assertArrayHasKey('test', $res);
|
||||
$testColor = $res['test'] ?? null;
|
||||
$this->assertNotNull($testColor);
|
||||
|
||||
$this->assertEquals(1, $testColor['i']);
|
||||
$this->assertEquals('test', $testColor['name']);
|
||||
$this->assertEquals('0.666000 0.333000 0.000000 0.250000 k' . "\n", $testColor['color']->getPdfColor());
|
||||
|
||||
// test overwrite
|
||||
$cmyk = new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => 0.25,
|
||||
'magenta' => 0.35,
|
||||
'yellow' => 0.45,
|
||||
'key' => 0.55,
|
||||
'alpha' => 0.65,
|
||||
]);
|
||||
$key = $spot->addSpotColor('test', $cmyk);
|
||||
$this->assertEquals('test', $key);
|
||||
|
||||
$res = $spot->getSpotColors();
|
||||
$this->assertArrayHasKey('test', $res);
|
||||
$testColor = $res['test'] ?? null;
|
||||
$this->assertNotNull($testColor);
|
||||
|
||||
$this->assertEquals(1, $testColor['i']);
|
||||
$this->assertEquals('test', $testColor['name']);
|
||||
$this->assertEquals('0.250000 0.350000 0.450000 0.550000 k' . "\n", $testColor['color']->getPdfColor());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testAddSpotColorFromArray(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$key = $spot->addSpotColorFromArray('Brand Spot', [
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
|
||||
$this->assertEquals('brandspot', $key);
|
||||
$res = $spot->getSpotColor('Brand Spot');
|
||||
$this->assertEquals('0.666000 0.333000 0.000000 0.250000 k' . "\n", $res['color']->getPdfColor());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testAddSpotLabColor(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$key = $spot->addSpotLabColor('Brand Orange', 64.25, 58.5, 71.2);
|
||||
$this->assertEquals('brandorange', $key);
|
||||
|
||||
$res = $spot->getSpotColor('Brand Orange');
|
||||
$this->assertEquals(1, $res['i']);
|
||||
$this->assertEquals('Brand Orange', $res['name']);
|
||||
$this->assertEquals('Lab', $res['space']);
|
||||
$this->assertInstanceOf(\Com\Tecnick\Color\Model\Cmyk::class, $res['color']);
|
||||
$this->assertIsArray($res['lab']);
|
||||
$this->assertEquals([0.9505, 1.0, 1.089], $res['lab']['whitepoint']);
|
||||
$this->assertEquals([100.0, 0.0, 0.0], $res['lab']['c0']);
|
||||
$this->assertInstanceOf(\Com\Tecnick\Color\Model\Lab::class, $res['lab']['model']);
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'lstar' => 64.25,
|
||||
'astar' => 58.5,
|
||||
'bstar' => 71.2,
|
||||
'alpha' => 1,
|
||||
], $res['lab']['model']->toLabArray());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetSpotLabColorObj(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$spot->addSpotLabColor('Brand Orange', 64.25, 58.5, 71.2);
|
||||
|
||||
$res = $spot->getSpotLabColorObj('Brand Orange');
|
||||
$this->assertInstanceOf(\Com\Tecnick\Color\Model\Lab::class, $res);
|
||||
$this->bcAssertEqualsWithDelta([
|
||||
'lstar' => 64.25,
|
||||
'astar' => 58.5,
|
||||
'bstar' => 71.2,
|
||||
'alpha' => 1,
|
||||
], $res->toLabArray());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetSpotColorObjFromLab(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$spot->addSpotLabColor('Brand Orange', 64.25, 58.5, 71.2);
|
||||
|
||||
$cmyk = $spot->getSpotColorObj('Brand Orange');
|
||||
$this->assertInstanceOf(\Com\Tecnick\Color\Model\Cmyk::class, $cmyk);
|
||||
$this->assertEquals('0.000000 0.596375 0.949051 0.000000 k' . "\n", $cmyk->getPdfColor());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetSpotLabColorObjFromCmyk(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$spot->getSpotColor('cyan');
|
||||
|
||||
$lab = $spot->getSpotLabColorObj('cyan');
|
||||
$this->assertInstanceOf(\Com\Tecnick\Color\Model\Lab::class, $lab);
|
||||
}
|
||||
|
||||
public function testGetPdfSpotObjectsEmpty(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$obj = 1;
|
||||
$res = $spot->getPdfSpotObjects($obj);
|
||||
$this->assertEquals(1, $obj);
|
||||
$this->assertEquals('', $res);
|
||||
}
|
||||
|
||||
public function testGetPdfSpotResourcesEmpty(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$pdfSpotResources = $spot->getPdfSpotResources();
|
||||
$this->assertEquals('', $pdfSpotResources);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetPdfSpotObjects(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$cmyk = new \Com\Tecnick\Color\Model\Cmyk([
|
||||
'cyan' => 0.666,
|
||||
'magenta' => 0.333,
|
||||
'yellow' => 0,
|
||||
'key' => 0.25,
|
||||
'alpha' => 0.85,
|
||||
]);
|
||||
$spot->addSpotColor('test', $cmyk);
|
||||
$spot->getSpotColor('cyan');
|
||||
$spot->getSpotColor('magenta');
|
||||
$spot->getSpotColor('yellow');
|
||||
$spot->getSpotColor('key');
|
||||
|
||||
$obj = 1;
|
||||
$res = $spot->getPdfSpotObjects($obj);
|
||||
$this->assertEquals(6, $obj);
|
||||
$this->assertEquals(
|
||||
'2 0 obj'
|
||||
. "\n"
|
||||
. '[/Separation /test /DeviceCMYK <</Range [0 1 0 1 0 1 0 1] /C0 [0 0 0 0]'
|
||||
. ' /C1 [0.666000 0.333000 0.000000 0.250000] /FunctionType 2 /Domain [0 1] /N 1>>]'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n"
|
||||
. '3 0 obj'
|
||||
. "\n"
|
||||
. '[/Separation /Cyan /DeviceCMYK <</Range [0 1 0 1 0 1 0 1] /C0 [0 0 0 0]'
|
||||
. ' /C1 [1.000000 0.000000 0.000000 0.000000] /FunctionType 2 /Domain [0 1] /N 1>>]'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n"
|
||||
. '4 0 obj'
|
||||
. "\n"
|
||||
. '[/Separation /Magenta /DeviceCMYK <</Range [0 1 0 1 0 1 0 1] /C0 [0 0 0 0]'
|
||||
. ' /C1 [0.000000 1.000000 0.000000 0.000000] /FunctionType 2 /Domain [0 1] /N 1>>]'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n"
|
||||
. '5 0 obj'
|
||||
. "\n"
|
||||
. '[/Separation /Yellow /DeviceCMYK <</Range [0 1 0 1 0 1 0 1] /C0 [0 0 0 0]'
|
||||
. ' /C1 [0.000000 0.000000 1.000000 0.000000] /FunctionType 2 /Domain [0 1] /N 1>>]'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n"
|
||||
. '6 0 obj'
|
||||
. "\n"
|
||||
. '[/Separation /Key /DeviceCMYK <</Range [0 1 0 1 0 1 0 1] /C0 [0 0 0 0]'
|
||||
. ' /C1 [0.000000 0.000000 0.000000 1.000000] /FunctionType 2 /Domain [0 1] /N 1>>]'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n",
|
||||
$res,
|
||||
);
|
||||
|
||||
$res = $spot->getPdfSpotResources();
|
||||
$this->assertEquals('/ColorSpace << /CS1 2 0 R /CS2 3 0 R /CS3 4 0 R /CS4 5 0 R /CS5 6 0 R >>' . "\n", $res);
|
||||
|
||||
$resk = $spot->getPdfSpotResourcesByKeys(['cyan', 'yellow']);
|
||||
$this->assertEquals('/ColorSpace << /CS2 3 0 R /CS4 5 0 R >>' . "\n", $resk);
|
||||
|
||||
$resk_empty = $spot->getPdfSpotResourcesByKeys([]);
|
||||
$this->assertEquals('', $resk_empty);
|
||||
|
||||
// Test with non-existent keys to trigger continue statement
|
||||
$resk_mixed = $spot->getPdfSpotResourcesByKeys(['cyan', 'nonexistent', 'yellow', 'invalid']);
|
||||
$this->assertEquals('/ColorSpace << /CS2 3 0 R /CS4 5 0 R >>' . "\n", $resk_mixed);
|
||||
}
|
||||
|
||||
public function testGetPdfSpotObjectsLab(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
$spot->addSpotLabColor('Brand Orange', 64.25, 58.5, 71.2);
|
||||
|
||||
$obj = 7;
|
||||
$res = $spot->getPdfSpotObjects($obj);
|
||||
$this->assertEquals(8, $obj);
|
||||
$this->assertEquals(
|
||||
'8 0 obj'
|
||||
. "\n"
|
||||
. '[/Separation /Brand#20Orange [/Lab << /WhitePoint [0.950500 1.000000 1.089000]'
|
||||
. ' /BlackPoint [0.000000 0.000000 0.000000] /Range [-128.000000 127.000000 -128.000000 127.000000]>>] <<'
|
||||
. ' /FunctionType 2 /Domain [0 1] /C0 [100.000000 0.000000 0.000000]'
|
||||
. ' /C1 [64.250000 58.500000 71.200000] /N 1>>]'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n",
|
||||
$res,
|
||||
);
|
||||
|
||||
$pdfSpotResources = $spot->getPdfSpotResources();
|
||||
$this->assertEquals('/ColorSpace << /CS1 8 0 R >>' . "\n", $pdfSpotResources);
|
||||
}
|
||||
|
||||
public function testGetPdfSpotObjectsSkipsInvalidNonCmykColor(): void
|
||||
{
|
||||
$spot = $this->getTestObject();
|
||||
|
||||
$property = new ReflectionProperty($spot, 'spot_colors');
|
||||
$property->setValue($spot, [
|
||||
'invalid' => [
|
||||
'i' => 1,
|
||||
'n' => 0,
|
||||
'name' => 'Invalid',
|
||||
'color' => new Lab([
|
||||
'lstar' => 50,
|
||||
'astar' => 0,
|
||||
'bstar' => 0,
|
||||
'alpha' => 1,
|
||||
]),
|
||||
'space' => 'DeviceCMYK',
|
||||
'lab' => null,
|
||||
],
|
||||
]);
|
||||
|
||||
$obj = 10;
|
||||
// An invalid (non-CMYK, non-Lab) entry is skipped entirely: no object is
|
||||
// emitted and the PDF object counter is left unchanged.
|
||||
$this->assertSame('', $spot->getPdfSpotObjects($obj));
|
||||
$this->assertSame(10, $obj);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* TestUtil.php
|
||||
*
|
||||
* @since 2020-12-19
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* Web Color class test
|
||||
*
|
||||
* @since 2020-12-19
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class TestUtil extends \PHPUnit\Framework\TestCase
|
||||
{
|
||||
public function bcAssertEqualsWithDelta(
|
||||
mixed $expected,
|
||||
mixed $actual,
|
||||
float $delta = 0.01,
|
||||
string $message = '',
|
||||
): void {
|
||||
parent::assertEqualsWithDelta($expected, $actual, $delta, $message);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param class-string<\Throwable> $exception
|
||||
*/
|
||||
public function bcExpectException(string $exception): void
|
||||
{
|
||||
parent::expectException($exception);
|
||||
}
|
||||
}
|
||||
+470
@@ -0,0 +1,470 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* WebTest.php
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use PHPUnit\Framework\Attributes\DataProvider;
|
||||
|
||||
/**
|
||||
* Web Color class test
|
||||
*
|
||||
* @since 2015-02-21
|
||||
* @category Library
|
||||
* @package Color
|
||||
* @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-color
|
||||
*/
|
||||
class WebTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Color\Web
|
||||
{
|
||||
return new \Com\Tecnick\Color\Web();
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetHexFromName(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$res = $web->getHexFromName('aliceblue');
|
||||
$this->assertEquals('f0f8ffff', $res);
|
||||
$res = $web->getHexFromName('color.yellowgreen');
|
||||
$this->assertEquals('9acd32ff', $res);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetHexFromNameInvalid(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$web = $this->getTestObject();
|
||||
$web->getHexFromName('invalid');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetNameFromHex(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$res = $web->getNameFromHex('f0f8ffff');
|
||||
$this->assertEquals('aliceblue', $res);
|
||||
$res = $web->getNameFromHex('9acd32ff');
|
||||
$this->assertEquals('yellowgreen', $res);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetNameFromHexBad(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$web = $this->getTestObject();
|
||||
$web->getNameFromHex('012345');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testExtractHexCode(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$res = $web->extractHexCode('abc');
|
||||
$this->assertEquals('aabbccff', $res);
|
||||
$res = $web->extractHexCode('#abc');
|
||||
$this->assertEquals('aabbccff', $res);
|
||||
$res = $web->extractHexCode('abcd');
|
||||
$this->assertEquals('aabbccdd', $res);
|
||||
$res = $web->extractHexCode('#abcd');
|
||||
$this->assertEquals('aabbccdd', $res);
|
||||
$res = $web->extractHexCode('112233');
|
||||
$this->assertEquals('112233ff', $res);
|
||||
$res = $web->extractHexCode('#112233');
|
||||
$this->assertEquals('112233ff', $res);
|
||||
$res = $web->extractHexCode('11223344');
|
||||
$this->assertEquals('11223344', $res);
|
||||
$res = $web->extractHexCode('#11223344');
|
||||
$this->assertEquals('11223344', $res);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testExtractHexCodeBad(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$web = $this->getTestObject();
|
||||
$web->extractHexCode('');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testExtractHexCodeInvalidLength(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$web = $this->getTestObject();
|
||||
// 5-character hex code is accepted by regex but not handled by switch
|
||||
$web->extractHexCode('12345');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testExtractHexCodeInvalidLength7(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$web = $this->getTestObject();
|
||||
// 7-character hex code is accepted by regex but not handled by switch
|
||||
$web->extractHexCode('1234567');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetRgbObjFromHex(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$rgb = $web->getRgbObjFromHex('#87ceebff');
|
||||
$this->assertEquals('#87ceebff', $rgb->getRgbaHexColor());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetRgbObjFromHexBad(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$web = $this->getTestObject();
|
||||
$web->getRgbObjFromHex('xx');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetRgbObjFromName(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$rgb = $web->getRgbObjFromName('skyblue');
|
||||
$this->assertEquals('#87ceebff', $rgb->getRgbaHexColor());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetRgbObjFromNameBad(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$web = $this->getTestObject();
|
||||
$web->getRgbObjFromName('xx');
|
||||
}
|
||||
|
||||
public function testNormalizeValue(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$res = $web->normalizeValue('50%', 50);
|
||||
$this->assertEquals(0.5, $res);
|
||||
$res = $web->normalizeValue(128, 255);
|
||||
$this->bcAssertEqualsWithDelta(0.5, $res);
|
||||
}
|
||||
|
||||
public function testNormalizeValueInvalidPercent(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$this->assertSame(0.0, $web->normalizeValue('abc%', 255));
|
||||
}
|
||||
|
||||
public function testNormalizeValueUnsupportedType(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$this->assertSame(0.0, $web->normalizeValue([], 255));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetColorObj(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$res = $web->getColorObj('');
|
||||
$this->assertNull($res);
|
||||
$res = $web->getColorObj('t()');
|
||||
$this->assertNull($res);
|
||||
$res = $web->getColorObj('["T"]');
|
||||
$this->assertNull($res);
|
||||
$res = $web->getColorObj('transparent');
|
||||
$this->assertNull($res);
|
||||
$res = $web->getColorObj('color.transparent');
|
||||
$this->assertNull($res);
|
||||
$res = $web->getColorObj('royalblue');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4169e1ff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('#1a2b3c4d');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#1a2b3c4d', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('#1a2b3c');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#1a2b3cff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('#1234');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#11223344', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('#123');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#112233ff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('["G",0.5]');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#808080ff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('["RGB",0.25,0.50,0.75]');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('["CMYK",0.666,0.333,0,0.25]');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('g(50%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#808080ff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('g(128)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#808080ff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('rgb(25%,50%,75%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('rgb(64,128,191)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('rgba(25%,50%,75%,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfd9', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('rgba(64,128,191,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfd9', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('hsl(210,50%,50%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
// saturation/lightness without "%" are treated as CSS percentages (÷100),
|
||||
// so the bare form is equivalent to the "%" form.
|
||||
$res = $web->getColorObj('hsl(210,50,50)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
// decimal percentages are accepted
|
||||
$res = $web->getColorObj('hsl(210,50.0%,50.0%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('hsla(210,50%,50%,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfd9', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('cmyk(67%,33%,0,25%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('cmyk(67,33,0,25)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('cmyka(67,33,0,25,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfd9', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('cmyka(67%,33%,0,25%,0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfd9', $res->getRgbaHexColor());
|
||||
// decimal percentages are accepted for CMYK components
|
||||
$res = $web->getColorObj('cmyk(66.5%,33%,0,25%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('lab(52% 0 -39)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#407fbfff', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('lab(52% 0 -39 / 0.85)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#407fbfd9', $res->getRgbaHexColor());
|
||||
$res = $web->getColorObj('lab(52 0 -39 / 85%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#407fbfd9', $res->getRgbaHexColor());
|
||||
}
|
||||
|
||||
/**
|
||||
* Modern CSS syntax: space-separated components and percentage alpha.
|
||||
*
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
public function testGetColorObjModernSyntax(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
|
||||
// space-separated components are equivalent to the comma-separated form
|
||||
$res = $web->getColorObj('rgb(64 128 191)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
|
||||
$res = $web->getColorObj('hsl(210 50% 50%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bfff', $res->getRgbaHexColor());
|
||||
|
||||
$res = $web->getColorObj('cmyk(67% 33% 0% 25%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#3f80bfff', $res->getRgbaHexColor());
|
||||
|
||||
// percentage alpha is accepted (50% == 0.5)
|
||||
$res = $web->getColorObj('rgba(64,128,191,50%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bf80', $res->getRgbaHexColor());
|
||||
|
||||
// modern space syntax with a "/" alpha separator
|
||||
$res = $web->getColorObj('rgb(64 128 191 / 50%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bf80', $res->getRgbaHexColor());
|
||||
|
||||
$res = $web->getColorObj('hsla(210,50%,50%,50%)');
|
||||
$this->assertNotNull($res);
|
||||
$this->assertEquals('#4080bf80', $res->getRgbaHexColor());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string[]>
|
||||
*/
|
||||
public static function getBadColor(): array
|
||||
{
|
||||
return [['g(-)'], ['rgb(-)'], ['hsl(-)'], ['cmyk(-)'], ['lab(-)']];
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Color\Exception
|
||||
*/
|
||||
#[DataProvider('getBadColor')]
|
||||
public function testGetColorObjBad(string $bad): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Color\Exception::class);
|
||||
$web = $this->getTestObject();
|
||||
$web->getColorObj($bad);
|
||||
}
|
||||
|
||||
public function testTryGetColorObj(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
|
||||
$ok = $web->tryGetColorObj('royalblue');
|
||||
$this->assertNotNull($ok);
|
||||
$this->assertEquals('#4169e1ff', $ok->getRgbaHexColor());
|
||||
|
||||
$bad = $web->tryGetColorObj('g(-)');
|
||||
$this->assertNull($bad);
|
||||
}
|
||||
|
||||
public function testGetRgbSquareDistance(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$cola = [
|
||||
'red' => 0,
|
||||
'green' => 0,
|
||||
'blue' => 0,
|
||||
];
|
||||
$colb = [
|
||||
'red' => 1,
|
||||
'green' => 1,
|
||||
'blue' => 1,
|
||||
];
|
||||
$dist = $web->getRgbSquareDistance($cola, $colb);
|
||||
$this->assertEquals(3, $dist);
|
||||
|
||||
$cola = [
|
||||
'red' => 0.5,
|
||||
'green' => 0.5,
|
||||
'blue' => 0.5,
|
||||
];
|
||||
$colb = [
|
||||
'red' => 0.5,
|
||||
'green' => 0.5,
|
||||
'blue' => 0.5,
|
||||
];
|
||||
$dist = $web->getRgbSquareDistance($cola, $colb);
|
||||
$this->assertEquals(0, $dist);
|
||||
|
||||
$cola = [
|
||||
'red' => 0.25,
|
||||
'green' => 0.50,
|
||||
'blue' => 0.75,
|
||||
];
|
||||
$colb = [
|
||||
'red' => 0.50,
|
||||
'green' => 0.75,
|
||||
'blue' => 1.00,
|
||||
];
|
||||
$dist = $web->getRgbSquareDistance($cola, $colb);
|
||||
$this->assertEquals(0.1875, $dist);
|
||||
}
|
||||
|
||||
public function testGetClosestWebColor(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
$col = [
|
||||
'red' => 1,
|
||||
'green' => 0,
|
||||
'blue' => 0,
|
||||
];
|
||||
$color = $web->getClosestWebColor($col);
|
||||
$this->assertEquals('red', $color);
|
||||
|
||||
$col = [
|
||||
'red' => 0,
|
||||
'green' => 1,
|
||||
'blue' => 0,
|
||||
];
|
||||
$color = $web->getClosestWebColor($col);
|
||||
$this->assertEquals('lime', $color);
|
||||
|
||||
$col = [
|
||||
'red' => 0,
|
||||
'green' => 0,
|
||||
'blue' => 1,
|
||||
];
|
||||
$color = $web->getClosestWebColor($col);
|
||||
$this->assertEquals('blue', $color);
|
||||
|
||||
$col = [
|
||||
'red' => 0.33,
|
||||
'green' => 0.4,
|
||||
'blue' => 0.18,
|
||||
];
|
||||
$color = $web->getClosestWebColor($col);
|
||||
$this->assertEquals('darkolivegreen', $color);
|
||||
|
||||
// On an exact tie between duplicate hex codes (aqua/cyan both 00ffff),
|
||||
// the first/canonical name is returned.
|
||||
$col = [
|
||||
'red' => 0,
|
||||
'green' => 1,
|
||||
'blue' => 1,
|
||||
];
|
||||
$color = $web->getClosestWebColor($col);
|
||||
$this->assertEquals('aqua', $color);
|
||||
}
|
||||
|
||||
public function testGetClosestWebColorFromString(): void
|
||||
{
|
||||
$web = $this->getTestObject();
|
||||
|
||||
$color = $web->getClosestWebColorFromString('rgb(255,0,0)');
|
||||
$this->assertEquals('red', $color);
|
||||
|
||||
$color = $web->getClosestWebColorFromString('#0000ff');
|
||||
$this->assertEquals('blue', $color);
|
||||
|
||||
$color = $web->getClosestWebColorFromString('invalid-color-value');
|
||||
$this->assertEquals('', $color);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user