www.aleph1.co.uk Git - yaffs-website/blob - vendor/instaclick/php-webdriver/lib/WebDriver/Service/CurlServiceInterface.php

   1 <?php
   2 /**
   3  * Copyright 2012-2017 Anthon Pang. All Rights Reserved.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * @package WebDriver
  18  *
  19  * @author Anthon Pang <apang@softwaredevelopment.ca>
  20  */
  21
  22 namespace WebDriver\Service;
  23
  24 /**
  25  * WebDriver\Service\CurlServiceInterface class
  26  *
  27  * @package WebDriver
  28  */
  29 interface CurlServiceInterface
  30 {
  31     /**
  32      * Send protocol request to WebDriver server using curl extension API.
  33      *
  34      * @param string $requestMethod HTTP request method, e.g., 'GET', 'POST', or 'DELETE'
  35      * @param string $url           Request URL
  36      * @param array  $parameters    If an array(), they will be posted as JSON parameters
  37      *                              If a number or string, "/$params" is appended to url
  38      * @param array  $extraOptions  key=>value pairs of curl options to pass to curl_setopt()
  39      *
  40      * @return array
  41      *
  42      * @throws \WebDriver\Exception\CurlExec only if http error and CURLOPT_FAILONERROR has been set in extraOptions
  43      */
  44     public function execute($requestMethod, $url, $parameters = null, $extraOptions = array());
  45 }