Base
[ class tree: Base ] [ index: Base ] [ all elements ]
Packages:
Base
Admin
Board
DATC
GameMaster
Map


Files:
auth.php
config.sample.php
database.php
definitions.php
error.php
header.php
html.php
index.php
invite.php
message.php
profile.php
time.php
user.php

subpackage EasyCaptcha
easycaptcha.php
php-captcha.inc.php

subpackage Forms
gamecreate.php
gamecreate.php
logon.php
register.php
user.php
usercp.php
userRegister.php

subpackage Game
findgames.php
game.php
gamelistings.php
gamemessage.php
halloffame.php
member.php
order.php
territory.php
unit.php

subpackage Static
credits.php
credits.php
developers.php
developers.php
faq.php
faq.php
help.php
help.php
intro.php
intro.php
points.php
points.php
translating.php
translating.php

Classes:
Config
Database
libAuth
libHTML
libTime
Message
User
Game
   Game
   libFindGames
   libGameMessage
   Member
   order
   Territory
   Unit
EasyCaptcha
   PhpCaptcha

Class: libFindGames

Source Location: /lib/findgames.php

Class Overview




This class will find games which fit certain criteria









        






Methods
























Class Details



[line 35]

This class will find games which fit certain criteria

If a user isn't supplied as an argument to these functions (for a user  profile) the global $User is used.
Used in players' profiles, the gamelistings.php page, and the  libHTML::notification box





[ Top ]








Class Methods



  

	
	
static method activegames [line 184]

	

    

    

		static array activegames(
[
$FORUser = false], bool
$FORUser=false)
    

    


	
		Games the user could watch





Tags:





  

    return:  An array of game IDs
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        bool  
        $FORUser=false  
        The user to search for (default is the global user)
      

          

          
        $FORUser  
        
      

        

    


        
[ Top ]

  

  

	
	
static method finishedgames [line 216]

	

    

    

		static array finishedgames(
[
$FORUser = false], bool
$FORUser=false)
    

    


	
		Games which are finished, but the user is not a member of





Tags:





  

    return:  An array of game IDs
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        bool  
        $FORUser=false  
        The user to search for (default is the global user)
      

          

          
        $FORUser  
        
      

        

    


        
[ Top ]

  

  

	
	
static method joinablegames [line 133]

	

    

    

		static array joinablegames(
[
$FORUser = false], [
$privategames = false], bool
$FORUser=false, bool
$privategames=false)
    

    


	
		Games the user could join





Tags:





  

    return:  An array of game IDs
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        bool  
        $FORUser=false  
        The user to search for (default is the global user)
      

          

        bool  
        $privategames=false  
        Search for private games too?
      

          

          
        $FORUser  
        
      

          

          
        $privategames  
        
      

        

    


        
[ Top ]

  

  

	
	
static method joinedactivegames [line 102]

	

    

    

		static array joinedactivegames(
[
$FORUser = false], bool
$FORUser=false)
    

    


	
		Active games the user has joined





Tags:





  

    return:  An array of game IDs
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        bool  
        $FORUser=false  
        The user to search for (default is the global user)
      

          

          
        $FORUser  
        
      

        

    


        
[ Top ]

  

  

	
	
static method joinedfinishedgames [line 72]

	

    

    

		static array joinedfinishedgames(
[
$FORUser = false], bool
$FORUser=false)
    

    


	
		Finished games the user has joined





Tags:





  

    return:  An array of game IDs
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        bool  
        $FORUser=false  
        The user to search for (default is the global user)
      

          

          
        $FORUser  
        
      

        

    


        
[ Top ]

  

  

	
	
static method notifyGames [line 44]

	

    

    

		static array notifyGames(
)
    

    


	
		Games which the current user needs to have appear in the notify bar





Tags:





  

    return:  An array of game records with info needed to display them
  

  

    access:  public
  









	
        
[ Top ]

  







        

		    

		    Documentation generated on Thu, 13 Nov 2008 18:15:37 +0900 by phpDocumentor 1.4.1