Login   Register  
PHP Classes
elePHPant
Icontem

File: _interfaces/IMessageDigest.intf.php

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Marius Zadara  >  Message Digest  >  _interfaces/IMessageDigest.intf.php  
File: _interfaces/IMessageDigest.intf.php
Role: Class source
Content type: text/plain
Description: Message Digest interface
Class: Message Digest
Generate message digests with hashing algorithms
 

Contents

Class file image Download
<?php

/**
 * Message digest interface definition. 
 * This interface will set the functions that a message digester must implement.
 *  
 * @author Marius Zadara <marius@zadara.org>
 * @category org.zadara.marius.messagedigester.interfaces 
 * @copyright (C) 2008, Marius Zadara <marius@zadara.org>
 * @license GNU GPL
 * @package org.zadara.marius.messagedigester
 * @access public
 */
interface IMessagedigest
{
    
/**
     * Get an instance of a hash algorithm.
     * 
     * @param String $hashAlgorithmName The name of the hash algorithm
     * @access public
     */
    
public function getInstance($hashAlgorithmName);    
    

    
/**
     * Reset the message digest internal data.
     * 
     * @access public
     */
    
public function reset();
    
    
/**
     * Function to set the text for digest.
     *  
     * @param String $text The text to digest later
     */
    
public function update($text);    
    
    
/**
     * Digest main function. 
     *
     * @return string The text digested
     */
    
public function digest();    
}


?>