Download the PHP package czim/laravel-service without Composer
On this page you can find all versions of the php package czim/laravel-service. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download czim/laravel-service
More information about czim/laravel-service
Files in czim/laravel-service
Package laravel-service
Short Description Basic webservice framework for Laravel.
License MIT
Homepage https://github.com/czim/laravel-service
Informations about the package laravel-service
Laravel Service
Basic framework for making standardized but flexible webservice classes.
Version Compatibility
Laravel | PHP | Package |
---|---|---|
5 - 8 | 5 - 7 | 0.9 |
7 - 8 | 7.2+ | 1.0 |
9 | 7.2+ | 1.1 |
9 | 8.0 | 2.0 |
9 | 8.1 | 3.0 |
Install
Via Composer
Unless you're using auto-discovery, add this line of code to the providers array
located in your config/app.php
file:
Requirements
To use the SshFileService
, you will require the libssh2
PHP extension.
Usage
Services
The basic approach to using a Service in three steps:
- Instantiate a Service
- passing in the defaults (optional)
- passing in an interpreter instance (optional)
- Perform a
call()
on the service instance
For a simple SOAP service, this might be as follows:
Available Services
RestService
: for HTTP REST requests, requires aServiceRestRequest
object for defaults/requests.- See the section about RestServices below.
RestCurlService
: same as above, but uses cURL directly instead of guzzleSoapService
: for SOAP requests, requires aServiceSoapRequest
object for defaults/requests.- See the note about BeSimple below.
FileService
: for retrieving the contents of a single file, requires aServiceSshRequest
object for defaults/requests.MultiFileService
: for retrieving the contents of multiple files and merging their interpretations, requires aServiceSshRequest
object for defaults/requests.SshFileService
: like the MultiFileService, but retrieves files by logging into an SSH server. See requirements above.
See this list of examples for more information.
RestServices and HTTP methods
One thing to look out for is a potential confusion over the 'method' when using the RestService
.
The $method
parameter in the service's call()
does not refer to the HTTP Method (GET
, POST
, etc).
For cross-services compatibility purposes it is used to set the URI path instead, since that best corresponds to the 'method' for SOAP calls.
The HTTP Method is to be separately set on the service before making the call, with setHttpMethod()
.
So making a DELETE
call to /comments/13
may be set up as follows:
If not set, the default HTTP method is POST
.
Alternatively, the HTTP method may be configured per-call without affecting the default, by setting it in a ServiceRequest
parameter:
The order of precedence is:
- HTTP method set in request for call
- HTTP method set in default request for service
- HTTP method defined in service directly
Interpreters
Services always return a ServiceResponse
for each call.
The content of the response (mainly the data accessible through getData()
, but also its other properties) is determined by the ServiceInterpreter
instance set for the service.
ServiceInterpreters are responsible for interpreting and converting the raw data retrieved to whatever (standardized) format and response content you prefer.
Standard available interpreters:
BasicDefaultInterpreter
: sets up response, but does not manipulate the raw data in any wayBasicJsonInterpreter
: converts a string with raw JSON to an object or associative arrayBasicQueryStringInterpreter
: converts a query string to an object or arrayBasicRawXmlInterpreter
: converts a string with raw XML to SimpleXML objectsBasicRawXmlAsArrayInterpreter
: same, but converts to an associative arrayBasicSoapXmlInterpreter
: makes response for SimpleXML object returned by a SoapClientBasicSoapXmlAsArrayInterpreter
: same, but converts to an associative array
It is recommended to extend these or roll your own interpreter for complex services.
I often build interpreters that use czim/laravel-dataobject
to convert raw data into validatable, specific data objects.
See the AbstractServiceInterpreter source for hints and useful methods.
Interpreter Decorators
Some decorators for interpreters are provided:
FixXmlNamespacesDecorator
: rewrites relative path namespaces to absolute in raw XML, since some XML may be uninterpretable otherwise (hacky).RemoveXmlNamespacesDecorator
: removes XML namespaces from raw XML entirely (hacky).
They follow the standard decorator pattern for interpreters, so they may be used as follows:
The AbstractValidationPreDecorator
may be extended to easily set up validation of raw data before the decorated interpreter does its business.
Likewise the AbstractValidationPostDecorator
may be extended to validate the ServiceResponse
object returned after the interpreter has treated the response.
Service Collection
By way of wrapping multiple services, this package offers a ServiceCollection
.
This is a simple extension of the Illuminate\Support\Collection
, which may only be used to store ServiceInterface
objects.
You can set one up just as you would a normal Collection:
Note that calling get()
on the collection for a non-existant service will throw an exception; as will trying to store something other than a ServiceInterface
in it.
Notes
BeSimple SoapClient
The BeSimpleSoapService
service class is set up to use the BeSimple SoapClient.
The only thing required to use it is to include the package:
DOMDocument parsing as an alternative to SimpleXml
When using the DomDocumentBasedXmlParser
, note that this will not return a SimpleXml-type object, but a DOMElement
.
To sensibly use this, convert it to an array using the DomObjectToArrayConverter
.
This means that when rebinding or injecting one of these, treat them as a pair.
Note that the DOMDocument method is slower and uses significantly more memory. If you have no specific reason to use this, stick to the default.
Contributing
Please see CONTRIBUTING for details.
Credits
- Coen Zimmerman
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-service with dependencies
czim/laravel-dataobject Version ^3.0
guzzlehttp/guzzle Version ^7.0
illuminate/support Version ^9