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 rootValueTable( $val ) {
73  if ( is_object( $val ) ) {
74  return $this->objectTable( $val );
75  }
76 
77  if ( is_array( $val ) ) {
78  // Wrap arrays in another array so that they're visually boxed in a container.
79  // Otherwise they are visually indistinguishable from a single value.
80  return $this->arrayTable( [ $val ] );
81  }
82 
83  return Html::rawElement( 'table', [ 'class' => 'mw-json mw-json-single-value' ],
84  Html::rawElement( 'tbody', [],
85  Html::rawElement( 'tr', [],
86  Html::element( 'td', [], $this->primitiveValue( $val ) )
87  )
88  )
89  );
90  }
91 
98  protected function objectTable( $mapping ) {
99  $rows = [];
100  $empty = true;
101 
102  foreach ( $mapping as $key => $val ) {
103  $rows[] = $this->objectRow( $key, $val );
104  $empty = false;
105  }
106  if ( $empty ) {
107  $rows[] = Html::rawElement( 'tr', [],
108  Html::element( 'td', [ 'class' => 'mw-json-empty' ],
109  wfMessage( 'content-json-empty-object' )->text()
110  )
111  );
112  }
113  return Html::rawElement( 'table', [ 'class' => 'mw-json' ],
114  Html::rawElement( 'tbody', [], implode( '', $rows ) )
115  );
116  }
117 
125  protected function objectRow( $key, $val ) {
126  $thContent = Html::element( 'span', [], $key );
127  $th = Html::rawElement( 'th', [], $thContent );
128  $td = $this->valueCell( $val );
129  return Html::rawElement( 'tr', [], $th . $td );
130  }
131 
138  protected function arrayTable( $mapping ) {
139  $rows = [];
140  $empty = true;
141 
142  foreach ( $mapping as $val ) {
143  $rows[] = $this->arrayRow( $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-array' )->text()
150  )
151  );
152  }
153  return Html::rawElement( 'table', [ 'class' => 'mw-json' ],
154  Html::rawElement( 'tbody', [], implode( "\n", $rows ) )
155  );
156  }
157 
164  protected function arrayRow( $val ) {
165  $td = $this->valueCell( $val );
166  return Html::rawElement( 'tr', [], $td );
167  }
168 
175  protected function valueCell( $val ) {
176  if ( is_object( $val ) ) {
177  return Html::rawElement( 'td', [], $this->objectTable( $val ) );
178  }
179 
180  if ( is_array( $val ) ) {
181  return Html::rawElement( 'td', [], $this->arrayTable( $val ) );
182  }
183 
184  return Html::element( 'td', [ 'class' => 'mw-json-value' ], $this->primitiveValue( $val ) );
185  }
186 
193  protected function primitiveValue( $val ) {
194  if ( is_string( $val ) ) {
195  // Don't FormatJson::encode for strings since we want quotes
196  // and new lines to render visually instead of escaped.
197  return '"' . $val . '"';
198  }
199  return FormatJson::encode( $val );
200  }
201 }
JsonContent\beautifyJSON
beautifyJSON()
Pretty-print JSON.
Definition: JsonContent.php:60
JsonContent\isValid
isValid()
Definition: JsonContent.php:49
JsonContent\arrayTable
arrayTable( $mapping)
Create HTML table representing a JSON array.
Definition: JsonContent.php:138
JsonContent\arrayRow
arrayRow( $val)
Create HTML table row representing the value in an array.
Definition: JsonContent.php:164
wfMessage
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Definition: GlobalFunctions.php:1183
JsonContent\objectTable
objectTable( $mapping)
Create HTML table representing a JSON object.
Definition: JsonContent.php:98
FormatJson\UTF8_OK
const UTF8_OK
Skip escaping most characters above U+007F for readability and compactness.
Definition: FormatJson.php:34
TextContent\getText
getText()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:153
JsonContent\rootValueTable
rootValueTable( $val)
Construct HTML table representation of any JSON value.
Definition: JsonContent.php:72
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:44
CONTENT_MODEL_JSON
const CONTENT_MODEL_JSON
Definition: Defines.php:212
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:96
JsonContent\$jsonParse
Status $jsonParse
Definition: JsonContent.php:21
JsonContent
Represents the content of a JSON content.
Definition: JsonContent.php:15
JsonContent\objectRow
objectRow( $key, $val)
Create HTML table row representing one object property.
Definition: JsonContent.php:125
JsonContent\valueCell
valueCell( $val)
Construct HTML table cell representing any JSON value.
Definition: JsonContent.php:175
FormatJson\parse
static parse( $value, $options=0)
Decodes a JSON string.
Definition: FormatJson.php:160
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:39
JsonContent\getData
getData()
Decodes the JSON string.
Definition: JsonContent.php:39
JsonContent\primitiveValue
primitiveValue( $val)
Construct text representing a JSON primitive value.
Definition: JsonContent.php:193
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
JsonContent\__construct
__construct( $text, $modelId=CONTENT_MODEL_JSON)
Definition: JsonContent.php:27
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232