Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7412242
CodexHTMLForm.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
6 KB
Referenced Files
None
Subscribers
None
CodexHTMLForm.php
View Options
<?php
/**
* HTML form generation using Codex components.
*
* @license GPL-2.0-or-later
* @file
*/
namespace
MediaWiki\HTMLForm
;
use
MediaWiki\Html\Html
;
use
MediaWiki\HTMLForm\Field\HTMLButtonField
;
use
MediaWiki\Linker\Linker
;
use
MediaWiki\Parser\Sanitizer
;
/**
* Codex based HTML form
*
* @since 1.41
*/
class
CodexHTMLForm
extends
HTMLForm
{
/** @inheritDoc */
protected
$displayFormat
=
'codex'
;
/** @inheritDoc */
public
static
function
loadInputFromParameters
(
$fieldname
,
$descriptor
,
?
HTMLForm
$parent
=
null
)
{
$field
=
parent
::
loadInputFromParameters
(
$fieldname
,
$descriptor
,
$parent
);
$field
->
setShowEmptyLabel
(
false
);
return
$field
;
}
/** @inheritDoc */
public
function
getHTML
(
$submitResult
)
{
$this
->
getOutput
()->
addModuleStyles
(
[
'mediawiki.htmlform.codex.styles'
,
]
);
return
parent
::
getHTML
(
$submitResult
);
}
/**
* @inheritDoc
*/
protected
function
formatField
(
HTMLFormField
$field
,
$value
)
{
return
$field
->
getCodex
(
$value
);
}
/** @inheritDoc */
protected
function
getFormAttributes
()
{
$attribs
=
parent
::
getFormAttributes
();
$attribs
[
'class'
]
=
[
'mw-htmlform'
,
'mw-htmlform-codex'
];
return
$attribs
;
}
/** @inheritDoc */
public
function
wrapForm
(
$html
)
{
return
Html
::
rawElement
(
'form'
,
$this
->
getFormAttributes
(),
$html
);
}
/** @inheritDoc */
protected
function
wrapFieldSetSection
(
$legend
,
$section
,
$attributes
,
$isRoot
)
{
$attributes
[
'class'
]
=
'cdx-field cdx-field--is-fieldset'
;
$legendElement
=
Html
::
rawElement
(
'legend'
,
[
'class'
=>
[
'cdx-label'
]
],
$legend
);
return
Html
::
rawElement
(
'fieldset'
,
$attributes
,
"$legendElement
\n
$section"
)
.
"
\n
"
;
}
/**
* Note that this method returns HTML, while the parent method specifies that it should return
* a plain string. This method is only used to get the `$legend` argument of the
* wrapFieldSetSection() call, so we can be reasonably sure that returning HTML here is okay.
*
* @inheritDoc
*/
public
function
getLegend
(
$key
)
{
$legendText
=
$this
->
msg
(
$this
->
mMessagePrefix
?
"{$this->mMessagePrefix}-$key"
:
$key
)->
text
();
$legendTextMarkup
=
Html
::
element
(
'span'
,
[
'class'
=>
[
'cdx-label__label__text'
]
],
$legendText
);
$isOptional
=
$this
->
mSections
[
$key
][
'optional'
]
??
false
;
$optionalFlagMarkup
=
''
;
if
(
$isOptional
)
{
$optionalFlagMarkup
=
Html
::
element
(
'span'
,
[
'class'
=>
[
'cdx-label__label__optional-flag'
]
],
$this
->
msg
(
'word-separator'
)->
text
()
.
$this
->
msg
(
'htmlform-optional-flag'
)->
text
()
);
}
$descriptionMarkup
=
''
;
if
(
isset
(
$this
->
mSections
[
$key
][
'description-message'
]
)
)
{
$needsParse
=
$this
->
mSections
[
$key
][
'description-message-parse'
]
??
false
;
$descriptionMessage
=
$this
->
msg
(
$this
->
mSections
[
$key
][
'description-message'
]
);
$descriptionMarkup
=
Html
::
rawElement
(
'span'
,
[
'class'
=>
[
'cdx-label__description'
]
],
$needsParse
?
$descriptionMessage
->
parse
()
:
$descriptionMessage
->
escaped
()
);
}
elseif
(
isset
(
$this
->
mSections
[
$key
][
'description'
]
)
)
{
$descriptionMarkup
=
Html
::
element
(
'span'
,
[
'class'
=>
[
'cdx-label__description'
]
],
$this
->
mSections
[
$key
][
'description'
]
);
}
return
Html
::
rawElement
(
'span'
,
[
'class'
=>
[
'cdx-label__label'
]
],
$legendTextMarkup
.
$optionalFlagMarkup
)
.
$descriptionMarkup
;
}
/** @inheritDoc */
protected
function
formatSection
(
array
$fieldsHtml
,
$sectionName
,
$anyFieldHasLabel
)
{
if
(
!
$fieldsHtml
)
{
// Do not generate any wrappers for empty sections. Sections may be empty if they only
// have subsections, but no fields. A legend will still be added in
// wrapFieldSetSection().
return
''
;
}
$html
=
implode
(
''
,
$fieldsHtml
);
if
(
$sectionName
)
{
$attribs
=
[
'id'
=>
Sanitizer
::
escapeIdForAttribute
(
$sectionName
),
'class'
=>
[
'cdx-field__control'
]
];
return
Html
::
rawElement
(
'div'
,
$attribs
,
$html
);
}
return
$html
;
}
/**
* Get the submit and cancel buttons.
* @stable to override
* @return string HTML.
*/
public
function
getButtons
()
{
$buttons
=
[];
if
(
$this
->
mShowSubmit
)
{
$value
=
$this
->
getSubmitText
();
// Define flag classes for the submit button
$submitFlags
=
$this
->
mSubmitFlags
;
$submitClasses
=
[
'mw-htmlform-submit'
,
'cdx-button'
];
$submitButtonLabel
=
$this
->
getSubmitText
();
$submitID
=
$this
->
mSubmitID
;
$submitName
=
$this
->
mSubmitName
;
$submitTooltip
=
[];
if
(
$this
->
mSubmitTooltip
!==
null
)
{
$submitTooltip
+=
Linker
::
tooltipAndAccesskeyAttribs
(
$this
->
mSubmitTooltip
);
}
$buttonAttribs
=
[
'value'
=>
$value
,
'type'
=>
'submit'
,
'name'
=>
$submitName
,
'id'
=>
$submitID
,
'class'
=>
$submitClasses
,
'formnovalidate'
=>
false
,
]
+
$submitTooltip
;
$button
=
HTMLButtonField
::
buildCodexComponent
(
$submitFlags
,
htmlspecialchars
(
$submitButtonLabel
),
$buttonAttribs
);
$buttons
[]
=
$button
;
}
// The reset button is unused and will be removed from HTMLForm (T361032).
if
(
$this
->
mShowCancel
)
{
$target
=
$this
->
getCancelTargetURL
();
$buttonClasses
=
[
'cdx-button'
,
'cdx-button--fake-button'
,
'cdx-button--fake-button--enabled'
,
];
$attr
=
[
'href'
=>
$target
,
'class'
=>
$buttonClasses
,
'role'
=>
'button'
,
];
$cancelButton
=
Html
::
element
(
'a'
,
$attr
,
$this
->
msg
(
'cancel'
)->
text
()
);
$buttons
[]
=
$cancelButton
;
}
foreach
(
$this
->
mButtons
as
$button
)
{
$attrs
=
[
'type'
=>
'submit'
,
'name'
=>
$button
[
'name'
],
'value'
=>
$button
[
'value'
]
];
if
(
isset
(
$button
[
'label-message'
]
)
)
{
$label
=
$this
->
getMessage
(
$button
[
'label-message'
]
)->
parse
();
}
elseif
(
isset
(
$button
[
'label'
]
)
)
{
$label
=
htmlspecialchars
(
$button
[
'label'
]
);
}
elseif
(
isset
(
$button
[
'label-raw'
]
)
)
{
$label
=
$button
[
'label-raw'
];
}
else
{
$label
=
htmlspecialchars
(
$button
[
'value'
]
);
}
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in self::addButton
if
(
$button
[
'attribs'
]
)
{
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in self::addButton
$attrs
+=
$button
[
'attribs'
];
}
if
(
isset
(
$button
[
'id'
]
)
)
{
$attrs
[
'id'
]
=
$button
[
'id'
];
}
Html
::
addClass
(
$attrs
[
'class'
],
'cdx-button'
);
$buttons
[]
=
Html
::
rawElement
(
'button'
,
$attrs
,
$label
)
.
"
\n
"
;
}
if
(
!
$buttons
)
{
return
''
;
}
return
Html
::
rawElement
(
'div'
,
[
'class'
=>
'mw-htmlform-submit-buttons'
],
implode
(
"
\n
"
,
$buttons
)
)
.
"
\n
"
;
}
}
/** @deprecated class alias since 1.42 */
class_alias
(
CodexHTMLForm
::
class
,
'CodexHTMLForm'
);
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 00:21 (1 d, 20 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
d2/73/0edb09374e5152a0cb7a33be29e8
Default Alt Text
CodexHTMLForm.php (6 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment