PasswordFactory.php

Go to the documentation of this file.

<?php
final class PasswordFactory {
    private $default = '';

    private $types = array(
        '' => array( 'type' => '', 'class' => 'InvalidPassword' ),
    );

    public function register( $type, array $config ) {
        $config['type'] = $type;
        $this->types[$type] = $config;
    }

    public function setDefaultType( $type ) {
        if ( !isset( $this->types[$type] ) ) {
            throw new InvalidArgumentException( "Invalid password type $type." );
        }
        $this->default = $type;
    }

    public function init( Config $config ) {
        foreach ( $config->get( 'PasswordConfig' ) as $type => $options ) {
            $this->register( $type, $options );
        }

        $this->setDefaultType( $config->get( 'PasswordDefault' ) );
    }

    public function getTypes() {
        return $this->types;
    }

    public function newFromCiphertext( $hash ) {
        if ( $hash === null || $hash === false || $hash === '' ) {
            return new InvalidPassword( $this, array( 'type' => '' ), null );
        } elseif ( $hash[0] !== ':' ) {
            throw new PasswordError( 'Invalid hash given' );
        }

        $type = substr( $hash, 1, strpos( $hash, ':', 1 ) - 1 );
        if ( !isset( $this->types[$type] ) ) {
            throw new PasswordError( "Unrecognized password hash type $type." );
        }

        $config = $this->types[$type];

        return new $config['class']( $this, $config, $hash );
    }

    public function newFromType( $type ) {
        if ( !isset( $this->types[$type] ) ) {
            throw new PasswordError( "Unrecognized password hash type $type." );
        }

        $config = $this->types[$type];

        return new $config['class']( $this, $config );
    }

    public function newFromPlaintext( $password, Password $existing = null ) {
        if ( $existing === null ) {
            $config = $this->types[$this->default];
            $obj = new $config['class']( $this, $config );
        } else {
            $obj = clone $existing;
        }

        $obj->crypt( $password );

        return $obj;
    }

    public function needsUpdate( Password $password ) {
        if ( $password->getType() !== $this->default ) {
            return true;
        } else {
            return $password->needsUpdate();
        }
    }
}