Adresář includes
pokračování
functions_content.php (includes)
gen_sort_selects(&$limit_days, &$sort_by_text, &$sort_days, &$sort_key, &$sort_dir, &$s_limit_days, &$s_sort_key, &$s_sort_dir, &$u_sort_param, $def_st = false, $def_sk = false, $def_sd = false): Tato funkce generuje výběrové seznamy pro řazení obsahu na stránce. Argumenty $limit_days, $sort_by_text, $sort_days, $sort_key, $sort_dir, $s_limit_days, $s_sort_key, $s_sort_dir a $u_sort_param jsou reference na proměnné, které uchovávají různé hodnoty pro řazení. Argumenty $def_st, $def_sk a $def_sd jsou výchozí hodnoty pro výběrové seznamy.
make_jumpbox($action, $forum_id = false, $select_all = false, $acl_list = false, $force_display = false): Tato funkce vytváří výběrový seznam pro skoky mezi fóry. Argument $action určuje akci, která se má provést. Další argumenty jsou volitelné a určují, zda zahrnout všechny fóra, seznam práv přístupu a zda vynutit zobrazení.
bump_topic_allowed($forum_id, $topic_bumped, $last_post_time, $topic_poster, $last_topic_poster): Tato funkce kontroluje, zda je povoleno "bumpování" tématu. Argumenty $forum_id, $topic_bumped, $last_post_time, $topic_poster a $last_topic_poster obsahují informace o tématu a posledním příspěvku.
get_context($text, $words, $length = 400): Tato funkce získává kontext textu. Argument $text je zpráva nebo text, $words je počet slov, které se mají zobrazit, a $length je maximální délka kontextu.
phpbb_clean_search_string($search_string): Tato funkce čistí řetězec pro vyhledávání.
decode_message(&$message, $bbcode_uid = ''): Tato funkce dekóduje zprávu obsahující BBCode. Argument $message je zpráva k dekódování a $bbcode_uid je identifikátor BBCode.
strip_bbcode(&$text, $uid = ''): Tato funkce odstraňuje BBCode z textu. Argument $text je text k odstranění BBCode a $uid je identifikátor BBCode.
generate_text_for_display($text, $uid, $bitfield, $flags, $censor_text = true): Tato funkce generuje text pro zobrazení na stránce. Argument $text je text k zobrazení, $uid je identifikátor BBCode, $bitfield je bitový pole obsahující informace o BBCode, $flags jsou příznaky zprávy a $censor_text určuje, zda má být text cenzurován.
Rozepíšeme nápovědu k funkcím v souboru /includes/functions_content.php:
gen_sort_selects(&$limit_days, &$sort_by_text, &$sort_days, &$sort_key, &$sort_dir, &$s_limit_days, &$s_sort_key, &$s_sort_dir, &$u_sort_param, $def_st = false, $def_sk = false, $def_sd = false): Tato funkce generuje výběrové seznamy pro řazení obsahu na základě zadaných argumentů. Argumenty $limit_days, $sort_by_text, $sort_days, $sort_key, $sort_dir a další slouží k předání dat a parametrů pro vytvoření výběrových seznamů. Argumenty $def_st, $def_sk a $def_sd určují výchozí hodnoty pro určité parametry, pokud nejsou zadány explicitně.
make_jumpbox($action, $forum_id = false, $select_all = false, $acl_list = false, $force_display = false): Tato funkce vytváří výběrový seznam (skokové pole) pro navigaci mezi fóry. Parametr $action určuje akci, která se má provést po výběru, zatímco ostatní parametry jsou volitelné a slouží k určení dalších vlastností výběrového seznamu.
bump_topic_allowed($forum_id, $topic_bumped, $last_post_time, $topic_poster, $last_topic_poster): Tato funkce kontroluje, zda je povoleno "bumpování" tématu v závislosti na různých parametrech, jako je ID fóra, čas posledního příspěvku a další.
get_context($text, $words, $length = 400): Funkce získává kontext textu. Parametry $text a $words obsahují text a klíčová slova, podle kterých se má kontext získat. Volitelný parametr $length určuje délku kontextu.
phpbb_clean_search_string($search_string): Tato funkce čistí řetězec pro vyhledávání, odstraňuje z něj nežádoucí znaky nebo formátování.
decode_message(&$message, $bbcode_uid = ''): Funkce dekóduje zprávu, odstraňuje kód BBCode a provede další úpravy pro zobrazení.
strip_bbcode(&$text, $uid = ''): Tato funkce odstraňuje z textu všechny značky BBCode.
generate_text_for_display($text, $uid, $bitfield, $flags, $censor_text = true): Funkce generuje text pro zobrazení na základě poskytnutých dat a příznaků.
generate_text_for_storage(&$text, &$uid, &$bitfield, &$flags, $allow_bbcode = false, $allow_urls = false, $allow_smilies = false, $allow_img_bbcode = true, $allow_flash_bbcode = true, $allow_quote_bbcode = true, $allow_url_bbcode = true, $mode = 'post'): Tato funkce generuje text pro uložení do databáze na základě poskytnutých dat a dalších parametrů.
generate_text_for_edit($text, $uid, $flags): Funkce generuje text pro úpravu.
make_clickable_callback($type, $whitespace, $url, $relative_url, $class): Tato funkce generuje odkazy na základě zadaných parametrů. Parametr $type určuje typ odkazu, $whitespace určuje, zda je odkaz vložen do textu s mezerami, $url a $relative_url určují cílovou adresu odkazu a $class určuje třídu použitou pro formátování odkazu.
make_clickable($text, $server_url = false, string $class = 'postlink'): Funkce automaticky zpřístupňuje všechny odkazy v textu. Parametr $text obsahuje text, ve kterém mají být odkazy zpřístupněny. Parametr $server_url určuje, zda má být zahrnut serverový URL do relativních odkazů, a $class určuje třídu použitou pro formátování odkazů.
censor_text($text): Tato funkce provádí cenzuru textu podle definovaných cenzurovacích pravidel.
bbcode_nl2br($text): Funkce nahrazuje nové řádky v textu značkami pro přechod na nový řádek v BBCode.
smiley_text($text, $force_option = false): Tato funkce nahrazuje emotikony v textu jejich odpovídajícími obrázky.
parse_attachments($forum_id, &$message, &$attachments, &$update_count_ary, $preview = false): Funkce analyzuje přílohy v textu a provádí odpovídající akce, jako je připojení příloh k příspěvku.
extension_allowed($forum_id, $extension, &$extensions): Tato funkce kontroluje, zda je určené rozšíření povoleno pro přílohy v daném fóru.
truncate_string($string, $max_length = 60, $max_store_length = 255, $allow_reply = false, $append = ''): Funkce zkracuje řetězec na zadanou délku a přidává koncovku, pokud je řetězec zkrácen.
get_username_string($mode, $user_id, $username, $username_colour = '', $guest_username = false, $custom_profile_url = false): Tato funkce generuje textový řetězec obsahující jméno uživatele na základě zadaných parametrů.
phpbb_add_quickmod_option($url, $option, $lang_string): Funkce přidává možnost rychlého modifikování na základě zadaných parametrů.
phpbb_generate_string_list($items, $user): Tato funkce generuje seznam řetězců na základě zadaných položek a uživatelů.
phpbb_format_quote($language, $message_parser, $text_formatter_utils, $bbcode_status, $quote_attributes, $message_link = ''): Funkce formátuje citáty v textu podle zadaných parametrů.
functions_display.php (includes)
display_forums($root_data = '', $display_moderators = true, $return_moderators = false): Tato funkce zobrazuje seznam fór na základě poskytnutých dat. Parametr $root_data obsahuje data o fórech, $display_moderators určuje, zda mají být zobrazeni moderátoři, a $return_moderators určuje, zda mají být moderátoři vráceni.
generate_forum_rules(&$forum_data): Tato funkce generuje pravidla fóra na základě poskytnutých dat o fórech.
generate_forum_nav(&$forum_data_ary): Funkce generuje navigační odkazy na základě poskytnutých dat o fórech.
get_forum_parents(&$forum_data): Tato funkce získává rodičovská fóra na základě poskytnutých dat o fórech.
get_moderators(&$forum_moderators, $forum_id = false): Funkce získává seznam moderátorů fóra na základě poskytnutých dat.
gen_forum_auth_level($mode, $forum_id, $forum_status): Tato funkce generuje úroveň oprávnění pro fórum na základě zadaných parametrů.
topic_status(&$topic_row, $replies, $unread_topic, &$folder_img, &$folder_alt, &$topic_type): Funkce určuje stav tématu na základě zadaných parametrů.
display_custom_bbcodes(): Tato funkce zobrazuje vlastní BB kódy.
display_user_activity(&$userdata_ary): Funkce zobrazuje aktivitu uživatele na základě poskytnutých dat o uživatelích.
watch_topic_forum($mode, &$s_watching, $user_id, $forum_id, $topic_id, $notify_status = 'unset', $start = 0, $item_title = ''): Tato funkce umožňuje sledovat témata ve fórech a upozornit uživatele na změny.
phpbb_get_user_rank($user_data, $user_posts): Funkce získává hodnost uživatele na základě poskytnutých dat o uživatelích a jejich příspěvcích.
phpbb_show_profile($data, $user_notes_enabled = false, $warn_user_enabled = false, $check_can_receive_pm = true): Tato funkce zobrazuje uživatelský profil na základě poskytnutých dat.
phpbb_sort_last_active($first, $second): Funkce provádí třídění podle poslední aktivity.
functions_mpc.php (includes)
phpbb_module__url($mode, $module_row): Tato funkce generuje URL pro různé režimy modulu zpráv pro řízení obsahu fóra. Argumenty:
$mode: Určuje režim modulu.$module_row: Obsahuje data o modulu.
phpbb_module_notes_url($mode, $module_row): Generuje URL pro režim poznámek modulu zpráv pro řízení obsahu fóra. Argumenty stejné jako v předchozí funkci.
phpbb_module_warn_url($mode, $module_row): Generuje URL pro režim varování modulu zpráv pro řízení obsahu fóra. Argumenty stejné jako v předchozí funkci.
phpbb_module_main_url($mode, $module_row): Generuje URL pro hlavní režim modulu zpráv pro řízení obsahu fóra. Argumenty stejné jako v předchozí funkci.
phpbb_module_logs_url($mode, $module_row): Generuje URL pro režim protokolů modulu zpráv pro řízení obsahu fóra. Argumenty stejné jako v předchozí funkci.
phpbb_module_ban_url($mode, $module_row): Generuje URL pro režim zákazů modulu zpráv pro řízení obsahu fóra. Argumenty stejné jako v předchozí funkci.
phpbb_module_queue_url($mode, $module_row): Generuje URL pro režim fronty modulu zpráv pro řízení obsahu fóra. Argumenty stejné jako v předchozí funkci.
phpbb_module_reports_url($mode, $module_row): Generuje URL pro režim hlášení modulu zpráv pro řízení obsahu fóra. Argumenty stejné jako v předchozí funkci.
phpbb_extra_url($additional_parameters = []): Generuje dodatečné URL parametry. Argument $additional_parameters je volitelný a obsahuje dodatečné parametry.
phpbb_get_topic_data($topic_ids, $acl_list = false, $read_tracking = false): Získává data témata na základě zadaných identifikátorů témat. Argumenty:
$topic_ids: Pole identifikátorů témat.$acl_list: Seznam oprávnění omezujících přístup k datům.$read_tracking: Určuje, zda se mají získat i informace o sledování čtení.
phpbb_get_post_data($post_ids, $acl_list = false, $read_tracking = false): Získává data příspěvků na základě zadaných identifikátorů příspěvků. Argumenty stejné jako v předchozí funkci.
phpbb_get_forum_data($forum_id, $acl_list = 'f_list', $read_tracking = false): Získává data fóra na základě zadaného identifikátoru fóra. Argumenty:
$forum_id: Identifikátor fóra.$acl_list: Seznam oprávnění omezujících přístup k datům.$read_tracking: Určuje, zda se mají získat i informace o sledování čtení.
phpbb_get_pm_data($pm_ids): Získává data soukromých zpráv na základě zadaných identifikátorů zpráv. Argument $pm_ids obsahuje pole identifikátorů zpráv.
phpbb_mcp_sorting($mode, &$sort_days_val, &$sort_key_val, &$sort_dir_val, &$sort_by_sql_ary, &$sort_order_sql, &$total_val, $forum_id = 0, $topic_id = 0, $where_sql = 'WHERE'): Tato funkce slouží k řazení v panelu řízení obsahu fóra. Argumenty:
$mode: Určuje režim řazení.$sort_days_val, $sort_key_val, $sort_dir_val: Reference na proměnné pro uchování hodnot řazení.$sort_by_sql_ary: Pole pro nastavení SQL dotazu pro řazení.$sort_order_sql: Řetězec pro SQL dotaz na řazení.$total_val: Reference na proměnnou pro uchování celkového počtu výsledků.$forum_id: ID fóra pro filtrování.$topic_id: ID tématu pro filtrování.$where_sql: Řetězec pro další SQL podmínky.
phpbb_check_ids(&$ids, $table, $sql_id, $acl_list = false, $single_forum = false): Tato funkce kontroluje platnost identifikátorů záznamů. Argumenty:
$ids: Pole identifikátorů.$table: Název tabulky v databázi.$sql_id: Název sloupce s identifikátorem v tabulce.$acl_list: Seznam oprávnění omezujících přístup.$single_forum: Určuje, zda se kontrola provádí pouze pro jedno fórum.
functions_posting (includes)
generate_smilies($mode, $forum_id)
$mode: Režim.$forum_id: ID fóra.
update_post_information($type, $ids, $return_update_sql = false)
$type: Typ aktualizace.$ids: ID příspěvků.$return_update_sql: Volitelný argument indikující, zda vrátit aktualizační SQL.
posting_gen_topic_icons($mode, $icon_id)
$mode: Režim.$icon_id: ID ikony.
posting_gen_topic_types($forum_id, $cur_topic_type = POST_NORMAL)
$forum_id: ID fóra.$cur_topic_type: Aktuální typ tématu.
get_img_size_format($width, $height)
$width: Šířka obrázku.$height: Výška obrázku.
get_supported_image_types($type = false)
$type: Typ obrázku (volitelný).
create_thumbnail($source, $destination, $mimetype)
$source: Zdrojový soubor.$destination: Cílový soubor.$mimetype: MIME typ.
posting_gen_inline_attachments(&$attachment_data)
$attachment_data: Data přílohy.
posting_gen_attachment_entry($attachment_data, &$filename_data, $show_attach_box = true, $forum_id = false)
$attachment_data: Data přílohy.$filename_data: Data názvu souboru.$show_attach_box: Indikátor zobrazení přílohového okna (volitelný).$forum_id: ID fóra (volitelný).
load_drafts($topic_id = 0, $forum_id = 0, $id = 0, $pm_action = '', $msg_id = 0)
$topic_id: ID tématu (volitelný).$forum_id: ID fóra (volitelný).$id: ID (volitelný).$pm_action: Akce zprávy (volitelný).$msg_id: ID zprávy (volitelný).
topic_review($topic_id, $forum_id, $mode = 'topic_review', $cur_post_id = 0, $show_quote_button = true)
$topic_id: ID tématu.$forum_id: ID fóra.$mode: Režim (volitelný).$cur_post_id: ID aktuálního příspěvku (volitelný).$show_quote_button: Indikátor zobrazení tlačítka pro citaci (volitelný).
delete_post($forum_id, $topic_id, $post_id, &$data, $is_soft = false, $softdelete_reason = '')
$forum_id: ID fóra.$topic_id: ID tématu.$post_id: ID příspěvku.&$data: Reference na data.$is_soft: Indikátor soft-delete (volitelný).$softdelete_reason: Důvod soft-delete (volitelný).
submit_post($mode, $subject, $username, $topic_type, &$poll_ary, &$data_ary, $update_message = true, $update_search_index = true)
$mode: Režim.$subject: Předmět.$username: Uživatelské jméno.$topic_type: Typ tématu.&$poll_ary: Reference na pole hlasování.&$data_ary: Reference na pole dat.$update_message: Indikátor aktualizace zprávy (volitelný).$update_search_index: Indikátor aktualizace indexu vyhledávání (volitelný).
phpbb_bump_topic($forum_id, $topic_id, $post_data, $bump_time = false)
$forum_id: ID fóra.$topic_id: ID tématu.$post_data: Data příspěvku.$bump_time: Čas bumpu (volitelný).
phpbb_upload_popup($forum_style = 0)
$forum_style: Styl fóra (volitelný).
phpbb_handle_post_delete($forum_id, $topic_id, $post_id, &$post_data, $is_soft = false, $delete_reason = '')$forum_id: ID fóra.$topic_id: ID tématu.$post_id: ID příspěvku.&$post_data: Reference na data příspěvku.$is_soft: Indikátor soft-delete (volitelný).$delete_reason: Důvod smazání (volitelný).
functions_messenger.php (includes)
__construct($use_queue = true): Konstruktor třídy phpbb_messenger inicializuje novou instanci objektu. Parametr $use_queue určuje, zda se má použít fronta pro odesílání zpráv (výchozí hodnota je true).
reset(): Resetuje stav objektu messenger.
set_addresses($user): Nastavuje adresy příjemců.
to($address, $realname = ''): Nastavuje adresu příjemce.
cc($address, $realname = ''): Nastavuje adresu kopie.
bcc($address, $realname = ''): Nastavuje adresu skryté kopie.
im($address, $realname = ''): Nastavuje adresu pro okamžité zprávy.
replyto($address): Nastavuje adresu pro odpověď.
from($address): Nastavuje adresu odesílatele.
subject($subject = ''): Nastavuje předmět zprávy.
headers($headers): Nastavuje hlavičky zprávy.
anti_abuse_headers($config, $user): Nastavuje anti-zneužitelné hlavičky.
set_mail_priority($priority = MAIL_NORMAL_PRIORITY): Nastavuje prioritu e-mailu.
template($template_file, $template_lang = '', $template_path = '', $template_dir_prefix = ''): Nastavuje šablonu zprávy.
assign_vars($vars): Přiřazuje proměnné do šablony.
assign_block_vars($blockname, $vars): Přiřazuje proměnné bloku v šabloně.
send($method = NOTIFY_EMAIL, $break = false): Odesílá zprávu. Parametr $method určuje způsob odeslání (výchozí je e-mail), $break indikuje, zda se má zpráva pouze formátovat.
error($type, $msg): Zaznamenává chybu v odesílání.
save_queue(): Ukládá frontu odesílaných zpráv.
generate_message_id(): Generuje ID zprávy.
build_header($to, $cc, $bcc): Sestavuje hlavičku zprávy s ohledem na příjemce, kopie a skryté kopie.
msg_email(): Metoda pro odeslání e-mailové zprávy. Obsahuje parametr $break, který indikuje, zda se má funkce vrátit po provedení hooku.
msg_jabber(): Metoda pro odeslání zprávy přes protokol Jabber.
setup_template(): Chráněná metoda pro nastavení šablony.
set_template_paths($path_name, $paths): Chráněná metoda pro nastavení cest k šablonám.
__construct(): Konstruktor třídy phpbb_network nebo phpbb_smtp nebo phpbb_mail inicializuje novou instanci objektu.
init($object, $package_size): Inicializuje spojení.
put($object, $scope): Přidá objekt do fronty odesílání.
process(): Zpracovává frontu odesílání.
save(): Ukládá zprávu.
smtpmail($addresses, $subject, $message, &$err_msg, $headers = false):
Funkce pro odeslání e-mailu přes SMTP server. Obsahuje parametry pro
adresy, předmět, obsah zprávy, zprávu o chybě a volitelné hlavičky.
add_backtrace($message): Přidá do zprávy stopu (backtrace).
server_send($command, $private_info = false): Odesílá příkaz na server.
server_parse($response, $line): Parsuje odpověď serveru.
close_session(&$err_msg): Uzavírá spojení se serverem.
log_into_server($hostname, $username, $password, $default_auth_method): Přihlašuje se do serveru.
hello($hostname): Metoda pro pozdravení se serverem.
starttls(): Zahajuje TLS spojení.
pop_before_smtp($hostname, $username, $password): Metoda pro autentizaci POP3 před SMTP.
plain($username, $password): Metoda pro autentizaci pomocí mechanismu PLAIN.
login($username, $password): Metoda pro autentizaci pomocí mechanismu LOGIN.
cram_md5($username, $password): Metoda pro autentizaci pomocí mechanismu CRAM-MD5.
digest_md5($username, $password): Metoda pro autentizaci pomocí mechanismu DIGEST-MD5.
mail_encode($str, $eol = "\r\n"): Zakóduje text zprávy pro e-mailový formát.
phpbb_mail($to, $subject, $msg, $headers, $eol, &$err_msg):
Funkce pro odeslání e-mailu přes PHP mail. Obsahuje parametry pro
adresy, předmět, obsah zprávy, hlavičky, znak konce řádku a zprávu o
chybě.
functions_privmsgs.php (includes)
get_folder($user_id, $folder_id = false)
$user_id: ID uživatele.$folder_id: ID složky (volitelné).
clean_sentbox($num_sentbox_messages)
$num_sentbox_messages: Počet zpráv v odeslané složce.
check_rule(&$rules, &$rule_row, &$message_row, $user_id)
&$rules: Reference na pravidla.&$rule_row: Reference na řádek pravidla.&$message_row: Reference na řádek zprávy.$user_id: ID uživatele.
update_pm_counts()
place_pm_into_folder(&$global_privmsgs_rules, $release = false)
&$global_privmsgs_rules: Reference na pravidla globálních soukromých zpráv.$release: Uvolnění (volitelné).
move_pm($user_id, $message_limit, $move_msg_ids, $dest_folder, $cur_folder_id)
$user_id: ID uživatele.$message_limit: Limit zpráv.$move_msg_ids: ID zpráv k přesunu.$dest_folder: Cílová složka.$cur_folder_id: ID aktuální složky.
update_unread_status($unread, $msg_id, $user_id, $folder_id)
$unread: Nepřečtené.$msg_id: ID zprávy.$user_id: ID uživatele.$folder_id: ID složky.
mark_folder_read($user_id, $folder_id)
$user_id: ID uživatele.$folder_id: ID složky.
handle_mark_actions($user_id, $mark_action)
$user_id: ID uživatele.$mark_action: Akce označení.
delete_pm($user_id, $msg_ids, $folder_id)
$user_id: ID uživatele.$msg_ids: ID zpráv k odstranění.$folder_id: ID složky.
phpbb_delete_users_pms($user_ids)
rebuild_header($check_ary)
$check_ary: Pole ke kontrole.
write_pm_addresses($check_ary, $author_id, $plaintext = false)
$check_ary: Pole k ověření.$author_id: ID autora.$plaintext: Čistý text (volitelné).
get_folder_status($folder_id, $folder)
$folder_id: ID složky.$folder: Složka.
submit_pm($mode, $subject, &$data_ary, $put_in_outbox = true)
$mode: Režim.$subject: Předmět zprávy.&$data_ary: Reference na pole dat.$put_in_outbox: Umístit do odeslané složky (volitelné).
message_history($msg_id, $user_id, $message_row, $folder, $in_post_mode = false)
$msg_id: ID zprávy.$user_id: ID uživatele.$message_row: Řádek zprávy.$folder: Složka.$in_post_mode: Režim příspěvku (volitelné).
set_user_message_limit()
phpbb_get_max_setting_from_group(\phpbb\db\driver\driver_interface $db, $user_id, $setting)
$db: Rozhraní databáze.$user_id: ID uživatele.$setting: Nastavení.
get_recipient_strings($pm_by_id)
$pm_by_id: Soukromé zprávy podle ID.
Rozdíl mezi funkcemi v souborech functions_privmsgs.php a functions_messenger
Rozdíl mezi funkcemi v souborech functions_privmsgs.php a functions_messenger.php spočívá převážně v jejich zaměření a účelu.
functions_privmsgs.php:
- Obsahuje funkce související se správou soukromých zpráv (PM) v diskuzním fóru.
- Zahrnuje funkce pro načítání, ukládání, mazání a manipulaci se soukromými zprávami.
- Obsahuje také funkce pro správu složek, označování zpráv jako přečtené nebo nepřečtené a provádění akcí souvisejících se správou soukromých zpráv.
functions_messenger.php:
- Obsahuje funkce související s odesíláním a manipulací s různými typy zpráv v rámci platformy.
- Zahrnuje funkce pro konstrukci, formátování, odesílání a zpracování zpráv, jako jsou e-maily, zprávy v Jabberu (XMPP) a další.
- Může obsahovat také funkce pro nastavení priorit zpráv, práci s frontou zpráv a dalšími úkoly souvisejícími s doručováním zpráv.
Základní rozdíl spočívá tedy v tom, že functions_privmsgs.php se zaměřuje na správu soukromých zpráv uživatelů v rámci diskuzního fóra, zatímco functions_messenger.php se zaměřuje na obecnější funkce spojené s odesíláním a manipulací s různými typy zpráv na platformě.
functions.php (includes)
Následuje seznam funkcí ze souboru includes/functions.php spolu s jejich argumenty:
- gen_rand_string($num_chars = 8): Generuje náhodný řetězec o zadané délce.
- gen_rand_string_friendly($num_chars = 8): Generuje náhodný přátelský řetězec o zadané délce.
- unique_id(): Generuje unikátní identifikátor.
- phpbb_mt_rand($min, $max): Generuje náhodné číslo v určeném rozsahu.
- phpbb_gmgetdate($time = false): Vrací pole s časovými údaji z Unixového timestampu.
- get_formatted_filesize($value, $string_only = true, $allowed_units = false): Formátuje velikost souboru.
- still_on_time($extra_time = 15): Kontroluje, zda je stále v čase.
- phpbb_version_compare($version1, $version2, $operator = null): Porovnává verze PHPBB.
- language_select($default = '', array $langdata = []): Vytváří rozbalovací seznam jazyků.
- style_select($default = '', $all = false, array $styledata = []): Vytváří rozbalovací seznam stylů.
- phpbb_format_timezone_offset($tz_offset, $show_null = false): Formátuje posun časového pásma.
- phpbb_tz_select_compare($a, $b): Porovnává hodnoty časových pásem.
- phpbb_get_timezone_identifiers($selected_timezone): Získává identifikátory časových pásem.
- phpbb_timezone_select($template, $user, $default = '', $truncate = false): Vytváří rozbalovací seznam časových pásem.
- markread($mode, $forum_id = false, $topic_id = false, $post_time = 0, $user_id = 0): Označuje přečtené položky.
- get_topic_tracking($forum_id, $topic_ids, &$rowset, $forum_mark_time, $global_announce_list = false): Získává informace o sledování témat.
- get_complete_topic_tracking($forum_id, $topic_ids, $global_announce_list = false): Získává kompletní informace o sledování témat.
- get_unread_topics($user_id = false, $sql_extra = '', $sql_sort = '', $sql_limit = 1001, $sql_limit_offset = 0): Získává nepřečtená témata.
- update_forum_tracking_info($forum_id, $forum_last_post_time, $f_mark_time = false, $mark_time_forum = false): Aktualizuje informace o sledování fóra.
- tracking_serialize($input): Serializuje sledovací data.
- tracking_unserialize($string, $max_depth = 3): Deserializuje sledovací data.
- append_sid($url, $params = false, $is_amp = true, $session_id = false, $is_route = false): Přidává session ID k URL.
- generate_board_url($without_script_path = false): Generuje URL pro diskuzní fórum.
- redirect($url, $return = false, $disable_cd_check = false): Přesměruje na jinou stránku.
- reapply_sid($url, $is_route = false): Aplikuje session ID na URL.
- build_url($strip_vars = false): Vytváří URL.
- meta_refresh($time, $url, $disable_cd_check = false): Generuje meta refresh hlavičku.
- send_status_line($code, $message): Odesílá statusovou hlášku.
- phpbb_request_http_version(): Získává verzi HTTP protokolu.
- generate_link_hash($link_name): Generuje hash odkazu.
- check_link_hash($token, $link_name): Kontroluje platnost hash odkazu.
- add_form_key($form_name, $template_variable_suffix = ''): Přidává klíč formuláře.
- check_form_key($form_name, $timespan = false): Kontroluje platnost klíče formuláře.
- confirm_box($check, $title = '', $hidden = '', $html_body = 'confirm_body.html', $u_action = ''): Generuje potvrzovací dialog.
- login_box($redirect = '', $l_explain = '', $l_success = '', $admin = false, $s_display = true): Generuje přihlašovací formulář.
- login_forum_box($forum_data): Generuje přihlašovací formulář pro fórum.
- _build_hidden_fields($key, $value, $specialchar, $stripslashes): Vytváří skrytá pole formuláře.
- build_hidden_fields($field_ary, $specialchar = false, $stripslashes = false): Vytváří skrytá pole formuláře z asociativního pole.
- parse_cfg_file($filename, $lines = false): Parzuje konfigurační soubor a vrací jeho obsah.
- get_backtrace(): Získává zásobník volání funkcí.
- get_preg_expression($mode): Vrací regulární výraz podle zadaného režimu.
- get_censor_preg_expression($word): Vrací regulární výraz pro cenzuru založený na zadaném slově.
- short_ipv6($ip, $length): Zkracuje IPv6 adresu na zadanou délku.
- phpbb_ip_normalise(string $address): Normalizuje IPv4 nebo IPv6 adresu.
- msg_handler($errno, $msg_text, $errfile, $errline): Zpracovává zprávy o chybách.
- phpbb_filter_root_path($errfile): Filtruje kořenovou cestu ze zadaného souboru.
- obtain_guest_count($item_id = 0, $item = 'forum'): Získává počet hostů online.
- obtain_users_online($item_id = 0, $item = 'forum'): Získává seznam uživatelů online.
- obtain_users_online_string($online_users, $item_id = 0, $item = 'forum'): Vytváří řetězec uživatelů online.
- phpbb_optionget($bit, $data): Získává hodnotu bitu z dat.
- phpbb_optionset($bit, $set, $data): Nastavuje hodnotu bitu v datech.
- phpbb_quoteattr($data, $entities = null): Zapisuje řetězec jako atribut HTML tagu.
- phpbb_get_user_avatar($user_row, $alt = 'USER_AVATAR', $ignore_config = false, $lazy = false): Získává URL uživatelského avataru.
- phpbb_get_group_avatar($group_row, $alt = 'GROUP_AVATAR', $ignore_config = false, $lazy = false): Získává URL avataru skupiny.
- phpbb_get_avatar($row, $alt, $ignore_config = false, $lazy = false): Získává URL avataru.
- page_header($page_title = '', $display_online_list = false, $item_id = 0, $item = 'forum', $send_headers = true): Generuje hlavičku stránky.
- phpbb_check_and_display_sql_report(\phpbb\request\request_interface $request, \phpbb\auth\auth $auth, \phpbb\db\driver\driver_interface $db): Kontroluje a zobrazuje zprávu o SQL reportu.
- phpbb_generate_debug_output(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\auth\auth $auth, \phpbb\user $user, \phpbb\event\dispatcher_interface $phpbb_dispatcher): Generuje výstup debugovacích informací.
- page_footer($run_cron = true, $display_template = true, $exit_handler = true): Generuje patičku stránky.
- garbage_collection(): Provede úklid.
- exit_handler(): Handler pro ukončení provádění.
- phpbb_user_session_handler(): Handler pro uživatelské relace.
- phpbb_to_numeric($input): Konvertuje vstup na numerickou hodnotu.
- phpbb_get_board_contact(\phpbb\config\config $config, $phpEx): Získává kontaktní informace o diskuzním fóru.
- phpbb_get_board_contact_link(\phpbb\config\config $config, $phpbb_root_path, $phpEx): Získává odkaz na kontaktní informace o diskuzním fóru.
functions_convert.php (includes)
dec($var) - Sníží hodnotu proměnné o 1.inc($var) - Zvýší hodnotu proměnné o 1.is_positive($n) - Vrátí true, pokud je číslo kladné.not($var) - Vrátí negaci zadaného výrazu.str_to_bool($str) - Převede řetězec na boolean hodnotu.is_empty($mixed) - Kontroluje, zda je proměnná prázdná.str_to_primary_group($status) - Převede řetězec na primární skupinu.is_item_locked($bool) - Vrátí true, pokud je položka uzamčená.days_to_seconds($days) - Převede počet dnů na sekundy.is_user_anonymous($user_id) - Vrátí true, pokud je uživatel anonymní.auto_id($pad = 0) - Automaticky generuje ID s možností nastavení výchozího čísla.set_user_type($user_active) - Nastavuje typ uživatele.minutes_to_hours($minutes) - Převede počet minut na hodiny.get_group_id($group_name) - Získává ID skupiny podle názvu.is_topic_locked($bool) - Vrátí true, pokud je téma uzamčené.make_uid($timestamp) - Vytvoří unikátní identifikátor.validate_website($url) - Ověřuje platnost URL adresy.null_to_zero($value) - Pokud je hodnota null, vrátí 0.null_to_str($value) - Pokud je hodnota null, vrátí prázdný řetězec.get_config_value($config_name) - Získává hodnotu konfiguračního klíče.decode_ip($int_ip) - Dekóduje IP adresu.decode_ban_ip($int_ip) - Dekóduje zabanovanou IP adresu.mimetype($filename) - Získá MIME typ souboru.remote_avatar_dims() - Získá rozměry vzdáleného avataru.import_avatar_gallery($gallery_name = '', $subdirs_as_galleries = false) - Importuje galerii avatarů.import_attachment_files($category_name = '') - Importuje soubory příloh.attachment_forum_perms($forum_id) - Získá oprávnění pro fórum příloh.base64_unpack($string) - Dekóduje Base64 řetězec._import_check($config_var, $source, $use_target) - Kontroluje importní proměnnou.import_attachment($source, $use_target = false) - Importuje přílohu.import_rank($source, $use_target = false) - Importuje hodnost.import_smiley($source, $use_target = false) - Importuje smajlíka.import_avatar($source, $use_target = false, $user_id = false) - Importuje avatar.get_image_dim($source) - Získá rozměry obrázku.get_smiley_width($src) - Získá šířku smajlíka.get_smiley_height($src) - Získá výšku smajlíka.get_smiley_dim($source, $axis) - Získá rozměry smajlíka na dané ose.get_avatar_width($src, $func = false, $arg1 = false, $arg2 = false) - Získá šířku avataru.get_avatar_height($src, $func = false, $arg1 = false, $arg2 = false) - Získá výšku avataru.get_avatar_dim($src, $axis, $func = false, $arg1 = false, $arg2 = false) - Získá rozměry avataru na dané ose.get_upload_avatar_dim($source, $axis) - Získá rozměry nahrávaného avataru.get_gallery_avatar_dim($source, $axis) - Získá rozměry galerie avatarů.get_remote_avatar_dim($src, $axis) - Získá rozměry vzdáleného avataru.set_user_options() - Nastavuje možnosti uživatele.search_indexing($message = '') - Indexuje pro vyhledávání.make_unique_filename($filename) - Vytvoří unikátní název souboru.words_unique(&$words) - Odstraní duplicitní slova.add_user_group($group_id, $user_id, $group_leader = false) - Přidá uživateli skupinu.user_group_auth($group, $select_query, $use_src_db) - Ověřuje oprávnění skupiny uživatele.get_config() - Získává konfiguraci.restore_config($schema) - Obnovuje konfiguraci.update_folder_pm_count() - Aktualizuje počet soukromých zpráv ve složce.path($path, $path_relative = true) - Vrátí cestu s ohledem na relativitu.extract_variables_from_file($_filename) - Extrahuje proměnné ze souboru.get_path($src_path, $src_url, $test_file) - Získá cestu pro zdrojový soubor.compare_table($tables, $tablename, &$prefixes) - Porovnává tabulky.
mass_auth($ug_type, $forum_id, $ug_id, $acl_list, $setting = ACL_NO) - Hromadné nastavení oprávnění skupinám uživatelů ve fóru.update_unread_count() - Aktualizuje počet nepřečtených zpráv.add_default_groups() - Přidává výchozí skupiny.add_groups_to_teampage() - Přidává skupiny na stránku týmu.sync_post_count($offset, $limit) - Synchronizuje počet příspěvků.add_bots() - Přidává boty.update_dynamic_config() - Aktualizuje dynamickou konfiguraci.update_topics_posted() - Aktualizuje témata, na která bylo odpovězeno.fix_empty_primary_groups() - Opravuje prázdné primární skupiny.remove_invalid_users() - Odebírá neplatné uživatele.convert_bbcode($message, $convert_size = true, $extended_bbcodes = false) - Konvertuje BB kódy.copy_file($src, $trg, $overwrite = false, $die_on_failure = true, $source_relative_path = true) - Kopíruje soubor.copy_dir($src, $trg, $copy_subdirs = true, $overwrite = false, $die_on_failure = true, $source_relative_path = true) - Kopíruje adresář.relative_base($path, $is_relative = true, $line = false, $file = false) - Vrátí relativní cestu.get_smiley_display() - Získá zobrazení smajlíků.fill_dateformat($user_dateformat) - Doplní formát datumu.
functions_user.php (includes)
- user_get_id_name(&$user_id_ary, &$username_ary, $user_type = false, $update_references = false): Získává ID a jména uživatelů.
- update_last_username(): Aktualizuje poslední uživatelské jméno.
- user_update_name($old_name, $new_name): Aktualizuje uživatelské jméno.
- user_add($user_row, $cp_data = false, $notifications_data = null): Přidává nového uživatele.
- user_delete($mode, $user_ids, $retain_username = true): Mazání uživatelů.
- user_active_flip($mode, $user_id_ary, $reason = INACTIVE_MANUAL): Aktivuje nebo deaktivuje uživatele.
- user_ban($mode, $ban, $ban_len, $ban_len_other, $ban_exclude, $ban_reason, $ban_give_reason = ''): Zakazuje uživatele.
- user_unban($mode, $ban): Zrušení zákazu uživatele.
- user_ipwhois($ip): Provádí IP WHOIS pro uživatele.
- validate_data($data, $val_ary): Validace dat.
- validate_string($string, $optional = false, $min = 0, $max = 0): Validace řetězce.
- validate_num($num, $optional = false, $min = 0, $max = 1E99): Validace čísla.
- validate_date($date_string, $optional = false): Validace data.
- validate_match($string, $optional = false, $match = ''): Validace shody.
- validate_language_iso_name($lang_iso): Validace názvu jazyka.
- phpbb_validate_timezone($timezone): Validace časového pásma.
- validate_username($username, $allowed_username = false, $allow_all_names = false): Validace uživatelského jména.
- validate_password($password): Validace hesla.
- phpbb_validate_email($email, $config = null): Validace e-mailu.
- validate_user_email($email, $allowed_email = false): Validace e-mailové adresy uživatele.
- validate_jabber($jid): Validace Jabberu.
- phpbb_validate_hex_colour($colour, $optional = false): Validace hexadecimální barvy.
- phpbb_style_is_active($style_id): Zjištění, zda je styl aktivní.
- avatar_delete($mode, $row, $clean_db = false): Mazání avataru.
- get_avatar_filename($avatar_entry): Získává název souboru s avatarem.
- phpbb_avatar_explanation_string(): Vrací vysvětlení k avatarmu.
- group_create(&$group_id, $type, $name, $desc, $group_attributes, $allow_desc_bbcode = false, $allow_desc_urls = false, $allow_desc_smilies = false): Vytváří skupinu.
- group_correct_avatar($group_id, $old_entry): Opravuje avatar skupiny.
- avatar_remove_db($avatar_name): Odebírá avatar z databáze.
- group_delete($group_id, $group_name = false): Mazání skupiny.
- group_user_add($group_id, $user_id_ary = false, $username_ary = false, $group_name = false, $default = false, $leader = 0, $pending = 0, $group_attributes = false): Přidává uživatele do skupiny.
- group_user_del($group_id, $user_id_ary = false, $username_ary = false, $group_name = false, $log_action = true): Odebírá uživatele ze skupiny.
- remove_default_avatar($group_id, $user_ids): Odebírá výchozí avatar.
- remove_default_rank($group_id, $user_ids): Odebírá výchozí hodnost.
- group_user_attributes($action, $group_id, $user_id_ary = false, $username_ary = false, $group_name = false, $group_attributes = false): Nastavuje atributy uživatelů ve skupině.
- group_validate_groupname($group_id, $group_name): Validuje název skupiny.
- group_set_user_default($group_id, $user_id_ary, $group_attributes = false, $update_listing = false): Nastavuje výchozí skupinu pro uživatele.
get_group_name($group_id): Tato funkce získává název skupiny na základě zadaného ID skupiny.
group_memberships($group_id_ary = false, $user_id_ary = false, $return_bool = false): Tato funkce zjišťuje, zda je zadaný uživatel členem zadané skupiny. Pokud je parametr $return_bool nastaven na true, funkce vrátí buď true (členství je potvrzeno) nebo false (členství není potvrzeno). Tato funkce nevrací členství, které ještě nebylo potvrzeno.
group_update_listings($group_id): Tato funkce aktualizuje seznamy skupin, zejména ve foru a v seznamu členů.
remove_newly_registered($user_id, $user_data = false): Tato funkce odstraňuje uživatele z nově registrovaných uživatelů. Je nutné volat group_user_del zde, protože tato funkce zajistí, že vše je správně změněno. Tato funkce není zaznamenána v protokolu při odstraňování uživatelů z nově registrovaných uživatelů.
phpbb_get_banned_user_ids($user_ids = array(), $ban_end = true): Tato funkce získává ID uživatelů, kteří jsou zakázáni. Pokud je parametr $ban_end nastaven na true, vrátí se pouze ID uživatelů, jejichž ban již skončil.
phpbb_module_zebra($mode, &$module_row): Tato funkce je určena pro modul Zebra, který slouží k implementaci různých modulů na webu. Funkce zpracovává provádění modulu Zebra s ohledem na zadaný režim a řádek modulu.