annotate core/lib/Drupal/Component/Gettext/PoStreamInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Component\Gettext;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Common functions for file/stream based PO readers/writers.
Chris@0 7 *
Chris@0 8 * @see PoReaderInterface
Chris@0 9 * @see PoWriterInterface
Chris@0 10 */
Chris@0 11 interface PoStreamInterface {
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Open the stream. Set the URI for the stream earlier with setURI().
Chris@0 15 */
Chris@0 16 public function open();
Chris@0 17
Chris@0 18 /**
Chris@0 19 * Close the stream.
Chris@0 20 */
Chris@0 21 public function close();
Chris@0 22
Chris@0 23 /**
Chris@0 24 * Gets the URI of the PO stream that is being read or written.
Chris@0 25 *
Chris@0 26 * @return
Chris@0 27 * URI string for this stream.
Chris@0 28 */
Chris@0 29 public function getURI();
Chris@0 30
Chris@0 31 /**
Chris@0 32 * Set the URI of the PO stream that is going to be read or written.
Chris@0 33 *
Chris@0 34 * @param $uri
Chris@0 35 * URI string to set for this stream.
Chris@0 36 */
Chris@0 37 public function setURI($uri);
Chris@0 38
Chris@0 39 }