Ampache
[ class tree: Ampache ] [ index: Ampache ] [ all elements ]
Packages:
Ampache
Catalog
Horde_Browser
Search
Web
XMLRPC
XML_RPC


Files:
access.class.php
access.php
ajax.class.php
ajax.server.php
album.class.php
albums.php
AmazonSearchEngine.class.php
ampachemail.class.php
ampacherss.class.php
api.class.php
archive.lib.php
artist.class.php
artists.php
batch.lib.php
batch.php
browse.ajax.php
browse.class.php
browse.php
captcha.php
catalog.php
catalog_update.inc
class.nusoap_base.php
class.soapclient.php
class.soap_fault.php
class.soap_parser.php
class.soap_server.php
class.soap_transport_http.php
class.soap_val.php
class.wsdl.php
class.wsdlcache.php
class.xmlschema.php
config.class.php
core.class.php
database_object.abstract.php
dba.class.php
debug.lib.php
delete_disabled.inc
democratic.ajax.php
democratic.class.php
democratic.php
dump_album_art.inc
duplicates.php
error.class.php
export.php
fix_filenames.inc
flag.ajax.php
flag.class.php
flag.php
flag.php
general.lib.php
genre.class.php
genre.php
gettext.php
gettext.php
httpq.controller.php
httpqplayer.class.php
image.php
index.ajax.php
index.php
index.php
index.php
init.php
install.php
install.php
jamendoSearch.class.php
lastfm.class.php
Lastfm.plugin.php
localplay.abstract.php
localplay.ajax.php
localplay.class.php
localplay.php
log.lib.php
login.php
logout.php
mail.php
media.interface.php
migrate_config.inc
modules.php
mp3tunes.class.php
mpd.class.php
mpd.controller.php
nusoap.php
nusoapmime.php
playlist.ajax.php
playlist.class.php
playlist.php
plugin.class.php
preference.class.php
preferences.php
preferences.php
print_tags.inc
radio.class.php
radio.php
random.ajax.php
random.class.php
random.php
rating.class.php
rating.lib.php
register.php
registration.class.php
RioPlayer.plugin.php
rss.php
scrobbler.class.php
search.php
shout.php
shout.php
shoutbox.class.php
shoutcast.controller.php
Snoopy.class.php
song.ajax.php
song.class.php
song.php
sort_files.inc
stats.ajax.php
stats.class.php
stats.php
stream.ajax.php
stream.class.php
stream.lib.php
stream.php
system.php
tag.ajax.php
tag.class.php
test.php
themes.php
tmpplaylist.class.php
update.class.php
update.php
user.class.php
users.php
util.php
vainfo.class.php
validateEmail.php
validateEmailFormat.php
vauth.class.php
video.class.php
write_playlists.inc
write_tags.inc
xml.server.php
xmldata.class.php
xmlrpc.server.php
xmlrpcclient.class.php
xmlrpcserver.class.php
xspf_player.php

Interfaces:
media
Classes:
Access
Ajax
Album
AmazonSearch
AmpacheHttpq
AmpacheLastfm
AmpacheMail
AmpacheMpd
AmpacheRioPlayer
AmpacheRSS
AmpacheShoutCast
Api
archive
Artist
Browse
bzip_file
captcha
Config
Core
database_object
Dba
Democratic
easy_captcha
easy_captcha_dxy_spike
easy_captcha_dxy_wave
easy_captcha_fuzzy
easy_captcha_graphic
easy_captcha_graphic_image_disturbed
easy_captcha_graphic_image_waved
easy_captcha_persistent_grant
easy_captcha_spamfree_no_new_urls
easy_captcha_text_disable
easy_captcha_text_math_formula
easy_captcha_utility
Error
Flag
Genre
gzip_file
HttpQPlayer
jamendoSearch
LastFMSearch
Localplay
localplay_controller
mp3tunes
mpd
nusoapservermime
nusoap_base
nusoap_client
nusoap_client_mime
nusoap_fault
nusoap_parser
nusoap_server
nusoap_server_mime
nusoap_wsdlcache
nusoap_xmlschema
Playlist
Plugin
Preference
Radio
Random
Rating
Registration
scrobbler
shoutBox
Snoopy
soapclient
soapclientmime
soapval
soap_fault
soap_parser
soap_server
soap_transport_http
Song
Stats
Stream
Tag
tar_file
tmpPlaylist
Update
User
vainfo
vauth
Video
wsdl
wsdlcache
xmlData
xmlRpcClient
xmlRpcServer
XMLSchema
zip_file

Class: Access

Source Location: /lib/class/access.class.php

Class Overview




Access Class









        




Variables







Methods
























Class Details



[line 26]

Access Class

This class handles the access list mojo for Ampache, it is ment to restrict  access based on IP and maybe something else in the future





[ Top ]







Class Variables



	
	

	
$enabled = 

	
[line 37]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$end = 

	
[line 32]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$id = 

	
[line 29]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$key = 

	
[line 36]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$level = 

	
[line 33]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$name = 

	
[line 30]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$start = 

	
[line 31]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$type = 

	
[line 35]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$user = 

	
[line 34]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
static method check [line 321]

	

    

    

		static void check(

$type, 
$level)
    

    


	
		check_access

This is the global 'has_access' function it can check for any 'type' of object  everything uses the global 0,5,25,50,75,100 stuff. GLOBALS['user'] is always used





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $type  
        
      

          

          
        $level  
        
      

        

    


        
[ Top ]

  

  

	
	
static method check_function [line 222]

	

    

    

		static void check_function(

$type)
    

    


	
		check_function

This checks if a specific functionality is enabled  it takes a type only





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $type  
        
      

        

    


        
[ Top ]

  

  

	
	
static method check_network [line 250]

	

    

    

		static void check_network(

$type, 
$user, 
$level, [
$ip = ''], [
$key = ''])
    

    


	
		check_network

This takes a type, ip, user, level and key  and then returns true or false if they have access to this  the IP is passed as a dotted quad





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $type  
        
      

          

          
        $user  
        
      

          

          
        $level  
        
      

          

          
        $ip  
        
      

          

          
        $key  
        
      

        

    


        
[ Top ]

  

  

	
	
static method create [line 139]

	

    

    

		static void create(

$data)
    

    


	
		create

This takes a key'd array of data and trys to insert it as a  new ACL entry





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $data  
        
      

        

    


        
[ Top ]

  

  

	
	
static method delete [line 210]

	

    

    

		static void delete(

$access_id)
    

    


	
		delete

deletes the specified access_list entry





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $access_id  
        
      

        

    


        
[ Top ]

  

  

	
	
static method exists [line 187]

	

    

    

		static void exists(

$data)
    

    


	
		exists

this sees if the ACL that we've specified already exists, prevent duplicates. This ignores the name





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $data  
        
      

        

    


        
[ Top ]

  

  

	
	
static method get_access_lists [line 383]

	

    

    

		static void get_access_lists(
)
    

    


	
		get_access_lists

returns a full listing of all access rules on this server





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method session_exists [line 465]

	

    

    

		static void session_exists(

$data, 
$key, 
$type)
    

    


	
		session_exists

This checks to see if the specified session of the specified type  exists, it also provides an array of key'd data that may be required  based on the type





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $data  
        
      

          

          
        $key  
        
      

          

          
        $type  
        
      

        

    


        
[ Top ]

  

  

	
	
static method validate_type [line 361]

	

    

    

		static void validate_type(

$type)
    

    


	
		validate_type

This cleans up and validates the specified type





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $type  
        
      

        

    


        
[ Top ]

  


  

	
	
constructor __construct [line 43]

	

    

    

		Access __construct(
[
$access_id = ''])
    

    


	
		constructor

Takes an ID of the access_id dealie :)





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $access_id  
        
      

        

    


        
[ Top ]

  

  

	
	
method format [line 80]

	

    

    

		void format(
)
    

    


	
		format  This makes the Access object a nice fuzzy human readable object, spiffy ain't it.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method get_level_name [line 404]

	

    

    

		void get_level_name(
)
    

    


	
		get_level_name

take the int level and return a named level





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method get_type_name [line 438]

	

    

    

		void get_type_name(
)
    

    


	
		get_type_name

This function returns the pretty name for our current type





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method get_user_name [line 425]

	

    

    

		void get_user_name(
)
    

    


	
		get_user_name

Take a user and return their full name





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method update [line 95]

	

    

    

		void update(

$data)
    

    


	
		update

This function takes a named array as a datasource and updates the current access list entry





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $data  
        
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Thu, 12 Feb 2009 07:59:48 +0900 by phpDocumentor 1.4.2