kernel/classes/ezcontentupload.php

Show: inherited
Table of Contents

File containing the eZContentUpload class.

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

\eZContentUpload

Package: kernel

File containing the eZContentUpload 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

Constant  STATUS_PERMISSION_DENIED = 1

Properties

Propertypublic  $Parameters= 'false'
Default valuefalseDetails
Type
n/a

Methods

methodpublicattribute(  $attributeName ) : void

Parameters
Name Type Description
$attributeName
methodpublicattributes( ) : void

methodpubliccheckAccess(  $nodeID,  $class ) : void

Parameters
Name Type Description
$nodeID
$class
methodpubliccleanup(  $actionName ) : void
static

Parameters
Name Type Description
$actionName
methodpubliccleanupAll( ) : void

methodpublicdetectClassIdentifier(  $mime ) : void

Parameters
Name Type Description
$mime
methodpublicdetectLocations(  $classIdentifier,  $class,  $location,  $parentNodes,  $parentMainNode ) : void

Parameters
Name Type Description
$classIdentifier
$class
$location
$parentNodes
$parentMainNode
methodpubliceZContentUpload(  $params = false ) : void

Parameters
Name Type Description
$params
methodpublicfetchHTTPFile(  $httpFileIdentifier,  $errors,  $file,  $mimeData ) : bool

Fetches the HTTP-File into $file and fills in MIME-Type information into $mimeData.

Parameters
Name Type Description
$httpFileIdentifier
$errors
$file
$mimeData
Returns
Type Description
bool false if something went wrong.
methodpublicfindHTTPFileAttribute(  $dataMap,  $fileAttribute ) : void

Parameters
Name Type Description
$dataMap
$fileAttribute
methodpublicfindHandler(  $result,  $mimeInfo ) : void

Parameters
Name Type Description
$result
$mimeInfo
methodpublicfindRegularFileAttribute(  $dataMap,  $fileAttribute ) : void

Parameters
Name Type Description
$dataMap
$fileAttribute
methodpublicfindStringAttribute(  $dataMap,  $nameAttribute ) : void

Parameters
Name Type Description
$dataMap
$nameAttribute
methodpublichandleLocalFile( array $result, string $filePath, mixed $location, \eZContentObjectTreeNode | false $existingNode, string $nameString = '', string | false $localeCode = false ) : boolean

Fetches the local file, figures out its MIME-type and creates the proper content object out of it.

Parameters
Name Type Description
$result array

Result data, will be filled with information which the client can examine, contains: errors An array with errors, each element is an array with a 'description' entry containing the text

$filePath string

Path to file which should be stored

$location mixed

The node ID which the new object will be placed or the string 'auto' for automatic placement of type.

$existingNode \eZContentObjectTreeNode | false

Pass a contentobjecttreenode object to let the uploading be done to an existing object, if not it will create one from scratch.

$nameString string

The name of the new object/new version

$localeCode string | false

Locale code (eg eng-GB, fre-FR, ...) to use when creating the object or the version.

Returns
Type Description
boolean
methodpublichandleUpload( array $result, string $httpFileIdentifier, mixed $location, \eZContentObjectTreeNode | false $existingNode, string $nameString = '', string | false $localeCode = false ) : boolean

Fetches the uploaded file, figures out its MIME-type and creates the proper content object out of it.

Parameters
Name Type Description
$result array

Result data, will be filled with information which the client can examine, contains: errors An array with errors, each element is an array with a 'description' entry containing the text

$httpFileIdentifier string

The HTTP identifier of the uploaded file, this must match the name of the input tag.

$location mixed

The node ID which the new object will be placed or the string 'auto' for automatic placement of type.

$existingNode \eZContentObjectTreeNode | false

Pass a contentobjecttreenode object to let the uploading be done to an existing object, if not it will create one from scratch.

$nameString string

The name of the new object/new version

$localeCode string | false

Locale code (eg eng-GB, fre-FR, ...) to use when creating the object or the version.

Returns
Type Description
boolean
methodpublichasAttribute(  $attributeName ) : void

Parameters
Name Type Description
$attributeName
methodpublicnodeAliasID(  $nodeName ) : void

Parameters
Name Type Description
$nodeName
methodpublicobjectFileInfo(  $contentObject ) : void

Parameters
Name Type Description
$contentObject
methodpublicprocessNamePattern(  $variables,  $namePattern ) : void

Parameters
Name Type Description
$variables
$namePattern
methodpublicpublishObject(  $result,  $errors,  $notices,  $object,  $publishVersion,  $class,  $parentNodes,  $parentMainNode ) : void

Parameters
Name Type Description
$result
$errors
$notices
$object
$publishVersion
$class
$parentNodes
$parentMainNode
methodpublicresult(  $actionName,  $cleanup = true ) : void
static

Parameters
Name Type Description
$actionName
$cleanup
methodpublicsetResult(  $result ) : void

Parameters
Name Type Description
$result
methodpublicupload(  $parameters = array(),  $module ) : void
static

Parameters
Name Type Description
$parameters
$module
Documentation was generated by DocBlox 0.18.1.