Add documentation to DisposableFullTextSearch->idenfier field

This commit is contained in:
Hypolite Petovan 2024-01-26 16:48:55 -05:00
parent 0ee87b8116
commit abd5768044

View file

@ -30,12 +30,15 @@ namespace Friendica\Database;
class DisposableFullTextSearch class DisposableFullTextSearch
{ {
private Database $db; private Database $db;
/** @var int Unique identifier of the haystack in the database. */
private int $identifier; private int $identifier;
public function __construct(Database $database, string $haystack) public function __construct(Database $database, string $haystack)
{ {
$this->db = $database; $this->db = $database;
// Unique identifier generation. Two DisposableFullTextSearch object should never have the same as the first object destruction
// would delete both check-full-text-search rows, before the second object destruction is called, leading to unexpected behavior.
// Maximum value is indicated by the INT UNSIGNED type of the check-full-text-search.pid field // Maximum value is indicated by the INT UNSIGNED type of the check-full-text-search.pid field
$this->identifier = random_int(0, pow(2, 32) - 1); $this->identifier = random_int(0, pow(2, 32) - 1);