interface PoStreamInterface

Common functions for file/stream based PO readers/writers.

Hierarchy

Expanded class hierarchy of PoStreamInterface

All classes that implement PoStreamInterface

See also

PoReaderInterface

PoWriterInterface

2 files declare their use of PoStreamInterface
PoStreamReader.php in drupal/core/lib/Drupal/Component/Gettext/PoStreamReader.php
Definition of Drupal\Component\Gettext\PoStreamReader.
PoStreamWriter.php in drupal/core/lib/Drupal/Component/Gettext/PoStreamWriter.php
Definition of Drupal\Component\Gettext\PoStreamWriter.

File

drupal/core/lib/Drupal/Component/Gettext/PoStreamInterface.php, line 16
Definition of Drupal\Component\Gettext\PoStreamInterface.

Namespace

Drupal\Component\Gettext
View source
interface PoStreamInterface {

  /**
   * Open the stream. Set the URI for the stream earlier with setURI().
   */
  function open();

  /**
   * Close the stream.
   */
  function close();

  /**
   * Get the URI of the PO stream that is being read or written.
   *
   * @return
   *   URI string for this stream.
   */
  function getURI();

  /**
   * Set the URI of the PO stream that is going to be read or written.
   *
   * @param $uri
   *   URI string to set for this stream.
   */
  function setURI($uri);

}

Members

Namesort descending Modifiers Type Description Overrides
PoStreamInterface::close function Close the stream. 2
PoStreamInterface::getURI function Get the URI of the PO stream that is being read or written. 2
PoStreamInterface::open function Open the stream. Set the URI for the stream earlier with setURI(). 2
PoStreamInterface::setURI function Set the URI of the PO stream that is going to be read or written. 2