Skip to content

Commit

Permalink
Merge pull request #90 from creative-commoners/pulls/3/remove-self
Browse files Browse the repository at this point in the history
ENH Use class name instead of self
  • Loading branch information
GuySartorelli authored Jun 17, 2024
2 parents a9f175b + 161ed4a commit 097313b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/TestSessionController.php
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ public function clear()
}

/**
* As with {@link self::start()}, if you want to extend the functionality of this, then look at
* As with {@link TestSessionController::start()}, if you want to extend the functionality of this, then look at
* {@link TestSessionEnvironent::endTestSession()} as the extension points have moved to there now that the logic
* is there.
*/
Expand Down
16 changes: 10 additions & 6 deletions src/TestSessionEnvironment.php
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ class TestSessionEnvironment
/**
* @var string The original database name, before we overrode it with our tmpdb.
*
* Used in {@link self::resetDatabaseName()} when we want to restore the normal DB connection.
* Used in {@link TestSessionEnvironment::resetDatabaseName()} when we want to restore the normal DB connection.
*/
private $oldDatabaseName;

Expand Down Expand Up @@ -136,14 +136,16 @@ public function getId()

/**
* Creates a temp database, sets up any extra requirements, and writes the state file. The database will be
* connected to as part of {@link self::applyState()}, so if you're continuing script execution after calling this
* connected to as part of {@link TestSessionEnvironment::applyState()}, so if you're continuing script
* execution after calling this
* method, be aware that the database will be different - so various things may break (e.g. administrator logins
* using the SS_DEFAULT_USERNAME / SS_DEFAULT_PASSWORD constants).
*
* If something isn't explicitly handled here, and needs special handling, then it should be taken care of by an
* extension to TestSessionEnvironment. You can either extend onBeforeStartTestSession() or
* onAfterStartTestSession(). Alternatively, for more fine-grained control, you can also extend
* onBeforeApplyState() and onAfterApplyState(). See the {@link self::applyState()} method for more.
* onBeforeApplyState() and onAfterApplyState(). See the {@link TestSessionEnvironment::applyState()}
* method for more.
*
* @param array $state An array of test state options to write.
* @param mixed $id
Expand Down Expand Up @@ -436,7 +438,8 @@ private function removeStateFile()

/**
* Cleans up the test session state by restoring the normal database connect (for the rest of this request, if any)
* and removes the {@link self::$test_state_file} so that future requests don't use this test state.
* and removes the {@link TestSessionEnvironment::$test_state_file} so that future requests don't use this
* test state.
*
* Can be extended by implementing either onBeforeEndTestSession() or onAfterEndTestSession().
*
Expand Down Expand Up @@ -505,7 +508,8 @@ public function loadFixtureIntoDb($fixtureFile)
}

/**
* Reset the database connection to use the original database. Called by {@link self::endTestSession()}.
* Reset the database connection to use the original database.
* Called by {@link TestSessionEnvironment::endTestSession()}.
*/
public function resetDatabaseName()
{
Expand All @@ -523,7 +527,7 @@ public function resetDatabaseName()
}

/**
* @return stdClass Data as taken from the JSON object in {@link self::loadFromFile()}
* @return stdClass Data as taken from the JSON object in {@link TestSessionEnvironment::loadFromFile()}
*/
public function getState()
{
Expand Down
6 changes: 3 additions & 3 deletions src/TestSessionState.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public static function incrementState()
{
$schema = DataObject::getSchema();

$update = SQLUpdate::create(sprintf('"%s"', $schema->tableName(self::class)))
$update = SQLUpdate::create(sprintf('"%s"', $schema->tableName(TestSessionState::class)))
->addWhere(['ID' => 1])
->assignSQL('"PendingRequests"', '"PendingRequests" + 1');

Expand All @@ -50,10 +50,10 @@ public static function decrementState()
{
$schema = DataObject::getSchema();

$update = SQLUpdate::create(sprintf('"%s"', $schema->tableName(self::class)))
$update = SQLUpdate::create(sprintf('"%s"', $schema->tableName(TestSessionState::class)))
->addWhere(['ID' => 1])
->assignSQL('"PendingRequests"', '"PendingRequests" - 1')
->assign('"LastResponseTimestamp"', self::millitime());
->assign('"LastResponseTimestamp"', TestSessionState::millitime());

$update->execute();
}
Expand Down

0 comments on commit 097313b

Please sign in to comment.