ParameterizedPassword.php

Go to the documentation of this file.

<?php
abstract class ParameterizedPassword extends Password {
    protected $params = [];
 
    protected $args = [];
 
    protected function parseHash( $hash ) {
        parent::parseHash( $hash );
 
        if ( $hash === null ) {
            $this->params = $this->getDefaultParams();
            return;
        }
 
        $parts = explode( $this->getDelimiter(), $hash );
        $paramKeys = array_keys( $this->getDefaultParams() );
 
        if ( count( $parts ) < count( $paramKeys ) ) {
            throw new PasswordError( 'Hash is missing required parameters.' );
        }
 
        if ( $paramKeys ) {
            $this->args = array_splice( $parts, count( $paramKeys ) );
            $this->params = array_combine( $paramKeys, $parts );
        } else {
            $this->args = $parts;
        }
 
        if ( $this->args ) {
            $this->hash = array_pop( $this->args );
        } else {
            $this->hash = null;
        }
    }
 
    public function needsUpdate() {
        return $this->params !== $this->getDefaultParams();
    }
 
    public function toString() {
        $str = ':' . $this->config['type'] . ':';
 
        if ( count( $this->params ) || count( $this->args ) ) {
            $str .= implode( $this->getDelimiter(), array_merge( $this->params, $this->args ) );
            $str .= $this->getDelimiter();
        }
 
        $res = $str . $this->hash;
        $this->assertIsSafeSize( $res );
        return $res;
    }
 
    abstract protected function getDelimiter();
 
    abstract protected function getDefaultParams();
}