datasift / storyplayer

src/php/DataSift/Storyplayer/PlayerLib/Story/Checkpoint.php

Indentation +135 added lines, -135 removed lines

@@ -59,143 +59,143 @@
  */
 class Story_Checkpoint implements IteratorAggregate
 {
-	/**
-	 * the StoryTeller object
-	 *
-	 * @var \DataSift\Storyplayer\PlayerLib\StoryTeller
-	 */
-	private $st;
-
-	/**
-	 * keep track of whether the checkpoint is readonly (true) or
-	 * read-write(false)
-	 *
-	 * @var boolean
-	 */
-	private $readOnly = false;
-
-	/**
-	 * the data stored inside the checkpoint
-	 *
-	 * @var array
-	 */
-	private $data = array();
-
-	/**
-	 * our constructor
-	 *
-	 * @param StoryTeller $st
-	 *        The StoryTeller object (which we will cache)
-	 */
-	public function __construct(StoryTeller $st)
-	{
-		// remember the StoryTeller object for future use
-		$this->st = $st;
-	}
-
-	/**
-	 * is the checkpoint currently readonly?
-	 *
-	 * @return boolean
-	 *         TRUE if the checkpoint is currently readonly
-	 *         FALSE if you can change the data in the checkpoint
-	 */
-	public function getReadOnly()
-	{
-		return $this->readOnly;
-	}
-
-	/**
-	 * put the checkpoint into readonly mode
-	 */
-	public function setReadOnly()
-	{
-		$this->readOnly = true;
-	}
-
-	/**
-	 * put the checkpoint into read-write mode
-	 */
-	public function setReadWrite()
-	{
-		$this->readOnly = false;
-	}
-
-	/**
-	 * magic method to retrieve data from the checkpoint
-	 *
-	 * throws the E5xx_NoSuchDataInCheckpoint exception if you attempt
-	 * to get data that does not exist
-	 *
-	 * @param  string $key
-	 *         the name of the data to store
-	 * @return mixed
-	 *         the data stored in the checkpoint
-	 */
-	public function &__get($key)
-	{
-		// what are we doing?
-		$log = Log::usingLog()->startAction("retrieve '{$key}' from the checkpoint");
-
-		// do we have the data to return?
-		if (!isset($this->data[$key])) {
-			// no, we do not
-			$log->endAction("'{$key}' is not in the checkpoint");
-			throw new E5xx_NoSuchDataInCheckpoint($key);
-		}
-
-		// yes, we do
+    /**
+     * the StoryTeller object
+     *
+     * @var \DataSift\Storyplayer\PlayerLib\StoryTeller
+     */
+    private $st;
+
+    /**
+     * keep track of whether the checkpoint is readonly (true) or
+     * read-write(false)
+     *
+     * @var boolean
+     */
+    private $readOnly = false;
+
+    /**
+     * the data stored inside the checkpoint
+     *
+     * @var array
+     */
+    private $data = array();
+
+    /**
+     * our constructor
+     *
+     * @param StoryTeller $st
+     *        The StoryTeller object (which we will cache)
+     */
+    public function __construct(StoryTeller $st)
+    {
+        // remember the StoryTeller object for future use
+        $this->st = $st;
+    }
+
+    /**
+     * is the checkpoint currently readonly?
+     *
+     * @return boolean
+     *         TRUE if the checkpoint is currently readonly
+     *         FALSE if you can change the data in the checkpoint
+     */
+    public function getReadOnly()
+    {
+        return $this->readOnly;
+    }
+
+    /**
+     * put the checkpoint into readonly mode
+     */
+    public function setReadOnly()
+    {
+        $this->readOnly = true;
+    }
+
+    /**
+     * put the checkpoint into read-write mode
+     */
+    public function setReadWrite()
+    {
+        $this->readOnly = false;
+    }
+
+    /**
+     * magic method to retrieve data from the checkpoint
+     *
+     * throws the E5xx_NoSuchDataInCheckpoint exception if you attempt
+     * to get data that does not exist
+     *
+     * @param  string $key
+     *         the name of the data to store
+     * @return mixed
+     *         the data stored in the checkpoint
+     */
+    public function &__get($key)
+    {
+        // what are we doing?
+        $log = Log::usingLog()->startAction("retrieve '{$key}' from the checkpoint");
+
+        // do we have the data to return?
+        if (!isset($this->data[$key])) {
+            // no, we do not
+            $log->endAction("'{$key}' is not in the checkpoint");
+            throw new E5xx_NoSuchDataInCheckpoint($key);
+        }
+
+        // yes, we do
         $log->endAction($this->data[$key]);
 
-		// all done
-		return $this->data[$key];
-	}
-
-	/**
-	 * magic method to tell if the data is stored in the checkpoint or not
-	 *
-	 * @param  string  $key
-	 *         the name of the data to test for
-	 * @return boolean
-	 *         TRUE if the data exists in the checkpoint
-	 *         FALSE if the data does not exist in the checkpoint
-	 */
-	public function __isset($key)
-	{
-		return (isset($this->data[$key]));
-	}
-
-	/**
-	 * magic method to store data in the checkpoint
-	 *
-	 * throws the E5xx_CheckpointIsReadOnly exception if you attempt
-	 * to store data when the checkpoint is in readonly mode
-	 *
-	 * @param  string  $key
-	 *         the name of the data to store
-	 * @param  mixed   $value
-	 *         the value to store in the checkpoint
-	 * @return void
-	 */
-	public function __set($key, $value)
-	{
-		// what are we doing?
-		$log = Log::usingLog()->startAction("store '{$key}' in the checkpoint");
-
-		// are we allowed to change the data at this time?
-		if ($this->readOnly)
-		{
-			// no, we are not
-			$log->endAction("checkpoint is readonly; did not store '{$key}'");
-			throw new E5xx_CheckpointIsReadOnly();
-		}
-
-		// if we get here, we're allowed to change the checkpoint
-		$this->data[$key] = $value;
-
-		// all done
-		$log->endAction($value);
-	}
+        // all done
+        return $this->data[$key];
+    }
+
+    /**
+     * magic method to tell if the data is stored in the checkpoint or not
+     *
+     * @param  string  $key
+     *         the name of the data to test for
+     * @return boolean
+     *         TRUE if the data exists in the checkpoint
+     *         FALSE if the data does not exist in the checkpoint
+     */
+    public function __isset($key)
+    {
+        return (isset($this->data[$key]));
+    }
+
+    /**
+     * magic method to store data in the checkpoint
+     *
+     * throws the E5xx_CheckpointIsReadOnly exception if you attempt
+     * to store data when the checkpoint is in readonly mode
+     *
+     * @param  string  $key
+     *         the name of the data to store
+     * @param  mixed   $value
+     *         the value to store in the checkpoint
+     * @return void
+     */
+    public function __set($key, $value)
+    {
+        // what are we doing?
+        $log = Log::usingLog()->startAction("store '{$key}' in the checkpoint");
+
+        // are we allowed to change the data at this time?
+        if ($this->readOnly)
+        {
+            // no, we are not
+            $log->endAction("checkpoint is readonly; did not store '{$key}'");
+            throw new E5xx_CheckpointIsReadOnly();
+        }
+
+        // if we get here, we're allowed to change the checkpoint
+        $this->data[$key] = $value;
+
+        // all done
+        $log->endAction($value);
+    }
 
     // ====================================================================
     //