Gecko [ ifk.uw.edu.pl ]

Name	Size	Permission
Gettext	[ DIR ]	drwxr-xr-x
ChoiceFormat.php	6.14 KB	-rw-r--r--
CultureInfo.php	12.32 KB	-rw-r--r--
IMessageSource.php	3.72 KB	-rw-r--r--
MessageCache.php	3.91 KB	-rw-r--r--
MessageFormat.php	5.9 KB	-rw-r--r--
MessageSource.php	8.17 KB	-rw-r--r--
MessageSource_Database.php	9.43 KB	-rw-r--r--
MessageSource_PHP.php	10.21 KB	-rw-r--r--
MessageSource_XLIFF.php	13.12 KB	-rw-r--r--
MessageSource_gettext.php	11.11 KB	-rw-r--r--
TCache_Lite.php	13.58 KB	-rw-r--r--
TMessageSourceIOException.php	702 B	-rw-r--r--

Code Editor : MessageSource.php

<?php
/**
 * MessageSource class file.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the BSD License.
 *
 * Copyright(c) 2004 by Qiang Xue. All rights reserved.
 *
 * To contact the author write to {@link mailto:qiang.xue@gmail.com Qiang Xue}
 * The latest version of PRADO can be obtained from:
 * {@link http://prado.sourceforge.net/}
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 */

namespace Prado\I18N\core;

/**
 * Get the IMessageSource interface.
 */
use Exception;

require_once(__DIR__ . '/IMessageSource.php');

/**
 * Get the MessageCache class file.
 */
require_once(__DIR__ . '/MessageCache.php');

/**
 * Abstract MessageSource class.
 *
 * The base class for all MessageSources. Message sources must be instantiated
 * using the factory method. The default valid sources are
 *
 *  # XLIFF -- using XML XLIFF format to store the translation messages.
 *  # PHP -- using PHP arrays to store the translation messages.
 *  # gettext -- Translated messages are stored in the gettext format.
 *  # Database -- Use an existing TDbConnection to store the messages.
 *
 * A custom message source can be instantiated by specifying the filename
 * parameter to point to the custom class file. E.g.
 * <code>
 *   $resource = '...'; //custom message source resource
 *   $classfile = '../MessageSource_MySource.php'; //custom message source
 *   $source = MessageSource::factory('MySource', $resource, $classfile);
 * </code>
 *
 * If you are writting your own message sources, pay attention to the
 * loadCatalogue method. It details how the resources are loaded and cached.
 * See also the existing message source types as examples.
 *
 * The following example instantiates a Database message source, set the culture,
 * set the cache handler, and use the source in a message formatter.
 * The messages are stored using an existing connection. The source parameter
 * for the factory method must contain a valid ConnectionID.
 * <code>
 *   // db1 must be already configured
 *   $source = MessageSource::factory('Database', 'db1');
 *
 *   //set the culture and cache, store the cache in the /tmp directory.
 *   $source->setCulture('en_AU')l
 *   $source->setCache(new MessageCache('/tmp'));
 *
 *   $formatter = new MessageFormat($source);
 * </code>
 *
 * @author Xiang Wei Zhuo <weizhuo[at]gmail[dot]com>
 */
abstract class MessageSource implements IMessageSource
{
	/**
	 * The culture name for this message source.
	 * @var string
	 */
	protected $culture;

/**
	 * Array of translation messages.
	 * @var array
	 */
	protected $messages = [];

/**
	 * The source of message translations.
	 * @var string
	 */
	protected $source;

/**
	 * The translation cache.
	 * @var MessageCache
	 */
	protected $cache;

protected $untranslated = [];

/**
	 * Private constructor. MessageSource must be initialized using
	 * the factory method.
	 */
	private function __construct()
	{
		//throw new Exception('Please use the factory method to instantiate.');
	}

/**
	 * Factory method to instantiate a new MessageSource depending on the
	 * source type. The allowed source types are 'XLIFF', 'PHP', 'gettext' and
	 * 'Database'. The source parameter depends on the source type.
	 * For 'gettext', 'PHP' and 'XLIFF', 'source' should point to the directory
	 * where the messages are stored.
	 * For 'Database', 'source' must be a valid connection id.
	 *
	 * Custom message source are possible by supplying the a filename parameter
	 * in the factory method.
	 *
	 * @param string $type the message source type.
	 * @param string $source the location of the resource or the ConnectionID.
	 * @param string $filename the filename of the custom message source.
	 * @throws \Exception if the file is not found
	 * @return MessageSource a new message source of the specified type.
	 */
	public static function &factory($type, $source = '.', $filename = '')
	{
		$types = ['XLIFF', 'PHP', 'gettext', 'Database'];

if (empty($filename) && !in_array($type, $types)) {
			throw new Exception('Invalid type "' . $type . '", valid types are ' .
				implode(', ', $types));
		}

$class = 'MessageSource_' . $type;

if (empty($filename)) {
			$filename = __DIR__ . '/' . $class . '.php';
		}

if (is_file($filename) == false) {
			throw new Exception("File $filename not found");
		}

include_once $filename;

$obj = new $class($source);

return $obj;
	}

/**
	 * Load a particular message catalogue. Use read() to
	 * to get the array of messages. The catalogue loading sequence
	 * is as follows
	 *
	 *  # [1] call getCatalogeList($catalogue) to get a list of
	 *    variants for for the specified $catalogue.
	 *  # [2] for each of the variants, call getSource($variant)
	 *    to get the resource, could be a file or catalogue ID.
	 *  # [3] verify that this resource is valid by calling isValidSource($source)
	 *  # [4] try to get the messages from the cache
	 *  # [5] if a cache miss, call load($source) to load the message array
	 *  # [6] store the messages to cache.
	 *  # [7] continue with the foreach loop, e.g. goto [2].
	 *
	 * @param string $catalogue a catalogue to load
	 * @return bool true if loaded, false otherwise.
	 * @see read()
	 */
	public function load($catalogue = 'messages')
	{
		$variants = $this->getCatalogueList($catalogue);

$this->messages = [];

foreach ($variants as $variant) {
			$source = $this->getSource($variant);

if ($this->isValidSource($source) == false) {
				continue;
			}

$loadData = true;

if ($this->cache) {
				$data = $this->cache->get(
					$variant,
					$this->culture,
					$this->getLastModified($source)
				);

if (is_array($data)) {
					$this->messages[$variant] = $data;
					$loadData = false;
				}
				unset($data);
			}
			if ($loadData) {
				$data = &$this->loadData($source);
				if (is_array($data)) {
					$this->messages[$variant] = $data;
					if ($this->cache) {
						$this->cache->save($data, $variant, $this->culture);
					}
				}
				unset($data);
			}
		}

return true;
	}

/**
	 * Get the array of messages.
	 * @return array translation messages.
	 */
	public function read()
	{
		return $this->messages;
	}

/**
	 * Get the cache handler for this source.
	 * @return MessageCache cache handler
	 */
	public function getCache()
	{
		return $this->cache;
	}

/**
	 * Set the cache handler for caching the messages.
	 * @param MessageCache $cache the cache handler.
	 */
	public function setCache(MessageCache $cache)
	{
		$this->cache = $cache;
	}

/**
	 * Add a untranslated message to the source. Need to call save()
	 * to save the messages to source.
	 * @param string $message message to add
	 */
	public function append($message)
	{
		if (!in_array($message, $this->untranslated)) {
			$this->untranslated[] = $message;
		}
	}

/**
	 * Set the culture for this message source.
	 * @param string $culture culture name
	 */
	public function setCulture($culture)
	{
		$this->culture = $culture;
	}

/**
	 * Get the culture identifier for the source.
	 * @return string culture identifier.
	 */
	public function getCulture()
	{
		return $this->culture;
	}

/**
	 * Get the last modified unix-time for this particular catalogue+variant.
	 * @param string $source catalogue+variant
	 * @return int last modified in unix-time format.
	 */
	protected function getLastModified($source)
	{
		return 0;
	}

/**
	 * Load the message for a particular catalogue+variant.
	 * This methods needs to implemented by subclasses.
	 * @param string $variant catalogue+variant.
	 * @return array of translation messages.
	 */
	protected function &loadData($variant)
	{
		return [];
	}

/**
	 * Get the source, this could be a filename or database ID.
	 * @param string $variant catalogue+variant
	 * @return string the resource key
	 */
	protected function getSource($variant)
	{
		return $variant;
	}

/**
	 * Determine if the source is valid.
	 * @param string $source catalogue+variant
	 * @return bool true if valid, false otherwise.
	 */
	protected function isValidSource($source)
	{
		return false;
	}

/**
	 * Get all the variants of a particular catalogue.
	 * This method must be implemented by subclasses.
	 * @param string $catalogue catalogue name
	 * @return array list of all variants for this catalogue.
	 */
	protected function getCatalogueList($catalogue)
	{
		return [];
	}
}

${this.title}

Code Editor : MessageSource.php