phpDocumentor plugin
[ class tree: plugin ] [ index: plugin ] [ all elements ]

Class: PluginNavix

Source Location: /navix.inc.php

Class PluginNavix

Class Overview

Navi (DocBook-like Navigation) Plugin

Located in /navix.inc.php [line 25]



		
				Author(s):
		
		
		
Information Tags:
Version:  $Id: navix.inc.php,v 2.0 2008-08-18 11:14:46 sonots $
Link:  http://lsx.osdn.jp/?Plugin%2Fnavixx.inc.php
License:  GPL v2

Properties

Methods

[ Top ]
Property Summary
mixed   $conf  
mixed   $conf_options  
mixed   $css  
mixed   $linkstr  
mixed   $plugin  

[ Top ]
Method Summary
PluginNavix   PluginNavix()  
void   action()   Action Plugin Main Function
array   check_options()   Check option validities and compatibilities
void   convert()   Block Plugin Main Function
string   display_navi()   Display navigation
array   get_navipages()   Get pages used for Navi
string   pagelist()   List pages

[ Top ]
Properties
mixed   $conf [line 94]

[ Top ]
mixed   $conf_options [line 92]

[ Top ]
mixed   $css [line 95]

[ Top ]
mixed   $linkstr [line 96]

[ Top ]
mixed   $plugin = "navix" [line 93]

[ Top ]
Methods
Constructor PluginNavix  [line 27]

  PluginNavix PluginNavix( )



[ Top ]
action  [line 132]

  void action( )

Action Plugin Main Function



[ Top ]
check_options  [line 156]

  array check_options( array $options, $unknowns, array $conf_options, array $unknown  )

Check option validities and compatibilities

Parameters:
array   $options: 
array   $unknown:  unknown options
array   $conf_options: 
   $unknowns: 


[ Top ]
convert  [line 102]

  void convert( )

Block Plugin Main Function



[ Top ]
display_navi  [line 318]

  string display_navi( array $navipages, [string $look = 'header'], [string $border = 'off'], [bool $printcss = false]  )

Display navigation

Parameters:
array   $navipages:  array($home, $up, $prev, $current, $next)
string   $look: 

Show DocBook 'footer' style or DocBook 'header'

DocBook header

     Prev          Home          Next
DocBook footer
     Prev          Home          Next
          Up     

string   $border:  'off' or 'top' or 'bottom'.
  • 'off' shows no border.
  • 'top' shows a border top.
  • 'bottom' shows a border bottom.
bool   $printcss:  print css with html as style="" attributes.

API Tags:
Return:  html


[ Top ]
get_navipages  [line 277]

  array get_navipages( object $pagelist, array $options  )

Get pages used for Navi

Parameters:
object   $pagelist:  PluginSonotsPagelist object
array   $options: 

API Tags:
Return:  array($home, $up, $prev, $current, $next)


[ Top ]
pagelist  [line 198]

  string pagelist( array $pages, array $options, array $argoptions  )

List pages

Parameters:
array   $pages: 
array   $options: 
array   $argoptions: 

API Tags:
Return:  html


[ Top ]

Documentation generated on Sat, 16 Aug 2008 15:27:30 -0400 by phpDocumentor 1.3.2