Dostęp do modelu obiektowego systemu eDokumenty:
Przykład pokazuje sposób zmiany statusu (tpstid) oraz oznaczenie dokumentu jako załatwiony:
include_once(MOD_PATH.'ADocuments/beans/Document.inc');
$doc_id = 123;
$document = Document::getInstance($doc_id);
if ($document->isReferenced()) {
$document->set('tpstid', 2);
$document->set('is_fix', TRUE);
$document->save();
}
Chodzi o formularz typu confir, który można wykorzystać w mechanizmie CustomWidget:
require_once(LIB_PATH.'widgets/ConfirmBox.inc');
// identyfikator sprawdzenia
$hwnd = Application::getShortName(__CLASS__.__LINE__);
// sprawdzenie czy przyszło potwierdzenie i jeśli jest i jest na Nie CONFIRM_NO
if (($confirmation = ConfirmBox::getConfirmation($hwnd)) AND ($confirmation == ConfirmBox::CONFIRM_NO)) {
// tutaj możesz coś zrobić jak users kliknął Nie
return FALSE;
}
// to samo się wywołuje i sprawdza
if (ConfirmBox::confirm($hwnd, Translator::translate('Treść pytania'), NULL, ConfirmBox::CONFIRM_YES|ConfirmBox::CONFIRM_NO, 'question.gif', NULL, NULL, 360, 150) == ConfirmBox::CONFIRM_YES) {
// tutaj możesz coś zrobić jak user dał Tak CONFIRM_YES
}
include_once(MOD_PATH.'ADocuments/beans/Document.inc');
$doc_id = 123;
$document = Document::getInstance($doc_id);
if ($document->isReferenced()) {
$document->set('tpstid', 2);
$document->set('is_fix', TRUE);
$document->save();
}
require_once('./commands/AddCommentCommand.inc'); $command = new AddCommentCommand(); $command->execute($bean, array('dscrpt' => 'test'.mktime(), 'notify' => 0));
Kod który należy dodać do komendy, by po jej wykonaniu odświeżyła się formatka.
JScript::add('App.DOCUMENTdlg'.$doc_id.'.refresh();');
Jak wywołać "dymek" informacyjny:
JScript::add('NewFrame.showInfo(\'Moja wiadomość\')'); // jeśli ma się pojawić nad konkretnym elementem JScript::add('BalloonHint.showAbove($(\'id elementu\'), \'Powiadomienie\', \'Treść powiadomienia\',220,null,BHS_LCLOSE,null,null,null,BHM_INFO)'); // jeśli nie zadziała metoda add należy użyć JScript::registerOnLoad('...');
Liczniki można wykorzystywać albo do samego generowania numeru, albo do generowania całego złożonego symbolu.
Metody API można wywołać również na lokalnym systemie: http://support.edokumenty.eu/trac/wiki/DeployerGuide/Others/eDokumentyApi/CompleteStage
require_once('./classes/eDokumentyApi/EDokApiClient.inc') $api = new EDokApi(); $api->completeStage(1,2);
Przykład tworzenia obiektu
$select = new ModernSelect('myselect'); $select->setCSSFormatting(NULL, 'width:200px; left:10px; top:10px; position:absolute;'); $select->setHTMLFormatting('onchange', 'App.mySelectOnChange(this.value);'); // Napełnianie ręczne $select->addItem(1, Translator::translate('One')); $select->addItem(2, Translator::translate('Two')); $select->addItem(3, Translator::translate('Three')); // Napełnianie z bazy $db = PgManager::getInstance(); $rows = $db->select('my_table', 'id____, text__', 'NOT is_del', false, PGSQL_ASSOC); if (is_array($rows) && !empty($rows)) { $select->addAssocArray($rows, 'id____', 'text__'); } $select->selectItem(2); $selest->selectItemOnEvent();
/**
* __construct
* Wymagany konstruktor aby lista domyslnych
* parametrow nie byla za dluga dla samej funkcji
*
* Uwaga parametr $setAllLabel i $choiceItem musza miec przemienne wartosci w
* innym przypadku gdy oba beda mialy TRUE priorytet ma $choiceItem
*
* @param boolean $setAllLabel czy ma dodac label -- wszyscy -- z wszystkimi id
* @param boolean $choiceItem czy ma byc label -- wybierz -- z NULL jako id
* @param boolean $unique czy gdzy sie powtorza to ma wywalac
* @return void
*/
public function __construct($setAllLabel = TRUE, $choiceItem = FALSE, $unique = FALSE, $allLabelText = NULL, $choiceItemText = NULL);
/**
* getDefaultData
*
* @access protected
* @return void
*/
protected function getDefaultData();
/**
* getKeyColumn
* Zwraca nazwe kolumny ktora jest aktualnie wykorzystywania przy
* pobieraniu danych i odpowiada kluczowi.
*
* Kolumna ta nie jest jednoznaczna z ta ktora jest w tablicy wynikowej
* i odpowiada za wartosc klucza (jest nia zawsze id____)
*
* @return string
*/
public function getKeyColumn();
/**
* getLabelColumn
* Zwraca nazwe kolumny ktora jest odpowiedzialna za wyswietlany
* opis. Kolumny moga byc inne dla kazdej metody zdefiniowanej
* w odpowiedniej klasie.
*
* Kolumna ta nie jest jednoznaczna z ta ktora jest w tablicy wynikowej
* i odpowiada za wartosc labela (jest nia zawsze text__)
*
* @return string
*/
public function getLabelColumn();
/**
* getAllData
* Pobiera dane wedlug standardowej konfiguracji klasy
* Zobacz metode getDefaultData tam sa dane
*
* @access public
* @return array
*/
public function getAllData();
/**
* getCustomData
* Metoda pobiera dane wedlug danej konfiguracji
* Jednak tabela pozostaje taka jaka zdefiniujemy w metodzie getDefaultData
* Zalecane jest aby jednak dopisywac odpowiednia metode do odpowiedniej klasy
* aby nie powielac kodu
*
* @param string $columns kolumny jakie zostana uzyte z zapytaniu
* @param string $keyColumn nazwa kolumny ktora bedzie kluczem w selecie
* @param string $textColumn nazwa kolumny ktora bedzie labelem w selecie
* @param string $statement warunek po jakim ma selectowac jesli wszystko to 1=1
* @param string $orderBy lista kolumn po ktorych nedzie sortowal np usrnam, firnam
* @return array
*/
public function getCustomData($columns, $keyColumn, $textColumn, $statement, $orderBy, $groupBy = FALSE);
/**
* getSQLQuery
* Zwraca wyłącznie jak wygląda zapytanie o listę danych.
* Przydatne w przypadku komponentu DBSelect.
*
* Data set konfiguruje zapytanie a DBSelect wyświetla ;)
*
* @access public
* @return void
*/
public function getSQLQuery();
/** Konstruktor
* Nadaje wartość domyślną, przywraca wartość ze schowka, przechwytuje wartość
* formularza HTML. Na żądanie waliduje czy pole puste.
* @param $name nazwa tagu INPUT
* @param $defaultValue domyślna wartość pola
* @param $mandatory flaga kontroli obowiązkowego wypełnienia
*/
function TextInput($name, $defaultValue = NULL, $mandatory = FALSE, $maxLength = NULL, $password = FALSE);
/** Set placeholder */
public function setPlaceholder($text) ;
/** Ustawia maksymalną długość treści pola */
function setMaxLength($maxLength);
/** Ustawia walidator z warunkiem niepustości */
function makeMandatory();
/** Pokazuje element HTML */
function show();
/** Ukrywa element HTML */
function hide();
/** Zwraca stan widoczności elementu HTML */
function isVisible();
/** Ustawia tryb tylko do odczytu elementu HTML
* przywrocone by tswienty potrzebne do disablowania formularzy
* @param $ro flaga read-only
*/
function setReadOnly($ro);
/** Ustawia element HTML do zapisu */
function enable();
/** Ustawia element HTML tylko do odczytu */
function disable();
/** Zwraca stan ustawienia do zapisu
* @return boolean dostępny do zapisu
*/
function isEnabled();
/** Zapamiętuje stan elementu */
function store();
/** Przywraca stan elementu */
function restore();
/** Ustawia wartość pola tagu
* @param $v wartość pola
*/
function setValue($v);
/** Zwraca zawartość pola tagu */
function getValue();
/** Czyści wartość pola tagu i ustawia flagę wyczyszczenia */
function reset();
/** Clear */
function clear();
/** Ustawia klasę i styl CSS tagu HTML
* @param $class string, klasa CSS
* @param $style string, styl inline CSS
*/
function setCSSFormatting($class = NULL, $style = NULL);
/** Ustawia parametry formatujące tag HTML
* Przykład: <code>setHtmlFormatting('width', '100%')</code>
* @param $k klucz tagu
* @param $v wartość klucza
*/
function setHtmlFormatting($k, $v);
/** Zwraca string formatujący tag HTML */
function getHtmlFormatting();
/** Ustawia fokus na elemencie, gdy user przesunie nad nim wskaźnik myszy
* @since 0.21.5
*/
function setHoverFocus();
/** Ustawia element, który będzie kliknięty po naciśnięciu Enter
* @since 0.21.5
*/
function setAutoSubmit($buttonName);
/** Ustawia warunek walidacji
* @param $regExp wyrażenie regularne walidujące
* @param $errorMsg komunikat błędu, domyślnie symbol wykrzyknika
*/
function setValidator($regExp, $errorMsg);
/** Waliduje
* @return boolean, wynik walidacji
*/
function isRequestValid();
/** Zwraca komunikat walidatora */
function getErrorMessage();
/** Ustawia komunikat błędu
* @param $errorMessage komunikat z błędem, domyślnie błąd z walidatora
* @since 0.21.4
*/
function setErrorMessage($errorMessage = TRUE);
/** Usuwa komunikat błędu
* @since 0.21.4
*/
function clearErrorMessage();
/** Get name */
function getName();
/** Serializuje do HTML */
function onEnterGoTo($domElement);
/** To HTML */
function toHtml();
require_once(LIB_PATH.'forms/DBSelect.inc');
$tpstid = new DBSelect('yourTpstidSelectName');
$tpstid->top = '10px';
$tpstid->left = '70px';
$tpstid->width = '200px';
$tpstid->query = 'SELECT tpstid, dscrpt FROM types_of_processes_states WHERE clsnam = \'FKDEMANDELEMENT\' ORDER BY dscrpt';
$tpstid->update();
require_once(LIB_PATH.'forms/CalendarInput.inc');
/* Wartość domyślna - bieżący czas */
$defaultValue = date('Y-m-d', time());
$adddat = new CalendarInput('yourInputName', $defaultValue);
$adddat->top = '10px';
$adddat->left = '10px';
$adddat->width = '90px';
/* Wersja tylko z datą */
$adddat->dateFormat = 'y-m-d';
/* Wersja z datą i godziną */
$adddat->dateFormat = 'y-m-d h:i';
require_once(LIB_PATH.'forms/PasswordInput.inc');
$passwd = new PasswordInput('yourInputName');
$passwd->setCSSFormatting(NULL, 'width:200px; top:10px;left:120px; position:absolute;');
require_once(LIB_PATH.'forms/ModernSelect.inc');
$list__ = new ModernSelect('yourInputName');
$list__->setCSSFormatting(NULL, 'width:200px; top:10px;left:120px; position:absolute;');
$list__->addItem({KEY}, {VALUE});
require_once(LIB_PATH.'forms/Label.inc');
require_once('./classes/LookupWidget/LookupWidget2.inc');
require_once('./classes/LookupWidget/Contact/ContactLookupManager.inc');
$this->lcontid = new Label($this->name.'lcontid');
$this->lcontid->top = '10px';
$this->lcontid->left = '370px';
$this->lcontid->width = '113px';
$this->lcontid->height = '20px';
$this->lcontid->text = CLIENT_NAME.':';
$this->contid = new LookupWidget2($this->name.'contid', new ContactSearchEngine(), FALSE, TRUE);
$this->contid->top = '10px';
$this->contid->left = '490px';
$this->contid->width = '280px';
// z opcją dodawania nowego plus dodtkowe komponenty
ContactLookupManager::manage($this->contid);
Id (usr_id) zalogowanego pracownika kryje się w sesji pod kluczem
SysContext::$usr_info['usr_id']
require_once(MOD_PATH.'CRegisters/beans/CRegisterEntry.inc'); $id____ = id wpisu w rejestrze; $tpstid = id statusu; $bean = new CRegisterEntry($id____); // tego ifa z zawartością można usunąć jeżeli bezwarunkowo chcemy zmienić status.. czyli bez sprawdzania uprawnień if ($bean->get('tpstid')) { $res = $this->db->select('types_of_processes_states', 'status,tpstnm', 'tpstid='.$bean->get('tpstid'), FALSE, PGSQL_ASSOC); if (is_array($res)) { $res = $res[0]; $stat = $res['status']; $desc = $res['tpstnm']; $can_change = ((($stat !== 'FINAL') && ($stat !== 'ACCEPTED')) || UserRights::checkSysAcc('bswfms.extras.privilages.status_change')); if (!$can_change) { if (($stat === 'ACCEPTED') && $bean->get('stcuid')) { if (!($can_change = UserRights::checkUsrAcc($bean->get('stcuid')))) { throw new UserRightsException(NULL, NULL, sprintf(Translator::translate('Zmianę statusu %s może dokonać osoba, która go ustawiła, jej przełożony lub inna osoba posiadająca prawo do stanowiska ustawiającego status.'), $desc)); } } } if (!$can_change) { throw new UserRightsException(NULL, NULL, sprintf(Translator::translate('Zmianę statusu %s może dokonać osoba posiadająca odpowiedni przywilej.'), $desc)); } } } $bean->set('tpstid', $tpstid); $bean->save();
require_once(MOD_PATH.'CRegisters/beans/CRegisterEntry.inc');
$id____ = FALSE; // jeśli edycja wpisu to podajemy id____
$cregid = 1; // podajemy id rejestru z tabli cregisters.register
$bean = new CRegisterEntry($id____, $cregid);
/* Każda kolumna wypełniania jest poprzez $bean->set. Nie musimy wypełnić wszystkich.
* $bean->set('tpstid', 1);
*/
$bean->save();
require_once(MOD_PATH.'CRegisters/services/CRegistersService.inc');
// wersja bezpieczna zalecana
$params = array(
'id____' => 1, // lub array(1, 2, 3) 1 wpis albo kolejne wpisy jako tablica
);
$srv = new CRegistersService();
$srv->deleteEntries($params);
// wersja mniej bezpieczna
$id____ = 1; // jeśli edycja wpisu to podajemy id____
$cregid = 1; // podajemy id rejestru z tabli cregisters.register
$bean = new CRegisterEntry($id____, $cregid);
$bean->delete();
require_once('./classes/FeatureBox/FeaturesHelper.inc');
$featureID = 1; // id cechy (features.featid)
$tblnam = 'contacts'; // nazwa tabeli bazowej (kolumna features.tblnam) zazwyczaj jest to nazwa tabeli w bazie, której dotyczą cechy wyjątkiem są dokumenty gdzie nazwa to types_of_documents_view
$tbl_id = 1; // identyfikator obiektu w systemie np. dla klientów jest to contid (contacts.contid)
$value = FeaturesHelper::getTextValue($featureID, $tblnam, $tbl_id);
require_once(LIB_PATH.'util/MapService.inc');
$clsnam = 'CONTACT'; // klasa obiektu aby zobaczyć wszystkie klasy można użyć metody $map = MapService::getMap();
$keyval = 1; // identyfikator danego obiektu jeśli chcemy utworzyć nowy wtedy $keyval = FALSE
$bean = MapService::getBean($clsnam, $keyval);
// ustawienie atrybutu
$bean->set('kolumna', 'wartość');
// zapisanie beana
$id = $bean->save();
// $id - w zależności od klasy oznacza doc_id, prc_id, contid
Tworząc szablony HTML/Flexy, bądź implementując akcje JavaScript w łatwy sposób można posługiwać się dialogami większości obiektów używając metody openDialogByCls.
Definicja:
/** * @param clsnam Text Identyfikator klasy obiektu * @param keyval Integer Identyfikator obiektu * @param op Text Dodatkowe parametry w formacie JSON */ App.openDialogByCls(clsnam, keyval, op)
Przykładowe wywołania:
// Otwarcie dialogu dokumentu o identyfikatorze doc_id = 991 App.openDialogByCls('DOCUMENT',991); // Otwarcie dialogu nowej wiadomości email z zainicjowanymi polami konta nadawcy, adresata i tematu App.openDialogByCls('EMAIL',0,({acntid:1,'to____':'support@edokumenty.eu','subjct':'Hello World!'}).toJSONString());
Główne klasy dialogów
Dialog | Wartość clsnam | Wartość keyval | Dodatkowe parametry |
Kontrahent w trybie podglądu | CONTACT | contacts.contid | |
Kontrahent w trybie edycji | CONTACT_EDIT | contacts.contid | |
Osoba kontaktowa | CONTACTPERSON | contact_persons.copeid | contid: identyfikator kontrahenta |
Sprawa | PROCESS | processes.prc_id | clsnam: identyfikator typu powiązanego obiektu (DOSS - teczka, PROCESS - sprawa nadrzędna) keyval: identyfikator obiektu powiązanego |
Dokument | DOCUMENT | documents.doc_id | dctpid: identyfikator typu dokumentu |
Wiadomość email | emails.eml_id | contid: identyfikator kontrahenta filtrujący lookup wyszukiwania adresata prc_id: identyfikator sprawy z którą zostanie powiązany zarchiwizowany email to____: adresaci w polu Do cc____: adresaci w polu Kopia bcc___: adresaci w polu Ukryta kopia subjct: temat wiadomości body__: treść wiadomości attchm: tablica tablic załączników (0 => ścieżka, 1 => nazwa, 2 => rozmiar) fileid: identyfikator pliku załącznika file_docid: identyfikator dokumentu, z którego pobrane zostaną wszystkie załączniki | |
Spotkanie | MEETING | events.evntid | |
Termin | EVENT | events.evntid | |
Zadanie | TODO | events.evntid | |
Rozmowa telefoniczna | PHONECALL | events.evntid | |
Adnotacja | EVENTNOTE | events.evntid | |
Alarm | ALARM | events.evntid | |
Wydarzenie korporacyjne | CORPEVENT | events.evntid | |
Podgląd pliku | ATTACHMENT_PREVIEW | files.fileid | |
Profil użytkownika | USERPROFILE | users.usr_id | |
Książka adresowa | ADDRESSBOOK | ||
Urządzenie | DEVICE | devices.devcid | |
Kampania | CAMPAIGN | campaigns.campid | |
Produkt | PRODUCT | depository.depoid | |
Projekt | PROJECT | projects.projid | |
Karta RCP | RCP | rcp_cards.rcp_id | |
Podgląd raportu | REPORT_VIEW | reports.reports.rep_id | parametry dla konkretnego raportu np.: FILTER_STRING:'grp_id = 1 AND NOT is_del' DATE_FROM:'2015-01-01' |
Pozycja rejestru | CREGISTER_ENTRY | cregisters.register_entry.id____ | parametry przykładowa dla nowego wpisu w rejestrze: {cregid:1,cre_id:4} |
Jeśli z jakiś przyczyn dla naszego skryptu to kółeczko się nie pojawi domyślnie trzeba wywołać kod JavaScript: Kręć się:
JScript::add('showLoadingDialog();');
Koniec kręcenia
JScript::add('hideLoadingDialog();');
Jeśli wywołanie JScript::add trzeba sprawdzić z JScript::registerOnLoad.