LoaderInterface.php in Plug 7

Namespace

Symfony\Component\Translation\Loader

File

lib/Symfony/translation/Loader/LoaderInterface.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Translation\Loader;

use Symfony\Component\Translation\MessageCatalogue;
use Symfony\Component\Translation\Exception\InvalidResourceException;
use Symfony\Component\Translation\Exception\NotFoundResourceException;

/**
 * LoaderInterface is the interface implemented by all translation loaders.
 *
 * @author Fabien Potencier <[e-mail]>
 *
 * @api
 */
interface LoaderInterface {

  /**
   * Loads a locale.
   *
   * @param mixed  $resource A resource
   * @param string $locale   A locale
   * @param string $domain   The domain
   *
   * @return MessageCatalogue A MessageCatalogue instance
   *
   * @api
   *
   * @throws NotFoundResourceException when the resource cannot be found
   * @throws InvalidResourceException  when the resource cannot be loaded
   */
  public function load($resource, $locale, $domain = 'messages');

}

Interfaces

Name	Description
LoaderInterface	LoaderInterface is the interface implemented by all translation loaders.