Page tree
Skip to end of metadata
Go to start of metadata

Diese API Klasse und deren Funktionen können mit dem TecArt-System ab Version 4.3 genutzt werden.

1. Methoden

1.1. addUserfield

Syntax:

int addUserfield( int $module, array $field )

Beschreibung:

Fügt ein benutzerdefiniertes Feld zum angegebenen Modul hinzu.

Gibt eine field_id zurück und wirft eine CRMException im Fehlerfall.

$module: Modul des benutzerdefinierten Feldes. Diese Variable muss einen der folgenden Integer-Werte beinhalten:

Wert   Modul
-------------------------------
  1    Kontakte
  2    Personen
  3    Projekte
  4    Verträge
  5    Angebote
  6    Tickets
  9    Ressourcen
 12    Artikel
 13    Rechnungskonten
 14    Ausgangsrechnungen
 15    Zahlungen
 18    Mahnungen
 20    Aufträge
 21    Lieferscheine
 22    Gutschriften
 29    Eingangsrechnungen
 30    Kassenbücher

$field ist ein assoziatives Array

Eigenschaften von $field:

Type(Length)            Eigenschaft                    Beschreibung
------------------------------------------------------------------------------------------------------------------
string(128)             $label                         angezeigter Feldname 
int                     $type                          Feldtyp
string(255)             $list                          Name der für Dropdown-Listen-Felder anzuzeigenden Liste
int                     $listsave                      Speichertyp für Dropdown-Listen-Felder (0 = Wert, 1 = Index)
string(255)             $stdvalue                      Standardwert
string(255)             $title                         Titel (Quickinfo)
int                     $obligatory                    Pflichtfeld (0 = Nein, 1 = Ja)
int                     $readonly                      Schreibgeschützt (0 = Nein, 1 = Ja)
int                     $size                          Feldgröße (Textlänge für Textfelder, Anzahl Nachkommastellen für Nummernfelder, Höhe für Listenfelder)
int                     $width                         Breite des Feldes in Pixel
int                     $pos                           Position (-1 = fixiert)
int                     $view                          Anzeigen (0 = Nein, 1 = Ja)
int                     $style                         Stil (0 = normal, 1 = fett, 2 = kursiv, 3 = unterstrichen)
int                     $hidelabel                     Bezeichnung ausblenden (0 = Nein, 1 = Ja)
int                     $grid_width                    Initial Spaltenbreite für Anzeige in Grids
int                     $keep_edit                     Bearbeitungsmodus nach Template-Wechsel beibehalten
int                     $listsorttype                  Sortierung von Listenfeldern (0 = Alphabetisch, 1 = Indexwert, 2 = Frei)
string(255)             $clickevent                    Click Event URL für Buttons
int                     $clickevent_new_window         Click Event URL in neuem Fenster öffnen
int                     $clickevent_window_scrollbars  Scrollbars in neuem Fenster anzeigen
int                     $clickevent_window_width       Breite des neuen Fensters in Pixel
int                     $clickevent_window_height      Höhe des neuen Fensters in Pixel
string(255)             $allow_grp                     Doppelpunkt-getrennt Liste der Gruppen-IDs mit Leseberechtigung ('' = Alle)
string(255)             $allow_grp_write               Doppelpunkt-getrennt Liste der Gruppen-IDs mit Schreibberechtigung ('' = Alle)

Feldtypen

Wert   Feldtyp
-------------------------------
  1    Text
  2    Nummer
  3    Datum
  4    Kontrollkästchen
  5    Dropdown-Liste
  6    Dropdown-Liste Mehrfachauswahl
  7    Währung
  8    Kontaktauswahl
  9    Projektauswahl
 10    Button
 11    Dropdown-Liste Template
 12    Ticketauswahl
 13    Vertragsauswahl
 14    Angebotsauswahl
 15    Textbereich
 17    Warengruppenauswahl
 18    Dropdown-Liste Drucklayout
 19    Rechnungskontoauswahl
 20    Artikelauswahl
 21    Auftragsauswahl
 23    Kostenstellenauswahl
 24    Datum mit Uhrzeit

Beispiel

<?php
 
$field = array(
	'type'  => 1, 
	'label' => 'Mein Textfeld',
	'pos'   => -1,
	'size'  => 10
);
 
try {
    $crmapi_fields = crmapi::fields();
    $field_id      = $crmapi_fields->addUserfield(1, $field);
} 
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo $field_id;

1.2. changeUserfield

Syntax:

boolean changeUserfield( int $module, int $field_id, array $field )

Beschreibung:

Ändert die Eigenschaften eines benutzerdefiniertes Feldes.

Gibt true zurück und wirft eine CRMException im Fehlerfall.

$module: Modul des benutzerdefinierten Feldes. (Eigenschaften siehe addUserfield)

$field_id: ID des zu ändernden Feldes.

$field ist ein assoziatives Array. (Eigenschaften siehe addUserfield)

Beispiel

<?php
 
$field = array(
	'type'  => 7, 
	'label' => 'Mein Währungsfeld',
	'size'  => 2
);
 
try {
    $crmapi_fields = crmapi::fields();
    $crmapi_fields->changeUserfield(1, 30, $field);
} 
catch (CRMException $e) {
    echo $e->getMessage();
}



1.3. removeUserfield

Syntax:

boolean removeUserfield( int $module, int $field_id )

Beschreibung:

Löscht ein benutzerdefiniertes Feld.

Gibt true zurück und wirft eine CRMException im Fehlerfall.

$module: Modul des benutzerdefinierten Feldes. (Eigenschaften siehe addUserfield)

$field_id: ID des zu löschenden Feldes.

Beispiel:

<?php
 
try {
    $crmapi_fields = crmapi::fields();
    $crmapi_fields->removeUserfield(1, 30);
} 
catch (CRMException $e) {
    echo $e->getMessage();
}



1.4. getFieldByID

Syntax:

array getFieldByID( int $module, int $field_id )

Beschreibung:

Gibt ein Array mit einem Feld-Element zurück.

Wirft eine CRMException im Fehlerfall.

$module: Modul des benutzerdefinierten Feldes. (Eigenschaften siehe addUserfield)

$field_id: ID des Feldes.

Eigenschaften des zurückgegebenen Feld-Elements:

Type(Length)            Eigenschaft                    Beschreibung
------------------------------------------------------------------------------------------------------------------
int                     $id                            ID des Feldes
string(128)             $label                         angezeigter Feldname 
string(128)             $field                         Name des Feldes
int                     $type                          Feldtyp
string(255)             $list                          Name der für Dropdown-Listen-Felder anzuzeigenden Liste
int                     $listsave                      Speichertyp für Dropdown-Listen-Felder (0 = Wert, 1 = Index)
string(255)             $stdvalue                      Standardwert
string(255)             $title                         Titel (Quickinfo)
int                     $obligatory                    Pflichtfeld (0 = Nein, 1 = Ja)
int                     $readonly                      Schreibgeschützt (0 = Nein, 1 = Ja)
int                     $size                          Feldgröße (Textlänge für Textfelder, Anzahl Nachkommastellen für Nummernfelder, Höhe für Listenfelder)
int                     $width                         Breite des Feldes in Pixel
int                     $pos                           Position (-1 = fixiert)
int                     $view                          Anzeigen (0 = Nein, 1 = Ja)
int                     $style                         Stil (0 = normal, 1 = fett, 2 = kursiv, 3 = unterstrichen)
int                     $hidelabel                     Bezeichnung ausblenden (0 = Nein, 1 = Ja)
int                     $grid_width                    Initial Spaltenbreite für Anzeige in Grids
int                     $keep_edit                     Bearbeitungsmodus nach Template-Wechsel beibehalten
int                     $listsorttype                  Sortierung von Listenfeldern (0 = Alphabetisch, 1 = Indexwert, 2 = Frei)
int                     $chguser                       User-Id der letzten Änderung
int                     $chgtime                       Unix-Timestamp der letzten Änderung
string(255)             $clickevent                    Click Event URL für Buttons
int                     $clickevent_new_window         Click Event URL in neuem Fenster öffnen
int                     $clickevent_window_scrollbars  Scrollbars in neuem Fenster anzeigen
int                     $clickevent_window_width       Breite des neuen Fensters in Pixel
int                     $clickevent_window_height      Höhe des neuen Fensters in Pixel
string(255)             $allow_grp                     Doppelpunkt-getrennt Liste der Gruppen-IDs mit Leseberechtigung ('' = Alle)
string(255)             $allow_grp_write               Doppelpunkt-getrennt Liste der Gruppen-IDs mit Schreibberechtigung ('' = Alle)

Beispiel

<?php
 
try {
    $crmapi_fields = crmapi::fields();
    $field = $crmapi_fields->getFieldByID(1, 30);
} 
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($field as $key => $value) {
    echo $key . " => " . $value . "<br>  ";
}



1.5. getFieldByName

Syntax:

array getFieldByName( int $module, string $fieldname )

Beschreibung:

Gibt ein Array mit einem Feld-Element zurück.

$module: Modul des benutzerdefinierten Feldes. (Eigenschaften siehe addUserfield)

$fieldname: Name des Feldes.

Eigenschaften des zurückgegebenen Feld-Elements siehe getFieldByID

Beispiel

<?php
 
try {
    $crmapi_fields = crmapi::fields();
    $field = $crmapi_fields->getFieldByName(1, 'user30');
} 
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($field as $key => $value) {
    echo $key . " => " . $value . "<br>  ";
}



1.6. getUserfields

Syntax:

array getUserfields( int $module )

Beschreibung:

Gibt ein Array mit einer Liste der benutzerdefinierten Felder des Moduls zurück.

$module: Modul der benutzerdefinierten Felder. (Eigenschaften siehe addUserfield)

Beispiel

<?php
 
try {
    $crmapi_fields = crmapi::fields();
    $fields = $crmapi_fields->getUserfields(1);
} 
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($fields as $field_id => $field_name) {
    echo $field_id . " => " . $field_name . "<br>  ";
}
  • No labels