MediaWiki REL1_39
ButtonAuthenticationRequest.php
Go to the documentation of this file.
1<?php
22namespace MediaWiki\Auth;
23
24use Message;
25use RawMessage;
26
35 protected $name;
36
38 protected $label;
39
41 protected $help;
42
50 public function __construct( $name, Message $label, Message $help, $required = false ) {
51 $this->name = $name;
52 $this->label = $label;
53 $this->help = $help;
54 $this->required = $required ? self::REQUIRED : self::OPTIONAL;
55 }
56
61 public function getUniqueId() {
62 return parent::getUniqueId() . ':' . $this->name;
63 }
64
69 public function getFieldInfo() {
70 return [
71 $this->name => [
72 'type' => 'button',
73 'label' => $this->label,
74 'help' => $this->help,
75 ]
76 ];
77 }
78
86 public static function getRequestByName( array $reqs, $name ) {
87 $requests = array_filter( $reqs, static function ( $req ) use ( $name ) {
88 return $req instanceof ButtonAuthenticationRequest && $req->name === $name;
89 } );
90 // @phan-suppress-next-line PhanTypeMismatchReturnSuperType False positive
91 return count( $requests ) === 1 ? reset( $requests ) : null;
92 }
93
100 public static function __set_state( $data ) {
101 if ( !isset( $data['label'] ) ) {
102 $data['label'] = new RawMessage( '$1', $data['name'] );
103 } elseif ( is_string( $data['label'] ) ) {
104 $data['label'] = new Message( $data['label'] );
105 } elseif ( is_array( $data['label'] ) && $data['label'] ) {
106 // @phan-suppress-next-line PhanParamTooFewUnpack Should infer non-emptiness from above
107 $data['label'] = Message::newFromKey( ...$data['label'] );
108 }
109 if ( !isset( $data['help'] ) ) {
110 $data['help'] = new RawMessage( '$1', $data['name'] );
111 } elseif ( is_string( $data['help'] ) ) {
112 $data['help'] = new Message( $data['help'] );
113 } elseif ( is_array( $data['help'] ) && $data['help'] ) {
114 // @phan-suppress-next-line PhanParamTooFewUnpack Should infer non-emptiness from above
115 $data['help'] = Message::newFromKey( ...$data['help'] );
116 }
117 $ret = new static( $data['name'], $data['label'], $data['help'] );
118 foreach ( $data as $k => $v ) {
119 $ret->$k = $v;
120 }
121 return $ret;
122 }
123}
This is a value object for authentication requests.
const OPTIONAL
Indicates that the request is not required for authentication to proceed.
int $required
For login, continue, and link actions, one of self::OPTIONAL, self::REQUIRED, or self::PRIMARY_REQUIR...
const REQUIRED
Indicates that the request is required for authentication to proceed.
This is an authentication request that just implements a simple button.
getFieldInfo()
Fetch input field info.This will be used in the AuthManager APIs and web UIs to define API input para...
static getRequestByName(array $reqs, $name)
Fetch a ButtonAuthenticationRequest or subclass by name.
getUniqueId()
Supply a unique key for deduplication.When the AuthenticationRequests instances returned by the provi...
__construct( $name, Message $label, Message $help, $required=false)
The Message class deals with fetching and processing of interface message into a variety of formats.
Definition Message.php:140
static newFromKey( $key,... $params)
Factory function that is just wrapper for the real constructor.
Definition Message.php:399
Variant of the Message class.