פרמטרים ומילון שפות

שתי מחלקות קטנות נושאות את ההגדרות שנערכות בלי לגעת בקוד. PARAMS היא טבלת מפתח וערך של הגדרות אתר (תבנית דוא"ל עוטפת, אסימוני שירותים, דגלים), ו-LANGS היא מילון של מילים וטקסטים קבועים בכמה שפות. בעמוד הזה תראו איך שתיהן נטענות, איך קוראים אותן ושומרים אליהן, ומתי צריך לנקות מטמון כדי שהשינוי יופיע. פירוט הסכמות והמפתחות מופיע ברפרנס פרמטרים ושפות.

PARAMS: הגדרות מפתח-ערך#

איך נטען#

בתחילת כל בקשה PAGE::load קורא ל-PARAMS::init(). הפונקציה טוענת את כל השורות של CRM_params מהמטמון (מפתח params, תוקף 30 יום, cache_engine::get("params", ..., 24*30, false)) ושומרת אותן במערך סטטי בזיכרון. מכאן, קריאה של פרמטר במהלך הבקשה אינה פונה למסד הנתונים.

קריאה וכתיבה בזיכרון#

$tpl = PARAMS::get("mail_tpl");
if ($tpl === "") {
    // אין תבנית עוטפת, ממשיכים בלי
}

if (PARAMS::get("poolse_mail") === "0") {
    // המפתח קיים והערך "0" (שימו לב להשוואת מחרוזות)
}

בתבניות Smarty אפשר לקרוא לאותה פונקציה ישירות, כמו שעושה תבנית הליבה views/admin/sqllog.tpl:

{if PARAMS::get('log_sql') == '1'}הרישום פעיל{else}הרישום כבוי{/if}

הטבלה CRM_params#

מפתחות שהליבה עצמה משתמשת בהם:

עריכה בפאנל#

הפאנל {admin}/Params מציג את השורות (קודם perm_developer ואחר כך לפי sysName), ומאפשר עריכת הערך ישירות בטבלה. עריכה, הוספה ומחיקה מנקות את מטמון params אוטומטית. מי שאינו מפתח (ADMIN::is_developer()) רואה רק שורות עם perm_developer = 0, ולא רואה את עמודת ההרשאה.

כתיבה מהקוד#

כתיבה מהקוד היא עדכון שורה ואחריו ניקוי מטמון. בלי הניקוי, אחרי עד 30 יום (או עד הניקוי הבא) הבקשות ימשיכו לקבל את הערך הישן.

function save_param($name, $value, $description = "")
{
    $row = DB::get_val("params", ["sysName" => $name]);

    $u = DB::update("params")->set("value", (string)$value);
    if ($row) {
        $u->update((int)$row["id"]);
    } else {
        $u->set("sysName", $name)
          ->set("description", $description)
          ->set("perm_developer", 0);
        $u->insert();
    }

    cache_engine::remove("params");
    PARAMS::set($name, (string)$value);   // גם בבקשה הנוכחית
}

ה-builder מקבל את שם הטבלה בלי CRM_ ומטפל ב-escape (ראו בנאי שאילתות). כשמוסיפים פרמטר חדש כחלק מהתקנה, עדיף INSERT ... ON DUPLICATE KEY UPDATE, כי sysName ייחודי:

INSERT INTO CRM_params (sysName, value, description, perm_developer)
VALUES ('my_feature_enabled', '1', 'הפעלת הפיצ''ר החדש', 0)
ON DUPLICATE KEY UPDATE description = VALUES(description);

LANGS: מילון הממשק#

איך נטען#

בהמשך אתחול הבקשה, אחרי PARAMS::init() וטעינת ההקשר של העמוד, PAGE::load קורא ל-LANGS::init_words(). הפונקציה טוענת את כל המילים בשפה הנוכחית (CONFIG::$lang) מהמטמון words_lang<N> (תוקף 4 שעות), ושומרת במערך בזיכרון. הטעינה היא DB::query("langs_words") עם השדות sysName, value; הצטרפות הערכים לשפה נעשית אוטומטית דרך טבלת התוכן (ראו מסד נתונים רב-לשוני).

השפה היא מזהה פלטפורמה (CRM_platforms.id, ראו פלטפורמות ורב-לשוניות), ולכל פלטפורמה מילון משלה.

הטבלאות#

קריאה#

echo LANGS::get_word("EDIT");                  // בשפת הבקשה הנוכחית
echo LANGS::get_word("EDIT", 2);               // בשפה 2, שאילתה למסד בכל קריאה

בתבניות Smarty:

<button>{LANGS::get_word('EDIT')}</button>

עריכה#

מילים נערכות בפאנל הניהול הוותיק ui_langs_legacy, שבו קבוצות (insertGroup), מילים (insertWord) ורשימת מילים בקבוצה. כל שמירה מנקה את מטמון המילים (cache_engine::remove("words")), מרעננת אותו (LANGS::init_words()) ומפעילה את האירוע words_update (PAGE::trigger).

כתיבה מהקוד#

הוספה של מילה חדשה היא שורה ב-CRM_langs_words ושורת ערך לכל שפה ב-CRM_langs_words_content. בסקריפט התקנה אפשר לכתוב את זה כך:

INSERT INTO CRM_langs_words (sysName, group_id) VALUES ('CHECKOUT_TITLE', 1);

INSERT INTO CRM_langs_words_content (parentId, langId, value)
SELECT id, 1, 'סיכום הזמנה' FROM CRM_langs_words WHERE sysName = 'CHECKOUT_TITLE' LIMIT 1
ON DUPLICATE KEY UPDATE value = VALUES(value);

ואחרי כל שינוי, מנקים את המטמון:

cache_engine::remove("words");

הפרמטר הוא קידומת של שם קובץ המטמון, ו-words תופס את words_lang1, words_lang2 וכן הלאה בכל תיקיות המטמון.

מתי מנקים מטמון#

מנגנון המטמון שומר ערך רק אם מספר שגיאות ה-DB לא עלה בזמן בנייתו, כך שתקלה רגעית לא "נתקעת" במטמון עד פקיעת התוקף (ראו API המטמון).

ראו גם#

• רפרנס: פרמטרים ושפות
• API המטמון
• ניהול מטמון
• פלטפורמות ורב-לשוניות
• מסד נתונים רב-לשוני
• משימות מתוזמנות
• דוא"ל ותור שליחה