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: Page

Source Location: /_includes/common.php

Class Overview




Describes a page that can be displayed. It's the end result of the whole  script.




Author(s):


    
          
  • Andreas Launila
    • 
      





    






Variables







Methods
























Class Details



[line 263]

Describes a page that can be displayed. It's the end result of the whole  script.





Tags:





  

    author:  Andreas Launila
  










[ Top ]







Class Variables



	
	

	
$doFollow = 

	
[line 283]

  True if links in the page be followed by robots, false otherwise.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$doIndex = 

	
[line 288]

  True if the page should be indexed by robots, false otherwise.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$headAdditions = 

	
[line 273]

  All instances of HeadAddable that should be added to the head contents.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$instance = 

	
[line 268]

  The one and only instance of the class.





Tags:





  

    static:  
  

  

    access:  private
  






  

	

  

    

      Type:  
      Page
    

      

	



	
[ Top ]


	
	

	
$project = 

	
[line 293]

  The project that the page belongs to.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      Project
    

      

	



	
[ Top ]


	
	

	
$title = 

	
[line 278]

  The title of the page.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 309]

	

    

    

		Page __construct(
)
    

    


	
		Constructor for Page.





Tags:





  

    access:  private
  










        
[ Top ]

  

  

	
	
method addToHead [line 359]

	

    

    

		void addToHead(
HeadAddable
$headAddable)
    

    


	
		Adds something that is head addable (implements HeadAddable) to the head  tag of the page.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        HeadAddable  
        $headAddable  
        The data that should be added.
      

        

    


        
[ Top ]

  

  

	
	
method display [line 321]

	

    

    

		void display(
)
    

    


	
		Displays the page.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method displayContents [line 339]

	

    

    

		void displayContents(
string
$contents)
    

    


	
		Displays the page with the specified contents.





Tags:





  

    access:  private
  










        
Parameters:

    

    

          

        string  
        $contents  
        The contents that the page should contain.
      

        

    


        
[ Top ]

  

  

	
	
method doFollow [line 419]

	

    

    

		boolean doFollow(
)
    

    


	
		Gets whether or not links in the page should be followed by robots.





Tags:





  

    return:  True if the page should be indexed by robots, false          otherwise.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method doIndex [line 410]

	

    

    

		boolean doIndex(
)
    

    


	
		Gets where or not the page should be indexed by robots.





Tags:





  

    return:  True if the page should be indexed by robots, false          otherwise.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method flush [line 331]

	

    

    

		void flush(
)
    

    


	
		Flushes the page, totally unprocessed, to the output stream.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getDescription [line 427]

	

    

    

		string getDescription(
)
    

    


	
		Gets the description of the current page.





Tags:





  

    return:  A short description of the page.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getHeadAddition [line 377]

	

    

    

		string getHeadAddition(
)
    

    


	
		Gets all additional head data that is specified by the page.





Tags:





  

    return:  XHTML compliant code that can be placed inside a head          tag.
  

  

    access:  public
  

  

    see:  com.lokorin.lokorin.lib.HeadAddable.getHeadAddition()
  










        
[ Top ]

  

  

	
	
method getInstance [line 299]

	

    

    

		CssTemplateConverter getInstance(
)
    

    


	
		Gets the one and only instance of the class.





Tags:





  

    return:  The one and only instance.
  

  

    static:  
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMainHeader [line 443]

	

    

    

		string getMainHeader(
)
    

    


	
		Gets the text that should be used in the main page header.





Tags:





  

    return:  A few words.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getSubmenu [line 478]

	

    

    

		string getSubmenu(
)
    

    


	
		Gets the submenu that should be disiplayed. The function should only  be called if hasSubmenu returns true.





Tags:





  

    return:  XHTML compliant code containing an unordered list of          links.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getTitle [line 455]

	

    

    

		string getTitle(
)
    

    


	
		Gets the title of the page.





Tags:





  

    return:  A textual page title.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method hasSubmenu [line 468]

	

    

    

		boolean hasSubmenu(
)
    

    


	
		Whether or not the page has a submenu that should be displayed.





Tags:





  

    return:  True if the page has a submenu, false otherwise.
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method setProject [line 492]

	

    

    

		void setProject(
Project
$newProject)
    

    


	
		Sets the project that the page is contained in.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        $newProject  
        $newProject  
        The new project that should be set. The value may be          null in which case the defailt project is used.
      

        

    


        
[ Top ]

  

  

	
	
method setShouldFollow [line 401]

	

    

    

		void setShouldFollow(
boolean
$shouldFollow)
    

    


	
		Sets whether or not links in the current page should be followed. This  is by default set to true.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        boolean  
        $shouldFollow  
        True if links in the page should be          followed by robots, false otherwise.
      

        

    


        
[ Top ]

  

  

	
	
method setShouldIndex [line 391]

	

    

    

		void setShouldIndex(
boolean
$shouldIndex)
    

    


	
		Sets whether or not the current page should be indexed by robots. This  is by default set to true.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        boolean  
        $shouldIndex  
        True if pages should be indexed by robots,          false otherwise.
      

        

    


        
[ Top ]

  

  

	
	
method setTitle [line 367]

	

    

    

		void setTitle(
string
$newTitle)
    

    


	
		Sets the title of the page to a new title.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $newTitle  
        The new title that should be sued for the page.
      

        

    


        
[ Top ]

  






        

		    

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