You are here

interface PoStreamInterface in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Component/Gettext/PoStreamInterface.php \Drupal\Component\Gettext\PoStreamInterface
  2. 10 core/lib/Drupal/Component/Gettext/PoStreamInterface.php \Drupal\Component\Gettext\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

File

core/lib/Drupal/Component/Gettext/PoStreamInterface.php, line 11

Namespace

Drupal\Component\Gettext
View source
interface PoStreamInterface {

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

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

  /**
   * Gets the URI of the PO stream that is being read or written.
   *
   * @return
   *   URI string for this stream.
   */
  public 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.
   */
  public function setURI($uri);

}

Members

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