216 lines
5.9 KiB
PHP
216 lines
5.9 KiB
PHP
<?php
|
|
/*+*******************************************************************************
|
|
* The contents of this file are subject to the vtiger CRM Public License Version 1.0
|
|
* ("License"); You may not use this file except in compliance with the License
|
|
* The Original Code is: vtiger CRM Open Source
|
|
* The Initial Developer of the Original Code is vtiger.
|
|
* Portions created by vtiger are Copyright (C) vtiger.
|
|
* All Rights Reserved.
|
|
******************************************************************************/
|
|
include_once('vtlib/Vtiger/Utils.php');
|
|
|
|
/**
|
|
* Provides API to work with vtiger CRM Module Blocks
|
|
* @package vtlib
|
|
*/
|
|
class Vtiger_Block {
|
|
/** ID of this block instance */
|
|
var $id;
|
|
/** Label for this block instance */
|
|
var $label;
|
|
|
|
var $sequence;
|
|
var $showtitle = 0;
|
|
var $visible = 0;
|
|
var $increateview = 0;
|
|
var $ineditview = 0;
|
|
var $indetailview = 0;
|
|
|
|
var $module;
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
function __construct() {
|
|
}
|
|
|
|
/**
|
|
* Get unquie id for this instance
|
|
* @access private
|
|
*/
|
|
function __getUniqueId() {
|
|
global $adb;
|
|
|
|
/** Sequence table was added from 5.1.0 */
|
|
$maxblockid = $adb->getUniqueID('vtiger_blocks');
|
|
return $maxblockid;
|
|
}
|
|
|
|
/**
|
|
* Get next sequence value to use for this block instance
|
|
* @access private
|
|
*/
|
|
function __getNextSequence() {
|
|
global $adb;
|
|
$result = $adb->pquery("SELECT MAX(sequence) as max_sequence from vtiger_blocks where tabid = ?", Array($this->module->id));
|
|
$maxseq = 0;
|
|
if($adb->num_rows($result)) {
|
|
$maxseq = $adb->query_result($result, 0, 'max_sequence');
|
|
}
|
|
return ++$maxseq;
|
|
}
|
|
|
|
/**
|
|
* Initialize this block instance
|
|
* @param Array Map of column name and value
|
|
* @param Vtiger_Module Instance of module to which this block is associated
|
|
* @access private
|
|
*/
|
|
function initialize($valuemap, $moduleInstance=false) {
|
|
$this->id = $valuemap[blockid];
|
|
$this->label= $valuemap[blocklabel];
|
|
$this->module=$moduleInstance? $moduleInstance: Vtiger_Module::getInstance($valuemap[tabid]);
|
|
}
|
|
|
|
/**
|
|
* Create vtiger CRM block
|
|
* @access private
|
|
*/
|
|
function __create($moduleInstance) {
|
|
global $adb;
|
|
|
|
$this->module = $moduleInstance;
|
|
|
|
$this->id = $this->__getUniqueId();
|
|
if(!$this->sequence) $this->sequence = $this->__getNextSequence();
|
|
|
|
$adb->pquery("INSERT INTO vtiger_blocks(blockid,tabid,blocklabel,sequence,show_title,visible,create_view,edit_view,detail_view)
|
|
VALUES(?,?,?,?,?,?,?,?,?)", Array($this->id, $this->module->id, $this->label,$this->sequence,
|
|
$this->showtitle, $this->visible,$this->increateview, $this->ineditview, $this->indetailview));
|
|
self::log("Creating Block $this->label ... DONE");
|
|
self::log("Module language entry for $this->label ... CHECK");
|
|
}
|
|
|
|
/**
|
|
* Update vtiger CRM block
|
|
* @access private
|
|
* @internal TODO
|
|
*/
|
|
function __update() {
|
|
self::log("Updating Block $this->label ... DONE");
|
|
}
|
|
|
|
/**
|
|
* Delete this instance
|
|
* @access private
|
|
*/
|
|
function __delete() {
|
|
global $adb;
|
|
self::log("Deleting Block $this->label ... ", false);
|
|
$adb->pquery("DELETE FROM vtiger_blocks WHERE blockid=?", Array($this->id));
|
|
self::log("DONE");
|
|
}
|
|
|
|
/**
|
|
* Save this block instance
|
|
* @param Vtiger_Module Instance of the module to which this block is associated
|
|
*/
|
|
function save($moduleInstance=false) {
|
|
if($this->id) $this->__update();
|
|
else $this->__create($moduleInstance);
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* Delete block instance
|
|
* @param Boolean True to delete associated fields, False to avoid it
|
|
*/
|
|
function delete($recursive=true) {
|
|
if($recursive) {
|
|
$fields = Vtiger_Field::getAllForBlock($this);
|
|
foreach($fields as $fieldInstance) $fieldInstance->delete($recursive);
|
|
}
|
|
$this->__delete();
|
|
}
|
|
|
|
/**
|
|
* Add field to this block
|
|
* @param Vtiger_Field Instance of field to add to this block.
|
|
* @return Reference to this block instance
|
|
*/
|
|
function addField($fieldInstance) {
|
|
$fieldInstance->save($this);
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Helper function to log messages
|
|
* @param String Message to log
|
|
* @param Boolean true appends linebreak, false to avoid it
|
|
* @access private
|
|
*/
|
|
static function log($message, $delim=true) {
|
|
Vtiger_Utils::Log($message, $delim);
|
|
}
|
|
|
|
/**
|
|
* Get instance of block
|
|
* @param mixed block id or block label
|
|
* @param Vtiger_Module Instance of the module if block label is passed
|
|
*/
|
|
static function getInstance($value, $moduleInstance=false) {
|
|
global $adb;
|
|
$instance = false;
|
|
|
|
$query = false;
|
|
$queryParams = false;
|
|
if(Vtiger_Utils::isNumber($value)) {
|
|
$query = "SELECT * FROM vtiger_blocks WHERE blockid=?";
|
|
$queryParams = Array($value);
|
|
} else {
|
|
$query = "SELECT * FROM vtiger_blocks WHERE blocklabel=? AND tabid=?";
|
|
$queryParams = Array($value, $moduleInstance->id);
|
|
}
|
|
$result = $adb->pquery($query, $queryParams);
|
|
if($adb->num_rows($result)) {
|
|
$instance = new self();
|
|
$instance->initialize($adb->fetch_array($result), $moduleInstance);
|
|
}
|
|
return $instance;
|
|
}
|
|
|
|
/**
|
|
* Get all block instances associated with the module
|
|
* @param Vtiger_Module Instance of the module
|
|
*/
|
|
static function getAllForModule($moduleInstance) {
|
|
global $adb;
|
|
$instances = false;
|
|
|
|
$query = "SELECT * FROM vtiger_blocks WHERE tabid=?";
|
|
$queryParams = Array($moduleInstance->id);
|
|
|
|
$result = $adb->pquery($query, $queryParams);
|
|
for($index = 0; $index < $adb->num_rows($result); ++$index) {
|
|
$instance = new self();
|
|
$instance->initialize($adb->fetch_array($result), $moduleInstance);
|
|
$instances[] = $instance;
|
|
}
|
|
return $instances;
|
|
}
|
|
|
|
/**
|
|
* Delete all blocks associated with module
|
|
* @param Vtiger_Module Instnace of module to use
|
|
* @param Boolean true to delete associated fields, false otherwise
|
|
* @access private
|
|
*/
|
|
static function deleteForModule($moduleInstance, $recursive=true) {
|
|
global $adb;
|
|
if($recursive) Vtiger_Field::deleteForModule($moduleInstance);
|
|
$adb->pquery("DELETE FROM vtiger_blocks WHERE tabid=?", Array($moduleInstance->id));
|
|
self::log("Deleting blocks for module ... DONE");
|
|
}
|
|
}
|
|
?>
|