פונקציות עזר (MISC)

MISC היא מחלקה סטטית עם פונקציות עזר קטנות שמשמשות את הליבה ואת קוד האתר: עיבוד מחרוזות ומספרים, אחסון רשימות מזהים בעמודה אחת, בניית כתובות, זיהוי IP, בקשות HTTP יוצאות ועוד. בעמוד הזה מתועדות הפונקציות הציבוריות שכדאי להכיר, עם חתימה מדויקת ועם הערות על התנהגות שמפתיעה. הפונקציות מחולקות לפי נושא.

מחרוזות ופלט#

echo MISC::special_chars($row["title"]);                 // בטוח בתוך תוכן HTML
echo MISC::max_chars($article["intro"], 160);            // "..." אם נחתך
if (!MISC::is_valid_email($_POST["email"])) { return "ERROR: email"; }

מספרים והשוואות#

echo MISC::my_number_format(1250);      // 1,250
echo MISC::my_number_format(1250.5);    // 1,250.50
var_dump(MISC::value_in(3, "1,2,3"));   // bool(true)
var_dump(MISC::value_in("b", ["a", "b"])); // bool(true)

רשימות מזהים בעמודה אחת: bgl_implode ו-bgl_explode#

כמה טבלאות בליבה שומרות רשימת מזהים (קטגוריות, תגיות) בעמודת טקסט אחת בפורמט צינורות, כך שאפשר לחפש אחד מהם עם LIKE '%|11|%'.

$stored = MISC::bgl_implode([11, 482]);        // "|11||482|"
$ids    = MISC::bgl_explode($stored);          // [11, 482] (כמחרוזות)

$id  = (int)$_GET["cat"];
$rows = DB::get_all("SELECT id, title FROM CRM_articles WHERE categories LIKE '%|" . $id . "|%'");

כתובות URL#

$url = MISC::add_querystring_var("/search?q=cms&page=2", "page", 3);
// "/search?q=cms&page=3"

$abs = MISC::absolute_url("/contact");
// "https://example.co.il/contact"  (לפי ה-Host של הבקשה)

$path = MISC::bgl_url_encode("files/דוח שנתי.pdf");
// "files/%D7%93%D7%95%D7%97+%D7%A9%D7%A0%D7%AA%D7%99.pdf"

כתובת IP ומיקום#

$info = MISC::ip_info(null, "location");
// ["city" => ..., "state" => ..., "country" => ..., "country_code" => "IL", "continent" => ..., "continent_code" => ...]

$code = MISC::ip_info(null, "countrycode");   // "IL" או NULL

ip_info ללא $ip תקף משתמשת ב-REMOTE_ADDR, ועם $deep_detect גם ב-HTTP_CF_CONNECTING_IP (Cloudflare), אחר כך HTTP_X_FORWARDED_FOR ו-HTTP_CLIENT_IP, כשהם כתובות תקינות. תוצאה מוצלחת נשמרת ב-SESSION תחת ip_check כדי לא לבצע בדיקה חוזרת באותו סשן, וכישלון לא נשמר. המידע מגיע משירות חיצוני עם גיבוי (get_ip_data_with_fallback), כך שהקריאה הראשונה בסשן היא בקשת רשת.

בקשות HTTP יוצאות#

MISC::file_get_contents($url) היא עטיפה של cURL, שעוקבת אחרי הפניות, שולחת User-Agent של דפדפן ומחזירה את גוף התשובה רק כשקוד ה-HTTP הוא 200. בכל מקרה אחר היא מחזירה false.

$html = MISC::file_get_contents("https://example.com/feed.xml");
if ($html === false) {
    return "ERROR: feed unavailable";
}

הצפנה פשוטה#

MISC::encode($str) ו-MISC::decode($str) מצפינות ערכים (AES-256-CBC) ומחזירות מחרוזת שמתאימה לכתובת URL. MISC::set_encrypt_secret_keys($key, $iv) מחליפה את מפתחות ברירת המחדל, ויש לקרוא לה באתר לפני כל שימוש.

אבטחת קלט, דפדפן ו-CLI#

עזרים לתצוגה ולמבנה העמוד#

MISC::breadcrumbs([
    ["title" => "בית",   "url" => "/"],
    ["title" => "חדשות", "url" => "/news"],
]);

$orderRef = MISC::uuid();      // למשל "3f2b1c7e-6a4d-4c0e-9d1a-0b7c2e5f8a14"

service_unavailable נועדה לתקלות תלות (למשל מסד נתונים שלא זמין): היא מחזירה 503 ולא 200 או 404, כדי שמנועי חיפוש יבינו שהתקלה זמנית, ומונעת שמירת התשובה במטמון של העמודים. היא גם לא פונה למסד הנתונים.

פונקציות ישנות שכדאי לא להשתמש בהן#

הפונקציות הבאות קיימות מטעמי תאימות לאחור או שאינן עובדות כמתוכנן. הן מופיעות כאן כדי שתדעו להימנע מהן.

ראו גם#

• הצפנה
• CSRF, XSS ו-SQLi
• מודל האבטחה
• משימות מתוזמנות
• דוא"ל ותור שליחה
• רפרנס: MISC