MediaWiki  master
RevDelFileItem Class Reference

Item class for an oldimage table row. More...

Inheritance diagram for RevDelFileItem:
Collaboration diagram for RevDelFileItem:

Public Member Functions

 __construct (RevisionListBase $list, $row)
 
 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...
 
 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...
 
 getBits ()
 Get the current deletion bitfield value. More...
 
 getHTML ()
 Get the HTML of the list item. 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...
 
 isDeleted ()
 
 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 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

 getComment ()
 Wrap and format the file's comment block, if the current user is allowed to view it. More...
 
 getLink ()
 Get the link to the file. 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

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

Detailed Description

Item class for an oldimage table row.

Definition at line 28 of file RevDelFileItem.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 34 of file RevDelFileItem.php.

References $list, and RevisionItemBase\$row.

Member Function Documentation

◆ canView()

RevDelFileItem::canView ( )

Returns true if the current user can view the item.

Reimplemented from RevisionItemBase.

Definition at line 77 of file RevDelFileItem.php.

References File\DELETED_RESTRICTED.

◆ canViewContent()

RevDelFileItem::canViewContent ( )

Returns true if the current user can view the item text/file.

Reimplemented from RevisionItemBase.

Definition at line 81 of file RevDelFileItem.php.

References File\DELETED_FILE.

Referenced by RevDelArchivedFileItem\getApiData(), getApiData(), RevDelArchivedFileItem\getLink(), and getLink().

◆ getApiData()

RevDelFileItem::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 RevDelItem.

Reimplemented in RevDelArchivedFileItem.

Definition at line 214 of file RevDelFileItem.php.

References $file, canViewContent(), OldLocalFile\getArchiveName(), LocalFile\getDescription(), LocalFile\getHeight(), LocalFile\getSize(), LocalFile\getTimestamp(), SpecialPage\getTitleFor(), File\getUrl(), LocalFile\getUser(), LocalFile\getWidth(), isDeleted(), OldLocalFile\isDeleted(), File\RAW, OldLocalFile\userCan(), and wfTimestamp().

◆ getAuthorActorField()

RevDelFileItem::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since
1.31
Returns
string|bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 67 of file RevDelFileItem.php.

◆ getAuthorIdField()

RevDelFileItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
string|bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 59 of file RevDelFileItem.php.

◆ getAuthorNameField()

RevDelFileItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
string|bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 63 of file RevDelFileItem.php.

◆ getBits()

RevDelFileItem::getBits ( )

Get the current deletion bitfield value.

Returns
int

Reimplemented from RevDelItem.

Definition at line 85 of file RevDelFileItem.php.

◆ getComment()

RevDelFileItem::getComment ( )
protected

Wrap and format the file's comment block, if the current user is allowed to view it.

Returns
string HTML

Definition at line 191 of file RevDelFileItem.php.

References Linker\commentBlock(), and File\DELETED_COMMENT.

Referenced by getHTML().

◆ getHTML()

RevDelFileItem::getHTML ( )

Get the HTML of the list item.

Should be include "<li></li>" tags. This is used to show the list in HTML form, by the special page.

Reimplemented from RevisionItemBase.

Definition at line 204 of file RevDelFileItem.php.

References getComment(), getLink(), and getUserTools().

◆ getId()

RevDelFileItem::getId ( )

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

Returns
int

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 71 of file RevDelFileItem.php.

◆ getIdField()

RevDelFileItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
string|null

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 51 of file RevDelFileItem.php.

◆ getLink()

RevDelFileItem::getLink ( )
protected

Get the link to the file.

Overridden by RevDelArchivedFileItem.

Returns
string

Reimplemented in RevDelArchivedFileItem.

Definition at line 137 of file RevDelFileItem.php.

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

Referenced by getHTML().

◆ getTimestampField()

RevDelFileItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
string|bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 55 of file RevDelFileItem.php.

◆ getUserTools()

RevDelFileItem::getUserTools ( )
protected

Generate a user tool link cluster if the current user is allowed to view it.

Returns
string HTML

Definition at line 170 of file RevDelFileItem.php.

References Linker\userLink(), and Linker\userToolLinks().

Referenced by getHTML().

◆ initFile()

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

Create file object from $row sourced from $list.

Parameters
RevisionListBase$list
mixed$row
Returns
mixed

Reimplemented in RevDelArchivedFileItem.

Definition at line 46 of file RevDelFileItem.php.

References RevisionItemBase\$row.

◆ isDeleted()

RevDelFileItem::isDeleted ( )

◆ lock()

RevDelFileItem::lock ( )

Lock the item against changes outside of the DB.

Returns
Status
Since
1.28

Reimplemented from RevDelItem.

Reimplemented in RevDelArchivedFileItem.

Definition at line 258 of file RevDelFileItem.php.

◆ setBits()

RevDelFileItem::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 RevDelItem.

Reimplemented in RevDelArchivedFileItem.

Definition at line 89 of file RevDelFileItem.php.

References DB_MASTER, File\DELETED_FILE, isDeleted(), and wfGetDB().

◆ unlock()

RevDelFileItem::unlock ( )

Unlock the item against changes outside of the DB.

Returns
Status
Since
1.28

Reimplemented from RevDelItem.

Reimplemented in RevDelArchivedFileItem.

Definition at line 262 of file RevDelFileItem.php.

Member Data Documentation

◆ $file

OldLocalFile RevDelFileItem::$file
protected

Definition at line 32 of file RevDelFileItem.php.

Referenced by RevDelArchivedFileItem\getApiData(), and getApiData().

◆ $list

RevDelFileList RevDelFileItem::$list
protected

Definition at line 30 of file RevDelFileItem.php.

Referenced by __construct(), and RevDelArchivedFileItem\__construct().


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