PHP Functions

Jamroom's PHP functions are documented in the code: every function has a docblock describing its parameters and return value. The code is always right for the version you run, so read it there, in your editor.

The core functions are in modules/jrCore/lib/ (by topic: datastore.php, form.php, page.php, cache.php and so on) and modules/jrCore/include.php. Each module's own functions are in its include.php and lib/ folder. All are named after their module: jrCore_..., jrUser_..., jrProfile_....

An editor with PHP support, such as PhpStorm or VS Code with a PHP extension, shows a function's docblock on hover, and completes names as you type: type jrCore_db_ to see all the DataStore functions.

• Modules and settings: jrCore_module_is_active(), jrCore_get_config_value(), jrCore_get_module_url(), jrCore_trigger_event(), jrCore_logger()
• DataStore: jrCore_db_create_item(), jrCore_db_get_item(), jrCore_db_get_multiple_items(), jrCore_db_update_item(), jrCore_db_delete_item(), jrCore_db_search_items()
• Database: jrCore_db_table_name(), jrCore_db_escape(), jrCore_db_query(), jrCore_db_get_prefix()
• Caching and flags: jrCore_add_to_cache(), jrCore_is_cached(), jrCore_delete_all_cache_entries(), jrCore_set_flag(), jrCore_get_flag(), jrCore_delete_flag(), jrCore_set_temp_value(), jrCore_get_temp_value()
• Pages and forms: jrCore_page_banner(), jrCore_page_button(), jrCore_page_custom(), jrCore_page_table_header(), jrCore_page_table_row(), jrCore_page_table_footer(), jrCore_page_cancel_button(), jrCore_page_display(), jrCore_form_create(), jrCore_form_field_create(), jrCore_form_result(), jrCore_set_form_notice(), jrCore_get_form_notice()
• Templates and output: jrCore_parse_template(), jrCore_parse_email_templates(), jrCore_json_response(), jrCore_location(), jrCore_notice(), jrCore_strip_html()
• Users and access: jrUser_is_logged_in(), jrUser_is_admin(), jrUser_session_require_login(), jrUser_admin_only(), jrUser_master_only(), jrUser_can_edit_item(), jrProfile_is_profile_owner(), jrUser_load_lang_strings(), jrCore_validate_location_url(), jrCore_checktype()

jrCore_checktype($value, $type) checks that a value is of a type, and returns true or false. Use it to validate input. The types in 7.0.3:

allowed_html, core_string, url_name, file_name, valid_name, unique_name, printable, string, not_empty, multi_word, number, number_nn, number_nz, signed, float, price, is_true, is_false, onoff, yesno, email, url, domain, ip_address, private_ip_address, phone_number, date, date_birthday, age_range, hex, md5, sha1, json, array.

For example:

if (!jrCore_checktype($_post['id'], 'number_nz')) {
    jrCore_notice_page('error', 'invalid id');
}

number_nz is an integer of 1 or more, number_nn one of 0 or more, core_string letters, numbers and underscores, and url_name those plus dashes. The docblocks in modules/jrCore/lib/checktype.php describe each type.