com\setasign\Konquadrat\Object\ObjectSet

ReferenceFinder

File: /Konquadrat/src/Object/ObjectSet/ReferenceFinder.php

Class hierarchy

Summary

Properties

$db

$objectConfig

$objectFinder

$objectTableManager


Methods

fetch()

public ReferenceFinder::fetch (
\com\setasign\Konquadrat\Object\ObjectSet $objectSet,
?\com\setasign\Konquadrat\Permission\PermissionControl $permissionControl,
null|string|array $fieldNames
): void

If $fieldNames is null all references will be resolved.

The $fieldNames array need to look like this:
$fieldNames = [
    'EventRelation' => ['Event', 'parent'],
    'Event', // load all references of containing event objects
];

If you're using a ObjectTemplate as type you can only resolve fields of this type.

Parameters
$objectSet: \com\setasign\Konquadrat\Object\ObjectSet
 
$permissionControl: ?\com\setasign\Konquadrat\Permission\PermissionControl
 
$fieldNames: null|string|array
 

fetchSmart()

public ReferenceFinder::fetchSmart (
\com\setasign\Konquadrat\Object\SmartObjectSet $objectSet,
?\com\setasign\Konquadrat\Permission\PermissionControl $permissionControl,
null|string|array $fieldNames
): array
Parameters
$objectSet: \com\setasign\Konquadrat\Object\SmartObjectSet
 
$permissionControl: ?\com\setasign\Konquadrat\Permission\PermissionControl
 
$fieldNames: null|string|array
 

getGroupedReferenceIds()

Returns the reference ids grouped by possible types

Parameters
$objectSet: \com\setasign\Konquadrat\Object\ObjectSet|\com\setasign\Konquadrat\Object\SmartObjectSet
 
$fieldNames: ?array
 
Return Values

Key is object type - Value is an array with the ids

loadReferences()

private ReferenceFinder::loadReferences (
int[] $ids,
string $allowedTargetType,
?\com\setasign\Konquadrat\Permission\PermissionControl $permissionControl
): \Generator
Parameters
$ids: int[]
 
$allowedTargetType: string
 
$permissionControl: ?\com\setasign\Konquadrat\Permission\PermissionControl