PoStreamInterface.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Component/Gettext/PoStreamInterface.php
  2. 10 core/lib/Drupal/Component/Gettext/PoStreamInterface.php
  3. 11.x core/lib/Drupal/Component/Gettext/PoStreamInterface.php

Namespace

Drupal\Component\Gettext

File

core/lib/Drupal/Component/Gettext/PoStreamInterface.php

View source
<?php

namespace Drupal\Component\Gettext;


/**
 * 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();
    
    /**
     * Gets 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 $uri
     *   URI string to set for this stream.
     */
    public function setURI($uri);

}

Interfaces

Title Deprecated Summary
PoStreamInterface Common functions for file/stream based PO readers/writers.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.