OpenPSA API Documentation
\
midcom
datamanager
extension
transformer
type
helper
indexer
storage
container
template
validation
dba
events
grid
provider
routing
workflow

\midcom_helper_nav_node

Summary

Methods
Properties
Constants
is_readable_by()
__get()
__set()
__isset()
is_object_visible()
get_data()
__construct()
get_subnodes()
get_leaves()
$subnodes
$guid
$id
$type
$name
$component
$url
$relativeurl
$absoluteurl
$fullurl
$permalink
$object
$noentry
$nodeid
No constants found
prepare_data()
get_cache()
$data
$loaded
N/A
translate_name()
write_leaves_to_cache()
load_data()
get_component_interface()
$topic
$topic_id
$backend
N/A

Properties

$subnodes

$subnodes : array

Type

array

$guid

$guid : string

Type

string

$id

$id : mixed

Type

mixed

$type

$type : string

Type

string

$name

$name : string

Type

string

$component

$component : string

Type

string

$url

$url : string

Type

string

$relativeurl

$relativeurl : string

Type

string

$absoluteurl

$absoluteurl : string

Type

string

$fullurl

$fullurl : string

Type

string

$permalink

$permalink : string

Type

string

$object

$object : mixed

Type

mixed

$noentry

$noentry : boolean

Type

boolean

$nodeid

$nodeid : integer

Type

integer

$data

$data :

Type

$loaded

$loaded :

Type

$topic

$topic :

Type

$topic_id

$topic_id :

Type

Methods

is_readable_by()

is_readable_by(  $user_id)

Parameters

$user_id

__get()

__get(  $name)

Parameters

$name

__set()

__set(string  $name, mixed  $value)

Magic setter. Also allows setting arbitrary non-constant keys for backward compatibility

Parameters

string $name
mixed $value

__isset()

__isset(  $name)

Parameters

$name

is_object_visible()

is_object_visible() : boolean

Checks if the NAP object is visible within the current runtime environment.

This includes checks for:

  • Nonexistent NAP information (null values)
  • Scheduling/Hiding (only on-site)
  • Approval (only on-site)

Returns

boolean —

Indicating visibility.

get_data()

get_data()

get_subnodes()

get_subnodes()

prepare_data()

prepare_data()

translate_name()

translate_name(  $name)

Parameters

$name

write_leaves_to_cache()

write_leaves_to_cache(array<mixed,\midcom_helper_nav_leaf>  $leaves)

Writes the passed leaves to the cache, assigning them to the specified node.

The function will bail out on any critical error. Data inconsistencies will be logged and overwritten silently otherwise.

Parameters

array<mixed,\midcom_helper_nav_leaf> $leaves

The leaves to store in the cache.

load_data()

load_data()