Download the PHP package cadulis/sdk without Composer
On this page you can find all versions of the php package cadulis/sdk. 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 sdk
This SDK aims to help you dealing with Cadulis APIs
Installation
It's recommended that you use Composer to install InterventionSDK.
This will install SDK and all required dependencies.
so each of your php scripts need to require composer autoload file
Usage
Available services are
- Intervention (search, create, update, read)
- InterventionType (getAvailable)
- ScheduleWizard (getSlots)
API init
Initialize api with your access url
Intervention service
You can access services directly from the api $cadulisAPI->services
Search interventions
Retrieve the SearchInput object to set all-what-you-need input parameters
Use the search method on the interventionService to get your interventions
Returned result is instance of \Cadulis\Sdk\Model\Response\Interventions
All in one to search interventions :
Read/Create/Update intervention
Instanciate new intervention model
cref field is required (to set or retrieve unique intervention informations), this is YOUR intervention unique identifier
Read intervention data
Intervention is find by cref
Create or update intervention
If needed you can instanciate new customer model. customer type/reference fields are required as unique identifier
Create :
If intervention with cref already exists, it is updated
Update :
Intervention is find by cref
Intervention and customer fields are available from corresponding classes. They are :
InterventionType service
you can retrieve your available intervention types. If you have multiple ones, creating intervention will required which one you want.
Schedule wizard service
To get available assignment slots, use ScheduleWizard !!!
Retrieve the ScheduleWizardInput object to set all-what-you-need input parameters
Use the getSlots method on the scheduleWizardService to get available slots
Returned result is instance of \Cadulis\Sdk\Model\Response\ScheduleWizard\ScheduleWizard
Schedule Wizard get options are :
Log
You can use a logger object within this sdk. It has just to implement \Bixev\LightLogger\LoggerInterface
Then pass it to your api initialization :
Override routes
You're able to force routes the sdk use to connect to the api (no use of autoconfig, or override)
Routes are on client level :
So you can simply set your own set of routes. A route must extend \Cadulis\Sdk\Model\Routes\Route
