IPBWI
[ class tree: IPBWI ] [ index: IPBWI ] [ all elements ]
Packages:
IPBWI
antispam
attachment
bbcode
blog
forum
gallery
group
Languages
liveExample
member
mimetypes
permissions
pm
poll
post
search
skin
stats
tagCloud
topic


Files:
ipbwi.inc.php
ips_output.inc.php
ips_public_core_global_login.inc.php
ips_register.inc.php
ips_wrapper.inc.php
recaptchalib.inc.php

Classes:
ipbwi
ipbwi_ips_output
ipbwi_ips_public_core_global_login
ipbwi_ips_public_core_global_register
ipbwi_ips_wrapper
ReCaptchaResponse

Class: ipbwi

Source Location: /ipbwi/ipbwi.inc.php

Class Overview













        




Variables






Constants






Methods















Child classes:






ipbwi_antispam

	






ipbwi_attachment

	






ipbwi_bbcode

	






ipbwi_blog

	






ipbwi_forum

	






ipbwi_gallery

	






ipbwi_group

	






ipbwi_member

	






ipbwi_permissions

	






ipbwi_pm

	






ipbwi_poll

	






ipbwi_post

	






ipbwi_search

	






ipbwi_skin

	






ipbwi_stats

	






ipbwi_tagCloud

	






ipbwi_topic

	

















Class Details



[line 27]






[ Top ]







Class Variables



	
	

	
static $ips =  null

	
[line 36]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$board = array()

	
[line 39]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$common = array()

	
[line 37]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$DBlog =  null

	
[line 40]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
static method addSystemMessage [line 228]

	

    

    

		static bool addSystemMessage(
string
$level, string
$message, [
$location = false])
    

    


	
		adds a system message





Tags:





  

    return:  this function always returns true
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $level  
        Message-Level, common levels: Notice, Error, Hidden
      

          

        string  
        $message  
        Message-Content
      

          

          
        $location  
        
      

        

    


        
[ Top ]

  

  

	
	
static method setLang [line 104]

	

    

    

		static true setLang(
string
$lang)
    

    


	
		Set's current SDK language





Tags:





  

    return:  if language was loaded, otherwise false
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $lang  
        language-name
      

        

    


        
[ Top ]

  


  

	
	
destructor __destruct [line 95]

	

    

    

		void __destruct(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method date [line 393]

	

    

    

		string date(
[int
$timeStamp = false], [string
$dateFormat = '%A, %d. %B %Y @ %T'], [int
$noBoard = false], [int
$noMember = false])
    

    


	
		Returns textual/timestamp offsetted date by board                      and by member offset and DST setting.





Tags:





  

    return:  formatted, localized date
  

  

    author:  Cow <khlo@global-centre.com>
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $timeStamp  
        Numeric representation of the time beeing formatted
      

          

        string  
        $dateFormat  
        strftime() compliant format (see PHP manual)
      

          

        int  
        $noBoard  
        true = Offset with Board Time firstly, default = false
      

          

        int  
        $noMember  
        true = Bypass member's time offset and DST, default = false
      

        

    


        
[ Top ]

  

  

	
	
method getBoardVar [line 165]

	

    

    

		board-var-value, getBoardVar(
string
$var)
    

    


	
		gets the requested board-var





Tags:





  

    return:  returns false if not exists
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $var  
        board-var-name
      

        

    


        
[ Top ]

  

  

	
	
method getLibLang [line 143]

	

    

    

		native getLibLang(
[string
$var = false])
    

    


	
		gets the language-var from actual requested native language-bit





Tags:





  

    return:  language bit or error msg
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $var  
        language-var-name
      

        

    


        
[ Top ]

  

  

	
	
method makeSafe [line 312]

	

    

    

		proper makeSafe(
string
$var)
    

    


	
		filtering html-strings, e.g. for db-queries





Tags:





  

    return:  and safe string
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $var  
        html-string
      

        

    


        
[ Top ]

  

  

	
	
method printSystemMessages [line 242]

	

    

    

		true printSystemMessages(
[string
$level = false], [
$simple = false])
    

    


	
		prints system messages





Tags:





  

    return:  HTML-Code containing requested messages
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $level  
        Message-Level, common levels: Notice, Error, Hidden
      

          

          
        $simple  
        
      

        

    


        
[ Top ]

  

  

	
	
method properXHTML [line 351]

	

    

    

		proper properXHTML(
string
$var)
    

    


	
		filtering HTML strings





Tags:





  

    return:  XHTML string
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $var  
        html-string
      

        

    


        
[ Top ]

  

  

	
	
method sysInfo [line 178]

	

    

    

		string sysInfo(
)
    

    


	
		informations about the current IPBWI and PHP installation





Tags:





  

    return:  HTML-code including the informations
  

  

    author:  Matthias Reuter
  

  

    since:  2.0
  

  

    access:  public
  









	
        
[ Top ]

  









Class Constants



	
	

	
DEV_TEAM =  'Matthias Reuter'

	
[line 31]

  
  

	
[ Top ]


	
	

	
DOCS =  'http://docs.ipbwi.com/'

	
[line 33]

  
  

	
[ Top ]


	
	

	
PROJECT_LEADER =  'Matthias Reuter'

	
[line 30]

  
  

	
[ Top ]


	
	

	
TITLE =  'IPBWI'

	
[line 29]

  
  

	
[ Top ]


	
	

	
VERSION =  '3.005'

	
[line 28]

  
  

	
[ Top ]


	
	

	
WEBSITE =  'http://ipbwi.com/'

	
[line 32]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Sat, 23 Oct 2010 23:35:53 +0200 by phpDocumentor 1.4.3