summaryrefslogtreecommitdiff
path: root/sites/all/modules/l10n_update/includes/gettext/PoStreamInterface.php
blob: f8ca36eb773f152c5100d263ae2662ede62a6231 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?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
   *   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);

}