Download the PHP package mosparo/php-api-client without Composer
On this page you can find all versions of the php package mosparo/php-api-client. 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 php-api-client
PHP API Client
This library offers the API client to communicate with mosparo to verify a submission.
Description
With this PHP library you can connect to a mosparo installation and verify the submitted data.
Installation
Install this library by using composer:
Usage
- Create a project in your mosparo installation
-
Include the mosparo script in your form
-
Include the library in your project
- After the form was submitted, verify the data before processing it
API Documentation
Client
Client initialization
Create a new client object to use the API client.
Verify form data
To verify the form data, call verifySubmission with the form data in an array and the submit and validation tokens, which mosparo generated on the form initialization and the form data validation. The method will return a VerificationResult object.
Request the statistical data
mosparo also has an API method to get the statistical data for a project. You can use the method getStatisticByDate to get the statistical data. You can specify the range in seconds or a start date from which mosparo should return the statistical data. This method will return a StatisticResult object.
VerificationResult
Constants
- FIELD_NOT_VERIFIED: 'not-verified'
- FIELD_VALID: 'valid'
- FIELD_INVALID: 'invalid'
isSubmittable(): boolean
Returns true, if the form is submittable. This means that the verification was successful and the form data are valid.
isValid(): boolean
Returns true, if mosparo determined the form as valid. The difference to isSubmittable() is, that this
is the original result from mosparo while isSubmittable() also checks if the verification was done correctly.
getVerifiedFields(): array (see Constants)
Returns an array with all verified field keys.
getVerifiedField($key): string (see Constants)
Returns the verification status of one field.
hasIssues(): boolean
Returns true, if there were verification issues.
getIssues(): array
Returns an array with all verification issues.
StatisticResult
getNumberOfValidSubmissions(): int
Returns the total number of valid submissions in the requested date range.
getNumberOfSpamSubmissions(): int
Returns the total number of spam submissions in the requested date range.
getNumbersByDate(): array
Returns an array with all statistical data for the requested time range. The date is the key in the array, while an array is set as a value. The array contains a key numberOfValidSubmissions with the number of valid submissions and a key numberOfSpamSubmissions with the number of spam submissions.
