ServiceOptions.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Config;
 
use InvalidArgumentException;
use Wikimedia\Assert\Assert;
 
class ServiceOptions {
    private $keys;
    private $options = [];
 
    public function __construct( array $keys, ...$sources ) {
        $this->keys = $keys;
        foreach ( $keys as $key ) {
            foreach ( $sources as $source ) {
                if ( $source instanceof Config ) {
                    if ( $source->has( $key ) ) {
                        $this->options[$key] = $source->get( $key );
                        continue 2;
                    }
                } elseif ( $source instanceof ServiceOptions ) {
                    if ( array_key_exists( $key, $source->options ) ) {
                        $this->options[$key] = $source->get( $key );
                        continue 2;
                    }
                } elseif ( array_key_exists( $key, $source ) ) {
                    $this->options[$key] = $source[$key];
                    continue 2;
                }
            }
            throw new InvalidArgumentException( "Key \"$key\" not found in input sources" );
        }
    }
 
    public function assertRequiredOptions( array $expectedKeys ) {
        if ( $this->keys !== $expectedKeys ) {
            $extraKeys = array_diff( $this->keys, $expectedKeys );
            $missingKeys = array_diff( $expectedKeys, $this->keys );
            Assert::precondition( !$extraKeys && !$missingKeys,
                (
                $extraKeys
                    ? 'Unsupported options passed: ' . implode( ', ', $extraKeys ) . '!'
                    : ''
                ) . ( $extraKeys && $missingKeys ? ' ' : '' ) . (
                $missingKeys
                    ? 'Required options missing: ' . implode( ', ', $missingKeys ) . '!'
                    : ''
                )
            );
        }
    }
 
    public function get( $key ) {
        if ( !array_key_exists( $key, $this->options ) ) {
            throw new InvalidArgumentException( "Unrecognized option \"$key\"" );
        }
        return $this->options[$key];
    }
}