MediaWiki  master
RevDelArchivedFileItem Class Reference
Inheritance diagram for RevDelArchivedFileItem:
Collaboration diagram for RevDelArchivedFileItem:

Public Member Functions

 __construct (RevisionListBase $list, $row)
 
 getApiData (ApiResult $result)
 Get the return information about the revision for the API. More...
 
 getAuthorActorField ()
 Get the DB field name storing actor ids. More...
 
 getAuthorIdField ()
 Get the DB field name storing user ids. More...
 
 getAuthorNameField ()
 Get the DB field name storing user names. More...
 
 getId ()
 Get the ID, as it would appear in the ids URL parameter. More...
 
 getIdField ()
 Get the DB field name associated with the ID list. More...
 
 getTimestampField ()
 Get the DB field name storing timestamps. More...
 
 lock ()
 Lock the item against changes outside of the DB. More...
 
 setBits ( $bits)
 Set the visibility of the item. More...
 
 unlock ()
 Unlock the item against changes outside of the DB. More...
 
- Public Member Functions inherited from RevDelFileItem
 canView ()
 Returns true if the current user can view the item. More...
 
 canViewContent ()
 Returns true if the current user can view the item text/file. More...
 
 getBits ()
 Get the current deletion bitfield value. More...
 
 getHTML ()
 Get the HTML of the list item. More...
 
 isDeleted ()
 
- Public Member Functions inherited from RevDelItem
 isHideCurrentOp ( $newBits)
 Returns true if the item is "current", and the operation to set the given bits can't be executed for that reason STUB. More...
 
- Public Member Functions inherited from RevisionItemBase
 formatDate ()
 Get the date, formatted in user's language. More...
 
 formatTime ()
 Get the time, formatted in user's language. More...
 
 getAuthorActor ()
 Get the author actor ID. More...
 
 getAuthorId ()
 Get the author user ID. More...
 
 getAuthorName ()
 Get the author user name. More...
 
 getTimestamp ()
 Get the timestamp in MW 14-char form. More...
 

Protected Member Functions

 getLink ()
 Get the link to the file. More...
 
- Protected Member Functions inherited from RevDelFileItem
 getComment ()
 Wrap and format the file's comment block, if the current user is allowed to view it. More...
 
 getUserTools ()
 Generate a user tool link cluster if the current user is allowed to view it. More...
 
- Protected Member Functions inherited from RevisionItemBase
 getLinkRenderer ()
 Returns an instance of LinkRenderer. More...
 

Static Protected Member Functions

static initFile ( $list, $row)
 Create file object from $row sourced from $list. More...
 

Protected Attributes

LocalFile $lockFile
 
- Protected Attributes inherited from RevDelFileItem
OldLocalFile $file
 
RevDelFileList $list
 
- Protected Attributes inherited from RevisionItemBase
RevisionListBase $list
 The parent. More...
 
 $row
 The database result row. More...
 

Detailed Description

Definition at line 31 of file RevDelArchivedFileItem.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelArchivedFileItem::__construct ( RevisionListBase  $list,
  $row 
)
Parameters
RevisionListBase$list
object$rowDB result row

Reimplemented from RevDelFileItem.

Definition at line 35 of file RevDelArchivedFileItem.php.

References RevDelFileItem\$list, and RevisionItemBase\$row.

Member Function Documentation

◆ getApiData()

RevDelArchivedFileItem::getApiData ( ApiResult  $result)

Get the return information about the revision for the API.

Since
1.23
Parameters
ApiResult$result
Returns
array Data for the API result

Reimplemented from RevDelFileItem.

Definition at line 108 of file RevDelArchivedFileItem.php.

References RevDelFileItem\$file, RevDelFileItem\canViewContent(), LocalFile\getHeight(), LocalFile\getSize(), LocalFile\getTimestamp(), SpecialPage\getTitleFor(), LocalFile\getUser(), LocalFile\getWidth(), RevDelFileItem\isDeleted(), OldLocalFile\isDeleted(), OldLocalFile\userCan(), and wfTimestamp().

◆ getAuthorActorField()

RevDelArchivedFileItem::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since
1.31
Returns
string|bool

Reimplemented from RevDelFileItem.

Definition at line 61 of file RevDelArchivedFileItem.php.

◆ getAuthorIdField()

RevDelArchivedFileItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
string|bool

Reimplemented from RevDelFileItem.

Definition at line 53 of file RevDelArchivedFileItem.php.

◆ getAuthorNameField()

RevDelArchivedFileItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
string|bool

Reimplemented from RevDelFileItem.

Definition at line 57 of file RevDelArchivedFileItem.php.

◆ getId()

RevDelArchivedFileItem::getId ( )

Get the ID, as it would appear in the ids URL parameter.

Returns
int

Reimplemented from RevDelFileItem.

Definition at line 65 of file RevDelArchivedFileItem.php.

◆ getIdField()

RevDelArchivedFileItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
string|null

Reimplemented from RevDelFileItem.

Definition at line 45 of file RevDelArchivedFileItem.php.

◆ getLink()

RevDelArchivedFileItem::getLink ( )
protected

Get the link to the file.

Overridden by RevDelArchivedFileItem.

Returns
string

Reimplemented from RevDelFileItem.

Definition at line 83 of file RevDelArchivedFileItem.php.

References RevDelFileItem\canViewContent(), RevisionItemBase\getLinkRenderer(), SpecialPage\getTitleFor(), and RevDelFileItem\isDeleted().

◆ getTimestampField()

RevDelArchivedFileItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
string|bool

Reimplemented from RevDelFileItem.

Definition at line 49 of file RevDelArchivedFileItem.php.

◆ initFile()

static RevDelArchivedFileItem::initFile (   $list,
  $row 
)
staticprotected

Create file object from $row sourced from $list.

Parameters
RevisionListBase$list
mixed$row
Returns
mixed

Reimplemented from RevDelFileItem.

Definition at line 41 of file RevDelArchivedFileItem.php.

References RevisionItemBase\$row, and ArchivedFile\newFromRow().

◆ lock()

RevDelArchivedFileItem::lock ( )

Lock the item against changes outside of the DB.

Returns
Status
Since
1.28

Reimplemented from RevDelFileItem.

Definition at line 147 of file RevDelArchivedFileItem.php.

◆ setBits()

RevDelArchivedFileItem::setBits (   $newBits)

Set the visibility of the item.

This should do any necessary DB queries.

The DB update query should have a condition which forces it to only update if the value in the DB matches the value fetched earlier with the SELECT. If the update fails because it did not match, the function should return false. This prevents concurrency problems.

Parameters
int$newBits
Returns
bool Success

Reimplemented from RevDelFileItem.

Definition at line 69 of file RevDelArchivedFileItem.php.

References DB_MASTER, and wfGetDB().

◆ unlock()

RevDelArchivedFileItem::unlock ( )

Unlock the item against changes outside of the DB.

Returns
Status
Since
1.28

Reimplemented from RevDelFileItem.

Definition at line 151 of file RevDelArchivedFileItem.php.

Member Data Documentation

◆ $lockFile

LocalFile RevDelArchivedFileItem::$lockFile
protected

Definition at line 33 of file RevDelArchivedFileItem.php.


The documentation for this class was generated from the following file: