deprecated-3.0.php

Go to the documentation of this file.

<?php

use Elgg\Database\Entities;
use Elgg\Database\Clauses\OrderByClause;

function unset_config($name) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_remove_config().', '3.0');
    return elgg_remove_config($name);
}

function set_config($name, $value) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_save_config().', '3.0');
    return elgg_save_config($name, $value);
}

function get_config($name) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_get_config().', '3.0');
    return elgg_get_config($name);
}

function elgg_register_admin_menu_item($section, $menu_id, $parent_id = null, $priority = 100) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_register_menu_item().', '3.0');
    // make sure parent is registered
    if ($parent_id && !elgg_is_menu_item_registered('page', $parent_id)) {
        elgg_register_admin_menu_item($section, $parent_id);
    }

    // in the admin section parents never have links
    if ($parent_id) {
        $href = "admin/$parent_id/$menu_id";
    } else {
        $href = "admin/$menu_id";
    }

    $name = $menu_id;
    if ($parent_id) {
        $name = "$parent_id:$name";
    }

    return elgg_register_menu_item('page', [
        'name' => $name,
        'href' => $href,
        'text' => elgg_echo("admin:$name"),
        'context' => 'admin',
        'parent_name' => $parent_id,
        'priority' => $priority,
        'section' => $section
    ]);
}

function register_metadata_as_independent($type, $subtype = '*') {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Metadata no longer is access bound.', '3.0');
}

function is_metadata_independent($type, $subtype) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Metadata no longer is access bound.', '3.0');

    return false;
}

function elgg_get_entities_from_attributes(array $options = []) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_get_entities.', '3.0');

    $options['metadata_name_value_pairs'] = elgg_extract('attribute_name_value_pairs', $options, []);
    $options['metadata_name_value_pairs_operator'] = elgg_extract('attribute_name_value_pairs_operator', $options, []);

    unset($options['attribute_name_value_pairs']);
    unset($options['attribute_name_value_pairs_operator']);

    return elgg_get_entities($options);
}

function ban_user($user_guid, $reason = "") {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggUser::ban()', '3.0');

    $user = get_user($user_guid);
    if (!$user) {
        return false;
    }

    return $user->ban($reason);
}

function unban_user($user_guid) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggUser::unban()', '3.0');

    $user = get_user($user_guid);
    if (!$user) {
        return false;
    }

    return $user->unban();
}

function make_user_admin($user_guid) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggUser::makeAdmin()', '3.0');

    $user = get_user($user_guid);
    if (!$user) {
        return false;
    }

    return $user->makeAdmin();
}

function remove_user_admin($user_guid) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggUser::removeAdmin()', '3.0');

    $user = get_user($user_guid);
    if (!$user) {
        return false;
    }

    return $user->removeAdmin();
}

function elgg_get_user_validation_status($user_guid) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggUser::isValidated()', '3.0');

    $user = get_user($user_guid);
    if (!$user) {
        return false;
    }

    return $user->isValidated();
}

function elgg_set_user_validation_status($user_guid, $status, $method = '') {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggUser::setValidationStatus()', '3.0');

    $user = get_user($user_guid);
    if (!$user) {
        return false;
    }

    $user->setValidationStatus($status, $method);
    return true;
}

function set_last_action($user) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggUser::setLastAction()', '3.0');

    if (!$user instanceof ElggUser) {
        $user = get_user($user);
    }
    if (!$user) {
        return;
    }

    $user->setLastAction();
}

function set_last_login($user_guid) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggUser::setLastLogin()', '3.0');

    $user = get_user($user_guid);
    if (!$user) {
        return;
    }

    $user->setLastLogin();
}

function update_metadata($id, $name, $value, $value_type) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use ElggEntity setter or ElggEntity::setMetadata()', '3.0');

    $metadata = elgg_get_metadata_from_id($id);
    if (!$metadata) {
        return false;
    }

    $metadata->name = $name;
    $metadata->value_type = $value_type;
    $metadata->value = $value;

    return $metadata->save();
}

function create_metadata($entity_guid, $name, $value, $value_type = '', $ignored1 = null,
                         $ignored2 = null, $allow_multiple = false) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' is deprecated.
        Use ElggEntity setter or ElggEntity::setMetadata()',
        '3.0');

    $entity = get_entity($entity_guid);
    if (!$entity) {
        return false;
    }

    if ($allow_multiple) {
        return $entity->setMetadata($name, $value, $value_type, $allow_multiple);
    }

    $metadata = new ElggMetadata();
    $metadata->entity_guid = $entity_guid;
    $metadata->name = $name;
    $metadata->value_type = $value_type;
    $metadata->value = $value;
    return $metadata->save();
}

function get_user_access_collections($owner_guid) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \ElggEntity->getOwnedAccessCollections() or elgg_get_access_collections()', '3.0');

    return _elgg_services()->accessCollections->getEntityCollections(['owner_guid' => $owner_guid]);
}


function elgg_get_entities_from_metadata(array $options = []) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        elgg_get_entities() now accepts all metadata options.
    ', '3.0');

    return elgg_get_entities($options);
}

function elgg_list_entities_from_metadata($options) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated. Use elgg_list_entities().
    ', '3.0');

    return elgg_list_entities($options);
}

function elgg_get_entities_from_annotations(array $options = []) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        elgg_get_entities() now accepts all annotation options
    ', '3.0');

    return elgg_get_entities($options);
}

function elgg_list_entities_from_annotations($options = []) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated. Use elgg_list_entities().
    ', '3.0');
    return elgg_list_entities($options);
}


function elgg_get_entities_from_relationship($options) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        elgg_get_entities() now accepts all relationship options.
    ', '3.0');

    return elgg_get_entities($options);
}

function elgg_list_entities_from_relationship(array $options = []) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated. Use elgg_list_entities().
    ', '3.0');

    return elgg_list_entities($options);
}

function elgg_get_entities_from_private_settings(array $options = []) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        elgg_get_entities() now accepts all private settings options.
    ', '3.0');

    return elgg_get_entities($options);
}

function elgg_list_entities_from_access_id(array $options = []) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated. Use elgg_list_entities().
    ', '3.0');

    return elgg_list_entities($options);
}

function elgg_get_entities_from_access_id(array $options = []) {

    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use elgg_get_entities() with "access_ids" option.
    ', '3.0');

    // restrict the resultset to access collection provided
    if (!isset($options['access_id']) && !isset($options['access_ids'])) {
        return false;
    }

    return elgg_get_entities($options);
}

function elgg_get_entities_from_annotation_calculation($options) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use elgg_get_entities() with "annotation_sort_by_calculation" option.
        To sort in an ascending order, pass "order_by" => new OrderByClause("annotation_calculation", "asc")
    ', '3.0');

    if (empty($options['count'])) {
        $options['annotation_sort_by_calculation'] = elgg_extract('calculation', $options, 'sum', false);
    }
    return Entities::find($options);
}

function elgg_list_entities_from_annotation_calculation($options) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use elgg_list_entities() with "annotation_sort_by_calculation" option.
        To sort in an ascending order, pass "order_by" => new OrderByClause("annotation_calculation", "asc")
    ', '3.0');

    if (empty($options['count'])) {
        $options['annotation_sort_by_calculation'] = elgg_extract('calculation', $options, 'sum', false);
    }

    return elgg_list_entities($options, 'elgg_get_entities');
}


function _elgg_set_metastring_based_object_enabled_by_id($id, $enabled, $type) {

    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggAnnotation::enable()
    ', '3.0');

    if (!in_array($type, ['annotation', 'annotations'])) {
        return false;
    }

    $annotation = elgg_get_annotation_from_id($id);
    if (!$annotation) {
        return false;
    }

    if ($enabled === 'no' || $enabled === 0 || $enabled === false) {
        return $annotation->disable();
    } else if ($enabled === 'yes' || $enabled === 1 || $enabled === true) {
        return $annotation->enable();
    }

    return false;
}

function _elgg_get_metastring_based_object_from_id($id, $type) {

    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use elgg_get_metadata_from_id() and elgg_get_annotation_from_id()
    ', '3.0');

    $id = (int) $id;
    if (!$id) {
        return false;
    }

    if ($type == 'metadata') {
        $object = elgg_get_metadata_from_id($id);
    } else {
        $object = elgg_get_annotation_from_id($id);
    }

    return $object;
}

function _elgg_delete_metastring_based_object_by_id($id, $type) {

    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggMetadata::delete() and ElggAnnotation::delete()
    ', '3.0');

    switch ($type) {
        case 'annotations':
        case 'annotation':
            $object = elgg_get_annotation_from_id($id);
            break;

        case 'metadata':
            $object = elgg_get_metadata_from_id($id);
            break;

        default:
            return false;
    }

    if ($object) {
        return $object->delete();
    }

    return false;
}

function get_metadata_url($id) {
    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated and will be removed', '3.0');
    $metadata = elgg_get_metadata_from_id($id);
    if (!$metadata instanceof ElggMetadata) {
        return;
    }

    return $metadata->getURL();
}


function create_annotation($entity_guid, $name, $value, $value_type = '', $owner_guid = 0, $access_id = ACCESS_PRIVATE) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggAnnotation::save() or ElggEntity::annotate()
        ', '3.0'
    );

    $annotation = new ElggAnnotation();
    $annotation->entity_guid = $entity_guid;
    $annotation->name = $name;
    $annotation->value_type = $value_type;
    $annotation->value = $value;
    $annotation->owner_guid = $owner_guid;
    $annotation->access_id = $access_id;

    return $annotation->save();
}

function update_annotation($annotation_id, $name, $value, $value_type, $owner_guid, $access_id) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggAnnotation::save() or ElggEntity::annotate()
        ', '3.0'
    );

    $annotation = elgg_get_annotation_from_id($annotation_id);
    if (!$annotation) {
        return false;
    }

    $annotation->name = $name;
    $annotation->value_type = $value_type;
    $annotation->value = $value;
    $annotation->owner_guid = $owner_guid;
    $annotation->access_id = $access_id;

    return $annotation->save();
}

function elgg_batch_delete_callback($object) {
    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated.', '3.0');

    // our db functions return the number of rows affected...
    return $object->delete() ? true : false;
}

function sanitise_filepath($path, $append_slash = true) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use \\Elgg\\Project\\Paths::sanitize().', 3.0);

    return \Elgg\Project\Paths::sanitize($path, $append_slash);
}

function get_private_setting($entity_guid, $name) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggEntity::getPrivateSetting()
    ', '3.0');

    $ia = elgg_set_ignore_access(true);
    $entity = get_entity($entity_guid);
    elgg_set_ignore_access($ia);

    if (!$entity) {
        return null;
    }

    return $entity->getPrivateSetting($name);
}

function get_all_private_settings($entity_guid) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggEntity::getAllPrivateSettings()
    ', '3.0');

    $ia = elgg_set_ignore_access(true);
    $entity = get_entity($entity_guid);
    elgg_set_ignore_access($ia);

    if (!$entity) {
        return null;
    }

    return $entity->getAllPrivateSettings();
}

function set_private_setting($entity_guid, $name, $value) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggEntity::setPrivateSetting()
    ', '3.0');

    $ia = elgg_set_ignore_access(true);
    $entity = get_entity($entity_guid);
    elgg_set_ignore_access($ia);

    if (!$entity) {
        return false;
    }

    return $entity->setPrivateSetting($name, $value);
}

function remove_private_setting($entity_guid, $name) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggEntity::removePrivateSetting()
    ', '3.0');

    $ia = elgg_set_ignore_access(true);
    $entity = get_entity($entity_guid);
    elgg_set_ignore_access($ia);

    if (!$entity) {
        return null;
    }

    return $entity->removePrivateSetting($name);
}

function remove_all_private_settings($entity_guid) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use ElggEntity::removeAllPrivateSettings()
    ', '3.0');

    $ia = elgg_set_ignore_access(true);
    $entity = get_entity($entity_guid);
    elgg_set_ignore_access($ia);

    if (!$entity) {
        return null;
    }

    return $entity->removeAllPrivateSettings();
}

function elgg_batch_enable_callback($object) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Perform batch operations on members of the batch.
    ', '3.0');
    // our db functions return the number of rows affected...
    return $object->enable() ? true : false;
}

function elgg_batch_disable_callback($object) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Perform batch operations on members of the batch.
    ', '3.0');
    // our db functions return the number of rows affected...
    return $object->disable() ? true : false;
}

function elgg_register_page_handler($identifier, callable $function) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use elgg_register_route() to register a named route or define it in elgg-plugin.php',
        '3.0'
    );
    return _elgg_services()->routes->registerPageHandler($identifier, $function);
}

function elgg_unregister_page_handler($identifier) {
    elgg_deprecated_notice(
        __FUNCTION__ . ' has been deprecated.
        Use new routing API to register and unregister routes.',
        '3.0'
    );
    _elgg_services()->routes->unregisterPageHandler($identifier);
}

function gatekeeper() {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_gatekeeper()', '3.0');
    elgg_gatekeeper();
}

function admin_gatekeeper() {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_admin_gatekeeper()', '3.0');
    elgg_admin_gatekeeper();
}

function group_gatekeeper($forward = true, $page_owner_guid = null) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_group_gatekeeper()', '3.0');
    return elgg_group_gatekeeper($forward, $page_owner_guid);
}


function elgg_group_gatekeeper($forward = true, $group_guid = null) {
    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated. Use elgg_entity_gatekeeper()', '3.0');
    if (null === $group_guid) {
        $group_guid = elgg_get_page_owner_guid();
    }

    if (!$group_guid) {
        return true;
    }

    try {
        return elgg_entity_gatekeeper($group_guid);
    } catch (Exception $ex) {
        if ($forward) {
            throw $ex;
        } else {
            return false;
        }
    }
}

function get_data($query, $callback = null, array $params = []) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg()->db', '3.0');
    return elgg()->db->getData($query, $callback, $params);
}

function get_data_row($query, $callback = null, array $params = []) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg()->db', '3.0');
    return elgg()->db->getDataRow($query, $callback, $params);
}

function insert_data($query, array $params = []) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg()->db', '3.0');
    return elgg()->db->insertData($query, $params);
}

function update_data($query, array $params = [], $get_num_rows = false) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg()->db', '3.0');
    return elgg()->db->updateData($query, $get_num_rows, $params);
}

function delete_data($query, array $params = []) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg()->db', '3.0');
    return elgg()->db->deleteData($query, $params);
}

function register_translations($path, $load_all = false, $language = null) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated and should not be used', '3.0');

    return elgg()->translator->registerTranslations($path, $load_all, $language);
}

function reload_all_translations() {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated and should not be used', '3.0');

    return elgg()->translator->reloadAllTranslations();
}

function elgg_list_registered_entities(array $options = []) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg_list_entities()', '3.0');
    
    elgg_register_rss_link();
    
    $defaults = [
        'full_view' => false,
        'allowed_types' => true,
        'list_type_toggle' => false,
        'pagination' => true,
        'offset' => 0,
        'types' => [],
        'type_subtype_pairs' => [],
    ];
    
    $options = array_merge($defaults, $options);
    
    $types = get_registered_entity_types();
    
    foreach ($types as $type => $subtype_array) {
        if (in_array($type, $options['allowed_types']) || $options['allowed_types'] === true) {
            // you must explicitly register types to show up in here and in search for objects
            if ($type == 'object') {
                if (is_array($subtype_array) && count($subtype_array)) {
                    $options['type_subtype_pairs'][$type] = $subtype_array;
                }
            } else {
                if (is_array($subtype_array) && count($subtype_array)) {
                    $options['type_subtype_pairs'][$type] = $subtype_array;
                } else {
                    $options['type_subtype_pairs'][$type] = ELGG_ENTITIES_ANY_VALUE;
                }
            }
        }
    }
    
    if (!empty($options['type_subtype_pairs'])) {
        $count = elgg_get_entities(array_merge(['count' => true], $options));
        if ($count > 0) {
            $entities = elgg_get_entities($options);
        } else {
            $entities = [];
        }
    } else {
        $count = 0;
        $entities = [];
    }
    
    $options['count'] = $count;
    return elgg_view_entity_list($entities, $options);
}

function elgg_get_upgrade_file_version($filename) {
    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated. Use asynchronous upgrades instead', '3.0');

    preg_match('/^([0-9]{10})([\.a-z0-9-_]+)?\.(php)$/i', $filename, $matches);

    if (isset($matches[1])) {
        return (int) $matches[1];
    }

    return false;
}

function elgg_get_upgrade_files($upgrade_path = null) {
    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated. Use asynchronous upgrades instead', '3.0');

    if (!$upgrade_path) {
        $upgrade_path = elgg_get_engine_path() . '/lib/upgrades/';
    }
    $upgrade_path = \Elgg\Project\Paths::sanitize($upgrade_path);
    
    if (!is_dir($upgrade_path)) {
        return false;
    }
    $handle = opendir($upgrade_path);
    if (!$handle) {
        return false;
    }

    $upgrade_files = [];

    while (($upgrade_file = readdir($handle)) !== false) {
        // make sure this is a well formed upgrade.
        if (!is_file($upgrade_path . $upgrade_file)) {
            continue;
        }
        $upgrade_version = elgg_get_upgrade_file_version($upgrade_file);
        if (!$upgrade_version) {
            continue;
        }
        $upgrade_files[] = $upgrade_file;
    }

    sort($upgrade_files);

    return $upgrade_files;
}

function get_entity_dates($type = '', $subtype = '', $container_guid = 0, $ignored = 0, $order_by = 'e.time_created') {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated, please use elgg_get_entity_dates()', '3.0');
    
    $options = [
        'types' => $type,
        'subtypes' => $subtype,
        'container_guids' => $container_guid,
        'order_by' => [
            new OrderByClause($order_by),
        ],
    ];

    return elgg_get_entity_dates($options);
}

function add_group_tool_option($name, $options = []) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg()->group_tools service', '3.0');

    if (!is_array($options)) {
        $arguments = func_get_args();
        $options = [
            'label' => elgg_extract(1, $arguments),
            'default_on' => elgg_extract(2, $arguments),
            'priority' => null,
        ];
    }

    elgg()->group_tools->register($name, $options);
}

function remove_group_tool_option($name) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg()->group_tools service', '3.0');

    elgg()->group_tools->unregister($name);
}

function elgg_get_group_tool_options(\ElggGroup $group = null) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Use elgg()->group_tools service', '3.0');

    if ($group) {
        return elgg()->group_tools->group($group);
    }

    return elgg()->group_tools->all();
}