Overview
  • Namespace
  • Class

Namespaces

  • APWG
    • API
      • Alerts
      • Groups
      • Index
      • MalIP
      • Phish
      • ReportPhishing

Classes

  • APWG\API\AbstractClient
  • APWG\API\Alerts\AlertsClient
  • APWG\API\Groups\GroupsClient
  • APWG\API\Index\IndexClient
  • APWG\API\MalIP\MalIPClient
  • APWG\API\Phish\PhishClient
  • APWG\API\ReportPhishing\ReportPhishingClient

Interfaces

  • APWG\API\ClientInterface
 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 
<?php

namespace APWG\API;

use Psr\Http\Message\ResponseInterface;

/**
 * The API module client interface
 *
 * Interface ClientInterface
 * @package APWG\API
 * @author Andrew Breksa <andrew@apwg.org>
 * @copyright Copyright (c) 2017 The Anti-Phishing Working Group
 */
interface ClientInterface {

    /**
     * Internal method to call the API
     *
     * @param $method
     * @param string $path the endpoint path relative to the base_uri
     * @param array $options the request (Guzzle) options
     *
     * @return ResponseInterface
     */
    public function _call($method, $path, $options = []);

    /**
     * Get the most recent request
     *
     * @return ResponseInterface
     */
    public function getCache();

    /**
     * Set the most recent request
     *
     * @param ResponseInterface
     * $cache
     */
    public function setCache($cache);

}
API documentation generated by ApiGen