deprecated-2.3.php

Go to the documentation of this file.

<?php

function ajax_forward_hook($hook, $type, $forward_url, $params) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated and is no longer used as a plugin hook handler', '2.3');
    
    if (!elgg_is_xhr()) {
        return;
    }

    // grab any data echo'd in the action
    $output = ob_get_clean();

    if ($type == 'walled_garden' || $type == 'csrf') {
        $type = '403';
    }

    $status_code = (int) $type;
    if ($status_code < 100 || ($status_code > 299 && $status_code < 400) || $status_code > 599) {
        // We only want to preserve OK and error codes
        // Redirect responses should be converted to OK responses as this is an XHR request
        $status_code = ELGG_HTTP_OK;
    }

    $response = elgg_ok_response($output, '', $forward_url, $status_code);

    $headers = $response->getHeaders();
    $headers['Content-Type'] = 'application/json; charset=UTF-8';
    $response->setHeaders($headers);

    _elgg_services()->responseFactory->respond($response);
    exit;
}

function ajax_action_hook() {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated and is no longer used as a plugin hook handler', '2.3');
    
    if (elgg_is_xhr()) {
        ob_start();
    }
}

function get_uploaded_file($input_name) {
    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated and will be removed', '2.3');
    $inputs = elgg_get_uploaded_files($input_name);
    $input = array_shift($inputs);
    if (!$input || !$input->isValid()) {
        return false;
    }
    return file_get_contents($input->getPathname());
}

function get_resized_image_from_uploaded_file($input_name, $maxwidth, $maxheight,
        $square = false, $upscale = false) {

    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated. Use elgg_save_resized_image()', '2.3');

    $file = _elgg_services()->request->getFile($input_name);
    if (empty($file)) {
        return false;
    }

    return get_resized_image_from_existing_file($file->getPathname(), $maxwidth, $maxheight, $square, 0, 0, 0, 0, $upscale);
}

function get_resized_image_from_existing_file($input_name, $maxwidth, $maxheight,
            $square = false, $x1 = 0, $y1 = 0, $x2 = 0, $y2 = 0, $upscale = false) {

    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated. Use elgg_save_resized_image()', '2.3');

    if (!is_readable($input_name)) {
        return false;
    }

    // we will write resized image to a temporary file and then delete it
    // need to add a valid image extension otherwise resizing fails
    $tmp_filename = tempnam(sys_get_temp_dir(), 'icon_resize');
    
    $params = [
        'w' => $maxwidth,
        'h' => $maxheight,
        'x1' => $x1,
        'y1' => $y1,
        'x2' => $x2,
        'y2' => $y2,
        'square' => $square,
        'upscale' => $upscale,
    ];

    $image_bytes = false;
    if (elgg_save_resized_image($input_name, $tmp_filename, $params)) {
        $image_bytes = file_get_contents($tmp_filename);
    }

    unlink($tmp_filename);

    return $image_bytes;
}

function get_image_resize_parameters($width, $height, array $params = []) {

    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated and will be removed from public API', '2.3');

    try {
        $params['w'] = elgg_extract('maxwidth', $params);
        $params['h'] = elgg_extract('maxheight', $params);
        unset($params['maxwidth']);
        unset($params['maxheight']);
        $params = _elgg_services()->imageService->normalizeResizeParameters($width, $height, $params);
        return [
            'newwidth' => $params['w'],
            'newheight' => $params['h'],
            'selectionwidth' => $params['x2'] - $params['x1'],
            'selectionheight' => $params['y2'] - $params['y1'],
            'xoffset' => $params['x1'],
            'yoffset' => $params['y1'],
        ];
    } catch (\LogicException $ex) {
        elgg_log($ex->getMessage(), 'ERROR');
        return false;
    }
}

function update_entity_last_action($guid, $posted = null) {
    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated. Refrain from updating last action timestamp manually', '2.3');

    $result = false;
    $ia = elgg_set_ignore_access(true);
    $entity = get_entity($guid);
    if ($entity) {
        $result = $entity->updateLastAction($posted);
    }
    elgg_set_ignore_access($ia);
    return $result;
}

function get_user_notification_settings($user_guid = 0) {

    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated by ElggUser::getNotificationSettings()', '2.3');

    if ((int) $user_guid == 0) {
        $user_guid = elgg_get_logged_in_user_guid();
    }

    $user = get_entity($user_guid);
    if (!$user instanceof \ElggUser) {
        return false;
    }

    return (object) $user->getNotificationSettings();
}

function set_user_notification_setting($user_guid, $method, $value) {
    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated by ElggUser::setNotificationSetting()', '2.3');

    if (!$user_guid) {
        $user_guid = elgg_get_logged_in_user_guid();
    }
    $user = get_entity($user_guid);
    if (!$user instanceof \ElggUser) {
        return false;
    }

    if (is_string($value)) {
        $value = strtolower($value);
    }
    if ($value == 'yes' || $value == 'on' || $value == 'enabled') {
        $value = true;
    } else if ($value == 'no' || $value == 'off' || $value == 'disabled') {
        $value = false;
    }

    return $user->setNotificationSetting($method, (bool) $value);
}

function elgg_error_page_handler($hook, $type, $result, $params) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Error pages are drawn by resource views without "forward" hook.', '2.3');
    
    // This draws an error page, and sometimes there's another 40* forward() call made during that process.
    // We want to allow the 2nd call to pass through, but draw the appropriate page for the first call.
    
    static $vars;
    if ($vars === null) {
        // keep first vars for error page
        $vars = [
            'type' => $type,
            'params' => $params,
        ];
    }

    static $calls = 0;
    $calls++;
    if ($calls < 3) {
        echo elgg_view_resource('error', $vars);
        exit;
    }

    // uh oh, may be infinite loop
    register_error(elgg_echo('error:404:content'));
    header('Location: ' . elgg_get_site_url());
    exit;
}

function elgg_view_input($input_type, array $vars = []) {

    elgg_deprecated_notice(__FUNCTION__ . '() is deprecated. Use elgg_view_field()', '2.3');

    $vars['#type'] = $input_type;

    if (isset($vars['label']) && $input_type !== 'checkbox') {
        $vars['#label'] = $vars['label'];
        unset($vars['label']);
    }
    if (isset($vars['help'])) {
        $vars['#help'] = $vars['help'];
        unset($vars['help']);
    }
    if (isset($vars['field_class'])) {
        $vars['#class'] = $vars['field_class'];
        unset($vars['field_class']);
    }

    return elgg_view_field($vars);
}

function sanitize_string($string) {
    return _elgg_services()->db->sanitizeString($string);
}

function sanitise_string($string) {
    return _elgg_services()->db->sanitizeString($string);
}

function sanitize_int($int, $signed = true) {
    return _elgg_services()->db->sanitizeInt($int, $signed);
}

function sanitise_int($int, $signed = true) {
    return sanitize_int($int, $signed);
}