Dms_Document_Version_Attachment_Controller_Upload
extends Admin_Form_Action_Controller
in package
Dms_Document_Version_Attachment_Controller_Upload.
Tags
Table of Contents
Properties
- $_Admin_Form_Action : Admin_Form_Action_Model
- Form Action
- $_Admin_Form_Controller : Admin_Form_Controller
- Form controller
- $_allowedProperties : array<string|int, mixed>
- Allowed object properties
- $_children : array<string|int, mixed>
- Children entities list
- $_content : string
- Content
- $_datasetId : int
- Dataset ID
- $_message : string
- Message text
- $_object : object
- Object
- $_propertiesValues : array<string|int, mixed>
- Properties values
- $_unlimitedProperties : bool
- Object has unlimited number of properties
Methods
- __construct() : mixed
- Constructor.
- addAllowedProperties() : self
- Add additional allowed properties
- addAllowedProperty() : self
- Add additional allowed property
- addContent() : self
- Add content
- addEntity() : self
- Add entity
- addMessage() : self
- Add message
- clearContent() : self
- Clear content
- controller() : self
- Set Admin_Form_Controller
- execute() : bool
- Executes the business logic.
- factory() : object
- Create and return controller for current skin
- getChildren() : array<string|int, mixed>
- Get Children
- getContent() : object
- Get content
- getController() : Admin_Form_Controller
- Get Admin_Form_Controller
- getDatasetId() : int
- Get dataset ID
- getMessage() : self
- Get message
- getName() : string
- Get action name
- getObject() : object
- Get object
- set() : self
- Run when writing data to inaccessible properties
- setDatasetId() : mixed
- Set dataset ID
- setObject() : self
- Set object
- setUnlimitedProperties() : self
- Set unlimitedProperties
- _checkCsrf() : mixed
- Check CSRF token
- _checkNeedCreationOfVersion() : bool
- Check need creation of version
- _uploadFile() : Dms_Document_Version_Attachment_Model
- Upload file
Properties
$_Admin_Form_Action
Form Action
protected
Admin_Form_Action_Model
$_Admin_Form_Action
= \NULL
$_Admin_Form_Controller
Form controller
protected
Admin_Form_Controller
$_Admin_Form_Controller
= \NULL
$_allowedProperties
Allowed object properties
protected
array<string|int, mixed>
$_allowedProperties
= array('file', 'oDocument')
$_children
Children entities list
protected
array<string|int, mixed>
$_children
= array()
$_content
Content
protected
string
$_content
= \NULL
$_datasetId
Dataset ID
protected
int
$_datasetId
= \NULL
$_message
Message text
protected
string
$_message
= \NULL
$_object
Object
protected
object
$_object
= \NULL
$_propertiesValues
Properties values
protected
array<string|int, mixed>
$_propertiesValues
= array()
$_unlimitedProperties
Object has unlimited number of properties
protected
bool
$_unlimitedProperties
= \FALSE
Methods
__construct()
Constructor.
public
__construct(Admin_Form_Action_Model $oAdmin_Form_Action) : mixed
Parameters
- $oAdmin_Form_Action : Admin_Form_Action_Model
-
action
addAllowedProperties()
Add additional allowed properties
public
addAllowedProperties(array<string|int, mixed> $array) : self
Parameters
- $array : array<string|int, mixed>
-
array of properties' names
Return values
selfaddAllowedProperty()
Add additional allowed property
public
addAllowedProperty(string $property) : self
Parameters
- $property : string
-
property name
Return values
selfaddContent()
Add content
public
addContent(string $content) : self
Parameters
- $content : string
-
content
Return values
selfaddEntity()
Add entity
public
addEntity(Admin_Form_Entity $oAdmin_Form_Entity) : self
Parameters
- $oAdmin_Form_Entity : Admin_Form_Entity
Return values
selfaddMessage()
Add message
public
addMessage(mixed $message) : self
Parameters
- $message : mixed
-
message
Return values
selfclearContent()
Clear content
public
clearContent() : self
Return values
selfcontroller()
Set Admin_Form_Controller
public
controller(Admin_Form_Controller $oAdmin_Form_Controller) : self
Parameters
- $oAdmin_Form_Controller : Admin_Form_Controller
Return values
selfexecute()
Executes the business logic.
public
execute([mixed $operation = NULL ]) : bool
Parameters
- $operation : mixed = NULL
-
Operation name
Return values
boolfactory()
Create and return controller for current skin
public
static factory(string $className, Admin_Form_Action_Model $oAdmin_Form_Action) : object
Parameters
- $className : string
-
name of class
- $oAdmin_Form_Action : Admin_Form_Action_Model
-
action
Return values
objectgetChildren()
Get Children
public
getChildren() : array<string|int, mixed>
Return values
array<string|int, mixed>getContent()
Get content
public
getContent() : object
Return values
objectgetController()
Get Admin_Form_Controller
public
getController() : Admin_Form_Controller
Return values
Admin_Form_ControllergetDatasetId()
Get dataset ID
public
getDatasetId() : int
Return values
intgetMessage()
Get message
public
getMessage() : self
Return values
selfgetName()
Get action name
public
getName() : string
Return values
stringgetObject()
Get object
public
getObject() : object
Return values
objectset()
Run when writing data to inaccessible properties
public
set(string $property, string $value) : self
Parameters
- $property : string
-
property name
- $value : string
-
property value
Return values
selfsetDatasetId()
Set dataset ID
public
setDatasetId(int $datasetId) : mixed
Parameters
- $datasetId : int
-
ID of dataset
setObject()
Set object
public
setObject(object $object) : self
Parameters
- $object : object
-
object
Return values
selfsetUnlimitedProperties()
Set unlimitedProperties
public
setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
- $value : bool = TRUE
-
default TRUR
Return values
self_checkCsrf()
Check CSRF token
protected
_checkCsrf(string $secret_csrf) : mixed
Parameters
- $secret_csrf : string
_checkNeedCreationOfVersion()
Check need creation of version
protected
_checkNeedCreationOfVersion(array<string|int, mixed> $aFileNames) : bool
Parameters
- $aFileNames : array<string|int, mixed>
Return values
bool_uploadFile()
Upload file
protected
_uploadFile(string $tmpFile, string $fileName, bool $bCreateNewVersion) : Dms_Document_Version_Attachment_Model
Parameters
- $tmpFile : string
- $fileName : string
- $bCreateNewVersion : bool