1: <?php
  2: namespace Azalea\Selenium\Core;
  3: 
  4: /**
  5:  * Base class which represents an entire page request.
  6:  */
  7: class View extends WebDriver
  8: {
  9:     /** @var string $hash The hash fragment corresponding to this view, if any. */
 10:     protected static $hash = "";
 11: 
 12:     /** @var string $selector Optional CSS selector for this view's element. */
 13:     protected static $selector = "";
 14: 
 15:     /**
 16:      * @param \Azalea\Test\TestCase\BaseTestCase $driver
 17:      * @param array $args
 18:      * @throws \InvalidArgumentException
 19:      */
 20:     public function __construct($driver, $args = array())
 21:     {
 22:         if (!$driver) {
 23:             throw new \InvalidArgumentException(get_class($this).": driver not defined");
 24:         }
 25:         $this->driver = $driver;
 26: 
 27:         //$this->spinWait(array($this, "verify"));
 28:         if (!$this->verify($args)) {
 29:             throw new \RuntimeException("Could not verify view: ".get_called_class());
 30:         }
 31:     }
 32: 
 33:     /**
 34:      * Gets the hash associated with this view.
 35:      * Child classes may override this method if the hash needs to be
 36:      * computed from any arguments.
 37:      * @param array $args
 38:      * @return string
 39:      */
 40:     public static function getHash($args = array())
 41:     {
 42:         return self::_replaceStringWithKeys(static::$hash, $args);
 43:     }
 44: 
 45:     /**
 46:      * Sets the hash for this view.
 47:      * @param string $hash
 48:      */
 49:     public static function setHash($hash)
 50:     {
 51:         static::$hash = $hash;
 52:     }
 53: 
 54:     /**
 55:      * Updates the hash fragment in the browser's url.
 56:      * @param string $hash
 57:      */
 58:     public function updateHash($hash)
 59:     {
 60:         $this->execute(array(
 61:             'script' => "window.location.hash = '".$hash."'",
 62:             'args' => array(),
 63:         ));
 64:         return true;
 65:     }
 66: 
 67:     /**
 68:      * Factory method. Loads the page in the browser.
 69:      * @param \Azaea\Test\TestCase\BaseTestCase $driver
 70:      * @param array $args
 71:      * @return \Azalea\Test\Core\View
 72:      */
 73:     public static function get($driver, $args = array())
 74:     {
 75:         if (!$driver) {
 76:             throw new \InvalidArgumentException(get_class($this).": driver not defined");
 77:         }
 78: 
 79:         $hash = static::getHash($args);
 80: 
 81:         if(!empty($hash)) {
 82:             $driver->execute(array(
 83:                 'script' => "window.location.hash = '".$hash."'",
 84:                 'args' => array(),
 85:             ));
 86:         }
 87: 
 88:         $classname = get_called_class();
 89:         return new $classname($driver, $args);
 90:     }
 91: 
 92:     /**
 93:      * A way to get the selector. This is used
 94:      * specifically due to the possibility of variables
 95:      * in selectors.
 96:      * @param array $args
 97:      * @return string
 98:      */
 99:     protected function getSelector($args = array())
100:     {
101:         return self::_replaceStringWithKeys(static::$selector, $args);
102:     }
103: 
104:     /**
105:      * Stub function. Override in child classes.
106:      * @return boolean
107:      */
108:     protected function verify($args = array())
109:     {
110:         $selector = $this->getSelector($args);
111:         if (!empty($selector)) {
112:             $this->byCss($selector);
113:         }
114:         return true;
115:     }
116: 
117: 
118:     /**
119:      * Replaces {key} in a string with a value defined by the supplied associative array (key => value).
120:      * @param array $args
121:      * @return string
122:      */
123:     private static function _replaceStringWithKeys($string='', $args=array())
124:     {
125:         foreach($args as $key => $val) {
126:             if(strpos($string, "{" . $key . "}") !== false) {
127:                 $string = str_replace("{" . $key . "}", $val, $string);
128:             }
129:         }
130:         return $string;
131:     }
132: }
133: ?>