PHPackages                             sfenvironment/signmaker - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. sfenvironment/signmaker

ActiveLibrary[Utility & Helpers](/categories/utility)

sfenvironment/signmaker
=======================

PHP application for generating refuse signs from configuration. Used with UI

0109PHP

Since Mar 26Pushed 1y ago2 watchersCompare

[ Source](https://github.com/sfenvironment/signmaker)[ Packagist](https://packagist.org/packages/sfenvironment/signmaker)[ RSS](/packages/sfenvironment-signmaker/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

SFEnvironment Signmaker
=======================

[](#sfenvironment-signmaker)

This PHP application generates printable signs for organizing refuse into bins. You provide it with a background and images of items that the user can select. It leverages Dompdf to convert HTML into PDF for printing.

Overview
--------

[](#overview)

The Signmaker application allows users to create custom signs by selecting images from a specified directory and placing them on a background image within defined bounding box coordinates. The application then generates a PDF of the created sign, suitable for printing.

This project is designed to be used in conjunction with a service such as `sfenvironment/signmaker_ui`, a Drupal module, that can dynamically assemble the necessary parameters, but the parameters can be passed manually as documented below.

Features
--------

[](#features)

- **Customizable Sign Layout:** Users can define the bounding box (top, right, bottom, left) within which images are placed on the background.
- **Image Selection:** Users can select images from a specified directory to include in their sign.
- **PDF Generation:** The application generates a PDF document of the created sign using Dompdf.
- **Dynamic Stylesheet Inclusion:** Supports inclusion of multiple stylesheets via URL parameters.
- **JavaScript Interaction:** Client-side JavaScript (`signmaker.js`) handles image selection and layout interactions.

Prerequisites
-------------

[](#prerequisites)

- PHP with Dompdf extension installed.
- Web server with PHP support.
- A directory containing images for the sign.
- A background image for the sign.

Installation
------------

[](#installation)

1. **Require via composer:**```
    composer require sfenvironment/signmaker
    ```
2. **Ensure the web server has write permissions to the directory where you want to save the PDFs (if applicable).**

Usage
-----

[](#usage)

Access the `index.php` file through your web browser with the following URL parameters:

- `directory`: The path to the directory containing the images and background (required).
- `background`: The filename of the background image (optional, defaults to `background.*` if present).
- `bbox`: The bounding box coordinates in percentages, separated by commas (top, right, bottom, left) (required).
- `root`: The root url of the application, for asset loading.
- `stylesheets`: A comma separated list of stylesheets to include.

Example URL: [http://your-server/?directory=/path/to/images&bbox=10,10,90,90&root=/your/root&stylesheets=/assets/css/extra.css,/assets/css/more.css](http://your-server/?directory=/path/to/images&bbox=10,10,90,90&root=/your/root&stylesheets=/assets/css/extra.css,/assets/css/more.css)

### User Interaction

[](#user-interaction)

1. **Select Items:** The left sidebar displays a list of images from the specified directory. Users can select images to add to the sign.
2. **Image Placement:** The selected images are displayed within the bounding box on the background image.
3. **Reset/Generate:**
    - **Start Over:** Clears the selected images and resets the sign.
    - **Save PDF:** Generates and downloads a PDF of the sign.

Code Explanation
----------------

[](#code-explanation)

### `Signmaker::handle()`

[](#signmakerhandle)

- Retrieves configuration parameters from the URL.
- Generates the HTML structure for the sign, including image selection menu and PDF generation controls.
- Dynamically calculates CSS styles based on the bounding box coordinates.
- Embeds JavaScript configuration data into the HTML.

### `Signmaker::generate($html, $output = 'output', $additional_chroot = [])`

[](#signmakergeneratehtml-output--output-additional_chroot--)

- Uses Dompdf to convert the provided HTML into a PDF.
- Sets PDF options, including remote image loading and chroot for file access.
- Handles different output modes: `stream` (displays PDF in browser) and `output` (returns PDF data).
- Injects the main stylesheet into the HTML.

### `Signmaker::getConfiguration()`

[](#signmakergetconfiguration)

- Parses URL parameters to retrieve configuration data.
- Scans the specified directory for image files.
- Validates required parameters (directory, bbox).
- Constructs and returns the configuration array.

Assets
------

[](#assets)

- `assets/css/style.css`: Contains the base CSS styles for the sign.
- `assets/js/signmaker.js`: Handles client-side interactions.

Dependencies
------------

[](#dependencies)

- Dompdf: PDF generation library.

Notes
-----

[](#notes)

- Ensure the image directory and background image are accessible to the web server.
- Adjust the bounding box coordinates to customize the image placement.
- The application assumes images are located within the specified directory.
- Error handling is basic, consider adding more robust validation and error reporting.

Contributing
------------

[](#contributing)

Feel free to submit pull requests or open issues for improvements or bug fixes.

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity15

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/3453adb119d84f36e8f217b0ed1972e0a47fa899d6ebeaa03a4a5168eec17d90?d=identicon)[tylerbrowncifushuster](/maintainers/tylerbrowncifushuster)

![](https://www.gravatar.com/avatar/c427cfea433de75ba7623360ea3a73c8471e884411b911676595afd3028aac74?d=identicon)[sfenvironment](/maintainers/sfenvironment)

---

Top Contributors

[![tylershuster](https://avatars.githubusercontent.com/u/3999320?v=4)](https://github.com/tylershuster "tylershuster (10 commits)")

### Embed Badge

![Health badge](/badges/sfenvironment-signmaker/health.svg)

```
[![Health](https://phpackages.com/badges/sfenvironment-signmaker/health.svg)](https://phpackages.com/packages/sfenvironment-signmaker)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)