{"id":20338223,"url":"https://github.com/openclassrooms/frontdesk","last_synced_at":"2025-08-09T06:07:17.849Z","repository":{"id":57032105,"uuid":"69547650","full_name":"OpenClassrooms/FrontDesk","owner":"OpenClassrooms","description":null,"archived":false,"fork":false,"pushed_at":"2017-11-20T16:01:23.000Z","size":154,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-03-01T14:46:43.385Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenClassrooms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-29T08:32:22.000Z","updated_at":"2020-01-17T09:31:47.000Z","dependencies_parsed_at":"2022-08-24T05:40:51.971Z","dependency_job_id":null,"html_url":"https://github.com/OpenClassrooms/FrontDesk","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenClassrooms%2FFrontDesk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenClassrooms%2FFrontDesk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenClassrooms%2FFrontDesk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenClassrooms%2FFrontDesk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenClassrooms","download_url":"https://codeload.github.com/OpenClassrooms/FrontDesk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241863325,"owners_count":20032966,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T21:12:04.982Z","updated_at":"2025-03-04T14:27:48.888Z","avatar_url":"https://github.com/OpenClassrooms.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/OpenClassrooms/FrontDesk.svg?branch=master)](https://travis-ci.org/OpenClassrooms/FrontDesk)\n[![SensioLabsInsight](https://insight.sensiolabs.com/projects/a938d1ba-3c55-43a9-b6a6-0f9612c526d9/mini.png)](https://insight.sensiolabs.com/projects/a938d1ba-3c55-43a9-b6a6-0f9612c526d9)\n[![Coverage Status](https://coveralls.io/repos/github/OpenClassrooms/FrontDesk/badge.svg)](https://coveralls.io/github/OpenClassrooms/FrontDesk)\n\n# FrontDesk\n\nThis is a PHP5 library that provides [FrontDesk Core API](https://developer.frontdeskhq.com/docs/api/v2) functionality in your application.\n\n## Install\nThe easiest way to install FrontDesk Library is via [composer](http://getcomposer.org/).\n\nCreate the following `composer.json` file and run the `php composer.phar install` command to install it.\n\n```json\n{\n    \"require\": {\n        \"openclassrooms/front-desk\": \"*\"\n    }\n}\n```\n```php\n\u003c?php\nrequire 'vendor/autoload.php';\n\nuse OpenClassrooms\\FrontDesk\\Services\\PackService;\nuse OpenClassrooms\\FrontDesk\\Services\\PersonService;\n\n//do things\n```\n\n## USAGE\n### Instanciation\nIf you plan to use FrontDesk in a Symfony2 project, check out the [FrontDeskBundle](https://github.com/OpenClassrooms/FrontDeskBundle). The bundle provides an easy configuration option for this library.\n\n##### Factory \nThe library provides a factory to create a client \n```php\nuse OpenClassrooms\\FrontDesk\\Client\\Impl\\ClientFactoryImpl; \n\n$factory = new ClientFactoryImpl();\u2028        \n$client = $factory-\u003ecreateCoreApi('your_front_desk_server_name', 'your_token');\n\\\\\n$client = $factory-\u003ecreateReportingApi('your_front_desk_server_name', 'your_token');\n```\n## ENDPOINTS\n### ENROLLMENT\n#### Gateway\n```php\nuse OpenClassrooms\\FrontDesk\\Repository\\PackRepository;\n\n$enrollmentGateway = new EnrollmentRepository();\u2028        \n$enrollmentGateway-\u003esetReportingApiClient($client);\u2028  \n```\n#### Services\n##### Services Instanciation\n```php\nuse OpenClassrooms\\FrontDesk\\Services\\Impl\\EnrollmentServiceImpl;\n\n$service = new EnrollmentServiceImpl();\n$service-\u003esetEnrollmentGateway($enrollmentGateway);\n```\n##### Create Query\n```php   \n...\n$service-\u003equery($field, $filter, $limit); \n```\n\n### PACK\n#### Gateway\n```php\nuse OpenClassrooms\\FrontDesk\\Repository\\PackRepository;\n\n$packGateway = new PackRepository();\u2028        \n$packGateway-\u003esetCoreApiClient($client);\u2028   \n```\n\n#### Builder\n```php\nuse OpenClassrooms\\FrontDesk\\Models\\PersonBuilder;\n\n$pack = $packBuilder\n            -\u003ecreate()\n            -\u003ewithCount(5)\n            -\u003ewithEndDate(new \\DateTime())\n            -\u003ewithPersonIds([21987])\n            -\u003ewithStartDate(new \\DateTime())\n            -\u003ebuild();\n```\n#### Services\n##### Services Instanciation\n```php\nuse OpenClassrooms\\FrontDesk\\Services\\Impl\\PackServiceImpl;\n\n$service = new PackServiceImpl();\n$service-\u003esetPackGateway($packGateway);\n```\n\n##### Create Pack \n```php   \n...\n$service-\u003ecreate($pack, $packProductId); \n```\n\n##### Delete Pack by id \n```php   \n...\n$service-\u003edeletePack($packId); \n```\n\n### PERSON\n#### Gateway\n```php\nuse OpenClassrooms\\FrontDesk\\Repository\\PersonRepository;\n\n$personGateway = new PersonRepository();\u2028        \n$personGateway-\u003esetCoreApiClient($client);\u2028\n$personGateway-\u003esetPersonBuilder(new PersonBuilderImpl());            \n```\n\n#### Builder\nThe library provides a builder to create a Person:\n \n```php\nuse OpenClassrooms\\FrontDesk\\Models\\PersonBuilder;\n\n$person = $personBuilder-\u003ecreate()\n                        -\u003ewithAddress('address')\n                        -\u003ewithEmail('email')\n                        -\u003ewithFirstName('first_name')\n                        -\u003ewithJoinedAt(new \\DateTime())\n                        -\u003ewithLastName('last_name')\n                        ...\n                        -\u003ebuild();\n```\n\n#### Services\n##### Services Instanciation\n```php\nuse OpenClassrooms\\FrontDesk\\Services\\Impl\\PersonServiceImpl;\n\n$service = new PersonServiceImpl();\n$service-\u003esetPersonGateway($personGateway);\n```\n##### Post a person \n```php\n$service-\u003ecreate($person);\n```\n\n##### Put a person \n```php\n$service-\u003eupdate($person);\n```\n\n##### Get person by id \n```php\n$service-\u003efind($personId);\n```\n\n##### Get all the people\n```php\n$service-\u003efindAll($page);\n```\n\n##### Search person by query\n```php\n$service-\u003esearch($query);\n```\n\n### PLAN\n#### Gateway\n##### Gateway\nThe library provides Gateway for a person, a pack, a plan and a visit:\n```php\n$planGateway = new PlanRepository();\u2028        \n$planGateway-\u003esetCoreApiClient($client);\u2028 \n$planGateway-\u003esetPlanBuilder(new PlanBuilderImpl());        \n```\n\n#### Services\n##### Services Instanciation\n```php\n$service = new PlanServiceImpl();\n$service-\u003esetPlanGateway($planGateway);\n```\n\n##### Get Plans by person id\n```php\n$service-\u003egetPlans($personId);\n```\n\n### VISIT\n#### Gateway\n```php\nuse OpenClassrooms\\FrontDesk\\Repository\\VisitRepository;\n\n$visitGateway = new VisitRepository();\u2028        \n$visitGateway-\u003esetCoreApiClient($client);\u2028 \n$visitGateway-\u003esetVisitBuilder(new VisitBuilderImpl());\n```\n\n#### Services\n##### Services Instanciation\n```php\n$service = new VisitServiceImpl();\n$service-\u003esetVisitGateway($visitGateway);\n```\n\n##### Get Visit by person id\n```php\n$service-\u003egetVisits($personId, $from, $to);\n```\n\n##### Delete Visit by id\n```php\n$service-\u003edeleteVisit($visitId);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclassrooms%2Ffrontdesk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenclassrooms%2Ffrontdesk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclassrooms%2Ffrontdesk/lists"}