minor symfony#42230 [HttpFoundation] update phpdoc to recommend createIndex over ensureIndex (kralos)

nicolas-grekas · nicolas-grekas · commit a7642f738aa2 · 2021-07-22T09:31:22.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [HttpFoundation] update phpdoc to recommend createIndex over ensureIndex | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no - kinda (phpdoc only fix) | New feature? | no | Deprecations? | no | Tickets | Fix symfony#42229 | License | MIT | Doc PR | symfony/symfony-docs#15548 Updated PHPDoc to recommend using `createIndex` instead of `ensureIndex`. `ensureIndex` was deprecated in `mongodb 3.0.0` and removed in `mongodb 5.0.0` Commits ------- 05d8ca1 symfony#42229 update phpdoc to recommend createIndex over ensureIndex
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php
@@ -51,7 +51,7 @@ class MongoDbSessionHandler extends AbstractSessionHandler
      * A TTL collections can be used on MongoDB 2.2+ to cleanup expired sessions
      * automatically. Such an index can for example look like this:
      *
-     *     db.<session-collection>.ensureIndex(
+     *     db.<session-collection>.createIndex(
      *         { "<expiry-field>": 1 },
      *         { "expireAfterSeconds": 0 }
      *     )

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ class MongoDbSessionHandler extends AbstractSessionHandler`
`51`	`51`	`* A TTL collections can be used on MongoDB 2.2+ to cleanup expired sessions`
`52`	`52`	`* automatically. Such an index can for example look like this:`
`53`	`53`	`*`
`54`		`- * db.<session-collection>.ensureIndex(`
	`54`	`+ * db.<session-collection>.createIndex(`
`55`	`55`	`* { "<expiry-field>": 1 },`
`56`	`56`	`* { "expireAfterSeconds": 0 }`
`57`	`57`	`* )`