whitedigital-eu / storage-item-resource
Storage Item resource
Installs: 409
Dependents: 2
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Type:symfony-bundle
Requires
- php: >=8.1.0
- ext-exif: *
- api-platform/core: ^3
- doctrine/annotations: *
- doctrine/doctrine-bundle: *
- doctrine/orm: *
- doctrine/persistence: *
- symfony/config: *
- symfony/framework-bundle: *
- symfony/http-foundation: *
- symfony/http-kernel: *
- symfony/property-info: *
- symfony/security-core: *
- symfony/serializer: *
- symfony/translation: *
- symfony/validator: *
- vich/uploader-bundle: *
- whitedigital-eu/entity-resource-mapper-bundle: *
Requires (Dev)
Conflicts
This package is auto-updated.
Last update: 2024-10-15 16:06:29 UTC
README
System Requirements
PHP 8.1+
Symfony 6.2+
Installation
The recommended way to install is via Composer:
composer require whitedigital-eu/storage-item-resource
With the help of vich/uploader-bundle
this package enables file upload when used with api platform.
After this, you need to update your database schema to use StorageItem entity.
If using migrations:
bin/console doctrine:migrations:diff bin/console doctrine:migrations:migrate
If by schema update:
bin/console doctrine:schema:update --force
This will enable new StorageItem
api resource with /api/storage_items
iri. If you want different iri, see
https://github.com/whitedigital-eu/entity-resource-mapper#extended-api-resource how to override it.
Overriding default api resource (and therefore api endpoints)
By default, StorageItem resource is based on StorageItemResource
If you wish not to use this resource and not expose the api endpoints it provides, just set a custom api resource path
with a configuration value. If you set it as null
, api platform will not register api resource located within this
package.
storage_item_resource: custom_api_resource_path: '%kernel.project_dir%/src/MyCustomPath' # custom_api_resource_path: null
use Symfony\Config\StorageItemResourceConfig; return static function (StorageItemResourceConfig $config): void { $config->customApiResourcePath('%kernel.project_dir%/src/MyCustomPath') // or ->customApiResourcePath(null); };
After overriding default api resource, do not forget to update ClassMapperConfigurator configuration that is used for
resource <-> entity mapping in whitedigital-eu/entity-resource-mapper-bundle
use App\ApiResource\Admin\StorageItemResource; use WhiteDigital\StorageItem\Entity\StorageItem; use WhiteDigital\EntityResourceMapper\Mapper\ClassMapper; use WhiteDigital\EntityResourceMapper\Mapper\ClassMapperConfiguratorInterface; final class ClassMapperConfigurator implements ClassMapperConfiguratorInterface { public function __invoke(ClassMapper $classMapper): void { $classMapper->registerMapping(StorageItemResource::class, StorageItem::class); } }