You are here

Home » API reference » Localization update 7.2 » PoDatabaseWriter.php

class PoDatabaseWriter in Localization update 7.2

Gettext PO writer working with the locale module database.

Hierarchy

Expanded class hierarchy of PoDatabaseWriter

File

includes/locale/PoDatabaseWriter.php, line 11
Definition of PoDatabaseWriter.

View source 
class PoDatabaseWriter implements PoWriterInterface {

  /**
   * An associative array indicating what data should be overwritten, if any.
   *
   * Elements of the array:
   * - override_options
   *   - not_customized: boolean indicating that not customized strings should
   *     be overwritten.
   *   - customized: boolean indicating that customized strings should be
   *     overwritten.
   * - customized: the strings being imported should be saved as customized.
   *     One of L10N_UPDATE_CUSTOMIZED or L10N_UPDATE_NOT_CUSTOMIZED.
   *
   * @var array
   */
  private $_options;

  /**
   * Language code of the language being written to the database.
   *
   * @var string
   */
  private $_langcode;

  /**
   * Header of the po file written to the database.
   *
   * @var PoHeader
   */
  private $_header;

  /**
   * Associative array summarizing the number of changes done.
   *
   * Keys for the array:
   *  - additions: number of source strings newly added
   *  - updates: number of translations updated
   *  - deletes: number of translations deleted
   *  - skips: number of strings skipped due to disallowed HTML.
   *
   * @var array
   */
  private $_report;

  /**
   * Database storage to store the strings in.
   *
   * @var StringDatabaseStorage
   */
  protected $storage;

  /**
   * Constructor, initialize reporting array.
   */
  public function __construct() {
    $this
      ->setReport();
    $this->storage = new StringDatabaseStorage();
  }

  /**
   * Implements PoMetadataInterface::getLangcode().
   */
  public function getLangcode() {
    return $this->_langcode;
  }

  /**
   * Implements PoMetadataInterface::setLangcode().
   */
  public function setLangcode($langcode) {
    $this->_langcode = $langcode;
  }

  /**
   * Get the report of the write operations.
   */
  public function getReport() {
    return $this->_report;
  }

  /**
   * Set the report array of write operations.
   *
   * @param array $report
   *   Associative array with result information.
   */
  public function setReport($report = array()) {
    $report += array(
      'additions' => 0,
      'updates' => 0,
      'deletes' => 0,
      'skips' => 0,
      'strings' => array(),
    );
    $this->_report = $report;
  }

  /**
   * Get the options used by the writer.
   */
  public function getOptions() {
    return $this->_options;
  }

  /**
   * Set the options for the current writer.
   */
  public function setOptions(array $options) {
    if (!isset($options['overwrite_options'])) {
      $options['overwrite_options'] = array();
    }
    $options['overwrite_options'] += array(
      'not_customized' => FALSE,
      'customized' => FALSE,
    );
    $options += array(
      'customized' => L10N_UPDATE_NOT_CUSTOMIZED,
    );
    $this->_options = $options;
  }

  /**
   * Implements PoMetadataInterface::getHeader().
   */
  public function getHeader() {
    return $this->_header;
  }

  /**
   * Implements PoMetadataInterface::setHeader().
   *
   * Sets the header and configure Drupal accordingly.
   *
   * Before being able to process the given header we need to know in what
   * context this database write is done. For this the options must be set.
   *
   * A langcode is required to set the current header's PluralForm.
   *
   * @param PoHeader $header
   *   Header metadata.
   *
   * @throws Exception
   *   Exception is thrown when required properties are not set.
   */
  public function setHeader(PoHeader $header) {
    $this->_header = $header;
    $languages = language_list();

    // Check for options.
    $options = $this
      ->getOptions();
    if (empty($options)) {
      throw new \Exception('Options should be set before assigning a PoHeader.');
    }
    $overwrite_options = $options['overwrite_options'];

    // Check for langcode.
    $langcode = $this->_langcode;
    if (empty($langcode)) {
      throw new \Exception('Langcode should be set before assigning a PoHeader.');
    }

    // Check is language is already created.
    if (!isset($languages[$langcode])) {
      throw new \Exception('Language should be known before using it.');
    }
    if (array_sum($overwrite_options) || empty($languages[$langcode]->plurals)) {

      // Get and store the plural formula if available.
      $plural = $header
        ->getPluralForms();
      if (isset($plural) && ($p = $header
        ->parsePluralForms($plural))) {
        list($nplurals, $formula) = $p;
        db_update('languages')
          ->fields(array(
          'plurals' => $nplurals,
          'formula' => $formula,
        ))
          ->condition('language', $langcode)
          ->execute();
      }
    }
  }

  /**
   * Implements PoWriterInterface::writeItem().
   */
  public function writeItem(PoItem $item) {
    if ($item
      ->isPlural()) {
      $sources = $item
        ->getSource();
      $translations = $item
        ->getTranslation();

      // Build additional source strings for plurals.
      $entries = array_keys($translations);
      for ($i = 3; $i <= count($entries); $i++) {
        $sources[] = $sources[1];
      }
      $translations = array_map('_locale_import_append_plural', $translations, $entries);
      $sources = array_map('_locale_import_append_plural', $sources, $entries);
      $plid = 0;
      foreach ($entries as $index) {
        $item
          ->setSource($sources[$index]);
        $item
          ->setTranslation($translations[$index]);
        $plid = $this
          ->importString($item, $plid, $index);
      }
    }
    else {
      $this
        ->importString($item);
    }
  }

  /**
   * Implements PoWriterInterface::writeItems().
   */
  public function writeItems(PoReaderInterface $reader, $count = -1) {
    $forever = $count == -1;
    while (($count-- > 0 || $forever) && ($item = $reader
      ->readItem())) {
      $this
        ->writeItem($item);
    }
  }

  /**
   * Imports one string into the database.
   *
   * @param PoItem $item
   *   The item being imported.
   * @param integer $plid
   *   The parent string identifier for plural strings.
   * @param integer $plural
   *   The plural index number.
   *
   * @return int
   *   The string ID of the existing string modified or the new string added.
   */
  private function importString(PoItem $item, $plid = 0, $plural = 0) {

    // Initialize overwrite options if not set.
    $this->_options['overwrite_options'] += array(
      'not_customized' => FALSE,
      'customized' => FALSE,
    );
    $overwrite_options = $this->_options['overwrite_options'];
    $customized = $this->_options['customized'];
    $context = $item
      ->getContext();
    $source = $item
      ->getSource();
    $translation = $item
      ->getTranslation();
    $textgroup = $item
      ->getTextgroup();

    // Look up the source string and any existing translation.
    $strings = $this->storage
      ->getTranslations(array(
      'language' => $this->_langcode,
      'source' => $source,
      'context' => $context,
      'textgroup' => $textgroup,
    ));
    $string = reset($strings);
    if (!empty($translation)) {

      // Skip this string unless it passes a check for dangerous code.
      if (!locale_string_is_safe($translation)) {
        watchdog('l10n_update', 'Import of string "%string" was skipped because of disallowed or malformed HTML.', array(
          '%string' => $translation,
        ), WATCHDOG_ERROR);
        $this->_report['skips']++;
        return 0;
      }
      elseif ($string) {
        $string
          ->setString($translation);
        if ($string
          ->isNew()) {

          // No translation in this language.
          $string
            ->setValues(array(
            'plid' => $plid,
            'plural' => $plural,
            'language' => $this->_langcode,
            'customized' => $customized,
          ));
          $string
            ->save();
          $this->_report['additions']++;
        }
        elseif ($overwrite_options[$string->customized ? 'customized' : 'not_customized']) {

          // Translation exists, only overwrite if instructed.
          $string->customized = $customized;
          $string
            ->save();
          $this->_report['updates']++;
        }
        $this->_report['strings'][] = $string
          ->getId();
        return $string->lid;
      }
      else {

        // No such source string in the database yet.
        $string = $this->storage
          ->createString(array(
          'source' => $source,
          'context' => $context,
          'textgroup' => $textgroup,
        ))
          ->save();
        $this->storage
          ->createTranslation(array(
          'lid' => $string
            ->getId(),
          'plid' => $plid,
          'plural' => $plural,
          'language' => $this->_langcode,
          'translation' => $translation,
          'customized' => $customized,
        ))
          ->save();
        $this->_report['additions']++;
        $this->_report['strings'][] = $string
          ->getId();
        return $string->lid;
      }
    }
    elseif ($string && !$string
      ->isNew() && $overwrite_options[$string->customized ? 'customized' : 'not_customized']) {

      // Empty translation, remove existing if instructed.
      $string
        ->delete();
      $this->_report['deletes']++;
      $this->_report['strings'][] = $string->lid;
      return $string->lid;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PoDatabaseWriter::$storage protected property Database storage to store the strings in.
PoDatabaseWriter::$_header private property Header of the po file written to the database.
PoDatabaseWriter::$_langcode private property Language code of the language being written to the database.
PoDatabaseWriter::$_options private property An associative array indicating what data should be overwritten, if any.
PoDatabaseWriter::$_report private property Associative array summarizing the number of changes done.
PoDatabaseWriter::getHeader public function Implements PoMetadataInterface::getHeader(). Overrides PoMetadataInterface::getHeader
PoDatabaseWriter::getLangcode public function Implements PoMetadataInterface::getLangcode(). Overrides PoMetadataInterface::getLangcode
PoDatabaseWriter::getOptions public function Get the options used by the writer.
PoDatabaseWriter::getReport public function Get the report of the write operations.
PoDatabaseWriter::importString private function Imports one string into the database.
PoDatabaseWriter::setHeader public function Implements PoMetadataInterface::setHeader(). Overrides PoMetadataInterface::setHeader
PoDatabaseWriter::setLangcode public function Implements PoMetadataInterface::setLangcode(). Overrides PoMetadataInterface::setLangcode
PoDatabaseWriter::setOptions public function Set the options for the current writer.
PoDatabaseWriter::setReport public function Set the report array of write operations.
PoDatabaseWriter::writeItem public function Implements PoWriterInterface::writeItem(). Overrides PoWriterInterface::writeItem
PoDatabaseWriter::writeItems public function Implements PoWriterInterface::writeItems(). Overrides PoWriterInterface::writeItems
PoDatabaseWriter::__construct public function Constructor, initialize reporting array.