lib/ezutils/classes/ezhttpfile.php

Show:

inherited

Classes
- \eZHTTPFile

Table of Contents

File containing the eZHTTPFile class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: lib
Version: 4.6.0

\eZHTTPFile
jump to top

Package: lib

File containing the eZHTTPFile class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Constants

 
                UPLOADEDFILE_OK
                = 0

 
                UPLOADEDFILE_DOES_NOT_EXIST
                = -1

 
                UPLOADEDFILE_EXCEEDS_PHP_LIMIT
                = -2

 
                UPLOADEDFILE_EXCEEDS_MAX_SIZE
                = -3

 
                UPLOADEDFILE_MISSING_TMP_DIR
                = -4

 
                UPLOADEDFILE_CANT_WRITE
                = -5

 
                UPLOADEDFILE_UNKNOWN_ERROR
                = -6

Properties


                 $Filename= ''

Details

Type: n/a


                 $HTTPName= ''

Details

Type: n/a


                 $IsTemporary= ''

Details

Type: n/a


                 $MimeCategory= ''

Details

Type: n/a


                 $MimePart= ''

Details

Type: n/a


                 $OriginalFilename= ''

Details

Type: n/a


                 $Size= ''

Details

Type: n/a


                 $Type= ''

Details

Type: n/a

Methods

attribute(
           $attr
          )
        
        :
          void

Parameters

Name	Type	Description
$attr

attributes(
          
          )
        
        :
          void

canFetch(
          string $httpName, bool | int $maxSize
              =
              false
          )
        
        :
          bool | int

static

Returns whether a file can be fetched.

Parameters

Name	Type	Description
$httpName	string	Name of the file.
$maxSize	bool \| int	Whether a maximum file size applies or size in bytes of the maximum allowed.

Returns

Type	Description
bool \| int	true if the HTTP file $httpName can be fetched. If $maxSize is given, the function returns eZHTTPFile::UPLOADEDFILE_OK if the file can be fetched, eZHTTPFile::UPLOADEDFILE_DOES_NOT_EXIST if there has been no file uploaded, eZHTTPFile::UPLOADEDFILE_EXCEEDS_PHP_LIMIT if the file was uploaded but size exceeds the upload_max_size limit (set in the PHP configuration), eZHTTPFile::UPLOADEDFILE_EXCEEDS_MAX_SIZE if the file was uploaded but size exceeds $maxSize or MAX_FILE_SIZE variable in the form. eZHTTPFile::UPLOADEDFILE_MISSING_TMP_DIR if the temporary directory is missing eZHTTPFile::UPLOADEDFILE_CANT_WRITE if the file can't be written eZHTTPFile::UPLOADEDFILE_UNKNOWN_ERROR if an unknown error occured

Type

Description

bool | int

true if the HTTP file $httpName can be fetched. If $maxSize is given, the function returns eZHTTPFile::UPLOADEDFILE_OK if the file can be fetched, eZHTTPFile::UPLOADEDFILE_DOES_NOT_EXIST if there has been no file uploaded, eZHTTPFile::UPLOADEDFILE_EXCEEDS_PHP_LIMIT if the file was uploaded but size exceeds the upload_max_size limit (set in the PHP configuration), eZHTTPFile::UPLOADEDFILE_EXCEEDS_MAX_SIZE if the file was uploaded but size exceeds $maxSize or MAX_FILE_SIZE variable in the form. eZHTTPFile::UPLOADEDFILE_MISSING_TMP_DIR if the temporary directory is missing eZHTTPFile::UPLOADEDFILE_CANT_WRITE if the file can't be written eZHTTPFile::UPLOADEDFILE_UNKNOWN_ERROR if an unknown error occured

eZHTTPFile(
           $http_name,  $variable
          )
        
        :
          void

Parameters

Name	Type	Description
$http_name
$variable

fetch(
           $http_name
          )
        
        :
          void

static

Parameters

Name	Type	Description
$http_name

hasAttribute(
           $attr
          )
        
        :
          void

Parameters

Name	Type	Description
$attr

setMimeType(
           $mime
          )
        
        :
          void

Parameters

Name	Type	Description
$mime

storageDir(
           $sub_dir
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$sub_dir

store(
           $sub_dir
              =
              false,  $suffix
              =
              false,  $mimeData
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$sub_dir
$suffix
$mimeData

lib/ezutils/classes/ezhttpfile.php

\eZHTTPFilejump to top

Constants

Properties

Methods

\eZHTTPFile
jump to top