Download the PHP package intelogie/zendesk_api_client_php without Composer
On this page you can find all versions of the php package intelogie/zendesk_api_client_php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download intelogie/zendesk_api_client_php
More information about intelogie/zendesk_api_client_php
Files in intelogie/zendesk_api_client_php
Package zendesk_api_client_php
Short Description PHP Client for Zendesk REST API. See http://developer.zendesk.com/api-docs
License Apache License Version 2.0
Homepage https://github.com/zendesk/zendesk_api_client_php
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 zendesk_api_client_php
Zendesk PHP API Client Library
API Client Version
This is the second version of our PHP API client. The previous version of the API client can be found on the v1 branch.
API version support
This client only supports Zendesk's API v2. Please see our API documentation for more information.
Requirements
- PHP 5.5+
Installation
The Zendesk PHP API client can be installed using Composer.
Composer
Inside of composer.json specify the following:
Upgrading from V1 to V2
If you are upgrading from v1 of the client, we've written an upgrade guide to highlight some of the key differences.
Configuration
Configuration is done through an instance of Zendesk\API\HttpClient.
The block is mandatory and if not passed, an error will be thrown.
Usage
Basic Operations
Attachments
Test suite
The test suite is run via phpunit. Note that these are all live tests that must be run targeted at a real Zendesk instance. Credentials can be provided by setting the environment variables in phpunit.xml; a sample is provided at phpunit.xml.dist.
To run the unit tests: vendor/bin/phpunit --testsuite "Zendesk API Unit Test Suites"
To run the live tests: vendor/bin/phpunit --testsuite "Zendesk API Live Test Suites"
Side-loading
Side-loading allows you to retrieve related records as part of a single request. See [the documentation] for more information. (https://developer.zendesk.com/rest_api/docs/core/side_loading).
An example of sideloading with the client is shown below.
Pagination
The Zendesk API offers a way to get the next pages for the requests and is documented in the Zendesk Deveoloper Documentation.
The way to do this is to pass it as an option to your request.
The allowed options are
- per_page
- page
- sort_order
Coding Standard
This project strictly follows the PSR-2 coding standard.
PHP Codesniffer is used to verify that the standard is being followed.
In addition to the PSR2 standard which we try to follow the following rules as much as possible:
PHPDoc
All Classes, Class Methods and Properties should have docblocs.
Classes
Class docblocks should contain:
- A short description of the class
- Any methods available that are called via magic method with what that method returns.
A good example is
Methods
Method docblocks should contain:
- A short description of what the method does.
- The parameters passed with what type to expect.
- Description of the parameters passed with examples(optional).
- The type of the return.
- All the possible exceptions the method may throw.
A good example of this is
Properties
Class properties docblocs should contain:
- A short description of the property (optional)
- The var type
A good example of this
Arrays
The short notations for declaring arrays ([]) is preferred over the longer array().
Align =>s following the longest key to make the arrays easier to read.
Grouped assignment statements
Align the = for grouped assignment statements.
Traits
Declaration
- Traits are added after class constants and arranged alphabetically when declared.
- Group traits accordingly by adding a new line after each group.
- Groups are ordered as follows:
- Instantiator
- Single resource
- Bulk traits
Resource Traits
When adding a resource, use traits to define available API calls. Resource traits are namespaced under Zendesk\API\Traits\Resource.
Single Resource
- Create
- Delete
- Find
- FindAll
- Update
- Defaults - this adds Find, FindAll, Create, Update, and Delete
Bulk traits
- CreateMany
- DeleteMany
- FindMany
- UpdateMany
- CreateOrUpdateMany
Utility Traits
Use Zendesk\API\Traits\Utility\InstantiatorTrait when you want a resource to be chainable to other resources. See Zendesk/API/Resources/Tickets.php.
Note on Patches/Pull Requests
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so that we don't break your improvement in a future version unintentionally.
- Please follow the coding standard described above.
- Commit and do not mess with version or history. (If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when we pull)
- Send a pull request. Bonus points for topic branches.
Copyright and license
Copyright 2013-present Zendesk
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
