From 161ed4a1747cbb9744a50f5702c174bc89401a75 Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Wed, 5 Jun 2024 17:28:05 +1200 Subject: [PATCH] ENH Use class name instead of self --- src/TestSessionController.php | 2 +- src/TestSessionEnvironment.php | 16 ++++++++++------ src/TestSessionState.php | 6 +++--- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/src/TestSessionController.php b/src/TestSessionController.php index ff91357..3bd5191 100644 --- a/src/TestSessionController.php +++ b/src/TestSessionController.php @@ -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. */ diff --git a/src/TestSessionEnvironment.php b/src/TestSessionEnvironment.php index 306315d..dcd1405 100644 --- a/src/TestSessionEnvironment.php +++ b/src/TestSessionEnvironment.php @@ -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; @@ -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 @@ -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(). * @@ -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() { @@ -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() { diff --git a/src/TestSessionState.php b/src/TestSessionState.php index 7cc3835..8efa5ac 100644 --- a/src/TestSessionState.php +++ b/src/TestSessionState.php @@ -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'); @@ -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(); }