Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]
Packages:
Geeklog
Calendar
kses
Links
net-geeklog-search
Polls
Spam-X
StaticPages
XMLSitemap
XMLsitemap


Files:
404.php
article.php
association.php
atom.feed.class.php
auth.inc.php
bigdump.php
block.php
calendar.class.php
comment.php
config-install.php
config.class.php
config.php
configinfo.php
configuration.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
consumer.php
database.php
directory.php
downloader.class.php
event.php
facebook.auth.class.php
feedparserbase.class.php
functions.php
functions.php
getimage.php
group.php
help.php
httpclient.php
index.php
index.php
index.php
index.php
index.php
index.php
info.php
install-plugins.php
install_defaults.php
install_updates.php
install_updates.php
install_updates.php
install_updates.php
install_updates.php
install_updates.php
interface.php
LDAP.auth.class.php
lib-admin.php
lib-comment.php
lib-common.php
lib-custom.php
lib-database.php
lib-install.php
lib-mbyte.php
lib-pingback.php
lib-plugins.php
lib-security.php
lib-sessions.php
lib-story.php
lib-syndication.php
lib-trackback.php
lib-upgrade.php
lib-user.php
lib-webservices.php
linkedin.auth.class.php
listfactory.class.php
LiveJournal.auth.class.php
mail.php
migrate.php
moderation.php
mssql.class.php
mssql_1.4.1_to_1.5.0.php
mssql_1.5.0_to_1.5.1.php
mssql_1.5.1_to_1.5.2.php
mssql_1.5.2_to_1.6.0.php
mssql_1.6.0_to_1.6.1.php
mssql_1.6.1_to_1.7.0.php
mssql_1.7.2_to_1.8.0.php
mssql_install.php
mssql_tableanddata.php
mysql.class.php
mysql_1.2.5-1_to_1.3.php
mysql_1.3.1_to_1.3.2.php
mysql_1.3.2-1_to_1.3.3.php
mysql_1.3.3_to_1.3.4.php
mysql_1.3.4_to_1.3.5.php
mysql_1.3.5_to_1.3.6.php
mysql_1.3.7_to_1.3.8.php
mysql_1.3.8_to_1.3.9.php
mysql_1.3.9_to_1.3.10.php
mysql_1.3.10_to_1.3.11.php
mysql_1.3.11_to_1.4.0.php
mysql_1.3_to_1.3.1.php
mysql_1.4.0_to_1.4.1.php
mysql_1.4.1_to_1.5.0.php
mysql_1.5.0_to_1.5.1.php
mysql_1.5.1_to_1.5.2.php
mysql_1.5.2_to_1.6.0.php
mysql_1.6.0_to_1.6.1.php
mysql_1.6.1_to_1.7.0.php
mysql_1.7.2_to_1.8.0.php
mysql_install.php
mysql_tableanddata.php
navbar.class.php
oauthhelper.class.php
oid_parse.php
oid_util.php
openidhelper.class.php
parserfactory.class.php
pgsql.class.php
pgsql_1.7.2_to_1.8.0.php
pgsql_install.php
pgsql_tableanddata.php
pingback.php
plugin.class.php
plugins.php
profiles.php
rdf.feed.class.php
rss.feed.class.php
sanitize.class.php
scripts.class.php
search.php
searchcriteria.class.php
sectest.php
server.php
stats.php
story.class.php
story.php
submit.php
success.php
switchlang.php
syndication.php
template.class.php
timer.class.php
timezoneconfig.class.php
topic.php
trackback.php
trackback.php
trustroot.php
twitter.auth.class.php
unpacker.class.php
upload.class.php
url.class.php
user.php
users.php
usersettings.php
validator.class.php

Interfaces:
ITemplate
Classes:
AbstractConsumerAssociationManager
ActionHandler
Association
Atom03
Atom10
Calendar
CalendarDay
CheckAuthRequired
config
ConsumerAssociation
ConsumerAssociationManager
ConsumerRequest
ConsumerResponse
database
DiffieHellman
DiffieHelmanAssociator
downloader
DumbAssociationManager
ErrorFromServer
facebookConsumer
FeedParserBase
FeedParserFactory
HTTPClient
InvalidLogin
LDAP
linkedinConsumer
ListFactory
LiveJournal
MultiRootTemplate
navbar
OAuthConsumer
OAuthConsumerBaseClass
oidParse
oidUtil
oidUtilPhpBigInt
oidUtilPhpSha1
OpenIDConsumer
OpenIDConsumerHelper
OpenIDServer
ParanoidHTTPClient
Plugin
RDF
Request
RSS0x
RSS20
sanitizer
scripts
SearchCriteria
ServerAssociationStore
ServerResponse
SimpleActionHandler
SimpleConsumer
SimpleHTTPClient
Story
Template
timerobject
TimeZoneConfig
TrustRoot
twitterConsumer
unpacker
upload
url
UserCancelled
UserSetupNeeded
validator
ValidLogin

Class: downloader

Source Location: /system/classes/downloader.class.php

Class Overview




This class allows you to download a file from outside the web tree.  Many  hooks around security and file types have been added for customization within  any app.




Author(s):


    
          
  • Tony Bibbs
    • 
      





    

        






Methods
























Class Details



[line 40]

This class allows you to download a file from outside the web tree.  Many  hooks around security and file types have been added for customization within  any app.





Tags:





  

    author:  Tony Bibbs
  










[ Top ]








Class Methods




  

	
	
constructor downloader [line 92]

	

    

    

		downloader downloader(
)
    

    


	
		Constructor





	
        
[ Top ]

  

  

	
	
method areErrors [line 381]

	

    

    

		boolean areErrors(
)
    

    


	
		Returns if any errors have been encountered thus far





Tags:





  

    return:  True if errors occurred otherwise false
  









	
        
[ Top ]

  

  

	
	
method checkExtension [line 428]

	

    

    

		boolean checkExtension(
string
$extension)
    

    


	
		Checks to see that mime type for current file is allowed for upload





Tags:





  

    return:  true if allowed otherwise false
  









	
        
Parameters:

    

    

          

        string  
        $extension  
        Verifies file extension is allowed for download
      

        

    


        
[ Top ]

  

  

	
	
method downloadFile [line 480]

	

    

    

		boolean downloadFile(
string
$fileName)
    

    


	
		Attempts to dowload a file





Tags:





  

    return:  true on success otherwise false
  









	
        
Parameters:

    

    

          

        string  
        $fileName  
        file to download without path
      

        

    


        
[ Top ]

  

  

	
	
method getAllowedExtensions [line 416]

	

    

    

		array getAllowedExtensions(
)
    

    


	
		Gets allowed mime types for this instance





Tags:





  

    return:  array of allowed mime types/file extensions
  









	
        
[ Top ]

  

  

	
	
method getPath [line 468]

	

    

    

		string getPath(
)
    

    


	
		Returns directory to upload to





Tags:





  

    return:  returns directory where files for downloading reside
  









	
        
[ Top ]

  

  

	
	
method limitByIP [line 240]

	

    

    

		boolean limitByIP(
[array
$validIPS = array('127.0.0.1')])
    

    


	
		Extra security option that forces all attempts to download a file to be  done so from a set of VERY specific IP's.  This is only good for those  who are paranoid





Tags:





  

    return:  returns true on success otherwise false
  









	
        
Parameters:

    

    

          

        array  
        $validIPS  
        Array of valid IP addresses to allow file uploads from
      

        

    


        
[ Top ]

  

  

	
	
method loggingEnabled [line 295]

	

    

    

		boolean loggingEnabled(
)
    

    


	
		Returns whether or not logging is enabled





Tags:





  

    return:  true if logging is enabled otherwise false
  









	
        
[ Top ]

  

  

	
	
method printDebugMsgs [line 363]

	

    

    

		void printDebugMsgs(
)
    

    


	
		This function will print any debug messages out.





	
        
[ Top ]

  

  

	
	
method printErrors [line 325]

	

    

    

		boolean printErrors(
[boolean
$verbose = true])
    

    


	
		This function will print any errors out.  This is useful in debugging





Tags:





  

    return:  string of all errors
  









	
        
Parameters:

    

    

          

        boolean  
        $verbose  
        will print errors to web browser if true
      

        

    


        
[ Top ]

  

  

	
	
method printWarnings [line 347]

	

    

    

		void printWarnings(
)
    

    


	
		This function will print any warnings out.  This is useful in debugging





	
        
[ Top ]

  

  

	
	
method setAllowedExtensions [line 396]

	

    

    

		void setAllowedExtensions(
[array
$validExtensions = array()])
    

    


	
		Sets allowed mime types for this instance





	
        
Parameters:

    

    

          

        array  
        $validExtensions  
        Array of allowed extensions and mime types
      

        

    


        
[ Top ]

  

  

	
	
method setDebug [line 307]

	

    

    

		void setDebug(
boolean
$switch)
    

    


	
		Will force the debug messages in this class to be  printed





	
        
Parameters:

    

    

          

        boolean  
        $switch  
        flag, true or false
      

        

    


        
[ Top ]

  

  

	
	
method setLogFile [line 259]

	

    

    

		boolean setLogFile(
[string
$logFile = ''])
    

    


	
		Sets log file





Tags:





  

    return:  true on success otherwise false
  









	
        
Parameters:

    

    

          

        string  
        $logFile  
        fully qualified path to log files
      

        

    


        
[ Top ]

  

  

	
	
method setLogging [line 277]

	

    

    

		void setLogging(
boolean
$switch)
    

    


	
		Enables/disables logging of errors and warnings





	
        
Parameters:

    

    

          

        boolean  
        $switch  
        flag, true or false
      

        

    


        
[ Top ]

  

  

	
	
method setPath [line 445]

	

    

    

		boolean setPath(
string
$uploadDir)
    

    


	
		Sets file upload path





Tags:





  

    return:  true on success otherwise false
  









	
        
Parameters:

    

    

          

        string  
        $uploadDir  
        Directory on server to store uploaded files
      

        

    


        
[ Top ]

  

  

	
	
method _setAvailableExtensions [line 189]

	

    

    

		void _setAvailableExtensions(
[array
$extensions = array()])
    

    


	
		Defines superset of available Mime types.





	
        
Parameters:

    

    

          

        array  
        $extensions  
        string array of valid mime types this object will accept
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Sat, 11 Feb 2012 02:07:30 -0500 by phpDocumentor 1.4.3