Download the PHP package optimuscms/pages without Composer
On this page you can find all versions of the php package optimuscms/pages. 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 pages
Optimus Pages
This package provides the core backend functionality for creating pages and page templates within the CMS.
Installation
This package can be installed through Composer.
In Laravel 5.5 and above the package will autoregister the service provider.
In Laravel 5.4 you must install this service provider:
API Routes
The API follows standard RESTful conventions, with responses being returned in JSON. Appropriate HTTP status codes are provided, and these should be used to check the outcome of an operation.
Pages
- List pages
- Get page
- Create page
- Update page
- Delete page
Templates
- List templates
List pages
List all pages.
Request Body
| Parameter | Required | Type | Description |
|---|---|---|---|
parent |
No | int |
A page ID. When provided will only show pages that have this page as their parent. |
Example Response
Create page
Create a new page.
Request Body
| Parameter | Required | Type | Description |
|---|---|---|---|
title |
Yes | string |
The page title |
template |
Yes | string |
The name of the template that should be applied to this page. |
is_stand_alone |
Yes | boolean |
If false, the page will not appear in any navigation and will only be accessible via a direct link. |
is_published |
Yes | boolean |
Whether the page is ready to be made public. |
parent_id |
No | int |
The ID of a page to nest this one under. |
slug |
No | string |
A URL-friendly identifier. Will be used as part of the final public-facing URL to the page. |
Example Response
Returns the newly created page. See single page response example.
Get page
Get the details of a specific page.
Request Body
None
Example Response
Update page
Update the details of a specific page.
Request Body
| Parameter | Required | Type | Description |
|---|---|---|---|
title |
Yes | string |
The page title |
template |
Yes | string |
The name of the template that should be applied to this page. |
is_stand_alone |
Yes | boolean |
If false, the page will not appear in any navigation and will only be accessible via a direct link. |
is_published |
Yes | boolean |
Whether the page is ready to be made public. |
parent_id |
No | int |
The ID of a page to nest this one under. |
slug |
No | string |
A URL-friendly identifier. Will be used as part of the final public-facing URL to the page. |
Example Response
Returns the updated page. See single page response example.
Delete page
Delete a specific page.
Request Body
None
Example Response
The HTTP status code will be 204 if successful.
List templates
List all available templates.
Request Body
None
Example Response
Working with page templates
Create a template
Register and retrieve templates
License
The MIT License (MIT). Please see License File for more information.
All versions of pages with dependencies
optimuscms/media Version ^0.2
optimuscms/meta Version ^1.1
optimuscms/users Version ^0.2
optix/draftable Version ^1.0
spatie/laravel-sluggable Version ^2.1