ButtonAuthenticationRequest.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Auth;
 
use MediaWiki\Language\RawMessage;
use MediaWiki\Message\Message;
 
#[\AllowDynamicProperties]
class ButtonAuthenticationRequest extends AuthenticationRequest {
    protected $name;
 
    protected Message $label;
    protected Message $help;
 
    public function __construct( $name, Message $label, Message $help, $required = false ) {
        $this->name = $name;
        $this->label = $label;
        $this->help = $help;
        $this->required = $required ? self::REQUIRED : self::OPTIONAL;
    }
 
    public function getUniqueId() {
        return parent::getUniqueId() . ':' . $this->name;
    }
 
    public function getFieldInfo() {
        return [
            $this->name => [
                'type' => 'button',
                'label' => $this->label,
                'help' => $this->help,
            ]
        ];
    }
 
    public static function getRequestByName( array $reqs, $name ) {
        $requests = array_filter( $reqs, static function ( $req ) use ( $name ) {
            return $req instanceof ButtonAuthenticationRequest && $req->name === $name;
        } );
        // @phan-suppress-next-line PhanTypeMismatchReturnSuperType False positive
        return count( $requests ) === 1 ? reset( $requests ) : null;
    }
 
    public static function __set_state( $data ) {
        if ( !isset( $data['label'] ) ) {
            $data['label'] = new RawMessage( '$1', $data['name'] );
        } elseif ( is_string( $data['label'] ) ) {
            $data['label'] = new Message( $data['label'] );
        } elseif ( is_array( $data['label'] ) && $data['label'] ) {
            // @phan-suppress-next-line PhanParamTooFewUnpack Should infer non-emptiness from above
            $data['label'] = Message::newFromKey( ...$data['label'] );
        }
        if ( !isset( $data['help'] ) ) {
            $data['help'] = new RawMessage( '$1', $data['name'] );
        } elseif ( is_string( $data['help'] ) ) {
            $data['help'] = new Message( $data['help'] );
        } elseif ( is_array( $data['help'] ) && $data['help'] ) {
            // @phan-suppress-next-line PhanParamTooFewUnpack Should infer non-emptiness from above
            $data['help'] = Message::newFromKey( ...$data['help'] );
        }
        $ret = new static( $data['name'], $data['label'], $data['help'] );
        foreach ( $data as $k => $v ) {
            $ret->$k = $v;
        }
        return $ret;
    }
}