API reference

classes

• yf_csrf_guard
  CSRF protection.
• yf_debug
  Debug console (DEBUG_MODE only): the panel at the end of the page, built from the debug() records of the request.
• yf_dir
  Filesystem utils.
• yf_graphics
  Core content-related methods stored here.
• yf_main
• yf_module
  Modules template class.
• yf_password
  Password hashing and verification shared by auth_user, auth_admin, the validators and the reset flow.
• yf_redirect
  Redirects handler.
• yf_router
  Incoming requests router.
• yf_security
  Security class, forked from codeigniter.
• yf_services
  Abstraction layer over YF services.
• yf_services_autoload
  Per-file lazy autoloader driven by services/<name>.lock.json (see yf_services_lock): class -> psr-4 / psr-0 / classmap index -> file under <vendor dir>/<vend...
• yf_services_lock
  Dependency lock of a services/ loader: walks the packagist p2 metadata of the loader's composer_names without composer, picks versions, prunes what the platf...
• yf_utf8
  Unicode methods.
• yf_utils
• yf_validate
  Validation common methods, part of this was inspired by codeigniter 2.1 form_validate.
• yf_wrapper_job
  Core jobs wrapper.

admin modules

• yf_admin
• yf_admin_account
• yf_admin_groups
  Admin groups handling class.
• yf_admin_modules
• yf_admin_wall
  Wall.

admin modules

• yf_admin_home
  Administrators home page.

classes

• yf_api
  module: api

classes

• yf_assets_filter_cssmin assets/
• yf_assets_filter_jsmin assets/
• yf_assets_filter_jsminplus assets/
• yf_assets
• yf_bs_theme
  Runtime layer of the internal Bootstrap 5 themes (assets/themes/): site themes and overrides of the shipped themes as a small stylesheet of `--bs-*` and comp...

admin modules

• yf_manage_assets

classes

• yf_auth_admin auth/
  Special methods for admin authentification.
• yf_auth_user auth/
  Special methods for user authentification.

classes

• yf_cache_driver cache/
• yf_cache_driver_apc cache/
• yf_cache_driver_db cache/
• yf_cache_driver_files cache/
• yf_cache_driver_memcache cache/
• yf_cache_driver_redis cache/
• yf_cache_driver_tmp cache/
• yf_cache
  Caching layer.
• yf_output_cache
  Class to handle output caching.

classes

• yf_cats
  Category display handler.

admin modules

• yf_category_editor

classes

• yf_charts_plugin_c3js charts/
• yf_charts_plugin_chartjs charts/
  Chart.js driver of the charts plugin: _class('charts')->chartjs($type, $data, $extra). The data goes to the page as JSON (never as JavaScript code), so label...
• yf_charts_plugin_flot charts/
• yf_charts_plugin_highcharts charts/
• yf_charts_plugin_morrisjs charts/
• yf_charts_plugin_nvd3 charts/
• yf_charts_plugin_sparkline charts/
• yf_charts

admin modules

• yf_ck_file_browser
• yf_ck_test

user modules

• yf_comments_integration comments/
  Comments integration.
• yf_comments_manage comments/
  Comments management.
• yf_comments
  Comments handler.

admin modules

• yf_manage_comments
  Comments management module.

classes

• yf_client_utils common/
  Some useful utils for the client (browser).
• yf_common_num2string common/
• yf_common_static_conf common/
• yf_common_tags_cloud common/
• yf_dashboards common/
  Dashboards for user.
• yf_diff common/
  Get file differences.
• yf_divide_pages common/
  Common used pager module.
• yf_email_page common/
  Email page handler.
• yf_image_manip common/
  Crop & rotate images.
• yf_intrusion_detection common/
  Intrusion detection methods here.
• yf_make_alphabet common/
  Generate alphabet for search names.
• yf_make_thumb common/
  Generating thumbs from images handler.
• yf_multi_accounts common/
  Check if given accounts has "multi_account" intersection.
• yf_multi_upload_image common/
  Multi Upload image handler.
• yf_other_common common/
  Other common methods container.
• yf_pdf_page common/
  PDF page view handler.
• yf_preview common/
  Class to handle output caching.
• yf_related_content common/
  Code for searching related content.
• yf_remote_files common/
• yf_rss_data common/
  RSS data handler.
• yf_spider_detection common/
  Spider detection code.
• yf_text_highlight common/
  Custom text hightlighting methods.
• yf_translit common/
  Translit from RU into EN.
• yf_upload_archive common/
  Archive file uploader.
• yf_upload_image common/
  Upload image handler.
• yf_url_to_absolute common/
• yf_user_ban common/
  User ban chacks.
• yf_utf8_clean common/
  Do clean UTF8-encoded text from unwanted chars.
• yf_common
  Class where most common used functions are stored.

user modules

• yf_advertising
• yf_browserconfigxml
• yf_crossdomainxml
• yf_robotstxt
• yf_sitemapxml
• yf_unsubscribe

admin modules

• yf_manage_conf
• yf_settings
  System settings interface.

classes

• yf_bb_codes
  BB codes handler.
• yf_captcha
  Class to handle CAPTCHA images (to prevent auto-registering, flooding etc).
• yf_resize_images
  Image resizing class.
• yf_upload_handler

user modules

• yf_faq
• yf_news

admin modules

• yf_manage_faq
• yf_manage_news
• yf_manage_tips

classes

• yf_dashboards2
  dashboards2 for user.

admin modules

• yf_manage_dashboards
• yf_manage_dashboards2
  Dashboards2 management.

classes

• yf_db_ddl_parser_mysql db/
• yf_db_driver db/
• yf_db_driver_mysql db/
• yf_db_driver_mysqli db/
• yf_db_driver_pdo db/
• yf_db_driver_pdo_mysql db/
• yf_db_driver_pdo_pgsql db/
• yf_db_driver_pgsql db/
• yf_db_installer db/
• yf_db_installer_mysql db/
• yf_db_installer_pgsql db/
• yf_db_migrator db/
• yf_db_migrator_mysql db/
• yf_db_migrator_pgsql db/
• yf_db_query_builder_driver db/
• yf_db_query_builder_mysql db/
  Query builder (Active Record) for mysql.
• yf_db_query_builder_pgsql db/
  Query builder (Active Record) for pgsql.
• yf_db_utils_driver db/
• yf_db_utils_helper_column db/
• yf_db_utils_helper_create_table db/
• yf_db_utils_helper_database db/
• yf_db_utils_helper_foreign_key db/
• yf_db_utils_helper_index db/
• yf_db_utils_helper_table db/
• yf_db_utils_helper_view db/
• yf_db_utils_mysql db/
• yf_db_utils_pgsql db/
  Schema utils for Postgres.
• yf_db
  Database abstraction layer.

admin modules

• yf_db_revisions
• yf_manage_revisions

classes

• yf_docs_api
  API reference of the docs site (/docs/api): the framework classes and global helpers, read by reflection.

user modules

• yf_docs

user modules

• yf_dynamic_assets dynamic/
• yf_dynamic_edit dynamic/
• yf_dynamic_find dynamic/
• yf_dynamic_image dynamic/
• yf_dynamic_lang dynamic/
• yf_dynamic_preview dynamic/
• yf_dynamic_validate dynamic/
• yf_dynamic

classes

• yf_mail_driver mail/
• yf_mail_driver_internal mail/
• yf_mail_driver_mailgun mail/
• yf_mail_driver_mandrill mail/
• yf_mail_driver_phpmailer mail/
• yf_mail_driver_sendgrid mail/
• yf_mail_driver_sendinblue mail/
• yf_mail_driver_ses mail/
• yf_mail_driver_simple mail/
• yf_mail_log mail/
• yf_email
  High level html emails wrapper.
• yf_send_mail
  Mail sender.

admin modules

• yf_manage_emails

classes

• yf_wrapper_ethereum
  Ethereum API wrapper.

classes

• yf_form2_ace_editor form2/
• yf_form2_auto form2/
• yf_form2_boxes form2/
• yf_form2_ckeditor form2/
• yf_form2_daterange form2/
• yf_form2_datetime form2/
• yf_form2_file_handler form2/
• yf_form2_google_maps form2/
• yf_form2_info form2/
• yf_form2_stars form2/
• yf_form2_tbl_funcs form2/
• yf_form2_tinymce form2/
• yf_form2_ui_range form2/
• yf_form2_upload form2/
• yf_form2_validate form2/
• yf_form2
• yf_form_api
  Form api.

classes

• yf_geo_ip
  GEO to IP handler.

user modules

• yf_geo_content

admin modules

• yf_manage_cities
  Cities management.
• yf_manage_countries
  Countries management.
• yf_manage_currencies
  Currencies management.
• yf_manage_geo_countries
• yf_manage_regions
  Regions management.

user modules

• yf_home_page
  Home page handling module.

classes

• yf_html_bs5 html/
  Bootstrap 5.3 markup of the yf_html widgets, used by yf_html when conf('css_framework') is bs5 (yf_html::_bs5()). Same signatures and options as the bs3 meth...
• yf_html_datetime html/
• yf_html_tree html/
• yf_html5fw_bs3 html5fw/
  Twitter bootstrap v3 html5 abstraction driver.
• yf_html5fw_bs4 html5fw/
  Twitter bootstrap v4 html5 abstraction driver.
• yf_html5fw_bs5 html5fw/
  Twitter bootstrap v5 html5 abstraction driver.
• yf_html5fw_empty html5fw/
• yf_html
  HTML high-level controls collection.
• yf_html5fw
  Abstraction layer over HTML5/CSS frameworks: conf('css_framework') = bs3 (default), bs4, bs5 or empty (no framework classes).

classes

• yf_htmx

classes

• yf_i18n
  Locale handler.

admin modules

• yf_locale_editor_autotranslate locale_editor/
• yf_locale_editor_cleanup locale_editor/
• yf_locale_editor_collect locale_editor/
• yf_locale_editor_export locale_editor/
• yf_locale_editor_import locale_editor/
• yf_locale_editor_langs locale_editor/
• yf_locale_editor_user_vars locale_editor/
• yf_locale_editor
• yf_manage_languages

classes

• yf_logs_auth_admin logs/
• yf_logs_auth_admin_fails logs/
• yf_logs_auth_user logs/
• yf_logs_auth_user_fails logs/
• yf_logs_ban logs/
• yf_logs_captcha logs/
• yf_logs_core_error logs/
• yf_logs_db_errors logs/
• yf_logs_db_queries logs/
• yf_logs_db_revisions logs/
• yf_logs_exec_admin logs/
• yf_logs_exec_user logs/
• yf_logs_i18n logs/
• yf_logs_mail logs/
• yf_logs_make_thumb logs/
• yf_logs_overload_detected logs/
• yf_logs_redirect logs/
• yf_logs_ssh logs/
• yf_logs_user_error logs/
  User errors handler.
• yf_logs_validation logs/
• yf_logs_webshell logs/
• yf_logger
  Application logger with the PSR-3 method set, usable as logger().
• yf_logger_psr
• yf_logs
  Logging some common actions.

admin modules

• yf_log_admin_auth
  Admin "log in" info analyser.
• yf_log_admin_auth_fails
  Log authentification fails viewer.
• yf_log_admin_exec
• yf_log_admin_redirects
• yf_log_user_auth
  Users "log in" info analyser.
• yf_log_user_auth_fails
  Log authentification fails viewer.
• yf_log_user_redirects

classes

• yf_wrapper_memcached
  Memcached API wrapper.

user modules

• yf_notifications

admin modules

• yf_manage_notifications
• yf_notifications_admin

classes

• yf_oauth_driver1 oauth/
• yf_oauth_driver2 oauth/
• yf_oauth_driver_bitbucket oauth/
• yf_oauth_driver_bitly oauth/
• yf_oauth_driver_box oauth/
• yf_oauth_driver_disqus oauth/
• yf_oauth_driver_dropbox oauth/
• yf_oauth_driver_facebook oauth/
• yf_oauth_driver_flickr oauth/
• yf_oauth_driver_foursquare oauth/
• yf_oauth_driver_github oauth/
• yf_oauth_driver_google oauth/
• yf_oauth_driver_heroku oauth/
• yf_oauth_driver_instagram oauth/
• yf_oauth_driver_linkedin oauth/
• yf_oauth_driver_live oauth/
• yf_oauth_driver_steamcommunity oauth/
• yf_oauth_driver_twitter oauth/
• yf_oauth_driver_vimeo oauth/
• yf_oauth_driver_wordpress oauth/
• yf_oauth

classes

• yf_payment_api
• yf_payment_api__currency
• yf_payment_api__provider
• yf_payment_api__provider_administration
• yf_payment_api__provider_bitaps
• yf_payment_api__provider_bitcoin
• yf_payment_api__provider_bitpay
• yf_payment_api__provider_ecommpay
• yf_payment_api__provider_interkassa
• yf_payment_api__provider_liqpay
• yf_payment_api__provider_nowpayments
• yf_payment_api__provider_payeer
• yf_payment_api__provider_perfectmoney
• yf_payment_api__provider_privat24
• yf_payment_api__provider_remote
• yf_payment_api__provider_remote_test
• yf_payment_api__provider_system
• yf_payment_api__provider_test
• yf_payment_handler

user modules

• yf_payment
• yf_payment__user yf_payment/
• yf_payment_test

admin modules

• yf_manage_currency
• yf_manage_deposit
• yf_manage_payment
• yf_manage_payment_lib
• yf_manage_payment_operation
• yf_manage_payout
• yf_manage_transfer

classes

• yf_pubsub_driver pubsub/
• yf_pubsub_driver_rabbitmq pubsub/
• yf_pubsub_driver_redis pubsub/
• yf_wrapper_pubsub
  Core PUB/SUB events wrapper.

classes

• yf_queue_driver queue/
• yf_queue_driver_redis queue/
• yf_wrapper_queue
  Core queue wrapper.

classes

• yf_wrapper_rabbitmq
  Rabbitmq API wrapper.

classes

• yf_wrapper_redis
  Redis API wrapper.
• yf_wrapper_redlock
  Relock algorithm http://antirez.com/news/77 Forked from https://github.com/ronnylt/redlock-php.

admin modules

• yf_manage_redis

classes

• yf_rewrite_pattern_yf rewrite/
  Default YF rewrite pattern.
• yf_rewrite

classes

• yf_search_driver search/
• yf_search_driver_db_fulltext search/
  Search with MATCH (fields) AGAINST ('+word ...' IN BOOLEAN MODE) on MySQL / MariaDB: needs one FULLTEXT index over exactly the searched fields. Every word is...
• yf_search_driver_db_like search/
  Search in a database table with one LIKE per word (pgsql: ILIKE): every word must be in one of the fields. index = table (DB_PREFIX added like db()->from()),...
• yf_search_driver_elasticsearch search/
  Elasticsearch 8 / 9 over its REST API with ext-curl (OpenSearch: the opensearch driver extends this one). Every request body is built with json_encode() from...
• yf_search_driver_manticore search/
  Manticore Search over SphinxQL: the sphinxsearch driver plus CREATE TABLE / DROP TABLE / TRUNCATE TABLE (RT mode, no index in the config), HIGHLIGHT() (text...
• yf_search_driver_opensearch search/
  OpenSearch 2.x over its REST API: the elasticsearch driver (same requests and answers) plus a check that GET / answers version.distribution "opensearch", and...
• yf_search_driver_sphinxsearch search/
  Sphinx 3.x over SphinxQL (Manticore: the manticore driver extends this one). Indexes are RT indexes declared in sphinx.conf (Sphinx has no CREATE TABLE); hig...
• yf_sphinxsearch
  Sphinx search querying.
• yf_wrapper_search
  Search wrapper: _class('wrapper_search')->search($params, $error) and the rest of the yf_search_driver contract, passed to the driver named by $driver (class...

classes

• yf_session_driver session/
• yf_session_driver_db session/
• yf_session_driver_files session/
• yf_session_handler_adapter session/
  Bridges a yf_session_driver (open/close/read/write/destroy/gc methods) to SessionHandlerInterface, which is the only form of session_set_save_handler() that...
• yf_session
  Core session handler.

user modules

• yf_shop__basket_api shop/
  Abstraction layer on basket inner representation with basic manipulation methods: get/set/del/clean...
• yf_shop__basket_save shop/
• yf_shop__basket_side shop/
• yf_shop__box shop/
• yf_shop__categories_show shop/
• yf_shop__format_price shop/
• yf_shop__get_children_cat shop/
• yf_shop__get_group_prices shop/
• yf_shop__get_select_attributes shop/
• yf_shop__hidden_field shop/
• yf_shop__hook_meta_tags shop/
• yf_shop__manufacturer_show shop/
• yf_shop__nav_bar_items shop/
• yf_shop__order_create shop/
• yf_shop__order_pay_authorize_net shop/
• yf_shop__order_step_delivery shop/
• yf_shop__order_step_do_payment shop/
• yf_shop__order_step_finish shop/
• yf_shop__order_step_select_payment shop/
• yf_shop__order_step_start shop/
• yf_shop__order_validate_delivery shop/
• yf_shop__order_validate_do_payment shop/
• yf_shop__order_validate_select_payment shop/
• yf_shop__product_get_price shop/
• yf_shop__product_id_url shop/
• yf_shop__products_get_attributes shop/
• yf_shop__products_last_viewed shop/
• yf_shop__site_map_items shop/
• yf_shop__site_title shop/
• yf_shop_basket shop/
• yf_shop_basket_add shop/
• yf_shop_basket_clean shop/
• yf_shop_basket_main shop/
• yf_shop_order shop/
• yf_shop_order_delete shop/
• yf_shop_order_validate_data shop/
• yf_shop_order_view shop/
• yf_shop_orders shop/
• yf_shop_payment_callback shop/
• yf_shop_product_details shop/
• yf_shop_products_related shop/
• yf_shop_products_show shop/
• yf_shop_products_similar_by_basket shop/
• yf_shop_products_similar_by_price shop/
• yf_shop_search shop/
• yf_shop_show shop/
• yf_shop
  Shop module.

admin modules

• yf_manage_shop__product_revisions manage_shop/
• yf_manage_shop__productparams_container manage_shop/
• yf_manage_shop__show_header manage_shop/
• yf_manage_shop_attributes manage_shop/
• yf_manage_shop_category_mapping manage_shop/
• yf_manage_shop_clear_products manage_shop/
• yf_manage_shop_coupons manage_shop/
• yf_manage_shop_dashboard manage_shop/
• yf_manage_shop_express manage_shop/
• yf_manage_shop_feedback manage_shop/
• yf_manage_shop_filter manage_shop/
• yf_manage_shop_hook_side_column manage_shop/
• yf_manage_shop_hook_widgets manage_shop/
• yf_manage_shop_import_products2 manage_shop/
• yf_manage_shop_invoice manage_shop/
• yf_manage_shop_manufacturers manage_shop/
• yf_manage_shop_novaposhta_ua manage_shop/
  todo: map, geocode src: http://novaposhta.ua/map/index/ua city: Avdiivka (654) map page: /map/citymap?id=654 map iframe: http://maps.novaposhta.ua/index.php?...
• yf_manage_shop_orders manage_shop/
• yf_manage_shop_pics_browser manage_shop/
• yf_manage_shop_price_markup_down manage_shop/
• yf_manage_shop_price_update manage_shop/
• yf_manage_shop_product_add manage_shop/
• yf_manage_shop_product_edit manage_shop/
• yf_manage_shop_product_images manage_shop/
• yf_manage_shop_product_sets manage_shop/
• yf_manage_shop_products manage_shop/
• yf_manage_shop_region manage_shop/
• yf_manage_shop_region_update manage_shop/
• yf_manage_shop_related_products manage_shop/
• yf_manage_shop_send_sms manage_shop/
• yf_manage_shop_suppliers manage_shop/
• yf_manage_shop_units manage_shop/
• yf_manage_shop_upload_images manage_shop/
• yf_manage_shop_users manage_shop/
• yf_manage_shop
  Shop managing module.
• yf_manage_shop_revisions
• yf_shop_contentm_panel
  Special panel for the supplier.
• yf_shop_supplier_panel
  Special panel for the supplier.

user modules

• yf_site_map

user modules

• yf_site_nav_bar

admin modules

• yf_site_nav_bar

classes

• yf_service_turbosms

classes

• yf_ssh_files ssh/
• yf_ssh_tar ssh/
• yf_ssh
  SSH Client (based on SSH2 PHP extension).

user modules

• yf_static_pages
  Static pages display module.

admin modules

• yf_static_pages
  Static/HTML pages content editor.

classes

• yf_core_api_admin_modules core_api/
• yf_core_api_sites_info core_api/
• yf_core_api_user_modules core_api/
• yf_model_relation model/
  Relations handler for model.
• yf_model_result model/
• yf_admin_methods
• yf_cookie
  YF Helper for cookies.
• yf_core_api
  Core API.
• yf_core_blocks
• yf_core_errors
  Custom error handler.
• yf_core_events
  Core events/observer handler.
• yf_core_menu
  Menu API methods.
• yf_encryption
  Symmetric encryption for cookies, hand-off links and files.
• yf_input
  Core input.
• yf_model
• yf_pcntl_signal
  pcntl_signal handler static class.
• yf_sites_info
  Get info about sites.

admin modules

• yf_blocks
• yf_file_manager
  File manager module.
• yf_manage_advertising
• yf_manage_cron
• yf_manage_icons
  Icons management.
• yf_manage_security
• yf_manage_servers
  Core servers management.
• yf_manage_sites
  Core sites management.
• yf_menus_editor

classes

• yf_table2_filter table2/
  Table2 plugin.
• yf_table2_image table2/
  Table2 plugin.
• yf_table2_postload table2/
  Table2 plugin.
• yf_table2

user modules

• yf_test_form2 test/
• yf_test_html5fw test/
  Bootstrap acceptance testing methods.
• yf_test_html5fw_bs3 test/
• yf_test_html5fw_bs4 test/
• yf_test_html5fw_bs5 test/
• yf_test_html5fw_empty test/
• yf_test_smtp_phpmailer test/
• yf_test_ssh test/
  Test sub-class.
• yf_test
• yf_test_403
• yf_test_404

admin modules

• yf_test

classes

• yf_tpl_driver_twig tpl/
• yf_tpl_driver_yf tpl/
• yf_tpl_driver_yf_compile tpl/
• yf_tpl_raw tpl/
  Value holder that tpl()->AUTO_ESCAPE prints without escaping; created by tpl()->raw($html).
• yf_tpl

admin modules

• yf_template_editor

classes

• yf_online_users

user modules

• yf_get_pswd
• yf_login
• yf_login_form
  YF Login Form.
• yf_logout
• yf_register
  Users registration.
• yf_user_profile

admin modules

• yf_manage_users
• yf_members
• yf_user_groups
  User groups editor.
• yf_user_modules
• yf_watch_online_users