MediaWiki  master
RevisionItemBase.php
Go to the documentation of this file.
1 <?php
24 
28 abstract class RevisionItemBase {
30  protected $list;
31 
33  protected $row;
34 
39  public function __construct( $list, $row ) {
40  $this->list = $list;
41  $this->row = $row;
42  }
43 
49  public function getIdField() {
50  return null;
51  }
52 
58  public function getTimestampField() {
59  return false;
60  }
61 
67  public function getAuthorIdField() {
68  return false;
69  }
70 
76  public function getAuthorNameField() {
77  return false;
78  }
79 
86  public function getAuthorActorField() {
87  return false;
88  }
89 
94  public function getId() {
95  $field = $this->getIdField();
96  return $this->row->$field;
97  }
98 
103  public function formatDate() {
104  return $this->list->getLanguage()->userDate( $this->getTimestamp(),
105  $this->list->getUser() );
106  }
107 
112  public function formatTime() {
113  return $this->list->getLanguage()->userTime( $this->getTimestamp(),
114  $this->list->getUser() );
115  }
116 
121  public function getTimestamp() {
122  $field = $this->getTimestampField();
123  return wfTimestamp( TS_MW, $this->row->$field );
124  }
125 
130  public function getAuthorId() {
131  $field = $this->getAuthorIdField();
132  return intval( $this->row->$field );
133  }
134 
139  public function getAuthorName() {
140  $field = $this->getAuthorNameField();
141  return strval( $this->row->$field );
142  }
143 
149  public function getAuthorActor() {
150  $field = $this->getAuthorActorField();
151  return strval( $this->row->$field );
152  }
153 
157  abstract public function canView();
158 
162  abstract public function canViewContent();
163 
168  abstract public function getHTML();
169 
174  protected function getLinkRenderer() {
175  return MediaWikiServices::getInstance()->getLinkRenderer();
176  }
177 }
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
getTimestamp()
Get the timestamp in MW 14-char form.
getAuthorNameField()
Get the DB field name storing user names.
RevisionListBase $list
The parent.
getTimestampField()
Get the DB field name storing timestamps.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
canViewContent()
Returns true if the current user can view the item text/file.
getId()
Get the ID, as it would appear in the ids URL parameter.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$row
The database result row.
getAuthorActor()
Get the author actor ID.
__construct( $list, $row)
getIdField()
Get the DB field name associated with the ID list.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
canView()
Returns true if the current user can view the item.
getHTML()
Get the HTML of the list item.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getAuthorIdField()
Get the DB field name storing user ids.
formatTime()
Get the time, formatted in user&#39;s language.
getAuthorName()
Get the author user name.
getLinkRenderer()
Returns an instance of LinkRenderer.
Abstract base class for revision items.
getAuthorId()
Get the author user ID.
formatDate()
Get the date, formatted in user&#39;s language.
getAuthorActorField()
Get the DB field name storing actor ids.