394 lines
15 KiB
PHP
394 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* InputDocument.php
|
|
*
|
|
* @package workflow.engine.classes.model
|
|
*
|
|
* ProcessMaker Open Source Edition
|
|
* Copyright (C) 2004 - 2011 Colosa Inc.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* For more information, contact Colosa Inc, 2566 Le Jeune Rd.,
|
|
* Coral Gables, FL, 33134, USA, or email info@colosa.com.
|
|
*
|
|
*/
|
|
|
|
//require_once 'classes/model/om/BaseInputDocument.php';
|
|
//require_once 'classes/model/Content.php';
|
|
|
|
/**
|
|
* Skeleton subclass for representing a row from the 'INPUT_DOCUMENT' table.
|
|
*
|
|
*
|
|
*
|
|
* You should add additional methods to this class to meet the
|
|
* application requirements. This class will only be generated as
|
|
* long as it does not already exist in the input directory.
|
|
*
|
|
* @package workflow.engine.classes.model
|
|
*/
|
|
class InputDocument extends BaseInputDocument
|
|
{
|
|
|
|
/**
|
|
* This value goes in the content table
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $inp_doc_title_content = '';
|
|
|
|
/**
|
|
* This value goes in the content table
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $inp_doc_description_content = '';
|
|
|
|
/*
|
|
* Load the application document registry
|
|
* @param string $sAppDocUid
|
|
* @return variant
|
|
*/
|
|
public function load ($sInpDocUid)
|
|
{
|
|
try {
|
|
$oInputDocument = InputDocumentPeer::retrieveByPK( $sInpDocUid );
|
|
if (! is_null( $oInputDocument )) {
|
|
$aFields = $oInputDocument->toArray( BasePeer::TYPE_FIELDNAME );
|
|
$this->fromArray($aFields, BasePeer::TYPE_FIELDNAME);
|
|
return $aFields;
|
|
} else {
|
|
throw (new Exception( 'This row doesn\'t exist!' ));
|
|
}
|
|
} catch (Exception $oError) {
|
|
throw ($oError);
|
|
}
|
|
}
|
|
|
|
public function getByUid ($sInpDocUid)
|
|
{
|
|
try {
|
|
$oInputDocument = InputDocumentPeer::retrieveByPK( $sInpDocUid );
|
|
if (is_null( $oInputDocument )) {
|
|
return false;
|
|
}
|
|
|
|
$aFields = $oInputDocument->toArray( BasePeer::TYPE_FIELDNAME );
|
|
$this->fromArray( $aFields, BasePeer::TYPE_FIELDNAME );
|
|
return $aFields;
|
|
} catch (Exception $oError) {
|
|
throw ($oError);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create the application document registry
|
|
*
|
|
* @param array $aData
|
|
* @return string
|
|
*
|
|
*/
|
|
public function create ($aData)
|
|
{
|
|
$oConnection = Propel::getConnection( InputDocumentPeer::DATABASE_NAME );
|
|
try {
|
|
if (isset( $aData['INP_DOC_UID'] ) && $aData['INP_DOC_UID'] == '') {
|
|
unset( $aData['INP_DOC_UID'] );
|
|
}
|
|
if (! isset( $aData['INP_DOC_UID'] )) {
|
|
$aData['INP_DOC_UID'] = G::generateUniqueID();
|
|
}
|
|
$oInputDocument = new InputDocument();
|
|
$oInputDocument->fromArray( $aData, BasePeer::TYPE_FIELDNAME );
|
|
if ($oInputDocument->validate()) {
|
|
$oConnection->begin();
|
|
if (isset( $aData['INP_DOC_TITLE'] )) {
|
|
$oInputDocument->setInpDocTitleContent( $aData['INP_DOC_TITLE'] );
|
|
}
|
|
if (isset( $aData['INP_DOC_DESCRIPTION'] )) {
|
|
$oInputDocument->setInpDocDescriptionContent( $aData['INP_DOC_DESCRIPTION'] );
|
|
}
|
|
$iResult = $oInputDocument->save();
|
|
$oConnection->commit();
|
|
//Add Audit Log
|
|
switch ($aData['INP_DOC_FORM_NEEDED']){
|
|
case 'VIRTUAL':
|
|
$docType = 'Digital';
|
|
break;
|
|
case 'REAL':
|
|
$docType = 'Printed';
|
|
break;
|
|
case 'VREAL':
|
|
$docType = 'Digital/Printed';
|
|
break;
|
|
}
|
|
if(isset($aData['INP_DOC_VERSIONING']) && $aData['INP_DOC_VERSIONING'] == 1){
|
|
$enableVersion = 'Yes';
|
|
}else{
|
|
$enableVersion = 'No';
|
|
}
|
|
$description = "Input Document Title: ".$aData['INP_DOC_TITLE'].", Input Document Uid: ".$aData['INP_DOC_UID'].", Document Type: ".$docType;
|
|
if(!empty($aData['INP_DOC_DESCRIPTION'])){
|
|
$description .= ", Description: ".$aData['INP_DOC_DESCRIPTION'];
|
|
}
|
|
if(!empty($aData['INP_DOC_DESTINATION_PATH'])){
|
|
$description .= ", Destination Path: ".$aData['INP_DOC_DESTINATION_PATH'];
|
|
}
|
|
$inputDocMaxFileSize = "";
|
|
if(!empty($aData['INP_DOC_MAX_FILESIZE'])){
|
|
$inputDocMaxFileSize = $aData['INP_DOC_MAX_FILESIZE']? $aData['INP_DOC_MAX_FILESIZE'].' '.$aData['INP_DOC_MAX_FILESIZE_UNIT'] : "256 MB";
|
|
$inputDocMaxFileSize = ", Maximum Input Document file size: ".$inputDocMaxFileSize;
|
|
}
|
|
if(!empty($aData['INP_DOC_MAX_FILESIZE'])){
|
|
$description .= ", Extensions: ".$aData['INP_DOC_TYPE_FILE'];
|
|
}
|
|
$description .= $inputDocMaxFileSize;
|
|
G::auditLog("CreateInputDocument", $description);
|
|
|
|
return $aData['INP_DOC_UID'];
|
|
} else {
|
|
$sMessage = '';
|
|
$aValidationFailures = $oInputDocument->getValidationFailures();
|
|
foreach ($aValidationFailures as $oValidationFailure) {
|
|
$sMessage .= $oValidationFailure->getMessage() . '<br />';
|
|
}
|
|
throw (new Exception( 'The registry cannot be created!<br />' . $sMessage ));
|
|
}
|
|
} catch (Exception $oError) {
|
|
$oConnection->rollback();
|
|
throw ($oError);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update the application document registry
|
|
*
|
|
* @param array $aData
|
|
* @return string
|
|
*
|
|
*/
|
|
public function update ($aData)
|
|
{
|
|
$oConnection = Propel::getConnection( InputDocumentPeer::DATABASE_NAME );
|
|
try {
|
|
$oInputDocument = InputDocumentPeer::retrieveByPK( $aData['INP_DOC_UID'] );
|
|
if (! is_null( $oInputDocument )) {
|
|
$oInputDocument->fromArray( $aData, BasePeer::TYPE_FIELDNAME );
|
|
if ($oInputDocument->validate()) {
|
|
$oConnection->begin();
|
|
if (isset( $aData['INP_DOC_TITLE'] )) {
|
|
$oInputDocument->setInpDocTitleContent( $aData['INP_DOC_TITLE'] );
|
|
}
|
|
if (isset( $aData['INP_DOC_DESCRIPTION'] )) {
|
|
$oInputDocument->setInpDocDescriptionContent( $aData['INP_DOC_DESCRIPTION'] );
|
|
}
|
|
$iResult = $oInputDocument->save();
|
|
$oConnection->commit();
|
|
//Add Audit Log
|
|
$docType = '';
|
|
if(!empty($aData['INP_DOC_FORM_NEEDED'])) {
|
|
switch ($aData['INP_DOC_FORM_NEEDED']) {
|
|
case 'VIRTUAL':
|
|
$docType = 'Digital';
|
|
break;
|
|
case 'REAL':
|
|
$docType = 'Printed';
|
|
break;
|
|
case 'VREAL':
|
|
$docType = 'Digital/Printed';
|
|
break;
|
|
}
|
|
}
|
|
if(isset($aData['INP_DOC_VERSIONING']) && $aData['INP_DOC_VERSIONING'] == 1){
|
|
$enableVersion = 'Yes';
|
|
}else{
|
|
$enableVersion = 'No';
|
|
}
|
|
$description = '';
|
|
if (!empty( $aData['INP_DOC_TITLE'] )) {
|
|
$description = "Input Document Title: ".$aData['INP_DOC_TITLE'].", Input Document Uid: ".$aData['INP_DOC_UID'].", Document Type: ".$docType;
|
|
}
|
|
if(!empty($aData['INP_DOC_DESCRIPTION'])){
|
|
$description .= ", Description: ".$aData['INP_DOC_DESCRIPTION'];
|
|
}
|
|
if(!empty($aData['INP_DOC_DESTINATION_PATH'])){
|
|
$description .= ", Destination Path: ".$aData['INP_DOC_DESTINATION_PATH'];
|
|
}
|
|
$inputDocMaxFileSize = "";
|
|
if(!empty($aData['INP_DOC_MAX_FILESIZE'])){
|
|
$inputDocMaxFileSize = $aData['INP_DOC_MAX_FILESIZE']? $aData['INP_DOC_MAX_FILESIZE'].' '.$aData['INP_DOC_MAX_FILESIZE_UNIT'] : "256 MB";
|
|
$inputDocMaxFileSize = ", Maximum Input Document file size: ".$inputDocMaxFileSize;
|
|
}
|
|
if(!empty($aData['INP_DOC_MAX_FILESIZE'])){
|
|
$description .= ", Extensions: ".$aData['INP_DOC_TYPE_FILE'];
|
|
}
|
|
$description .= $inputDocMaxFileSize;
|
|
G::auditLog("UpdateInputDocument", $description);
|
|
|
|
return $iResult;
|
|
} else {
|
|
$sMessage = '';
|
|
$aValidationFailures = $oInputDocument->getValidationFailures();
|
|
foreach ($aValidationFailures as $oValidationFailure) {
|
|
$sMessage .= $oValidationFailure->getMessage() . '<br />';
|
|
}
|
|
throw (new Exception( 'The registry cannot be updated!<br />' . $sMessage ));
|
|
}
|
|
} else {
|
|
throw (new Exception( 'This row doesn\'t exist!' ));
|
|
}
|
|
} catch (Exception $oError) {
|
|
$oConnection->rollback();
|
|
throw ($oError);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Remove the application document registry
|
|
*
|
|
* @param array $aData
|
|
* @return string
|
|
*
|
|
*/
|
|
public function remove ($sInpDocUid)
|
|
{
|
|
$oConnection = Propel::getConnection( InputDocumentPeer::DATABASE_NAME );
|
|
try {
|
|
$oInputDocument = InputDocumentPeer::retrieveByPK( $sInpDocUid );
|
|
if (! is_null( $oInputDocument )) {
|
|
$nameInput = $oInputDocument->getInpDocTitle();
|
|
$descInput = $oInputDocument->getInpDocDescription();
|
|
$oConnection->begin();
|
|
Content::removeContent( 'INP_DOC_TITLE', '', $oInputDocument->getInpDocUid() );
|
|
Content::removeContent( 'INP_DOC_DESCRIPTION', '', $oInputDocument->getInpDocUid() );
|
|
$iResult = $oInputDocument->delete();
|
|
$oConnection->commit();
|
|
//Add Audit Log
|
|
G::auditLog("DeleteInputDocument", "Input Document Name: ".$nameInput.", Input Document Uid: ".$sInpDocUid.", Description: ".$descInput);
|
|
|
|
return $iResult;
|
|
} else {
|
|
throw (new Exception( 'This row doesn\'t exist!' ));
|
|
}
|
|
} catch (Exception $oError) {
|
|
$oConnection->rollback();
|
|
throw ($oError);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the [inp_doc_title_content] column value.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getInpDocTitleContent ()
|
|
{
|
|
if ($this->inp_doc_title_content == '') {
|
|
try {
|
|
$this->inp_doc_title_content = Content::load( 'INP_DOC_TITLE', '', $this->getInpDocUid(), (defined( 'SYS_LANG' ) ? SYS_LANG : 'en') );
|
|
} catch (Exception $oError) {
|
|
throw ($oError);
|
|
}
|
|
}
|
|
return $this->inp_doc_title_content;
|
|
}
|
|
|
|
/**
|
|
* Set the [inp_doc_title_content] column value.
|
|
*
|
|
* @param string $sValue new value
|
|
* @return void
|
|
*/
|
|
public function setInpDocTitleContent ($sValue)
|
|
{
|
|
if ($sValue !== null && ! is_string( $sValue )) {
|
|
$sValue = (string) $sValue;
|
|
}
|
|
if (in_array(InputDocumentPeer::INP_DOC_TITLE, $this->modifiedColumns) || $sValue === '') {
|
|
try {
|
|
$this->inp_doc_title_content = $sValue;
|
|
|
|
$iResult = Content::addContent( 'INP_DOC_TITLE', '', $this->getInpDocUid(), (defined( 'SYS_LANG' ) ? SYS_LANG : 'en'), $this->inp_doc_title_content );
|
|
} catch (Exception $oError) {
|
|
$this->inp_doc_title_content = '';
|
|
throw ($oError);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the [inp_doc_comment] column value.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getInpDocDescriptionContent ()
|
|
{
|
|
if ($this->inp_doc_description_content == '') {
|
|
try {
|
|
$this->inp_doc_description_content = Content::load( 'INP_DOC_DESCRIPTION', '', $this->getInpDocUid(), (defined( 'SYS_LANG' ) ? SYS_LANG : 'en') );
|
|
} catch (Exception $oError) {
|
|
throw ($oError);
|
|
}
|
|
}
|
|
return $this->inp_doc_description_content;
|
|
}
|
|
|
|
/**
|
|
* Set the [inp_doc_comment] column value.
|
|
*
|
|
* @param string $sValue new value
|
|
* @return void
|
|
*/
|
|
public function setInpDocDescriptionContent ($sValue)
|
|
{
|
|
if ($sValue !== null && ! is_string( $sValue )) {
|
|
$sValue = (string) $sValue;
|
|
}
|
|
if (in_array(InputDocumentPeer::INP_DOC_DESCRIPTION, $this->modifiedColumns) || $sValue === '') {
|
|
try {
|
|
$this->inp_doc_description_content = $sValue;
|
|
|
|
$iResult = Content::addContent( 'INP_DOC_DESCRIPTION', '', $this->getInpDocUid(), (defined( 'SYS_LANG' ) ? SYS_LANG : 'en'), $this->inp_doc_description_content );
|
|
} catch (Exception $oError) {
|
|
$this->inp_doc_description_content = '';
|
|
throw ($oError);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* verify if Input row specified in [DynUid] exists.
|
|
*
|
|
* @param string $sUid the uid of the Prolication
|
|
*/
|
|
|
|
public function InputExists ($sUid)
|
|
{
|
|
$con = Propel::getConnection( InputDocumentPeer::DATABASE_NAME );
|
|
try {
|
|
$oObj = InputDocumentPeer::retrieveByPk( $sUid );
|
|
if (is_object( $oObj ) && get_class( $oObj ) == 'InputDocument') {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
} catch (Exception $oError) {
|
|
throw ($oError);
|
|
}
|
|
}
|
|
}
|
|
// InputDocument
|
|
|