WebDriver.php

<?php
/**
 * Copyright 2004-present Facebook. All Rights Reserved.
 *
 * 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.
 *
 * @package WebDriver
 */

/**
 * WebDriver class
 *
 * @package WebDriver
 *
 * @method status
 */
final class WebDriver extends WebDriver_Base {
	/**
	 * Check browser names used in static functions in the selenium source:
	 * @see http://code.google.com/p/selenium/source/browse/trunk/java/client/src/org/openqa/selenium/remote/DesiredCapabilities.java
	 *
	 * Note: Capability array takes these browserNames and not the "browserTypes"
	 *
	 * Also check
	 * @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Capabilities_JSON_Object
	 */
	const ANDROID           = 'android';
	const CHROME            = 'chrome';
	const FIREFOX           = 'firefox';
	const HTMLUNIT          = 'htmlunit';
	const INTERNET_EXPLORER = 'internet explorer';
	const IPHONE            = 'iPhone';
	const IPAD              = 'iPad';
	const OPERA             = 'opera';

	/**
	 * Return array of supported method names and corresponding HTTP request types
	 *
	 * @return array
	 */
	protected function methods() {
		return array(
			'status' => 'GET',
		);
	}

	/**
	 * Get session object for chaining
	 *
	 * @param string $browser
	 * @param array $additional_capabilities
	 * @return WebDriver_Session
	 */
	public function session($browser = self::FIREFOX, $additional_capabilities = array()) {
		$desired_capabilities = array_merge(
			$additional_capabilities,
			array(WebDriver_Session::BROWSER_NAME => $browser)
		);

		$results = $this->curl(
			'POST',
			'/session',
			array('desiredCapabilities' => $desired_capabilities),
			array(CURLOPT_FOLLOWLOCATION => true)
		);

		if ($this->url . '/session' == $results['info']['url']) {
			// in this case debug $raw_results of $this->curl as this might contain more inforamtion (e.g. when connecting to saucelabs)
			throw new Exception('No sessionId found in return url. Connection failed');
		}

		return new WebDriver_Session($results['info']['url']);
	}

	/**
	 * Get list of currently active sessions
	 *
	 * @return array an of WebDriver_Session objects
	 */
	public function sessions() {
		$result = $this->curl('GET', '/sessions');
		$sessions = array();
		foreach ($result['value'] as $session) {
			$sessions[] = new WebDriverSession(
				$this->url . '/session/' . $session['id']);
		}
		return $sessions;
	}
}