/PHPWebDriver/WebDriverStorage.php

<?php
/**
 * Copyright 2011-2012 Anthon Pang. 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
 *
 * @author Anthon Pang <anthonp@nationalfibre.net>
 */

/**
 * WebDriverStorage class
 *
 * @package WebDriver
 *
 * @method mixed getKey($key) Get key/value pair.
 * @method void deleteKey($key) Delete a specific key.
 * @method integer size() Get the number of items in the storage.
 */
abstract class PHPWebDriver_WebDriverStorage extends PHPWebDriver_WebDriverBase
{
    /**
     * {@inheritdoc}
     */
    protected function methods()
    {
        return array(
            'key' => array('GET', 'DELETE'),
            'size' => array('GET'),
        );
    }

    /**
     * Get all keys from storage or a specific key/value pair
     *
     * @return mixed
     *
     * @throw UnhandledWebDriverError
     */
    public function get()
    {
        // get all keys
        if (func_num_args() == 0) {
            $result = $this->curl('GET', '');

            return $result['value'];
        }

        // get key/value pair
        if (func_num_args() == 1) {
            return $this->getKey(func_get_arg(0));
        }

        throw new PHPWebDriver_UnhandledWebDriverError;
    }

    /**
     * Set specific key/value pair
     *
     * @return PHPWebDriver_WebDriverStorage
     *
     * @throw UnhandledWebDriverError
     */
    public function set()
    {
        if (func_num_args() == 1
            && is_array($arg = func_get_arg(0))
        ) {
            $this->curl('POST', '', $arg);

            return $this;
        }

        if (func_num_args() == 2) {
            $arg = array(
                'key' => func_get_arg(0),
                'value' => func_get_arg(1),
            );
            $this->curl('POST', '', $arg);

            return $this;
        }

        throw new PHPWebDriver_UnhandledWebDriverError;
    }

    /**
     * Delete storage or a specific key
     *
     * @return PHPWebDriver_WebDriverStorage
     *
     * @throw UnhandledWebDriverError
     */
    public function delete()
    {
        // delete storage
        if (func_num_args() == 0) {
            $this->curl('DELETE', '');

            return $this;
        }

        // delete key from storage
        if (func_num_args() == 1) {
            return $this->deleteKey(func_get_arg(0));
        }

        throw new PHPWebDriver_UnhandledWebDriverError;
    }

    /**
     * Factory method to create Storage objects
     *
     * @param string $type 'local' or 'session' storage
     * @param string $url  URL
     *
     * @return PHPWebDriver_WebDriverStorage
     */
    public static function factory($type, $url)
    {
        // dynamically define custom storage classes
        $className = __CLASS__ . '_' . ucfirst(strtolower($type));

        if (!class_exists($className, false)) {
            eval(
                'final class ' . $className.' extends PHPWebDriver_WebDriverStorage {}'
            );
        }

        return new $className($url);
    }
}