Helper class that serves as a cache for OpenPSA site information

It locates topics for specific components used in OpenPSA and automatically generates a cached version of the site structure in the config snippet

package org.openpsa.core

 Methods

__construct ()

get_instance ()

Static

get_node_full_url (string $component)

Helper function to retrieve the full URL for the first topic of a given component

Parameters

$component

stringthe component to look for

Returns

mixedThe component URL or false

get_node_guid (string $component)

Helper function to retrieve the GUID for the first topic of a given component

Parameters

$component

stringthe component to look for

Returns

mixedthe component URL or false

get_node_relative_url (string $component)

Helper function to retrieve the relative URL for the first topic of a given component

Parameters

$component

stringThe component to look for

Returns

mixedthe component URL or false

node_exists (string $component)

Check if a node for a given component is available

Parameters

$component

stringthe component to look for

get ($type, $suffix)

Parameters

$type

$suffix

initialize_site_structure ()

load_snippet ()

Save the configuration to the config snippet

set_config_value (string $key, string $value)

Helper function to set the values in the config snippet

Parameters

$key

stringThe config key to set

$value

stringThe config value to set

 Properties

 

array $components

The components for which we're creating the structure information
 

mixed $data

 

\org_openpsa_core_siteconfig $instance

The singleton siteconfig instance
 

\midcom_db_snippet $snippet

The snippet we're working with