MessageHandle.php

Go to the documentation of this file.

<?php
class MessageHandle {
    protected $title = null;
    protected $key = null;
    protected $code = null;
    protected $groupIds = null;
    protected $group = false;

    public function __construct( Title $title ) {
        $this->title = $title;
    }

    public function isMessageNamespace() {
        global $wgTranslateMessageNamespaces;
        $namespace = $this->getTitle()->getNamespace();

        return in_array( $namespace, $wgTranslateMessageNamespaces );
    }

    public function figureMessage() {
        if ( $this->key === null ) {
            $title = $this->getTitle();
            // Check if this is a valid message first
            $this->key = $title->getDBKey();
            $known = count( MessageIndex::singleton()->getGroupIds( $this ) );

            $pos = strrpos( $this->key, '/' );
            if ( $known || $pos === false ) {
                $this->code = '';
            } else {
                // For keys like Foo/, substr returns false instead of ''
                $this->code = strval( substr( $this->key, $pos + 1 ) );
                $this->key = substr( $this->key, 0, $pos );
            }
        }

        return array( $this->key, $this->code );
    }

    public function getKey() {
        $this->figureMessage();

        return $this->key;
    }

    public function getCode() {
        $this->figureMessage();

        return $this->code;
    }

    public function getEffectiveLanguageCode() {
        global $wgContLang;
        $code = $this->getCode();
        if ( $code === '' || $this->isDoc() ) {
            return $wgContLang->getCode();
        }

        return $code;
    }

    public function isDoc() {
        global $wgTranslateDocumentationLanguageCode;

        return $this->getCode() === $wgTranslateDocumentationLanguageCode;
    }

    public function isPageTranslation() {
        return $this->getTitle()->getNamespace() == NS_TRANSLATIONS;
    }

    public function getGroupIds() {
        if ( $this->groupIds === null ) {
            $this->groupIds = MessageIndex::singleton()->getGroupIds( $this );
        }

        return $this->groupIds;
    }

    public function getGroup() {
        $ids = $this->getGroupIds();
        if ( !isset( $ids[0] ) ) {
            throw new MWException( 'called before isValid' );
        }

        return MessageGroups::getGroup( $ids[0] );
    }

    public function isValid() {
        if ( !$this->isMessageNamespace() ) {
            return false;
        }

        $groups = $this->getGroupIds();
        if ( !$groups ) {
            return false;
        }

        // Do another check that the group actually exists
        $group = $this->getGroup();
        if ( !$group ) {
            $warning = "MessageIndex is out of date – refers to unknown group {$groups[0]}. ";
            $warning .= "Doing a rebuild.";
            wfWarn( $warning );
            MessageIndexRebuildJob::newJob()->run();

            return false;
        }

        return true;
    }

    public function getTitle() {
        return $this->title;
    }

    public static function hasFuzzyString( $text ) {
        return strpos( $text, TRANSLATE_FUZZY ) !== false;
    }

    public function isFuzzy() {
        $dbr = wfGetDB( DB_SLAVE );

        $tables = array( 'page', 'revtag' );
        $field = 'rt_type';
        $conds = array(
            'page_namespace' => $this->title->getNamespace(),
            'page_title' => $this->title->getDBkey(),
            'rt_type' => RevTag::getType( 'fuzzy' ),
            'page_id=rt_page',
            'page_latest=rt_revision'
        );

        $res = $dbr->selectField( $tables, $field, $conds, __METHOD__ );

        return $res !== false;
    }
}