\org_openpsa_relatedto_suspect

Class for finding suspected "related to" links

Note, that the request data, for ease of use, already contains the L10n Databases of the Component and MidCOM itself located in this class. They are stored as 'l10n' and 'l10n_midcom'. Also available as 'config' is the current component configuration.

Summary

Methods

Properties

Constants

__construct()
__get()
__isset()
set_active_leaf()
add_stylesheet()
get_workflow()
find_links_object()
find_links_object_component()
defaults_helper()

$_component
$_i18n
$_l10n
$_l10n_midcom
$_config

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$_services

N/A

File: lib/org/openpsa/relatedto/suspect.php
Package: org.openpsa.relatedto
Class hierarchy: \midcom_baseclasses_components_base

\midcom_baseclasses_components_purecode

\org_openpsa_relatedto_suspect

Properties

$_component

$_component : string

The name of the component, e.g. net.nehmer.static. Should be used whenever the component's name is required instead of hardcoding it.

Type

string

$_i18n

$_i18n : \midcom_services_i18n

A handle to the i18n service.

Type

\midcom_services_i18n

$_l10n

$_l10n : \midcom_services_i18n_l10n

The components' L10n string database.

Type

\midcom_services_i18n_l10n

$_l10n_midcom

$_l10n_midcom : \midcom_services_i18n_l10n

The global MidCOM string database.

Type

\midcom_services_i18n_l10n

$_config

$_config : \midcom_helper_configuration

The current configuration.

Type

\midcom_helper_configuration

$_services

$_services : array

Array that holds the already instantiated services

Type

array

Methods

__construct()

__construct()

Initialize all member variables, remember to set $_component before calling this constructor from your derived classes.

__get()

__get(  $field)

Parameters

$field

__isset()

__isset(  $field)

Parameters

$field

set_active_leaf()

set_active_leaf(  $leaf_id)

Parameters

$leaf_id

add_stylesheet()

add_stylesheet(string  $url, string  $media = false)

Convenience shortcut for adding CSS files

Parameters

string	$url	The stylesheet URL
string	$media	The media type(s) for the stylesheet, if any

get_workflow()

get_workflow(string  $identifier, array  $options = array()) : \midcom\workflow\dialog

Parameters

string	$identifier
array	$options

Returns

\midcom\workflow\dialog

find_links_object()

find_links_object(\midcom_core_dbaobject  $object,   $defaults = false)

Query all installed components for objects related to given object

If optional $defaults (org_openpsa_relatedto_dba object) is given it's used to fill default values for link objects returned.

NOTE: Only returns new suspected relations, confirmed/notrelated links are filtered out

returns array with the target object and prefilled link object

The see org.openpsa.projects for an example of how the component interface method org_openpsa_relatedto_find_suspects() should work.

Parameters

\midcom_core_dbaobject	$object
	$defaults

find_links_object_component()

find_links_object_component(\midcom_core_dbaobject  $object,   $component,   $defaults = false)

Query all specific component for objects related to given object

See org_openpsa_relatedto_suspect::find_links_object() for details

Parameters

\midcom_core_dbaobject	$object
	$component
	$defaults

defaults_helper()

defaults_helper(  $link,   $defaults,   $component = false,   $obj = false)

Fill properties of given $link object from given link object with defaults

Tries to be smart about the direction (inbound vs outbound) properties

Parameters

	$link
	$defaults
	$component
	$obj