PHPackages                             notafacil/image - 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. [Framework](/categories/framework)
4. /
5. notafacil/image

ActiveProject[Framework](/categories/framework)

notafacil/image
===============

API to consume resources for apigility project as statics image and files management

0.1.1(8y ago)05MITPHP

Since Feb 19Pushed 8y ago1 watchersCompare

[ Source](https://github.com/notafacil/image)[ Packagist](https://packagist.org/packages/notafacil/image)[ RSS](/packages/notafacil-image/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (1)Dependencies (5)Versions (4)Used By (0)

notafacil/image for Apigility
=============================

[](#notafacilimage-for-apigility)

\#Images API Handler This module is purposed to handle image for an API (create/upload, read, update, delete). It use MySQL with Doctrine ORM. This module is extendable to use another database adapter.

Currently this module has support these resources with required OAuth2 Authentication

- POST /v1.0/image
- GET /v1.0/image/id
- PATCH /v1.0/image/id
- DELETE /v1.0/image/id

To retrieve the access token, you can use this resource `POST /oauth` by use some params:

- grant\_type
- client\_secret
- client\_id
- username
- password

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

[](#dependencies)

- [doctrine/doctrine-orm-module](https://packagist.org/packages/doctrine/doctrine-orm-module)
- [zfcampus/zf-oauth2-doctrine](https://packagist.org/packages/zfcampus/zf-oauth2-doctrine)

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

[](#installation)

This is a ZF2/Apigility module, so to use it on your ZF2/Apigility project, need to add `repositories` and `require` on `composer.json`.

```
  "require": {
    .
    .
    .
    "notafacil/image": "1.1"
  }

```

Run `composer update` then enable the module on `config/application.config.php`

```
return array(
    'modules' => array(
       .
       .
       .
       'Notafacil\\Image',
       'ZF\\OAuth2\\Doctrine',
       'DoctrineDataFixtureModule'
    )
)

```

Configuration
-------------

[](#configuration)

Because of this module use `doctrine/doctrine-orm-module`, we just need to configure database credential using configuration file. I prepare the config file here `config/doctrine.local.php.dst`. Just copy this file to `config/autoload/doctrine.local.php` and change the `connection params`

```
    'connection' => array(
        'orm_default' => array(
            'driverClass' => 'Doctrine\\DBAL\\Driver\\PDOMySql\\Driver',
            'params' => array(
                'host'     => '127.0.0.1',
                'dbname'   => 'apigility',
                'user'     => 'apigility',
                'password' => 'apigility',
            ),
        ),
    ),

```

After that, we need to configure the `image path`, `thumbnail path`, `original file path` and `Asset Manager path`. The configuration file is here `config/notafacil.image.local.php.dist`. Copy this file to `config/autoload/notafacil.image.local.php` and adjust these configuration

```
    'asset_manager' => array(
        'resolver_configs' => array(
            'paths' => array(
                'data/upload',
            ),
        ),
    ),
    'images' => array(
        'asset_manager_resolver_path' => 'data/upload',
        'target' => 'data/upload/images/img',
        'thumb_path' => 'data/upload/images/thumbs',
        'ori_path'   => 'data/upload/images/ori',
    ),

```

Make sure those paths are exists and writeable by `Web Server`, but if you just use `PHP built in web server` for development you don't need to change their permissions.

OAuth2
------

[](#oauth2)

To enable `OAuth2` Authentication, just copy default configuration files `(config/oauth2.doctrine-orm.local.php.dist, config/oauth2.local.php.dist)` to `config/autoload/oauth2.doctrine-orm.local.php` and `config/autoload/oauth2.local.php`.

We also able to configure `authorization` based on `Scope`. Currently ACL by `Scope` just supported by `Client Credentials` **Grant Type**. This is caused by limitation from `ZF-OAUTH2`. To add another **Grant Type** we should extend the `ZF-OAUTH2` code. For configuration, just add configuration mentioned above (`config/autoload/notafacil.image.local.php`)

```
    'authorization' => array(
        'scopes' => array(
            'post' => array(
                'resource' => 'Notafacil\Image\V1\Rest\Image\Controller::collection',
                'method' => 'POST',
            ),
            'update' => array(
                'resource' => 'Notafacil\Image\V1\Rest\Image\Controller::entity',
                'method' => 'PATCH',
            ),
            'delete' => array(
                'resource' => 'Notafacil\Image\V1\Rest\Image\Controller::entity',
                'method' => 'DELETE',
            )
        )
    ),

```

Define `Scope` name as key, and define `resource` and `method` wanna be authorized.

Database
--------

[](#database)

This module use a tables `image`, `user` and another tables for `OAuth2`. Currently it use `MySQL`, but you can change it based on your need easily as long as the database is supported by `Doctrine ORM`. If you have follow instructions above, it mean just remain creating the database table.

To do that just run this command from `app skeleton` working directory

```
vendor/bin/doctrine-module orm:schema-tool:create

```

Table will be created and if you wanna try the API with sample data. I have prepare them on the source code. Please run this command

```
vendor/bin/doctrine-module data-fixture:import

```

Then run the API

```
php -S 0.0.0.0:8080 -t public public/index.php

```

Example
-------

[](#example)

Here are some screenshots I made while trying the API. I use `Postman Chrome Extension` as `REST Client`. You can use the same data with the screenshots, because I make it same in `Data Fixtures`.

\####Request Access Token From OAuth Using Credential, Client ID and Client Secret [![Request Access Token From OAuth Using Credential, Client ID and Client Secret](https://github.com/notafacil/image/raw/master/media/01-request-oauth2-access-token.png)](https://github.com/notafacil/image/blob/master/media/01-request-oauth2-access-token.png)

**Then use the access token on `Authorization Header` while send `Request` to API**

\####Upload Image Using POST Method[![Upload Image Using POST Method](https://github.com/notafacil/image/raw/master/media/02-uploading-image-use-post-method.png)](https://github.com/notafacil/image/blob/master/media/02-uploading-image-use-post-method.png)

\####Retrieve The Uploaded Image Using GET Method[![Retrieve The Uploaded Image Using GET Method](https://github.com/notafacil/image/raw/master/media/03-retrieving-image-use-get-method.png)](https://github.com/notafacil/image/blob/master/media/03-retrieving-image-use-get-method.png)

\####Update Image Using PATCH Method[![Update Image Using PATCH Method](https://github.com/notafacil/image/raw/master/media/04-updating-image-use-patch-method.png)](https://github.com/notafacil/image/blob/master/media/04-updating-image-use-patch-method.png)

\####Retrieve Images Collection Using GET Method[![Retrieve Images Collection Using GET Method](https://github.com/notafacil/image/raw/master/media/05-retrieving-images-01-using-get-method.png)](https://github.com/notafacil/image/blob/master/media/05-retrieving-images-01-using-get-method.png)

[![Retrieve Images Collection Using GET Method](https://github.com/notafacil/image/raw/master/media/06-retrieving-images-02-using-get-method.png)](https://github.com/notafacil/image/blob/master/media/06-retrieving-images-02-using-get-method.png)

\#####Delete Image Using DELETE Method[![Delete Image Using DELETE Method](https://github.com/notafacil/image/raw/master/media/07-deleting-images-using-del-method.png)](https://github.com/notafacil/image/blob/master/media/07-deleting-images-using-del-method.png)

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 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.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

3006d ago

### Community

Maintainers

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

---

Top Contributors

[![sergiohermes](https://avatars.githubusercontent.com/u/1915564?v=4)](https://github.com/sergiohermes "sergiohermes (23 commits)")

---

Tags

apiframeworkimagezf3apigility

### Embed Badge

![Health badge](/badges/notafacil-image/health.svg)

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

###  Alternatives

[lanin/laravel-api-debugger

Easily debug your JSON API.

2311.8M](/packages/lanin-laravel-api-debugger)[gotzmann/comet

Modern PHP framework for building blazing fast REST APIs and microservices

68816.2k1](/packages/gotzmann-comet)[psx/psx

PHP REST API Framework

17112.6k3](/packages/psx-psx)

PHPackages © 2026

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