You are here

PoStreamInterface.php in Localization update 7.2

File

includes/gettext/PoStreamInterface.php
View source
<?php

/**
 * @file
 * Definition of Drupal\Component\Gettext\PoStreamInterface.
 */

/**
 * Common functions for file/stream based PO readers/writers.
 *
 * @see PoReaderInterface
 * @see PoWriterInterface
 */
interface PoStreamInterface {

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

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

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

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

}

Interfaces

Namesort descending Description
PoStreamInterface Common functions for file/stream based PO readers/writers.