Mediawiki\Api\ApiUser

Complexity

Total Complexity

14

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	12	7
A	getUsername()	0	3	1
A	getPassword()	0	3	1
A	getDomain()	0	3	1
A	equals()	0	6	4

<?php

namespace Mediawiki\Api;

use InvalidArgumentException;

/**
 * @since 0.1
 *
 * @author Addshore
 * @author RobinR1
 * @author Bene
 *
 * Represents a user that can log in to the api
 */
class ApiUser {

	/**
	 * @var string
	 */
	private $password;

	/**
	 * @var string
	 */
	private $username;

	/**
	 * @var string
	 */
	private $domain;

	/**
	 * @param string $username The username.
	 * @param string $password The user's password.
	 * @param string|null $domain The domain (for authentication systems that support domains).
	 *
	 * @throws \InvalidArgumentException
	 */
	public function __construct( $username, $password, $domain = null ) {
		$domainIsStringOrNull = ( is_string( $domain ) || $domain === null );
		if ( !is_string( $username ) || !is_string( $password ) || !$domainIsStringOrNull ) {
			throw new InvalidArgumentException( 'Username, Password and Domain must all be strings' );
		}
		if ( empty( $username ) || empty( $password ) ) {
			throw new InvalidArgumentException( 'Username and Password are not allowed to be empty' );
		}
		$this->username = $username;
		$this->password = $password;
		$this->domain   = $domain;
	}

	/**
	 * @since 0.1
	 * @return string
	 */
	public function getUsername() {
		return $this->username;
	}

	/**
	 * @since 0.1
	 * @return string
	 */
	public function getPassword() {
		return $this->password;
	}

	/**
	 * @since 0.1
	 * @return string
	 */
	public function getDomain() {
		return $this->domain;
	}

	/**
	 * @since 0.1
	 * @param mixed $other Another ApiUser object to compare with.
	 *
	 * @return bool
	 */
	public function equals( $other ) {
		return $other instanceof self
			&& $this->username == $other->getUsername()
			&& $this->password == $other->getPassword()
			&& $this->domain == $other->getDomain();
	}

}