363 lines
14 KiB
PHP
363 lines
14 KiB
PHP
<?php
|
|
/*
|
|
* $License$
|
|
*/
|
|
/**
|
|
* @package API\UIKit
|
|
*/
|
|
class APIUIKitSample extends APIFactory {
|
|
protected $main_class = 'UIKitSampleFactory';
|
|
|
|
/**
|
|
* APIUIKitSample constructor.
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct(); //Make sure parent constructor is always called.
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get options for dropdown boxes.
|
|
* @param bool|string $name Name of options to return, ie: 'columns', 'type', 'status'
|
|
* @param mixed $parent Parent name/ID of options to return if data is in hierarchical format. (ie: Province)
|
|
* @return bool|array
|
|
*/
|
|
function getOptions( $name = false, $parent = null ) {
|
|
if ( $name == 'columns'
|
|
&& ( !$this->getPermissionObject()->Check( 'user', 'enabled' )
|
|
|| !( $this->getPermissionObject()->Check( 'user', 'view' ) || $this->getPermissionObject()->Check( 'user', 'view_own' ) || $this->getPermissionObject()->Check( 'user', 'view_child' ) ) ) ) {
|
|
$name = 'list_columns';
|
|
}
|
|
|
|
return parent::getOptions( $name, $parent );
|
|
}
|
|
|
|
/**
|
|
* Get default UIKitSample data for creating new UIKitSamples.
|
|
* @return array
|
|
*/
|
|
function getUIKitSampleDefaultData() {
|
|
$company_obj = $this->getCurrentCompanyObject();
|
|
|
|
Debug::Text( 'Getting UIKitSample default data...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$data = [
|
|
'company_id' => $company_obj->getId(),
|
|
'combo_box_parent' => 'CA',
|
|
'combo_box_child' => 'BC',
|
|
'combo_box' => 20,
|
|
'awesome_box_single' => TTUUID::getZeroID(),
|
|
'tag' => 'tag1,tag2,tag3',
|
|
'textarea' => 'This is a textarea',
|
|
'numeric_input' => 123.45,
|
|
'checkbox' => true,
|
|
'wysiwg_text' => '<p>This is <strong>bold text</strong>.</p>',
|
|
'date' => '21-Nov-98',
|
|
'date_range' => [ '27-Feb-96', '28-Sep-98' ],
|
|
'time' => '7:30 PM',
|
|
'color' => 'C0FFEE',
|
|
];
|
|
|
|
return $this->returnHandler( $data );
|
|
}
|
|
|
|
/**
|
|
* Get UIKitSample data for one or more UIKitSamples.
|
|
* @param array $data filter data
|
|
* @param bool $disable_paging
|
|
* @return array | bool
|
|
*/
|
|
function getUIKitSample( $data = null, $disable_paging = false ) {
|
|
$data = $this->initializeFilterAndPager( $data, $disable_paging );
|
|
|
|
if ( !$this->getPermissionObject()->Check( 'user', 'enabled' )
|
|
|| !( $this->getPermissionObject()->Check( 'user', 'view' ) || $this->getPermissionObject()->Check( 'user', 'view_own' ) || $this->getPermissionObject()->Check( 'user', 'view_child' ) ) ) {
|
|
return $this->getPermissionObject()->PermissionDenied();
|
|
}
|
|
|
|
$uiksf = TTnew( 'UIKitSampleListFactory' ); /** @var UIKitSampleListFactory $uiksf */
|
|
$uiksf->getAPISearchByCompanyIdAndArrayCriteria( $this->getCurrentCompanyObject()->getId(), $data['filter_data'], $data['filter_items_per_page'], $data['filter_page'], null, $data['filter_sort'] );
|
|
Debug::Text( 'Record Count: ' . $uiksf->getRecordCount(), __FILE__, __LINE__, __METHOD__, 10 );
|
|
if ( $uiksf->getRecordCount() > 0 ) {
|
|
$this->getProgressBarObject()->start( $this->getAPIMessageID(), $uiksf->getRecordCount() );
|
|
|
|
$this->setPagerObject( $uiksf );
|
|
|
|
$retarr = [];
|
|
foreach ( $uiksf as $b_obj ) {
|
|
$retarr[] = $b_obj->getObjectAsArray( $data['filter_columns'] );
|
|
|
|
$this->getProgressBarObject()->set( $this->getAPIMessageID(), $uiksf->getCurrentRow() );
|
|
}
|
|
|
|
$this->getProgressBarObject()->stop( $this->getAPIMessageID() );
|
|
|
|
return $this->returnHandler( $retarr );
|
|
}
|
|
|
|
return $this->returnHandler( true ); //No records returned.
|
|
}
|
|
|
|
/**
|
|
* Validate UIKitSample data for one or more UIKitSamples.
|
|
* @param array $data UIKitSample data
|
|
* @return array
|
|
*/
|
|
function validateUIKitSample( $data ) {
|
|
return $this->setUIKitSample( $data, true );
|
|
}
|
|
|
|
/**
|
|
* Set UIKitSample data for one or more UIKitSamples.
|
|
* @param array $data UIKitSample data
|
|
* @param bool $validate_only
|
|
* @param bool $ignore_warning
|
|
* @return array|bool
|
|
*/
|
|
function setUIKitSample( $data, $validate_only = false, $ignore_warning = true ) {
|
|
$validate_only = (bool)$validate_only;
|
|
$ignore_warning = (bool)$ignore_warning;
|
|
|
|
if ( !is_array( $data ) ) {
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
if ( $this->getPermissionObject()->checkAuthenticationType( 700 ) == false ) { //700=HTTP Auth with username/password
|
|
return $this->getPermissionObject()->AuthenticationTypeDenied();
|
|
}
|
|
|
|
if ( !$this->getPermissionObject()->Check( 'user', 'enabled' )
|
|
|| !( $this->getPermissionObject()->Check( 'user', 'edit' ) || $this->getPermissionObject()->Check( 'user', 'edit_own' ) || $this->getPermissionObject()->Check( 'user', 'edit_child' ) || $this->getPermissionObject()->Check( 'user', 'add' ) ) ) {
|
|
return $this->getPermissionObject()->PermissionDenied();
|
|
}
|
|
|
|
if ( $validate_only == true ) {
|
|
Debug::Text( 'Validating Only!', __FILE__, __LINE__, __METHOD__, 10 );
|
|
}
|
|
|
|
[ $data, $total_records ] = $this->convertToMultipleRecords( $data );
|
|
Debug::Text( 'Received data for: ' . $total_records . ' UIKitSamples', __FILE__, __LINE__, __METHOD__, 10 );
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$validator_stats = [ 'total_records' => $total_records, 'valid_records' => 0 ];
|
|
$validator = $save_result = []; $key = false;
|
|
if ( is_array( $data ) && $total_records > 0 ) {
|
|
$this->getProgressBarObject()->start( $this->getAPIMessageID(), $total_records );
|
|
|
|
foreach ( $data as $key => $row ) {
|
|
$primary_validator = new Validator();
|
|
$lf = TTnew( 'UIKitSampleListFactory' ); /** @var UIKitSampleListFactory $lf */
|
|
$lf->StartTransaction();
|
|
if ( isset( $row['id'] ) && $row['id'] != '' ) {
|
|
//Modifying existing object.
|
|
//Get UIKitSample object, so we can only modify just changed data for specific records if needed.
|
|
$lf->getByIdAndCompanyId( $row['id'], $this->getCurrentCompanyObject()->getId() );
|
|
if ( $lf->getRecordCount() == 1 ) {
|
|
//Object exists, check edit permissions
|
|
if (
|
|
$validate_only == true
|
|
||
|
|
(
|
|
$this->getPermissionObject()->Check( 'user', 'edit' )
|
|
|| ( $this->getPermissionObject()->Check( 'user', 'edit_own' ) && $this->getPermissionObject()->isOwner( $lf->getCurrent()->getCreatedBy(), $lf->getCurrent()->getID() ) === true )
|
|
) ) {
|
|
|
|
Debug::Text( 'Row Exists, getting current data for ID: ' . $row['id'], __FILE__, __LINE__, __METHOD__, 10 );
|
|
$lf = $lf->getCurrent();
|
|
$row = array_merge( $lf->getObjectAsArray(), $row );
|
|
} else {
|
|
$primary_validator->isTrue( 'permission', false, TTi18n::gettext( 'Edit permission denied' ) );
|
|
}
|
|
} else {
|
|
//Object doesn't exist.
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Edit permission denied, record does not exist' ) );
|
|
}
|
|
} else {
|
|
//Adding new object, check ADD permissions.
|
|
$primary_validator->isTrue( 'permission', $this->getPermissionObject()->Check( 'user', 'add' ), TTi18n::gettext( 'Add permission denied' ) );
|
|
|
|
//Because this class has sub-classes that depend on it, when adding a new record we need to make sure the ID is set first,
|
|
//so the sub-classes can depend on it. We also need to call Save( TRUE, TRUE ) to force a lookup on isNew()
|
|
$row['id'] = $lf->getNextInsertId();
|
|
}
|
|
Debug::Arr( $row, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
if ( $validate_only == true ) {
|
|
$lf->Validator->setValidateOnly( $validate_only );
|
|
}
|
|
|
|
$is_valid = $primary_validator->isValid();
|
|
if ( $is_valid == true ) { //Check to see if all permission checks passed before trying to save data.
|
|
Debug::Text( 'Setting object data...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
//Force Company ID to current company.
|
|
$row['company_id'] = $this->getCurrentCompanyObject()->getId();
|
|
|
|
$lf->setObjectFromArray( $row );
|
|
|
|
$is_valid = $lf->isValid( $ignore_warning );
|
|
if ( $is_valid == true ) {
|
|
Debug::Text( 'Saving data...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
if ( $validate_only == true ) {
|
|
$save_result[$key] = true;
|
|
} else {
|
|
$save_result[$key] = $lf->Save( true, true );
|
|
}
|
|
$validator_stats['valid_records']++;
|
|
}
|
|
}
|
|
|
|
if ( $is_valid == false ) {
|
|
Debug::Text( 'Data is Invalid...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$lf->FailTransaction(); //Just rollback this single record, continue on to the rest.
|
|
|
|
$validator[$key] = $this->setValidationArray( [ $primary_validator, $lf ] );
|
|
} else if ( $validate_only == true ) {
|
|
$lf->FailTransaction();
|
|
}
|
|
|
|
|
|
$lf->CommitTransaction();
|
|
|
|
$this->getProgressBarObject()->set( $this->getAPIMessageID(), $key );
|
|
}
|
|
|
|
$this->getProgressBarObject()->stop( $this->getAPIMessageID() );
|
|
|
|
return $this->handleRecordValidationResults( $validator, $validator_stats, $key, $save_result );
|
|
}
|
|
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
/**
|
|
* Delete one or more UIKitSample.
|
|
* @param array $data UIKitSample data
|
|
* @return array|bool
|
|
*/
|
|
function deleteUIKitSample( $data ) {
|
|
if ( !is_array( $data ) ) {
|
|
$data = [ $data ];
|
|
}
|
|
|
|
if ( !is_array( $data ) ) {
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
if ( $this->getPermissionObject()->checkAuthenticationType( 700 ) == false ) { //700=HTTP Auth with username/password
|
|
return $this->getPermissionObject()->AuthenticationTypeDenied();
|
|
}
|
|
|
|
if ( !$this->getPermissionObject()->Check( 'branch', 'enabled' )
|
|
|| !( $this->getPermissionObject()->Check( 'branch', 'delete' ) || $this->getPermissionObject()->Check( 'branch', 'delete_own' ) || $this->getPermissionObject()->Check( 'branch', 'delete_child' ) ) ) {
|
|
return $this->getPermissionObject()->PermissionDenied();
|
|
}
|
|
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' UIKitSample', __FILE__, __LINE__, __METHOD__, 10 );
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$total_records = count( $data );
|
|
$validator = $save_result = []; $key = false;
|
|
$validator_stats = [ 'total_records' => $total_records, 'valid_records' => 0 ];
|
|
if ( is_array( $data ) && $total_records > 0 ) {
|
|
$this->getProgressBarObject()->start( $this->getAPIMessageID(), $total_records );
|
|
|
|
foreach ( $data as $key => $id ) {
|
|
$primary_validator = new Validator();
|
|
$lf = TTnew( 'UIKitSampleListFactory' ); /** @var UIKitSampleListFactory $lf */
|
|
$lf->StartTransaction();
|
|
if ( $id != '' ) {
|
|
//Modifying existing object.
|
|
//Get UIKitSample object, so we can only modify just changed data for specific records if needed.
|
|
$lf->getByIdAndCompanyId( $id, $this->getCurrentCompanyObject()->getId() );
|
|
if ( $lf->getRecordCount() == 1 ) {
|
|
//Object exists, check edit permissions
|
|
if ( $this->getPermissionObject()->Check( 'branch', 'delete' )
|
|
|| ( $this->getPermissionObject()->Check( 'branch', 'delete_own' ) && $this->getPermissionObject()->isOwner( $lf->getCurrent()->getCreatedBy(), $lf->getCurrent()->getID() ) === true ) ) {
|
|
Debug::Text( 'Record Exists, deleting record ID: ' . $id, __FILE__, __LINE__, __METHOD__, 10 );
|
|
$lf = $lf->getCurrent();
|
|
} else {
|
|
$primary_validator->isTrue( 'permission', false, TTi18n::gettext( 'Delete permission denied' ) );
|
|
}
|
|
} else {
|
|
//Object doesn't exist.
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Delete permission denied, record does not exist' ) );
|
|
}
|
|
} else {
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Delete permission denied, record does not exist' ) );
|
|
}
|
|
|
|
//Debug::Arr($lf, 'AData: ', __FILE__, __LINE__, __METHOD__, 10);
|
|
|
|
$is_valid = $primary_validator->isValid();
|
|
if ( $is_valid == true ) { //Check to see if all permission checks passed before trying to save data.
|
|
Debug::Text( 'Attempting to delete record...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
$lf->setDeleted( true );
|
|
|
|
$is_valid = $lf->isValid();
|
|
if ( $is_valid == true ) {
|
|
Debug::Text( 'Record Deleted...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
$save_result[$key] = $lf->Save();
|
|
$validator_stats['valid_records']++;
|
|
}
|
|
}
|
|
|
|
if ( $is_valid == false ) {
|
|
Debug::Text( 'Data is Invalid...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$lf->FailTransaction(); //Just rollback this single record, continue on to the rest.
|
|
|
|
$validator[$key] = $this->setValidationArray( [ $primary_validator, $lf ] );
|
|
}
|
|
|
|
$lf->CommitTransaction();
|
|
|
|
$this->getProgressBarObject()->set( $this->getAPIMessageID(), $key );
|
|
}
|
|
|
|
$this->getProgressBarObject()->stop( $this->getAPIMessageID() );
|
|
|
|
return $this->handleRecordValidationResults( $validator, $validator_stats, $key, $save_result );
|
|
}
|
|
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
/**
|
|
* Copy one or more UIKitSample.
|
|
* @param array $data UIKktSample IDs
|
|
* @return array
|
|
*/
|
|
function copyUIKitSample( $data ) {
|
|
if ( !is_array( $data ) ) {
|
|
$data = [ $data ];
|
|
}
|
|
|
|
if ( !is_array( $data ) ) {
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' UIKitSample', __FILE__, __LINE__, __METHOD__, 10 );
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$src_rows = $this->stripReturnHandler( $this->getUIKitSample( [ 'filter_data' => [ 'id' => $data ] ], true ) );
|
|
if ( is_array( $src_rows ) && count( $src_rows ) > 0 ) {
|
|
Debug::Arr( $src_rows, 'SRC Rows: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
foreach ( $src_rows as $key => $row ) {
|
|
unset( $src_rows[$key]['id'] ); //Clear fields that can't be copied
|
|
$src_rows[$key]['text_input'] = Misc::generateCopyName( $row['text_input'] ); //Generate unique name
|
|
}
|
|
|
|
//Debug::Arr($src_rows, 'bSRC Rows: ', __FILE__, __LINE__, __METHOD__, 10);
|
|
|
|
return $this->setUIKitSample( $src_rows ); //Save copied rows
|
|
}
|
|
|
|
return $this->returnHandler( false );
|
|
}
|
|
}
|
|
|
|
?>
|