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

Class: PluginIncludex

Source Location: /includex.inc.php

Class PluginIncludex

Class Overview

Page Include Plugin

Located in /includex.inc.php [line 22]



		
				Author(s):
		
  • sonots
Information Tags:
Version:  $Id: includex.inc.php,v 2.0 2008-07-30 07:23:17Z sonots $
Link:  http://lsx.osdn.jp/?Plugin%2Fincludex.inc.php
License:  GPL v2

Properties

Methods

[ Top ]
Property Summary
mixed   $conf_options  
mixed   $plugin  
mixed   $syntax  
mixed   $visited  

[ Top ]
Method Summary
PluginIncludex   PluginIncludex()  
array   check_options()   Check Option Compatibilities
string   check_page()   Check Page Validity
void   convert()   Convert Plugin Main Function
string   display_include()   Include page
$string   display_title()   Get <h1> title of a page
void   get_sections()  

[ Top ]
Properties
mixed   $conf_options [line 61]

[ Top ]
mixed   $plugin = "includex" [line 64]

[ Top ]
mixed   $syntax [line 62]

[ Top ]
mixed   $visited [line 63]

[ Top ]
Methods
Constructor PluginIncludex  [line 24]

  PluginIncludex PluginIncludex( )



[ Top ]
check_options  [line 244]

  array check_options( array $options, [array $unknowns = array()], array $argoptions  )

Check Option Compatibilities

Parameters:
array   $options: 
array   $unknowns: 
array   $argoptions:  options before evaluated


[ Top ]
check_page  [line 266]

  string check_page( string $page, string $current, [array $visited = array()]  )

Check Page Validity

Parameters:
string   $page: 
string   $current: 
array   $visited: 

API Tags:
Return:  evaluated page


[ Top ]
convert  [line 69]

  void convert( )

Convert Plugin Main Function



[ Top ]
display_include  [line 105]

  string display_include( string $page, array $options, array $syntax  )

Include page

Parameters:
string   $page: 
array   $options: 
array   $syntax: 

API Tags:
Return:  html


[ Top ]
display_title  [line 295]

  $string display_title( string $page, [string $titlestr = ''], [boolean $link = FALSE], [boolean $editlink = FALSE], [string $cssclass = '']  )

Get <h1> title of a page

Parameters:
string   $page:  pagename
string   $titlestr:  titlestr
boolean   $link:  link to page or not
boolean   $editlink:  add edit link icon or not
string   $cssclass: 

API Tags:
Return:  html


[ Top ]
get_sections  [line 190]

  void get_sections( $lines, $page, $options  )

Parameters:
   $lines: 
   $page: 
   $options: 


[ Top ]

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