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

Die API Klasse für Bookmarks kann nur mit dem TecArt-System Version >= 3.5 genutzt werden.

1. Methoden

1.1. createFolder

Syntax:

int createFolder( array $data )

Beschreibung:

Gibt eine ID für den Ordner zurück.

Wirft eine CRMException im Fehlerfall.

Eigenschaften von $data array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     userid                       User ID
int                     parent                       ID des übergeordneten Ordners
string(255)             name                         Name des Ordners
int                     status
int                     ext_id                       Externe ID ( ab Version 4.2 )

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
    $tree_id = $crmapi_bookmarks->createFolder(
		array(
			"name"    => "Testordner",
			"parent"  => 71
		)
	);
	echo "Neuer Ordner: '$tree_id'";
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.2. getFolder

Syntax:

array getFolder( int $tree_id )

Beschreibung:

Gibt den Array mit den Daten für den Ordner mit der ID $tree_id zurück.

Wirft eine CRMException im Fehlerfall.

Eigenschaften von $data array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     userid                       User ID
int                     parent                       ID des übergeordneten Ordners
string(255)             name                         Name des Ordners
int                     doc
int                     status
int                     ext_id                       Externe ID ( ab Version 4.2 )

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$folder = $crmapi_bookmarks->getFolder(71);
 
	foreach($folder as $k => $v) {
		echo "$k => $v";
	}
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.3. getUserBookmarks

Syntax:

array getUserBookmarks( int $user_id )

Beschreibung:

Gibt ein Array mit allen Lesezeichen für den User mit der ID $user_id zurück.

Wenn $user_id kleiner als 1 ist, werden die Lesezeichen für den aktuellen Nutzer zurückgegeben.

Wirft eine CRMException im Fehlerfall.

Eigenschaften von return array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     id                           Lesezeichen ID
int                     userid                       User ID
int                     tree_id                      ID des übergeordneten Ordners
string(255)             name                         Name des Ordners
string(255)             address                      URL des Lesezeichens
int                     ext_id                       Externe ID ( ab Version 4.2 )

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$folders = $crmapi_bookmarks->getUserBookmarkTree(-1);
 
	foreach($folders as $id => $folder) {
		foreach($folder as $k => $v) {
			// $id und $v["id"] haben den gleichen Wert
			echo "$k => $v";
		}
	}
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.4. getUserBookmarkTree

Syntax:

array getUserBookmarkTree( int $user_id )

Beschreibung:

Gibt ein Array mit allen Lesezeichen-Ordnern für den User mit der ID $user_id zurück.

Wenn $user_id kleiner als 1 ist, werden die Ordner für den aktuellen Nutzer zurückgegeben.

Wirft eine CRMException im Fehlerfall.

Eigenschaften von return array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     userid                       User ID
int                     parent                       ID des übergeordneten Ordners
string(255)             name                         Name des Ordners
int                     doc
int                     status
int                     ext_id                       Externe ID ( ab Version 4.2 )

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$folders = $crmapi_bookmarks->getUserBookmarkTree(-1);
 
	foreach($folders as $folder) {
		foreach($folder as $k => $v) {
			echo "$k => $v";
		}
	}
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.5. renameFolder

Syntax:

void renameFolder( int $id, string $name )

Beschreibung:

Benennt den Ordner mit der ID $id nach $name um.

Wirft eine CRMException im Fehlerfall.

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$crmapi_bookmarks->renameFolder(71, "Umbenannter Ordnername");
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.6. moveFolder

Syntax:

void createFolder( int $tree_id, int $destination )

Beschreibung:

Verschiebt den Ordner mit der ID $tree_id in den Ordner mit der ID $destination.

Wirft eine CRMException im Fehlerfall.

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$crmapi_bookmarks->moveFolder(71, 23);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.7. removeFolder

Syntax:

void removeFolder( int $tree_id )

Beschreibung:

Löscht den Ordner mit der ID $tree_id.

Wirft eine CRMException im Fehlerfall.

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$crmapi_bookmarks->removeFolder(71);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.8. createBookmark

Syntax:

int createBookmark( array $data )

Beschreibung:

Gibt die ID des erstellten Lesezeichens zurück.

Wirft eine CRMException im Fehlerfall.

Eigenschaften von $data array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     userid                       User ID
int                     tree_id                      ID des übergeordneten Ordners
string(255)             name                         Name des Lesezeichens
string(255)             address                      URL des Lesezeichens
int                     ext_id                       Externe ID ( ab Version 4.2 )

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$b_id = $crmapi_bookmarks->createBookmark(
		array(
			"name"    => "Testlesezeichen",
			"parent"  => 71,
			"address" => "http://www.example.com"
		)
	);
	echo "Neues Lesezeichen: '$b_id'";
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.9. getBookmark

Syntax:

array getBookmark( int $id )

Beschreibung:

Gibt ein Array für das Lesezeichen mit der ID $id zurück.

Wirft eine CRMException im Fehlerfall.

Eigenschaften von return array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     id                           Lesezeichen ID
int                     userid                       User ID
int                     tree_id                      ID des übergeordneten Ordners
string(255)             name                         Name des Lesezeichens
string(255)             address                      URL des Lesezeichens
int                     ext_id                       Externe ID ( ab Version 4.2 )

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$bookmark = $crmapi_bookmarks->getBookmark(12);
 
	foreach ($bookmark as $k => $v) {
		echo "$k => $v";
	}
}
catch (CRMException $e) {
	echo $e->getMessage();
}


1.10. changeBookmark

Syntax:

void changeBookmark( int $id, array $data )

Beschreibung:

Überschreibt die Daten für das Lesezeichen mit der ID $id mit den Daten in $data.

$data kann die gleichen Eigenschaften wie für createBookmark enthalten

Wirft eine CRMException im Fehlerfall.

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$crmapi_bookmarks->changeBookmark(
		12, 
		array("name" => "Geändertes Lesezeichen")
	);
}
catch (CRMException $e) {
	echo $e->getMessage();
}


1.11. removeBookmark

Syntax:

void removeBookmark( int $id )

Beschreibung:

Löscht das Lesezeichen mit der ID $id.

Wirft eine CRMException im Fehlerfall.

Beispiel':

<?php
try {
	$crmapi_bookmarks = crmapi::bookmarks();
 
	$tree_id = $crmapi_bookmarks->removeBookmark(12);
}
catch (CRMException $e) {
	echo $e->getMessage();
}


1.12. getBookmarkIdByExtId

(Version >= 4.2)

Syntax:

array getBookmarkIdByExtId( int $external_id, int $user_id )

Beschreibung

Liefert interne ID(s) von Lesezeichen mit der übergebenen externen ID zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen bookmark ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			$id			      Bookmark-Id 

Beispiel:

<?php
 
try {
	$crmapi_bookmarks = crmapi::bookmarks();
   
	$result = $crmapi_bookmarks->getBookmarkIdByExtId(12345);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
    echo $id."<br>  ";
}



1.13. getAllBookmarkExtIds

(Version >= 4.2)

Syntax:

array getAllBookmarkExtIds( int $user_id )

Beschreibung

Liefert eine Liste aller externen IDs in Lesezeichen zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen bookmark ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			$id			      externe Bookmark-Id 

Beispiel:

<?php
 
try {   
    $crmapi_bookmarks = crmapi::bookmarks();
   
    $result = $crmapi_bookmarks->getAllBookmarkExtIds();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $id) {
    echo $id."<br>  ";
}



1.14. getBookmarkFolderIdByExtId

(Version >= 4.2)

Syntax:

array getBookmarkFolderIdByExtId( int $external_id, int $user_id )

Beschreibung

Liefert interne ID(s) von Lesezeichen-Ordner mit der übergebenen externen ID zurück.

$user_id enthält die ID des Benutzers, für den die Informationen abgerufen werden sollen. (0 wenn nicht gesetzt)

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen bookmark ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			$id			      Bookmark-Folder-Id 

Beispiel:

<?php
 
try {   
    $crmapi_bookmarks = crmapi::bookmarks();
   
    $result = $crmapi_bookmarks->getBookmarkFolderIdByExtId(12345);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $id) {
    echo $id."<br>  ";
}



1.15. getAllBookmarkFolderExtIds

(Version >= 4.2)

Syntax:

array getAllBookmarkFolderExtIds( int $user_id )

Beschreibung

Liefert eine Liste aller externen IDs in Lesezeichen-Ordner zurück.

$user_id enthält die ID des Benutzers, für den die Informationen abgerufen werden sollen. (0 wenn nicht gesetzt)

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen bookmark ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			$id			      externe Bookmark-Folder-Id 

Beispiel:

<?php
 
try {   
    $crmapi_bookmarks = crmapi::bookmarks();
  
    $result = $crmapi_bookmarks->getAllBookmarkFolderExtIds();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $id) {
    echo $id."<br>  ";
}
  • No labels