MediaWiki  master
JsonContent.php
Go to the documentation of this file.
1 <?php
15 class JsonContent extends TextContent {
16 
21  protected $jsonParse;
22 
27  public function __construct( $text, $modelId = CONTENT_MODEL_JSON ) {
28  parent::__construct( $text, $modelId );
29  }
30 
39  public function getData() {
40  if ( $this->jsonParse === null ) {
41  $this->jsonParse = FormatJson::parse( $this->getText() );
42  }
43  return $this->jsonParse;
44  }
45 
49  public function isValid() {
50  return $this->getData()->isGood();
51  }
52 
60  public function beautifyJSON() {
61  return FormatJson::encode( $this->getData()->getValue(), true, FormatJson::UTF8_OK );
62  }
63 
72  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
73  // FIXME: WikiPage::doEditContent invokes PST before validation. As such, native data
74  // may be invalid (though PST result is discarded later in that case).
75  if ( !$this->isValid() ) {
76  return $this;
77  }
78 
79  return new static( self::normalizeLineEndings( $this->beautifyJSON() ) );
80  }
81 
91  protected function fillParserOutput( Title $title, $revId,
93  ) {
94  // FIXME: WikiPage::doEditContent generates parser output before validation.
95  // As such, native data may be invalid (though output is discarded later in that case).
96  if ( $generateHtml && $this->isValid() ) {
97  $output->setText( $this->rootValueTable( $this->getData()->getValue() ) );
98  $output->addModuleStyles( 'mediawiki.content.json' );
99  } else {
100  $output->setText( '' );
101  }
102  }
103 
112  protected function rootValueTable( $val ) {
113  if ( is_object( $val ) ) {
114  return $this->objectTable( $val );
115  }
116 
117  if ( is_array( $val ) ) {
118  // Wrap arrays in another array so that they're visually boxed in a container.
119  // Otherwise they are visually indistinguishable from a single value.
120  return $this->arrayTable( [ $val ] );
121  }
122 
123  return Html::rawElement( 'table', [ 'class' => 'mw-json mw-json-single-value' ],
124  Html::rawElement( 'tbody', [],
125  Html::rawElement( 'tr', [],
126  Html::element( 'td', [], $this->primitiveValue( $val ) )
127  )
128  )
129  );
130  }
131 
138  protected function objectTable( $mapping ) {
139  $rows = [];
140  $empty = true;
141 
142  foreach ( $mapping as $key => $val ) {
143  $rows[] = $this->objectRow( $key, $val );
144  $empty = false;
145  }
146  if ( $empty ) {
147  $rows[] = Html::rawElement( 'tr', [],
148  Html::element( 'td', [ 'class' => 'mw-json-empty' ],
149  wfMessage( 'content-json-empty-object' )->text()
150  )
151  );
152  }
153  return Html::rawElement( 'table', [ 'class' => 'mw-json' ],
154  Html::rawElement( 'tbody', [], implode( '', $rows ) )
155  );
156  }
157 
165  protected function objectRow( $key, $val ) {
166  $th = Html::element( 'th', [], $key );
167  $td = $this->valueCell( $val );
168  return Html::rawElement( 'tr', [], $th . $td );
169  }
170 
177  protected function arrayTable( $mapping ) {
178  $rows = [];
179  $empty = true;
180 
181  foreach ( $mapping as $val ) {
182  $rows[] = $this->arrayRow( $val );
183  $empty = false;
184  }
185  if ( $empty ) {
186  $rows[] = Html::rawElement( 'tr', [],
187  Html::element( 'td', [ 'class' => 'mw-json-empty' ],
188  wfMessage( 'content-json-empty-array' )->text()
189  )
190  );
191  }
192  return Html::rawElement( 'table', [ 'class' => 'mw-json' ],
193  Html::rawElement( 'tbody', [], implode( "\n", $rows ) )
194  );
195  }
196 
203  protected function arrayRow( $val ) {
204  $td = $this->valueCell( $val );
205  return Html::rawElement( 'tr', [], $td );
206  }
207 
214  protected function valueCell( $val ) {
215  if ( is_object( $val ) ) {
216  return Html::rawElement( 'td', [], $this->objectTable( $val ) );
217  }
218 
219  if ( is_array( $val ) ) {
220  return Html::rawElement( 'td', [], $this->arrayTable( $val ) );
221  }
222 
223  return Html::element( 'td', [ 'class' => 'mw-json-value' ], $this->primitiveValue( $val ) );
224  }
225 
232  protected function primitiveValue( $val ) {
233  if ( is_string( $val ) ) {
234  // Don't FormatJson::encode for strings since we want quotes
235  // and new lines to render visually instead of escaped.
236  return '"' . $val . '"';
237  }
238  return FormatJson::encode( $val );
239  }
240 }
__construct( $text, $modelId=CONTENT_MODEL_JSON)
Definition: JsonContent.php:27
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2633
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
addModuleStyles( $modules)
setText( $text)
preSaveTransform(Title $title, User $user, ParserOptions $popts)
Beautifies JSON prior to save.
Definition: JsonContent.php:72
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
arrayRow( $val)
Create HTML table row representing the value in an array.
Status $jsonParse
Definition: JsonContent.php:21
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
getText()
Returns the text represented by this Content object, as a string.
const CONTENT_MODEL_JSON
Definition: Defines.php:239
arrayTable( $mapping)
Create HTML table representing a JSON array.
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2217
const UTF8_OK
Skip escaping most characters above U+007F for readability and compactness.
Definition: FormatJson.php:34
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
rootValueTable( $val)
Construct HTML table representation of any JSON value.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
objectTable( $mapping)
Create HTML table representing a JSON object.
fillParserOutput(Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
Set the HTML and add the appropriate styles.
Definition: JsonContent.php:91
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1982
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
objectRow( $key, $val)
Create HTML table row representing one object property.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getData()
Decodes the JSON string.
Definition: JsonContent.php:39
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
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
Represents the content of a JSON content.
Definition: JsonContent.php:15
valueCell( $val)
Construct HTML table cell representing any JSON value.
primitiveValue( $val)
Construct text representing a JSON primitive value.
beautifyJSON()
Pretty-print JSON.
Definition: JsonContent.php:60
static parse( $value, $options=0)
Decodes a JSON string.
Definition: FormatJson.php:188
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473