mprins / dokuwiki-plugin-description

action.php

<?php

/**

 *  Description action plugin

 *

 *  @lastmodified 2012-07-02

 *  @license      GPL 2 (http://www.gnu.org/licenses/gpl.html)

 *  @author       Ikuo Obataya <I.Obataya@gmail.com>

 *  @author       Matthias Schulte <dokuwiki@lupo49.de>

 *  @version      2012-07-02

 */


if(!defined('DOKU_INC')) die();

if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');

The constant DOKU_INC was not found. Maybe you did not declare it correctly or list all dependencies?

require_once(DOKU_PLUGIN.'action.php');


define('KEYWORD_SOURCE_ABSTRACT', 'abstract');

define('KEYWORD_SOURCE_GLOBAL', 'global');

define('KEYWORD_SOURCE_SYNTAX', 'syntax');


class action_plugin_description extends DokuWiki_Action_Plugin {

The type DokuWiki_Action_Plugin was not found. Maybe you did not declare it correctly or list all dependencies?

    function register(Doku_Event_Handler $controller) {

The type Doku_Event_Handler was not found. Maybe you did not declare it correctly or list all dependencies?

It is generally recommended to explicitly declare the visibility for methods.

        $controller->register_hook('TPL_METAHEADER_OUTPUT','BEFORE',$this,'description',array());

    }


    /**

     * Add an abstract, global value or a specified string to meta header

     */

    function description(&$event, $param) {

It is generally recommended to explicitly declare the visibility for methods.

        if(empty($event->data) || empty($event->data['meta'])) return;

        

        global $ID;

        $source = $this->getConf('keyword_source');

        if(empty($source)) $source = 'abstract';

        

        if($source == KEYWORD_SOURCE_ABSTRACT) {

            if (auth_quickaclcheck($ID) < AUTH_READ) {

                // don't add meta header when user has no read permissions

                return;

            }


            $d = p_get_metadata($ID, 'description');

            if(empty($d)) return;

    

            $a = str_replace("\n", " ", $d['abstract']);

            if(empty($a)) return;

        }

        

        if($source == KEYWORD_SOURCE_GLOBAL) {

            $a = $this->getConf('global_description');

            if(empty($a)) return;

        }


        if($source == KEYWORD_SOURCE_SYNTAX) {

            if (auth_quickaclcheck($ID) < AUTH_READ) {

                // don't add meta header when user has no read permissions

                return;

            }

            $metadata = p_get_metadata($ID);

            $a = $metadata['plugin_description']['keywords'];

            if(empty($a)) return;

        }

        

        $m = array("name" => "description", "content" => $a);

        $event->data['meta'][] = $m;

    }

}