river.php

Go to the documentation of this file.

<?php
use Elgg\Exceptions\InvalidArgumentException as ElggInvalidArgumentException;

function elgg_create_river_item(array $options = []): ?\ElggRiverItem {
    $item = new \ElggRiverItem();
    $item->action_type = elgg_extract('action_type', $options);
    $item->view = elgg_extract('view', $options);
    $item->subject_guid = elgg_extract('subject_guid', $options, elgg_get_logged_in_user_guid());
    $item->object_guid = elgg_extract('object_guid', $options);
    $item->target_guid = elgg_extract('target_guid', $options);
    $item->annotation_id = elgg_extract('annotation_id', $options);
    $item->posted = elgg_extract('posted', $options);
    
    if (!$item->save()) {
        return null;
    }
    
    return $item;
}

function elgg_get_river(array $options = []) {
    return \Elgg\Database\River::find($options);
}

function elgg_get_river_item_from_id(int $id): ?\ElggRiverItem {
    return _elgg_services()->riverTable->get($id);
}

function elgg_delete_river(array $options = []): bool {

    $required = [
        'id', 'ids',
        'subject_guid', 'subject_guids',
        'object_guid', 'object_guids',
        'target_guid', 'target_guids',
        'annotation_id', 'annotation_ids',
        'view', 'views',
    ];

    $found = false;
    foreach ($required as $key) {
        // check that it exists and is something.
        if (isset($options[$key]) && !elgg_is_empty($options[$key])) {
            $found = true;
            break;
        }
    }

    if (!$found) {
        // requirements not met
        throw new ElggInvalidArgumentException(__METHOD__ . ' requires at least one of the following keys in $options: ' . implode(', ', $required));
    }

    return elgg_call(ELGG_IGNORE_ACCESS, function() use ($options) {
        $options['batch'] = true;
        $options['batch_size'] = 25;
        $options['batch_inc_offset'] = false;
    
        $river = elgg_get_river($options);
        $count = $river->count();
    
        if (!$count) {
            return true;
        }
    
        $success = 0;
        foreach ($river as $river_item) {
            if ($river_item->delete()) {
                $success++;
            }
        }
    
        return $success === $count;
    });
}

function elgg_list_river(array $options = []): string {
    $defaults = [
        'offset'     => (int) max(get_input('offset', 0), 0),
        'limit'      => (int) max(get_input('limit', max(20, _elgg_services()->config->default_limit)), 0),
        'pagination' => true,
        'list_class' => 'elgg-list-river',
    ];

    $options = array_merge($defaults, $options);
    
    $options['register_rss_link'] = elgg_extract('register_rss_link', $options, elgg_extract('pagination', $options));
    if ($options['register_rss_link']) {
        elgg_register_rss_link();
    }
    
    if (!$options['limit'] && !$options['offset']) {
        // no need for pagination if listing is unlimited
        $options['pagination'] = false;
    }
    
    $options['count'] = false;
    $items = elgg_get_river($options);
    $options['count'] = is_array($items) ? count($items) : 0;
    
    if (!empty($items)) {
        $count_needed = true;
        if (!$options['pagination']) {
            $count_needed = false;
        } elseif (!$options['offset'] && !$options['limit']) {
            $count_needed = false;
        } elseif (($options['count'] < (int) $options['limit']) && !$options['offset']) {
            $count_needed = false;
        }
        
        if ($count_needed) {
            $options['count'] = true;
        
            $options['count'] = (int) elgg_get_river($options);
        }
    }
    
    $options['items'] = $items;

    return elgg_view('page/components/list', $options);
}