Prose\Prose

Complexity

Total Complexity

12

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	3
Bugs	3	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	2
A	initPageContext()	0	6	1
A	initActions()	0	3	1
A	initDevice()	0	20	1
A	__call()	0	5	1
A	getTopElement()	0	4	1
A	setTopElement()	0	4	1
A	getTopXpath()	0	4	1
A	setTopXpath()	0	4	1
A	toNum()	0	6	1
A	getSourceFilename()	0	5	1

<?php

/**
 * Copyright (c) 2011-present Mediasift Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Libraries
 * @package   Storyplayer/Prose
 * @author    Stuart Herbert <stuart.herbert@datasift.com>
 * @copyright 2011-present Mediasift Ltd www.datasift.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://datasift.github.io/storyplayer
 */

namespace Prose;

use ReflectionObject;
use DataSift\Storyplayer\PlayerLib\StoryTeller;

/**
 * base class for all Prose classes
 *
 * @category  Libraries
 * @package   Storyplayer/Prose
 * @author    Stuart Herbert <stuart.herbert@datasift.com>
 * @copyright 2011-present Mediasift Ltd www.datasift.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://datasift.github.io/storyplayer
 */
class Prose
{
    /**
     * the one object that knows how to get to everything
     * @var \DataSift\Storyplayer\PlayerLib\StoryTeller
     */
    protected $st = null;
    protected $args = array();
    protected $topElement = null;
    protected $topXpath   = null;
    protected $device     = null;

    public function __construct(StoryTeller $st, $args = array())
    {
        // save the StoryTeller object; we're going to need it!
        $this->st = $st;

        // save any arguments that have been passed into the constructor
        // our child classes may be interested in them
        if (!is_array($args)) {
            throw new E5xx_ActionFailed(__METHOD__);
        }
        $this->args = $args;

        // setup the page context
        $this->initPageContext();

        // run any context-specific setup that we need
        $this->initActions();
    }

    protected function initPageContext()
    {
        // make sure we are looking at the right part of the page
        $pageContext = $this->st->getPageContext();
        $pageContext->switchToContext($this->st);
    }

    /**
     * override this method if required (for example, for web browsers)
     *
     * @return void
     */
    protected function initActions()
    {
    }

    protected function initDevice()
    {
        // start the test device
        $this->device = $this->st->getRunningDevice();

        // set our top XPATH node
        //
        // for the moment, we are assuming that the test device is
        // a web browser, because historically this has always been
        // the case
        //
        // when this assumption is no longer valid, we will need to
        // revisit this code
        $this->setTopXpath("//html");

        // set our top element
        //
        // we cannot assume that the browser has any DOM loaded at all
        $this->setTopElement($this->device);
    }

    public function __call($methodName, $params)
    {
        // this only gets called if there's no matching method
        throw new E5xx_NotImplemented(get_class($this) . '::' . $methodName);
    }

    public function getTopElement()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->topElement;
    }

    public function setTopElement($element)
    {
        $this->topElement = $element;
    }

    protected function getTopXpath()
    {
        return $this->topXpath;
    }

    /**
     * @param string $xpath
     */
    protected function setTopXpath($xpath)
    {
        $this->topXpath = $xpath;
    }

    // ====================================================================
    //
    // Convertors go here
    //
    // --------------------------------------------------------------------

    public function toNum($string)
    {
        $final = str_replace(array(',', '$', ' '), '', $string);

        return (double)$final;
    }

    public function getSourceFilename()
    {
        $refObj = new ReflectionObject($this);
        return $refObj->getFileName();
    }


}