Download the PHP package protacon/vf-rest without Composer
On this page you can find all versions of the php package protacon/vf-rest. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package vf-rest
What is this
Simple library for ValueFrame REST API.
Basically this is a wrapper for guzzlehttp/guzzle - this library just adds necessary headers to each request.
Table of Contents
- What is this?
- Table of Contents
- Requirements
- Installation
- Usage
- Development
- IDE
- PHP Code Sniffer
- Testing
- Metrics
- Authors
- License
Requirements
- PHP 7.3 or higher
- Composer
Installation
The recommended way to install this library is with Composer. Composer is a dependency management tool for PHP that allows you to declare the dependencies your project needs and installs them into your project.
You can add this library as a dependency to your project using following command:
After installing, you need to require Composer's autoloader:
Note that this is only needed if you're using this library as a stand-alone component - usually your framework (eg. Symfony) is already handling this part for you.
Usage
First of all you should read official documentation about ValueFrame REST API.
Simple usage example:
Development
IDE
We highly recommend that you use "proper" IDE to development your application. Below is short list of some popular IDEs that you could use.
PHP Code Sniffer
It's highly recommended that you use this tool while doing actual development
to application. PHP Code Sniffer is added to project dev
dependencies, so
all you need to do is just configure it to your favorite IDE. So the phpcs
command is available via following example command.
If you're using PhpStorm following links will help you to get things rolling.
Testing
Library uses PHPUnit for testing. You can run all tests by following command:
Or you could easily configure your IDE to run those for you.
Metrics
Library uses PhpMetrics to make static analyze of its code. You can run this by following command:
And after that open build/phpmetrics/index.html
with your favorite browser.
Authors
License
The MIT License (MIT)
Copyright (c) 2018 Pinja