Documentation

Uploader extends EntityBase
in package

Class Uploader

Tags
copyright

CLOUDREXX CMS - Cloudrexx AG Thun

author

Robin Glauser robin.glauser@comvation.com

subpackage

coremodule_uploader

Table of Contents

Constants

UPLOADER_TYPE_INLINE  = 'Inline'
UPLOADER_TYPE_MODAL  = 'Modal'

Properties

$cx  : Cx
$id  : int
The uploader id
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$nestingCount  : int
Counts the nesting level of __call()
$options  : array<string|int, mixed>
$stringRepresentationBlank  : bool
Whether blank string representations are valid
$stringRepresentationFields  : array<string|int, mixed>
List of fields that should be available in the string representation
$stringRepresentationFormat  : string
Sprintf format for the string representation
$tag  : string
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual  : bool
Defines if an entity is virtual and therefore not persistable.

Methods

__call()  : mixed
Route methods like getName(), getType(), getDirectory(), etc.
__construct()  : mixed
__get()  : mixed
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
__toString()  : string
Returns this entity's identifying value
addClass()  : self
Add a class to the button
destroy()  : mixed
Drop the upload instance (it's session data) identified by ID $id.
getComponentController()  : SystemComponent
Returns the component controller for this component
getContainer()  : mixed
getId()  : string
Return's the uploader id
getKeyAsString()  : string
Returns this entity's key
getMaxFileSize()  : string
Get the currently set upload file size limit
getOption()  : string
getOptionsString()  : string
Get all options as a string.
getTag()  : string
Returns the tag name to be used when returning the uploader button
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
getType()  : string
getXHtml()  : string
initializeValidators()  : mixed
Set $this->validators
isValidId()  : bool
Verifies that the ID $id is a valid upload ID of the current user's session
isVirtual()  : bool
Returns the virtuality of the entity
setCallback()  : $this
Set a javascript callback on a global function.
setData()  : $this
Add additional data for the uploader
setFinishedCallback()  : $this
Saves the callback in the session.
setMaxFileSize()  : mixed
Set the maximum file size for the upload
setOptions()  : mixed
setTag()  : void
Sets the tag to use for the uploader button
setType()  : mixed
setUploadLimit()  : self
Set a file upload limit.
setVirtual()  : mixed
Set the virtuality of the entity
validate()  : mixed
generateId()  : string
Generate a new unique ID within the user's session
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank()  : bool
Whether blank string representations are valid
getStringRepresentationFields()  : array<string|int, mixed>
Returns a list of fields available in the string representation
getStringRepresentationFormat()  : string
Returns the sprintf() format for the string representation

Constants

UPLOADER_TYPE_INLINE

public mixed UPLOADER_TYPE_INLINE = 'Inline'

Properties

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance

protected static array<string|int, mixed> $localeCodes = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

Tags
see
getFallbackLocaleCodes()

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$options

protected array<string|int, mixed> $options = array('pl-Max-File-Size' => '')

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )

protected array<string|int, mixed> $validators = array()

$virtual

Defines if an entity is virtual and therefore not persistable.

protected bool $virtual = false

Defaults to FALSE - not virtual.

Methods

__call()

Route methods like getName(), getType(), getDirectory(), etc.

public __call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
$methodName : string

Name of method to call

$arguments : array<string|int, mixed>

List of arguments for the method to call

Tags
throws
Exception

If __call() nesting level reaches 20

Attributes
#[ReturnTypeWillChange]
Return values
mixed —

Return value of the method to call

__construct()

public __construct([mixed $id = '' ]) : mixed
Parameters
$id : mixed = ''

__get()

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.

public __get(mixed $name) : mixed
Parameters
$name : mixed
Attributes
#[ReturnTypeWillChange]

__toString()

Returns this entity's identifying value

public __toString() : string

By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.

Return values
string —

Identifying value for this entity

addClass()

Add a class to the button

public addClass(mixed $class) : self
Parameters
$class : mixed
Return values
self

destroy()

Drop the upload instance (it's session data) identified by ID $id.

public static destroy(string $id) : mixed

This should be called after the upload was successful and will no longer be used.

Parameters
$id : string

The ID of the upload instance to drop

getId()

Return's the uploader id

public getId() : string
Return values
string —

Uploader id

getKeyAsString()

Returns this entity's key

public final getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters
$separator : string = '/'

(optional) Separator for composite key fields, default "/"

Return values
string —

Entity key as string

getMaxFileSize()

Get the currently set upload file size limit

public getMaxFileSize() : string
Return values
string —

Set upload file size limit

getOption()

public getOption(mixed $option) : string
Parameters
$option : mixed
Return values
string

getOptionsString()

Get all options as a string.

public getOptionsString() : string
Return values
string

getTag()

Returns the tag name to be used when returning the uploader button

public getTag() : string
Return values
string —

Uploader button tag name

getTranslatedFieldValue()

Returns the value of a translatable field using fallback mechanisms

public getTranslatedFieldValue(string $fieldName) : mixed

If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):

  • Current locale
  • Default locale
  • All other locales
Parameters
$fieldName : string

Name of a translatable field

getXHtml()

public getXHtml([string $buttonName = 'Upload' ]) : string
Parameters
$buttonName : string = 'Upload'
Return values
string

initializeValidators()

Set $this->validators

public initializeValidators() : mixed

Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called

isValidId()

Verifies that the ID $id is a valid upload ID of the current user's session

public static isValidId(mixed $id) : bool
Parameters
$id : mixed
Return values
bool —

TRUE if the ID $id is valid, otherwise FALSE.

isVirtual()

Returns the virtuality of the entity

public isVirtual() : bool
Return values
bool —

TRUE if the entity is virtual, otherwise FALSE

setCallback()

Set a javascript callback on a global function.

public setCallback(string $string) : $this
Parameters
$string : string
Return values
$this

setData()

Add additional data for the uploader

public setData(mixed $data) : $this
Parameters
$data : mixed
Return values
$this

setFinishedCallback()

Saves the callback in the session.

public setFinishedCallback(mixed $callback) : $this
Parameters
$callback : mixed
Return values
$this

setMaxFileSize()

Set the maximum file size for the upload

public setMaxFileSize(string $type) : mixed
Parameters
$type : string

setOptions()

public setOptions(mixed $options) : mixed
Parameters
$options : mixed

setTag()

Sets the tag to use for the uploader button

public setTag(string $tag) : void
Parameters
$tag : string

Tag name to use for uploader button

setType()

public setType(string $type) : mixed
Parameters
$type : string

setUploadLimit()

Set a file upload limit.

public setUploadLimit(mixed $limit) : self
Parameters
$limit : mixed
Return values
self

setVirtual()

Set the virtuality of the entity

public setVirtual(bool $virtual) : mixed
Parameters
$virtual : bool

TRUE to set the entity as virtual or otherwise to FALSE

generateId()

Generate a new unique ID within the user's session

protected static generateId() : string
Return values
string —

Unique new ID

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order

protected getFallbackLocaleCodes() : array<string|int, mixed>
  • First entry is the current locale
  • Second entry is the default locale (if different from current, it's omitted otherwise)
  • Then all other locales follow (in no particular order)
Tags
todo

Order the array by the fallback order (same as in ContentManager)

Return values
array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid

protected getStringRepresentationBlank() : bool
Return values
bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation

protected getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation

protected getStringRepresentationFormat() : string
Return values
string —

sprintf() format string


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results