MessageList - The source code for the component with sample code and tutorial (+) borebiller.info

MessageList, Sample code, tutorial

Sådan benyttes komponenten MessageList klassen

Først skal du inkludere den fil der beskriver komponenten, som en klasse fil


<?

require_once(HTML_PACKAGE_PATH.'/MessageList.php');

?>

Dernæst kan du enten benytte komponenten som et taglib (statiske metoder):


<?

MessageList::display($param1, $param2, $param3, ...);

?>

eller du kan lave en instance af komponenten og benytte metoderne direkte:


<?

$object = new MessageList($param1, $param2, $param3, ...);

print $object->getHtml();

?>

MessageList, PHP source code

Den fulde PHP kildekode for MessageList klassen


<?php
/**
 * @package basic
 * @filesource
 * @see HTML_BASIC_UTIL_PATH.'/MessageList.php'
 * @copyright (c) http://Finn-Rasmussen.com
 * @license http://Finn-Rasmussen.com/license/ myPHP License conditions
 * @author http://Finn-Rasmussen.com
 * @version 1.11
 * @since 27-nov-2009
 */

/**
 * The required files
 */

/**
 * The MessageList is used as a singleton class, 
 * so all the messages are kept in one place only
 * <code>
 *    $key = __FILE__.' : '.__LINE__;
 *    $messagelist = & Singleton::getInstance(CLASS_NAME_MESSAGE_LIST);
 *    $messagelist->add('Message to add', $key);
 *    print $messagelist->get($key);
 * Or
 *    foreach($messagelist->getMessageList(() as $key=>$value) {
 *       print $messagelist->get($key); // $value is an array
 *    }
 * </code>
 * @package basic
 */
 
class MessageList {
    /**
     * @var array $messageList The array of messages
     */
    protected $messageList = array();
    
    /**
     * Constructor
     */
    function __construct() {
    }
    
    /**
     * Get the message with the specified key
     * @param  String $key The key to use as lookup
     * @return String The message associated with the key
     */
    function get($key) {
        $html = '';
        if (array_key_exists($key, $this->messageList)) {
            $html .= $this->messageList[$key];
        } else {
            $html .= MESSAGE_TEXT_NO_MSG."$key\r\n";
        }
        return $html;
    }
    
    /**
     * Return the array of messages
     * @return array The array of messages
     */
    function getMessageList() {
        return $this->messageList;
    }
    
    /**
     * Add a message to the list of messages
     * @param String $msg The message
     * @param String $key The key to use
     */
    function add($msg, $key) {
        $this->messageList[$key] = $msg;
    }
    
    /**
     * Get the size of the message list array
     * @return int The count of the message list array
     */
     function size() {
        return count($this->messageList);
     }
    
    /**
     * Clear the message list array
     */
     function clear() {
        unset($this->messageList);
        $this->messageList = array();
     }
}
?>

MessageList.php

MessageList, Sample code, tutorial

MessageList, Sådan vises komponenten

MessageList, PHP source code

MessageList, HTML source code

MessageList, Class methods

MessageList, Object vars