PHP wrapper for the API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitignore
LICENSE
README.md
composer.json
composer.lock
phpunit.xml

README.md

Passmarked PHP

Use the Passmarked Web API with simple and convenient object oriented PHP. You will require an API token and credit which can be obtained by registering on Passmarked and generating a token. Passmarked PHP does not include bindings to Passmarked's CLI toolkit. The Passmarked CLI tool lives in this repo.

About

Passmarked PHP is based on Guzzle 6 and Guzzle Psr7 and conforms to the PSR-7 standard. Passmarked PHP can also be used with any other PSR-7 compatible HTTP client by using the Passmarked\RequestFactory class to generate GuzzleHttp\Psr7\Request instances that implement Psr\Http\Message\RequestInterface.

See the usage examples below for more details.

Install

Composer

N.B Not yet available

composer require passmarked/passmarked

N.B Not yet available View the project at packagist.org/packages/passmarked/passmarked.

From Source

To build from source:

git clone git@github.com:passmarked/php.git passmarked-php/
cd passmarked-php/
composer install

How to use

You can use Passmarked PHP in a variety of ways:

  • The easiest way is to use the Passmarked\Client class to do the HTTP request and return a Passmarked\Helper object which will give you easy access to the information returned by the Web API. The simplest example of using Passmarked PHP in this way, looks like this:
$config = [
    'api_token'     => 'PASSMARKED_API_TOKEN', // required
    'api_url'      => 'https://api.passmarked.com', // optional / default
    'api_version'   => '2',     // optional / default
    'http_version'  => '1.1',   // optional / default
    'telemetry'     => true     // optional / default
];
$passmarked = new \Passmarked\Client($config); // Get one on passmarked.com
$result = $passmarked->create();
echo $result->status
// Outputs "ok" or "error" if the Web API returned an error.

Any other config options will be passed to the underlying GuzzleHttp\Client constructor. For supported options see Guzzle's Quickstart. However base_uri will always be replaced with api_url or fallback to the default https://api.passmarked.com.

N.B You can also construct the client without arguments, you will then have to pass your token in as the last argument for each request.

  • Alternatively, you can generate GuzzleHttp\Psr7\Request objects using the Passmarked\RequestFactory and execute the request with another PSR-7 compatible client:
$request_factory = \Passmarked\RequestFactory($config);
$psr7_request = $request_factory->getWebsites();
  • You can also "unwrap" the helpers to get the GuzzleHttp\Psr7\Response from them. Just use getPsr7Response() on a helper:
$websites_helper = $client->getWebsites();
$psr7_response = $websites_helper->getPsr7Response();

Create

Create is the only method of Passmarked\Client that expects an array of arguments. Supported options:

$options = [
    'url'       => 'http://somesite.com', // The site to test
    'token'     => 'myapitoken', // Optional, falls back to your client config
    'recursive' => false,   // Optional
    'limit'     => 0,       // Optional
    'bail'      => false,   // Optional
    'level'     => 0,       // Optional
    'patterns' => [],       // Optional
]
$create_helper = $passmarked->create($options);
echo $create_helper->uid;
echo $create_helper->status;

The client also supports the following methods:

// Method signatures
Passmarked\Helper\Helper getWebsites ( [string $api_token] )
Passmarked\Helper\Helper getWebsite ( string $key, [string $api_token] )
Passmarked\Helper\Helper getReport ( string $report_uid, [string $api_token] )
Passmarked\Helper\Helper getIssues ( string $report_uid, [string $api token] )
Passmarked\Helper\Helper getUser ( [string $api_token] )
Passmarked\Helper\Helper getBalance ( [string $api_token] )

All methods except create optionally accept a API token string as the last parameter. If you do not specify a token in the constructor options of Passmarked\Client then you must specify the token each time when making the request. You can also override the token specified in your constructor options for an individual request this way.

Other Syntaxes

You can also use some other shorthand syntax if you would prefer.

Single Result

$user = $passmarked->getUser();

// instead of:
echo $user->getName();
// you can also do:
echo $user->name;
// and even
echo $user->get('name');

Multiple Results

$issues = $passmarked->getIssues();

// instead of:
echo $issues->at(0)->getMessage();
// you can also do:
echo $issues->at(0)->message;
// and
echo $issues->at(0)->get('message');
// or
echo $issues->items[0]->message;
// BUT NOT:
echo $issues->items[0]->getMessage();
// or
echo $issues->items[0]->get('message');

You can iterate over the results by returning them as an array.

foreach($issues->getItems() as $item) {
    echo $item->message;
}
// or
foreach($issues->items as $item) {
    echo $item->message
}
// but you CAN NOT do:
foreach($issues->items as $item) {
    echo $item->getMessage();
}
// or
foreach($issues->getItems() as $item) {
    echo $item->getMessage();
}

Full Example

$client = new \Passmarked\Client();

$report = $client->create(['url' => 'http://www.github.com', 'token' => 'PASSMARKEDTOKEN']);

echo "Response Status: {$report->status}";
echo "UID: {$reporty->uid}";
// or
echo "Response Status: ".$report->get('status');
echo "UID: ".$create_helper->get('uid');

Getting the PSR-7 Response

$config = [
    'api_token'     => 'PASSMARKED_API_TOKEN', // Get one on passmarked.com
];
$client = new \Passmarked\Client($config);

$response = $client->create(['url' => 'http://www.github.com'])->getPsr7Response();

echo $response->getBody()->getContents();

Generating PSR-7 Requests

$config = [
    'api_token'     => 'PASSMARKED_API_TOKEN', // Get one on passmarked.com
];
$request_factory = \Passmarked\RequestFactory($config);
$psr7_request = $request_factory->create(['url' => 'http://www.github.com']);
// Then execute the request using your own client

Main API Reference

On Github:

On Passmarked.com

Contributing

  1. Fork the project
  2. Write a test that reproduces the bug
  3. Fix the bug without breaking any of the existing tests
  4. Submit a pull request

We're busy building the tests and refactoring code as we go. If you spot any area that could use help feel free to open a PR.

License

Copyright 2016 Passmarked Inc

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.