Download the PHP package leuchtdiode/pimcore-rest-api without Composer
On this page you can find all versions of the php package leuchtdiode/pimcore-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download leuchtdiode/pimcore-rest-api
More information about leuchtdiode/pimcore-rest-api
Files in leuchtdiode/pimcore-rest-api
Package pimcore-rest-api
Short Description Zend Framework 2 module for accessing pimcore via its REST API
License MIT
Homepage https://github.com/leuchtdiode/pimcore-rest-api
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 pimcore-rest-api
pimcore (REST API) module for Zend Framework 2
Zend Framework 2 module for accessing pimcore via its REST API.
Installation
Installation of this module uses composer. For composer documentation, please refer to getcomposer.org.
Then add PimcoreRestApi to your config/application.config.php.
Usage
Currently there are the following features included:
- Retrieve document by ID
- Retrieve document by its path
- Search documents
- A view helper to print freetext of a document
Set up
In order to use the API, you have to specify a config set pimcoreRestApi somewhere in your application (e.g. config/autoload/local.php)
You have to set the following parameters:
host: The host where your pimcore API resides (e.g. cms.company.com)ssl: Defaults to false. Setting it to true will request API through SSL. (e.g. https://cms.company.com)apiKey: The API-Key you generated in pimcore for your user
For example:
Services
We are suggesting not to use the API directly, but the services the module is providing through service locator. At the moment there is only a document service included.
You can use PimcoreRestApi\Service\Documents from service locator for retrieving documents:
- Get one document by ID
getById($documentId) - Get one document by path
getByPath($documentPath) - Get all documents by path
getAllByPath($path)
View helpers
The module is also providing a view helper for displaying freetext of a given document path.
PraDocument
By calling $this->praDocument() in your view you can get an instance of the document view helper which provides the following methods at the moment:
Print text for path
$this->praDocument()->printTextForPath($path)
This method tries to fetch a document by its path, searching for all of its WYSIWYG elements, concatenates them and outputs the text. null gets returned if there was a problem fetching the document or finding WYSIWYG elements.
Caching
To minimize the API calls to the external pimcore system via its REST API we are suggesting setting up a storage cache provided by zend-cache.
The module has already implemented caching. You only have to tell him.
Setting up is as simple as defining a factory in service locator which is returning a Zend\Cache\Storage\StorageInterface for key PimcoreRestApi\StorageCache,
All versions of pimcore-rest-api with dependencies
zendframework/zend-http Version ~2.5
netresearch/jsonmapper Version ^0.11.0