EntityPreloader.php

Go to the documentation of this file.

<?php
 
namespace Elgg;
 
use Elgg\Cache\EntityCache;
use Elgg\Database\Entities;
 
class EntityPreloader {
    
    const MAX_PRELOAD = 256;
    
    public function __construct(protected EntityCache $entity_cache) {
    }
 
    public function preload(array $objects, array $guid_properties): void {
        $guids = $this->getGuidsToLoad($objects, $guid_properties);
        
        // If only 1 to load, not worth the overhead of elgg_get_entities(),
        // get_entity() will handle it later.
        if (count($guids) > 1) {
            Entities::find([
                'guids' => $guids,
                'limit' => self::MAX_PRELOAD,
                'order_by' => false,
            ]);
        }
    }
 
    protected function getGuidsToLoad(array $objects, array $guid_properties): array {
        if (count($objects) < 2) {
            return [];
        }
        
        $preload_guids = [];
        foreach ($objects as $object) {
            if (!is_object($object)) {
                continue;
            }
            
            foreach ($guid_properties as $property) {
                if (empty($object->{$property})) {
                    continue;
                }
                
                $guid = (int) $object->{$property};
                if ($guid && is_null($this->entity_cache->load($guid))) {
                    $preload_guids[] = $guid;
                }
            }
        }
        
        return array_unique($preload_guids);
    }
}