com.lokorin.lokorin.lib
[ class tree: com.lokorin.lokorin.lib ] [ index: com.lokorin.lokorin.lib ] [ all elements ]
Packages:
com.lokorin.lokorin.lib
com.lokorin.lokorin.admin
com.lokorin.lokorin.cache
com.lokorin.lokorin.includes
com.lokorin.lokorin.js
com.lokorin.lokorin.modules
com.lokorin.lokorin.public


Files:
lib_abbreviations.php
lib_admin.php
lib_admin_panel.php
lib_cache.php
lib_calendar.php
lib_counters.php
lib_css.php
lib_db.php
lib_displayer.php
lib_dkpbank.php
lib_downloads.php
lib_errors.php
lib_events.php
lib_event_digest.php
lib_forms.php
lib_graphs.php
lib_images.php
lib_languages.php
lib_links.php
lib_markup.php
lib_menu.php
lib_mplf_archive.php
lib_news.php
lib_performance.php
lib_projects.php
lib_readme.php
lib_redirects.php
lib_search.php
lib_sitemap.php
lib_tables.php
lib_util.php

Classes:
AbbreviationHandler
AbstractTableDisplayer
AddModule
AdminAction
AdminModule
AdminPanel
AliasCalendar
Axis
Browse
Button
Calendar
CallbackModule
Category
Chapter
Checkbox
Comment
Counter
CssHandler
CustomSearch
CustomTableDisplayer
DataBase
DateField
DeleteModule
DetailsModule
DownloadCategory
DownloadItem
Edit
EditModule
EqualSearch
Field
FileNotFoundException
Filter
FilterArchive
Form
FulltextSearch
Graph
GraphFunction
GreaterEqualSearch
GreaterSearch
HeadAddable
HeadData
Header
Hidden
IllegalArgumentException
IllegalStateException
IOException
LesserEqualSearch
LesserSearch
LikeSearch
Link
MenuItem
Moderator
News
NoSuchElementException
Page
PasswordField
PerformanceData
ProgrammingLanguage
Project
ProjectMenu
Readme
ReadOnly
ResetButton
SearchField
Select
Sitemap
SitemapIndex
SizedField
Stage
SubmitButton
Table
TableDisplayer
TableEntry
TableField
TableSearcher
TextArea
TextField
TimedEvent
TimeField
UpdateModule
UrlNotFoundException
Validatable

Class: Chapter

Source Location: /_includes/lib_readme.php

Class Overview




Describes a readme chapter. A chapter contains information about one  specific topic.




Author(s):


    
          
  • Andreas Launila
    • 
      





    






Variables







Methods
























Class Details



[line 94]

Describes a readme chapter. A chapter contains information about one  specific topic.





Tags:





  

    author:  Andreas Launila
  










[ Top ]







Class Variables



	
	

	
$contents = 

	
[line 104]

  The actual contents of the chapter. The text (XHTML) informing about the  chapter's topic.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$topic = 

	
[line 99]

  The topic of the chapter.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 112]

	

    

    

		Chapter __construct(
string
$topic, string
$contents)
    

    


	
		Constructor for Chapter.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $topic  
        The opic that the chapter is about.
      

          

        string  
        $contents  
        The (XHTML) text that informs about the          chapter's topic.
      

        

    


        
[ Top ]

  

  

	
	
method getAsHtml [line 129]

	

    

    

		string getAsHtml(
)
    

    


	
		Gets the chapter as XHTML compliant code.





Tags:





  

    return:  XHTML compliant code that represents the chapter.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getContents [line 137]

	

    

    

		string getContents(
)
    

    


	
		Gets the contents of the chapter.





Tags:





  

    return:  The chapter's contents.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getTopic [line 121]

	

    

    

		string getTopic(
)
    

    


	
		Gets the chapter's topic.





Tags:





  

    return:  A chapter topic.
  

  

    access:  public
  










        
[ Top ]

  






        

		    

		    Documentation generated on Sun, 16 Apr 2006 21:03:49 +0200 by phpDocumentor 1.3.0RC4