Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openclassrooms/frontdeskbundle
https://github.com/openclassrooms/frontdeskbundle
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/openclassrooms/frontdeskbundle
- Owner: OpenClassrooms
- License: mit
- Created: 2016-10-04T14:32:53.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-20T16:12:09.000Z (almost 7 years ago)
- Last Synced: 2024-04-27T12:04:31.228Z (7 months ago)
- Language: PHP
- Size: 26.4 KB
- Stars: 0
- Watchers: 26
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://insight.sensiolabs.com/projects/35e8fb65-9fb3-4e98-82dd-305ef058a784)
[](https://travis-ci.org/OpenClassrooms/FrontDeskBundle.svg?branch=master)
[](https://coveralls.io/github/OpenClassrooms/FrontDeskBundle?branch=master)
The FrontDeskBundle offers integration of the FrontDesk Library.
FrontDesk Library is a PHP5 library that provides FrontDesk functionality in your application.
See [FrontDesk](https://github.com/OpenClassrooms/FrontDesk) for full details.
## Installation
This bundle can be installed using composer:
```composer require openclassrooms/front-desk-bundle```
or by adding the package to the composer.json file directly:
```json
{
"require": {
"openclassrooms/front-desk-bundle": "*"
}
}
```
After the package has been installed, add the bundle to the AppKernel.php file:
```php
// in AppKernel::registerBundles()
$bundles = array(
// ...
new OpenClassrooms\Bundle\FrontDeskBundle\OpenClassroomsFrontDeskBundle(),
// ...
);
```
## Configuration
```yml
# app/config/config.yml
openclassrooms_frontdesk:
key: %frontdesk.key%
token: %frontdesk.token%
```
## Usage
### ENROLLMENT
```php
$enrollmentService = $container->get('openclassrooms.frontdesk.service.enrollment');
```
#### Query Enrollment
```php
$enrollmentService->query($field, $filter, $limit);
```
### PACK
```php
$packService = $container->get('openclassrooms.frontdesk.service.pack');
```
#### Create Pack
```php
$packService->create(new PackStub());
```
#### Delete Pack by id
```php
$packService->deletePack($packId);
```
### PERSON
```php
$personService = $container->get('openclassrooms.frontdesk.service.person');
```
#### Post Person
```php
$personService->create(new PersonStub());
```
#### Put Person
```php
$personService->update(new PersonStub());
```
#### Get Person by id
```php
$personService->find($personId);
```
#### Get All People
```php
$personService->findAll($page);
```
#### Get person by query
```php
$personService->search($query);
```
### PLAN
####Get Plan by Person id
```php
$planService = $container->get('openclassrooms.frontdesk.service.plan');
$planService->getPlans($personId);
```
### VISIT
#### Get Visits by person id
```php
$visitService = $container->get('openclassrooms.frontdesk.service.visit');
$visitService->getVisits($personId, $from, $to);
```
#### Delete Visit by id
```php
$visitService = $container->get('openclassrooms.frontdesk.service.visit');
$visitService->deleteVisit($visitId);
```