SemanticMediaWiki/includes/datavalues/SMW_DV_WikiPage.php

Go to the documentation of this file.

<?php
class SMWWikiPageValue extends SMWDataValue {

        protected $m_fragment = '';

        protected $m_prefixedtext = '';

        protected $m_id = -1;

        protected $m_title = null;

        protected $m_fixNamespace = NS_MAIN;

        public function __construct( $typeid ) {
                parent::__construct( $typeid );
                switch ( $typeid ) {
                        case '__typ':
                                $this->m_fixNamespace = SMW_NS_TYPE;
                        break;
                        case '_wpp' : case '__sup':
                                $this->m_fixNamespace = SMW_NS_PROPERTY;
                        break;
                        case '_wpc' : case '__suc': case '__sin':
                                $this->m_fixNamespace = NS_CATEGORY;
                        break;
                        case '_wpf' : case '__spf':
                                $this->m_fixNamespace = SF_NS_FORM;
                        break;
                        default: // case '_wpg':
                                $this->m_fixNamespace = NS_MAIN;
                }
        }

        protected function parseUserValue( $value ) {
                global $wgContLang;

                // support inputs like " [[Test]] ";
                // note that this only works in pages if $smwgLinksInValues is set to true
                $value = ltrim( rtrim( $value, ' ]' ), ' [' );

                if ( $this->m_caption === false ) {
                        $this->m_caption = $value;
                }

                if ( $value !== '' ) {
                        if ( $value[0] == '#' ) {
                                if ( is_null( $this->m_contextPage ) ) {
                                        $this->addError( wfMsgForContent( 'smw_notitle', $value ) );
                                        return;
                                } else {
                                        $this->m_title = Title::makeTitle( $this->m_contextPage->getNamespace(),
                                                $this->m_contextPage->getDBkey(), substr( $value, 1 ),
                                                $this->m_contextPage->getInterwiki() );
                                }
                        } else {
                                $this->m_title = Title::newFromText( $value, $this->m_fixNamespace );
                        }

                        if ( is_null( $this->m_title ) ) {
                                $this->addError( wfMsgForContent( 'smw_notitle', $value ) );
                        } elseif ( ( $this->m_fixNamespace != NS_MAIN ) &&
                                 ( $this->m_fixNamespace != $this->m_title->getNamespace() ) ) {
                                $this->addError( wfMsgForContent( 'smw_wrong_namespace',
                                        $wgContLang->getNsText( $this->m_fixNamespace ) ) );
                        } else {
                                $this->m_fragment = str_replace( ' ', '_', $this->m_title->getFragment() );
                                $this->m_prefixedtext = '';
                                $this->m_id = -1; // unset id
                                $this->m_dataitem = SMWDIWikiPage::newFromTitle( $this->m_title, $this->m_typeid );
                        }
                } else {
                        $this->addError(  wfMsgForContent( 'smw_notitle', $value ) );
                }
        }

        protected function loadDataItem( SMWDataItem $dataItem ) {
                if ( $dataItem->getDIType() == SMWDataItem::TYPE_CONTAINER ) {
                        // might throw an exception, we just pass it through
                        $dataItem = $dataItem->getSemanticData()->getSubject();
                }

                if ( $dataItem->getDIType() == SMWDataItem::TYPE_WIKIPAGE ) {
                        $this->m_dataitem = $dataItem;
                        $this->m_id = -1;
                        $this->m_title = null;
                        $this->m_fragment = $dataItem->getSubobjectName();
                        $this->m_prefixedtext = '';
                        $this->m_caption = false; // this class can handle this

                        if ( ( $this->m_fixNamespace != NS_MAIN ) &&
                                ( $this->m_fixNamespace != $dataItem->getNamespace() ) ) {
                                        global $wgContLang;
                                        $this->addError( wfMsgForContent( 'smw_wrong_namespace',
                                                $wgContLang->getNsText( $this->m_fixNamespace ) ) );
                        }
                        return true;
                } else {
                        return false;
                }
        }

        public function getShortWikiText( $linked = null ) {
                if ( is_null( $linked ) || $linked === false ||
                        $this->m_outformat == '-' || !$this->isValid() ||
                        $this->m_caption === '' ) {
                        return $this->m_caption !== false ? $this->m_caption : $this->getWikiValue();
                } else {
                        if ( $this->m_dataitem->getNamespace() == NS_FILE ) {
                                $linkEscape = '';
                                $defaultCaption = '|' . $this->getShortCaptionText() . '|frameless|border|text-top';
                        } else {
                                $linkEscape = ':';
                                $defaultCaption = '|' . $this->getShortCaptionText();
                        }
                        if ( $this->m_caption === false ) {
                                return '[[' . $linkEscape . $this->getWikiLinkTarget() . $defaultCaption . ']]';
                        } else {
                                return '[[' . $linkEscape . $this->getWikiLinkTarget() . '|' . $this->m_caption . ']]';
                        }
                }
        }

        public function getShortHTMLText( $linker = null ) {
                // init the Title object, may reveal hitherto unnoticed errors:
                if ( !is_null( $linker ) && $linker !== false &&
                                $this->m_caption !== '' && $this->m_outformat != '-' ) {
                        $this->getTitle();
                }

                if ( is_null( $linker ) || $linker === false || !$this->isValid() ||
                                $this->m_outformat == '-' || $this->m_caption === '' ) {
                        return htmlspecialchars( $this->m_caption !== false ? $this->m_caption : $this->getWikiValue() );
                } else {
                        $caption = htmlspecialchars(
                                $this->m_caption !== false ? $this->m_caption : $this->getShortCaptionText() );
                        if ( $this->getNamespace() == NS_MEDIA ) { // this extra case *is* needed
                                return $linker->makeMediaLinkObj( $this->getTitle(), $caption );
                        } else {
                                return $linker->makeLinkObj( $this->getTitle(), $caption );
                        }
                }
        }

        public function getLongWikiText( $linked = null ) {
                if ( !$this->isValid() ) {
                        return $this->getErrorText();
                }

                if ( is_null( $linked ) || $linked === false || $this->m_outformat == '-' ) {
                        return $this->getWikiValue();
                } elseif ( $this->m_dataitem->getNamespace() == NS_FILE ) {
                        // Embed images and other files
                        // Note that the embedded file links to the image, hence needs no additional link text.
                        // There should not be a linebreak after an impage, just like there is no linebreak after
                        // other values (whether formatted or not).
                        return '[[' . $this->getWikiLinkTarget() . '|' .
                                $this->getLongCaptionText() . '|frameless|border|text-top]]';
                } else {
                        return '[[:' . $this->getWikiLinkTarget() . '|' . $this->getLongCaptionText() . ']]';
                }
        }

        public function getLongHTMLText( $linker = null ) {
                // init the Title object, may reveal hitherto unnoticed errors:
                if ( !is_null( $linker ) && ( $this->m_outformat != '-' ) ) {
                        $this->getTitle();
                }
                if ( !$this->isValid() ) {
                        return $this->getErrorText();
                }

                if ( is_null( $linker ) || $this->m_outformat == '-' ) {
                        return htmlspecialchars( $this->getWikiValue() );
                } elseif ( $this->getNamespace() == NS_MEDIA ) { // this extra case is really needed
                        return $linker->makeMediaLinkObj( $this->getTitle(),
                                htmlspecialchars( $this->getLongCaptionText() ) );
                } else { // all others use default linking, no embedding of images here
                        return $linker->makeLinkObj( $this->getTitle(),
                                htmlspecialchars( $this->getLongCaptionText() ) );
                }
        }

        public function getWikiValue() {
                return ( $this->m_fixNamespace == NS_MAIN ? $this->getPrefixedText() : $this->getText() ) .
                        ( $this->m_fragment !== '' ? "#{$this->m_fragment}" : '' );
        }

        public function getHash() {
                return $this->isValid() ? $this->getPrefixedText() : implode( "\t", $this->getErrors() );
        }

        protected function getServiceLinkParams() {
                if ( $this->isValid() ) {
                        return array( rawurlencode( str_replace( '_', ' ', $this->m_dataitem->getDBkey() ) ) );
                } else {
                        return array();
                }
        }


        public function getTitle() {
                if ( ( $this->isValid() ) && is_null( $this->m_title ) ) {
                        $this->m_title = $this->m_dataitem->getTitle();

                        if ( is_null( $this->m_title ) ) { // should not normally happen, but anyway ...
                                global $wgContLang;
                                $this->addError( wfMsgForContent( 'smw_notitle', $wgContLang->getNsText( $this->m_dataitem->getNamespace() ) . ':' . $this->m_dataitem->getDBkey() ) );
                        }
                }

                return $this->m_title;
        }

        public function getArticleID() {
                if ( $this->m_id === false ) {
                        $this->m_id = !is_null( $this->getTitle() ) ? $this->m_title->getArticleID() : 0;
                }

                return $this->m_id;
        }

        public function getNamespace() {
                return $this->m_dataitem->getNamespace();
        }

        public function getDBkey() {
                return $this->m_dataitem->getDBkey();
        }

        public function getText() {
                return str_replace( '_', ' ', $this->m_dataitem->getDBkey() );
        }

        public function getPrefixedText() {
                global $wgContLang;
                if ( $this->m_prefixedtext === '' ) {
                        if ( $this->isValid() ) {
                                $nstext = $wgContLang->getNSText( $this->m_dataitem->getNamespace() );
                                $this->m_prefixedtext =
                                        ( $this->m_dataitem->getInterwiki() !== '' ?
                                                $this->m_dataitem->getInterwiki() . ':' : '' ) .
                                        ( $nstext !== '' ? "$nstext:" : '' ) . $this->getText();
                        } else {
                                $this->m_prefixedtext = 'NO_VALID_VALUE';
                        }
                }
                return $this->m_prefixedtext;
        }

        public function getInterwiki() {
                return $this->m_dataitem->getInterwiki();
        }

        protected function getShortCaptionText() {
                if ( $this->m_fragment !== '' && $this->m_fragment[0] != '_' ) {
                        $fragmentText = '#' . $this->m_fragment;
                } else {
                        $fragmentText = '';
                }
                return $this->getText() . $fragmentText;
        }

        protected function getLongCaptionText() {
                if ( $this->m_fragment !== '' && $this->m_fragment[0] != '_' ) {
                        $fragmentText = '#' . $this->m_fragment;
                } else {
                        $fragmentText = '';
                }
                return ( $this->m_fixNamespace == NS_MAIN ? $this->getPrefixedText() : $this->getText() ) . $fragmentText;
        }

        protected function getWikiLinkTarget() {
                return str_replace( "'", '&#x0027;', $this->getPrefixedText() ) .
                        ( $this->m_fragment !== '' ? "#{$this->m_fragment}" : '' );
        }

        public function getSortKey() {
                return smwfGetStore()->getWikiPageSortKey( $this->m_dataitem );
        }

        static public function makePage( $dbkey, $namespace, $ignoredParameter = '', $interwiki = '' ) {
                $diWikiPage = new SMWDIWikiPage( $dbkey, $namespace, $interwiki );
                $dvWikiPage = new SMWWikiPageValue( '_wpg' );
                $dvWikiPage->setDataItem( $diWikiPage );
                return $dvWikiPage;
        }

        static public function makePageFromTitle( Title $title ) {
                $dvWikiPage = new SMWWikiPageValue( '_wpg' );
                $diWikiPage = SMWDIWikiPage::newFromTitle( $title );
                $dvWikiPage->setDataItem( $diWikiPage );
                $dvWikiPage->m_title = $title; // optional, just for efficiency
                return $dvWikiPage;
        }

}

---