Skip to content

Commit

Permalink
inital
Browse files Browse the repository at this point in the history
  • Loading branch information
AndiKeiser committed Dec 16, 2021
0 parents commit a57b253
Show file tree
Hide file tree
Showing 17 changed files with 1,107 additions and 0 deletions.
15 changes: 15 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# License
Copyright (C) 2016-2021 CI HUB GmbH

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
71 changes: 71 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@

[![Software License](https://img.shields.io/badge/license-GPLv3-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Latest Stable Version](https://img.shields.io/packagist/v/ci-hub-gmbh/pimcore-ci-hub-adapter-bundle.svg?style=flat-square)](https://packagist.org/packages/ci-hub/pimcore-ci-hub-adapter-bundle)

This bundle integrates [CI HUB](https://ci-hub.com/) to [Pimcore DataHub](https://github.com/pimcore/data-hub)
and therefore allows integrating Pimcore Assets and DataObjects directly into Adobe and Microsoft products.

## Features in a nutshell
* Configure a schema and expose data like with other DataHub adapters via Drag & Drop.
* Exported data is cached to get a high performance API.
* A token is provided which can be used for connecting CI HUB with your Pimcore DataHub endpoint.

![Sample Configuration](docs/images/ci_hub_config.png "Sample Configuration")

## Installation
This bundle depends on the [Pimcore DataHub](https://github.com/pimcore/data-hub) and the
[Simple REST Adapter](https://github.com/ci-hub-gmbh/SimpleRESTAdapterBundle) bundles. They need to be installed first.

To install the CI HUB Adapter complete following steps:
* Install via composer
```
composer require ci-hub/pimcore-ci-hub-adapter-bundle:^1.0
```
* Enable via command-line (or inside the Pimcore extension manager)
```
bin/console pimcore:bundle:enable PimcoreCIHubAdapterBundle
```
* Clear cache and reload Pimcore
```
bin/console cache:clear --no-warmup
```

> Make sure, that the priority of the Pimcore DataHub is higher than the priority of the Simple REST Adapter,
> and the priority of the Simple REST Adapter is higher than the priority of the CI HUB Adapter.
> This can be specified as parameter of the `pimcore:bundle:enable` command or in the Pimcore extension manager.
## Bundle Configuration
Configure the default thumbnail, which is used by CI HUB to display the preview of your Pimcore Assets:

```yaml
# Default configuration for "CIHubAdapterBundle"
ci_hub_adapter:

# Default image/document thumbnail settings.
default_preview_thumbnail:

# Defaults:
format: PNG
width: 300
height: 300
frame: true
forceResize: true
```
> Attention: This configuration is overwritten by any image thumbnail configuration with the name of
> "galleryThumbnail" in the Pimcore Back-End.
## Further Information
Since this bundle is based on the [Simple REST Adapter Bundle](https://github.com/ci-hub-gmbh/SimpleRESTAdapterBundle)
for Pimcore DataHub, see its documentation for details on configuration and usage.
## Planned features
- [ ] Add or update Pimcore Assets via CI HUB interface
- [ ] Identification endpoint with permission details (CRUD)
## License
**CI HUB GmbH**, Benkertstrasse 4, 14467 Potsdam, Germany
[www.ci-hub.com](https://ci-hub.com), [email protected]
Copyright © 2021 CI HUB GmbH. All rights reserved.
For licensing details please visit [LICENSE.md](LICENSE.md)
41 changes: 41 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"name": "ci-hub/pimcore-ci-hub-adapter-bundle",
"type": "pimcore-bundle",
"license": "GPL-3.0-or-later",
"description": "CI HUB Adapter for Pimcore DataHub",
"keywords": [
"pimcore",
"pimcore-bundle"
],
"homepage": "https://github.com/ci-hub-gmbh/PimcoreCIHubAdapterBundle",
"authors": [
{
"name": "CI HUB GmbH",
"email": "[email protected]",
"homepage": "https://ci-hub.com"
}
],
"require": {
"php": ">=7.2",
"pimcore/data-hub": "^1.0",
"pimcore/pimcore": "^6.0",
"ci-hub/simple-rest-adapter-bundle": "^1.0"
},
"require-dev": {
"phpstan/phpstan": "^0.12",
"phpstan/phpstan-symfony": "^0.12",
"symplify/easy-coding-standard": "^9.0"
},
"autoload": {
"psr-4": {
"CIHub\\Bundle\\PimcoreCIHubAdapterBundle\\": "src/PimcoreCIHubAdapterBundle/"
}
},
"extra": {
"pimcore": {
"bundles": [
"CIHub\\Bundle\\PimcoreCIHubAdapterBundle\\PimcoreCIHubAdapterBundle"
]
}
}
}
Binary file added docs/images/ci_hub_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a57b253

Please sign in to comment.