Download the PHP package spiral/writeaway without Composer
On this page you can find all versions of the php package spiral/writeaway. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package writeaway
PHP API server for Writeaway editor
License:
MIT License (MIT). Please see Spiral Scout.
TODO
- add tests for public services
Usage
- Register
WriteawayBootloaderin the AppNote that it must be registered and after
RouterBootloader. - Implement
MetaProviderInterface WriteawayCommandBootloadercan be added if you want to have a reset command.Note that it uses
TokenizerBootloaderso it must be registered beforeCommandsBootloader.WriteawayViewsBootloadercan be added if you want use ready views bundle.
API Endpoints:
List Images
GET or POST writeaway:images:list to fetch a full list of available images.
Example response:
| Possible image fields: | Field | Type | Required | Description |
|---|---|---|---|---|
| id | string | Required | Image id | |
| src | string | Required | Image source URL | |
| thumbnailSrc | string | Optional | Image thumbnail URL | |
| height | number | Optional | Image height to display | |
| width | number | Optional | Image width to display |
Upload Image
POST writeaway:images:upload to upload an image file.
Example request:
image - FormData file
Example response:
For possible image fields see the previous endpoint.
Delete Image
POST or DELETE writeaway:images:delete to delete a particular image
Example request:
Example response:
Get Piece
GET or POST writeaway:pieces:get to fetch a particular piece by its id and type.
Example request:
If no pieces found, a new one wil be created.
idis a unique value across all pieces.
Example response:
In case if validation errors the example response will be:
Get Pieces in bulk
GET or POST writeaway:pieces:bulk to fetch a particular pieces by theirs id and type.
Example request:
Example response:
Not found pieces will be ignored.
In case if validation errors the example response will be:
Save Piece
POST writeaway:pieces:save to save a particular piece by its id and type.
Example request:
If no pieces found, a new one wil be created.
idis a unique value across all pieces.
Example response:
In case if validation errors the example response will be:
Components
Meta
Meta is a structure designed to represent current piece editor. While this package knows nothing about real app actors,
\Spiral\Writeaway\Service\Meta\ProviderInterface is given - a developer can bind it to a more rich implementation,
so the meta will contain the real user's id, label and time. Example:
All versions of writeaway with dependencies
spiral/helpers Version ^1.0
spiral/framework Version ^2.9
spiral/cycle-bridge Version ^1.0
doctrine/collections Version ^1.6
ext-imagick Version *