Item class for a filearchive table row. More...
Public Member Functions | |
| __construct ($list, $row) | |
| getApiData (ApiResult $result) | |
| Get the return information about the revision for the API. | |
| getAuthorIdField () | |
| Get the DB field name storing user ids. | |
| getAuthorNameField () | |
| Get the DB field name storing user names. | |
| getId () | |
| Get the ID, as it would appear in the ids URL parameter. | |
| getIdField () | |
| Get the DB field name associated with the ID list. | |
| getTimestampField () | |
| Get the DB field name storing timestamps. | |
| setBits ($bits) | |
| Set the visibility of the item. | |
Protected Member Functions | |
| getLink () | |
| Get the link to the file. | |
Detailed Description
Item class for a filearchive table row.
Definition at line 25 of file RevDelArchivedFileItem.php.
Constructor & Destructor Documentation
| RevDelArchivedFileItem::__construct | ( | $ | list, |
| $ | row | ||
| ) |
- Parameters:
-
RevisionListBase $list object $row DB result row
Reimplemented from RevDelFileItem.
Definition at line 26 of file RevDelArchivedFileItem.php.
References RevisionItemBase\$list, RevisionItemBase\$row, file, and ArchivedFile\newFromRow().
Member Function Documentation
| RevDelArchivedFileItem::getApiData | ( | ApiResult $ | result | ) |
Get the return information about the revision for the API.
- Since:
- 1.23
- Parameters:
-
ApiResult $result API result object
- Returns:
- array Data for the API result
Reimplemented from RevDelFileItem.
Definition at line 90 of file RevDelArchivedFileItem.php.
References RevDelFileItem\$file, $ret, $user, array(), RevDelFileItem\canViewContent(), Revision\DELETED_COMMENT, Revision\DELETED_USER, file, File\getHeight(), File\getSize(), File\getTimestamp(), SpecialPage\getTitleFor(), File\getUser(), File\getWidth(), RevDelFileItem\isDeleted(), File\isDeleted(), list, File\userCan(), and wfTimestamp().
Get the DB field name storing user ids.
Override this function.
- Returns:
- bool
Reimplemented from RevDelFileItem.
Definition at line 39 of file RevDelArchivedFileItem.php.
Get the DB field name storing user names.
Override this function.
- Returns:
- bool
Reimplemented from RevDelFileItem.
Definition at line 43 of file RevDelArchivedFileItem.php.
Get the ID, as it would appear in the ids URL parameter.
- Returns:
- int
Reimplemented from RevDelFileItem.
Definition at line 47 of file RevDelArchivedFileItem.php.
Get the DB field name associated with the ID list.
Override this function.
- Returns:
- null
Reimplemented from RevDelFileItem.
Definition at line 31 of file RevDelArchivedFileItem.php.
| RevDelArchivedFileItem::getLink | ( | ) | [protected] |
Get the link to the file.
Overridden by RevDelArchivedFileItem.
- Returns:
- string
Reimplemented from RevDelFileItem.
Definition at line 65 of file RevDelArchivedFileItem.php.
References $key, $link, array(), RevDelFileItem\canViewContent(), file, SpecialPage\getTitleFor(), RevDelFileItem\isDeleted(), Linker\link(), and list.
Get the DB field name storing timestamps.
Override this function.
- Returns:
- bool
Reimplemented from RevDelFileItem.
Definition at line 35 of file RevDelArchivedFileItem.php.
| 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 51 of file RevDelArchivedFileItem.php.
The documentation for this class was generated from the following file:
- includes/revisiondelete/RevDelArchivedFileItem.php
