https://github.com/femtopixel/crop

PHP Component to resize images from a configuration file
https://github.com/femtopixel/crop

crop dimensions distortion image packagist php resized-images

Last synced: 4 months ago
JSON representation

PHP Component to resize images from a configuration file

• Host: GitHub
• URL: https://github.com/femtopixel/crop
• Owner: femtopixel
• License: mit
• Created: 2016-06-14T11:01:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-02T16:14:24.000Z (10 months ago)
• Last Synced: 2024-09-26T14:07:42.997Z (5 months ago)
• Topics: crop, dimensions, distortion, image, packagist, php, resized-images
• Language: PHP
• Homepage: https://brands.jaymoulin.me/femtopixel/crop/
• Size: 122 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
> [!CAUTION]

> As-of 2021, this product does not have a free support team anymore. If you want this product to be maintained, please support my work.

 

> [!NOTE]

> (This product is available under a free and permissive license, but needs financial support to sustain its continued improvements. In addition to maintenance and stability there are many  desirable features yet to be added.)

![logo](logo.png)

Crop

====

[![Latest Stable Version](https://poser.pugx.org/femtopixel/crop/v/stable)](https://packagist.org/packages/femtopixel/crop) 

[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.0-8892BF.svg?style=flat-square)](https://php.net/)

[![License](https://poser.pugx.org/femtopixel/crop/license)](https://packagist.org/packages/femtopixel/crop)

[![PayPal donation](https://github.com/jaymoulin/jaymoulin.github.io/raw/master/ppl.png "PayPal donation")](https://www.paypal.me/jaymoulin)

[![Buy me a coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png "Buy me a coffee")](https://www.buymeacoffee.com/jaymoulin)

[![Buy me a coffee](https://ko-fi.com/img/githubbutton_sm.svg "Buy me a coffee")](https://www.ko-fi.com/jaymoulin)

This component will resize images following configuration rules.

allows only defined format

## Installation

```

composer require femtopixel/crop

```

## Usage

```php

 array(

        'width' => 100,

        'height' => 100,

        'full' => 'cropped',

    ),

);

$image = new \FemtoPixel\Crop\Crop('/path/to/file.png', 'mini');

$image->setFormatsFromArray($formats)->render();

```

You can define as many format that you want!

- First parameter is path to your file to display

- Second (optional) is the format you want to display in (default : 'original' (no modification))

- Third (optional) is path to default image displayed if path in first parameter doesn't exist. This file will be displayed in requested format. (default : 'src/missing.png')

 

## Configuration

Each format given in method `setFormatsFromArray` must define `width`, `height` and optional `full` index.

 

`full` can be configured to 4 values depending on attended rendering :

 - `none` : No cropping, no resize. Will render image with original file dimensions.

 - `cropped` : Crop the rendered image to be exactly dimensions defined in configuration.

 - `height` : Resize the image without distortion to have height to value defined in configuration.

 - `width` : Resize the image without distortion to have width to value defined in configuration.