Icons.php

Go to the documentation of this file.

<?php

namespace Elgg\Traits\Entity;

use Elgg\Exceptions\InvalidArgumentException;
use Elgg\Exceptions\RangeException;

trait Icons {
    
    public function saveIconFromUploadedFile(string $input_name, string $type = 'icon', array $coords = []): bool {
        return _elgg_services()->iconService->saveIconFromUploadedFile($this, $input_name, $type, $coords);
    }
    
    public function saveIconFromLocalFile(string $filename, string $type = 'icon', array $coords = []): bool {
        return _elgg_services()->iconService->saveIconFromLocalFile($this, $filename, $type, $coords);
    }
    
    public function saveIconFromElggFile(\ElggFile $file, string $type = 'icon', array $coords = []): bool {
        return _elgg_services()->iconService->saveIconFromElggFile($this, $file, $type, $coords);
    }
    
    public function getIcon(string $size, string $type = 'icon'): \ElggIcon {
        return _elgg_services()->iconService->getIcon($this, $size, $type);
    }
    
    public function deleteIcon(string $type = 'icon'): bool {
        return _elgg_services()->iconService->deleteIcon($this, $type);
    }
    
    public function getIconLastChange(string $size, string $type = 'icon'): ?int {
        return _elgg_services()->iconService->getIconLastChange($this, $size, $type);
    }
    
    public function hasIcon(string $size, string $type = 'icon'): bool {
        return _elgg_services()->iconService->hasIcon($this, $size, $type);
    }
    
    public function getIconURL(string|array $params = []): string {
        return _elgg_services()->iconService->getIconURL($this, $params);
    }
    
    public function saveIconCoordinates(array $coords, string $type = 'icon'): void {
        // remove noise from the coords array
        $allowed_keys = ['x1', 'x2', 'y1', 'y2'];
        $coords = array_filter($coords, function($value, $key) use ($allowed_keys) {
            return in_array($key, $allowed_keys) && is_int($value);
        }, ARRAY_FILTER_USE_BOTH);
        
        if (!isset($coords['x1']) || !isset($coords['x2']) || !isset($coords['y1']) || !isset($coords['y2'])) {
            throw new InvalidArgumentException('Please provide correct coordinates [x1, x2, y1, y2]');
        }
        
        if ($coords['x1'] < 0 || $coords['x2'] < 0 || $coords['y1'] < 0 || $coords['y2'] < 0) {
            throw new RangeException("Coordinates can't have negative numbers");
        }
        
        $this->{"{$type}_coords"} = serialize($coords);
    }
    
    public function getIconCoordinates(string $type = 'icon'): array {
        if (!isset($this->{"{$type}_coords"})) {
            return [];
        }
        
        $coords = unserialize($this->{"{$type}_coords"}) ?: [];
        
        // cast to integers
        array_walk($coords, function(&$value) {
            $value = (int) $value;
        });
        
        // remove invalid values
        return array_filter($coords, function($value) {
            return $value >= 0;
        });
    }
    
    public function removeIconCoordinates(string $type = 'icon'): void {
        unset($this->{"{$type}_coords"});
    }
    
    public function lockIconThumbnailGeneration(string $type = 'icon'): void {
        $this->{"{$type}_thumbnail_locked"} = time();
    }
    
    public function isIconThumbnailGenerationLocked(string $type = 'icon', int $ttl = 30): bool {
        if (!isset($this->{"{$type}_thumbnail_locked"})) {
            return false;
        }
        
        $locked = (int) $this->{"{$type}_thumbnail_locked"};
        return $locked > (time() - $ttl);
    }
    
    public function unlockIconThumbnailGeneration(string $type = 'icon'): void {
        unset($this->{"{$type}_thumbnail_locked"});
    }
}