structurize/structurize is a versatile PHP package designed to facilitate communication with the Structurize API. This framework-agnostic package empowers developers to interact seamlessly with the Structurize API, utilizing the expressive and dynamic features of PHP. The primary functionality of this package lies in its ability to generate JSON payloads, providing a convenient way to structure and send data to the Structurize API.
Structurize/Structurize is built to be independent of any specific PHP framework, making it compatible with a wide range of PHP applications. Whether you are using Laravel, Symfony, CodeIgniter, or any other framework, you can easily integrate this package into your project.
The Structurize API relies on JSON for data communication. Structurize/Structurize takes advantage of this by allowing developers to create JSON payloads using a PHP-based API. This simplifies the process of constructing complex data structures, making it more intuitive and developer-friendly.
Integrating Structurize/Structurize into your project is straightforward. The package is installable via Composer, the de facto PHP package manager. Once installed, you can leverage the package to streamline your interactions with the Structurize API without the need for extensive configuration.
To install structurize/structurize, use Composer:
composer require structurize/structurizeIn this programmatic flow, a series of operations are executed to process an image through a pipeline of actions. The process begins by initializing a new Building instance with specified parameters, including a webhook URL and input/output file names. The subsequent actions are chained using the add method, forming a sequence of image processing steps:
-
StorageGet Operation: Retrieves the input image file from storage, specified as 'your_input.jpg', and assigns it to the variable
$input_stream. -
ImageBlur Operation: Applies a blur effect to the input image stored in
$input_streamand stores the result in the variable$blurred. -
ImageRemoveBg Operation: Removes the background from the blurred image stored in
$blurredand saves the result in the variable$removed. -
ImageResize Operation: Resizes the image stored in
$removedto a width of 1024 pixels, and the resized image is stored in the variable$resized. -
StoragePut Operation: Stores the final resized image,
$resized, into the specified output file, 'your_output.jpg', in the storage.
This programmatic flow encapsulates a streamlined image processing pipeline, demonstrating the power and flexibility of the underlying Building class and the various image processing operations.
new Building(['webhook' => 'http://webhook.acme.com', 'input_file' => 'your_input.jpg', 'output_file' => 'your_output.jpg']))
->add((new StorageGet())->parameters(filename: '$input_file')->as('$input_stream'))
->add((new ImageBlur())->parameters(input: '$input_stream')->as('$blurred'))
->add((new ImageRemoveBg())->parameters(input: '$blurred')->as('$removed'))
->add((new ImageResize())->parameters(input: '$removed',width: 1024)->as('$resized'))
->add((new StoragePut())->parameters(filename:'$output_file', input:'$resized'))Contributions to Structurize/Structurize are welcome! If you encounter issues, have suggestions, or want to contribute improvements, please feel free to open an issue or submit a pull request on the GitHub repository.
Structurize/Structurize is open-source software licensed under the MIT License.
Structurize/Structurize simplifies the integration of your PHP application with the Structurize API. By providing a convenient PHP API for constructing JSON payloads, this package enhances the developer experience and promotes cleaner, more expressive code. Explore the documentation on GitHub to unlock the full potential of Structurize/Structurize in your projects.