Class phpgw_interlink

Description

Inter module data linking manager for phpGroupWare

Located in /class.interlink.inc.php (line 34)


	
			
Method Summary
phpgw_interlink __construct ()
int add_link (string $app1, string $class1, int $id1, string $app2, string $class2, int $id2, [bool $private = true])
int count_links (string $app, string $clss, int $id)
bool delete_link (int $link_id)
array list_links (string $app, string $clss, int $id)
Methods
Constructor __construct (line 44)

Constructor

  • access: public
phpgw_interlink __construct ()
add_link (line 59)

Add a link

  • return: the new link id, or 0 on failure
  • access: public
int add_link (string $app1, string $class1, int $id1, string $app2, string $class2, int $id2, [bool $private = true])
  • string $app1: the first application (usually the source)
  • string $class1: the first class
  • int $id1: the first record id
  • string $app2: the second application (usually the target)
  • string $class2: the second class
  • int $id2: the second record id
  • bool $private: is the link private
count_links (line 71)

Count the number of records linked to a record

  • return: the number of links found
  • access: public
int count_links (string $app, string $clss, int $id)
  • string $app: the module to link to
  • string $clss: the class to link to
  • int $id: the id to link to
delete_link (line 80)

Delete a link

  • return: was the link deleted?
  • access: public
bool delete_link (int $link_id)
  • int $link_id: the link to delete
list_links (line 91)

List available links

  • return: list of links in the following format - ['link_id'] = array('app' => 'string', 'summary' => 'string', 'account_id' => int, 'view' => 'string', 'edit' => 'string')
  • access: public
array list_links (string $app, string $clss, int $id)
  • string $app: the module to link to
  • string $clss: the class to link to
  • int $id: the id to link to

Documentation generated on Mon, 29 Oct 2007 13:42:18 +1100 by phpDocumentor 1.4.0a2