68 lines
2.3 KiB
PHP
68 lines
2.3 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
namespace MediaWiki\Linker;
|
|
|
|
use RuntimeException;
|
|
use stdClass;
|
|
use Wikimedia\Rdbms\IDatabase;
|
|
|
|
/**
|
|
* @since 1.38
|
|
*/
|
|
interface LinkTargetLookup {
|
|
/**
|
|
* Instantiate a new LinkTarget object based on a $row from the linktarget table.
|
|
*
|
|
* Use this method when a linktarget row was already fetched from the DB via a join.
|
|
* This method just constructs a new instance and does not try fetching missing
|
|
* values from the DB again.
|
|
*
|
|
* @param stdClass $row with the following fields:
|
|
* - int lt_id
|
|
* - int lt_namespace
|
|
* - string lt_title
|
|
* @return LinkTarget
|
|
*/
|
|
public function newLinkTargetFromRow( stdClass $row ): LinkTarget;
|
|
|
|
/**
|
|
* Find an link target by $id.
|
|
*
|
|
* @param int $linkTargetId
|
|
* @return LinkTarget|null Returns null if no link target with this $linkTargetId exists in the database.
|
|
*/
|
|
public function getLinkTargetById( int $linkTargetId ): ?LinkTarget;
|
|
|
|
/**
|
|
* Attempt to assign an link target ID to the given $linkTarget. If it is already assigned,
|
|
* return the existing ID.
|
|
*
|
|
* @note If called within a transaction, the returned ID might become invalid
|
|
* if the transaction is rolled back, so it should not be passed outside of the
|
|
* transaction context.
|
|
*
|
|
* @param LinkTarget $linkTarget
|
|
* @param IDatabase $dbw The database connection to acquire the ID from.
|
|
* @return int linktarget ID greater then 0
|
|
* @throws RuntimeException if no linktarget ID has been assigned to this $linkTarget
|
|
*/
|
|
public function acquireLinkTargetId( LinkTarget $linkTarget, IDatabase $dbw ): int;
|
|
|
|
}
|