קונפיגורציה (CONFIG_USER)

הקונפיגורציה של אתר היא מחלקה אחת, CONFIG_USER, בקובץ system/config.php של האתר. הליבה לא מגדירה אותה: היא מצפה שהאתר כבר הגדיר אותה לפני שהיא נטענת, ומרחיבה אותה במחלקה משלה. הדף הזה מפרט כל מאפיין שהליבה קוראת, אילו חובה, מה קורה כשהם חסרים, ואיפה בקוד כל אחד נקרא.

נתיבי קבצי ליבה בדף כתובים יחסית ל-api/core בריפו (למשל collections/DB.php). בעת הפריסה התיקייה הזו יושבת ב-system/core/ של האתר, ראו מבנה התיקיות של אתר. רשימת הפניות בסגנון ספר חתימות נמצאת ב-CONFIG_USER (רפרנס).

איפה הקונפיגורציה מוגדרת ומתי היא נטענת#

הסדר הוא קבוע, והוא נובע מ-index.php של האתר ומ-core.php:

1. index.php עושה require_once("system/config.php"). הקובץ מגדיר class CONFIG_USER עם מאפיינים סטטיים.
2. index.php הופך את CONFIG_USER::$core_path מנתיב יחסי לנתיב מוחלט (ראו הערה בהמשך).
3. index.php טוען את core.php של הליבה. הוא טוען את כל קבצי collections/*.php, ביניהם collections/CONFIG.php שמגדיר class CONFIG extends CONFIG_USER.
4. CONFIG::preinit() רץ ראשון, אחריו MISC::cli_check() ואז CONFIG::init(). רק אחרי כל אלה נטען application/includes/init.php של האתר, ואחריו בדיקת ה-page cache וניתוב הבקשה.

כל הקוד של הליבה והאתר פונה אל CONFIG::$something (לא אל CONFIG_USER). בזכות הירושה שני השמות מצביעים על אותם נתונים, אבל CONFIG היא גם זו שמוסיפה את המאפיינים שהיא מחשבת בעצמה.

<?php
// system/config.php: הקובץ היחיד שהאתר כותב, הליבה לא נוגעת בו
class CONFIG_USER
{
    static $db_type = "PDO";
    // ... ראו את הטבלה ואת הדוגמה המלאה בהמשך
}

core_path: מה index.php עושה איתו#

ב-system/config.php רושמים את core_path כנתיב יחסי, "system/core" בהתקנה רגילה. index.php של האתר ממיר אותו לנתיב מוחלט, והליבה קוראת אותו כנתיב מוחלט בכל מקום (CONFIG::$core_path מופיע בקוד הליבה כ-470 פעמים).

<?php
// index.php של האתר (ללא display_errors: בייצור לא מציגים שגיאות בדפדפן)
error_reporting(E_ALL);

ob_start("ob_gzhandler");

require_once("system/config.php");

// מציאת נתיב הליבה האמיתי
$ex = explode("../", CONFIG_USER::$core_path);
$realPath = dirname(__FILE__);
if (CONFIG_USER::$core_path != "system/core") for ($i = 0; $i < (count($ex)); $i++) $realPath = dirname($realPath);
CONFIG_USER::$core_path = $realPath . "/" . $ex[(count($ex) - 1)];

// טעינת הליבה
require_once(CONFIG_USER::$core_path . "/core.php");

עבור "system/core" המשתנה $realPath נשאר שורש האתר והתוצאה היא <שורש האתר>/system/core. אם הליבה יושבת מחוץ לאתר (ליבה משותפת למספר אתרים), הערך נכתב עם קידומת ../, והלולאה מטפסת count($ex) רמות מעל שורש האתר, כלומר רמה אחת יותר ממספר ה-../ שכתבתם.

מאפיינים ש-CONFIG מגדירה בעצמה#

אל תצהירו על המאפיינים האלה ב-CONFIG_USER. collections/CONFIG.php מצהיר עליהם (שורות 6-16, מסומנים שם "Do not defind this variables") ומחשב אותם בכל בקשה.

CONFIG::preinit#

preinit() רץ לפני כל גישה למסד הנתונים ועושה ארבעה דברים:

• קובע date_default_timezone_set('Asia/Jerusalem'). האזור קבוע בקוד ולא ניתן להגדרה ב-CONFIG_USER.
• קובע את $protocol ואת $base_path.
• הופך את $models_folder ל-נתיב מוחלט: $base_path . "/" . $models_folder, ואם הוא מכיל ../ עובר דרך realpath().
• עושה את אותו דבר ל-$cache_folder.

CONFIG::init: בחירת הפלטפורמה#

init() קורא את CRM_platforms דרך cache_engine::get("platforms", ..., 24*30, false) (מטמון גלובלי ל-30 יום, מפתח לפי עמודת domain) וממפה את הבקשה לפלטפורמה:

1. התאמה מדויקת של $_SERVER['SERVER_NAME'] לעמודת domain.
2. אם אין, מחפשים בעמודת allowed_domains של כל פלטפורמה (מפוצלת לפי MISC::bgl_explode) שם שמכיל את ה-host. אם נמצא, גם $env_url מתעדכן ל-host המבוקש.
3. אם עדיין אין, נבחרת הפלטפורמה הראשונה בטבלה.

כלומר הליבה אף פעם לא נכשלת בבחירת פלטפורמה. הדחייה של דומיין לא מוכר קורה אחר כך, ב-PAGE::load (ראו $ignore_domain_check). פרטי הפלטפורמות בדף פלטפורמות ורב-לשוניות.

הטבלה המלאה: מאפיינים שהאתר חייב להצהיר עליהם#

ה"חובה" בטבלה פירושו שהליבה קוראת את המאפיין בלי isset. גם מאפיין שנקרא רק בתנאי (למשל SMTP) מסומן, עם התנאי בעמודת המשמעות, כי כשהתנאי מתקיים המאפיין חייב להיות קיים.

מסד נתונים#

נתיבים וניתוב#

התנהגות#

אחסון קבצים#

מפתחות S3 לא ב-CONFIG. הליבה קוראת אותם מ-MISC::$GLOBALS["Storage_remote_s3_key"], ["Storage_remote_s3_secret"] ו-["Storage_remote_s3_bucket"] (STORAGE.php:446-452), ואף קובץ בליבה לא מגדיר אותם. האתר מציב אותם ב-application/includes/init.php (ראו הדוגמה בהמשך). פרטי ההעלאה ב-STORAGE: העלאה ואחסון.

דואר#

פירוט נוסף בדף שליחת דואר.

מאפיינים אופציונליים#

הליבה קוראת אותם רק אחרי isset או property_exists, ולכן אפשר להשמיט אותם:

מאפיין אחד שרידי: $zend_db נקרא רק ב-zend_query של DB.php (שורה 1282), פונקציה שבורה שלא נקראת מהליבה. אל תצהירו עליו.

שכבות קונפיגורציה אחרות#

CONFIG_USER מכילה רק את מה שחייב להיות ידוע לפני שיש חיבור למסד: חיבור, נתיבים ומצבי הפעלה. כל השאר חי במסד, ומנוהל מפאנל הניהול:

• פלטפורמה (CRM_platforms): דומיין, allowed_domains, ערכת נושא ברירת מחדל (deftheme), כותרת ותיאור SEO ברירת מחדל, כיוון שפה. השורה הנבחרת היא CONFIG::$platform_data. ראו פלטפורמות ורב-לשוניות.
• פרמטרים (CRM_params): מפתח וערך (sysName, value) שנטענים כולם בבקשה לזיכרון דרך PARAMS::init() ונקראים עם PARAMS::get("key"). מטמון של 30 יום. ראו פרמטרים ומילים.
• מילים (CRM_langs_words): טקסטים לפי שפה, דרך LANGS::init_words(), מטמון words_lang<lang> ל-4 שעות.

כלל אצבע: ערך שמשתנה בין סביבות (dev ו-production) או מכיל סוד נשאר ב-CONFIG_USER; ערך שעורך תוכן או מנהל אמור לשנות נכנס ל-PARAMS.

דוגמה מינימלית#

האתר הקטן ביותר שרץ: מסד MySQL, אחסון מקומי, בלי SMTP.

<?php
// system/config.php
class CONFIG_USER
{
    // מסד נתונים
    static $db_type     = "PDO";
    static $db_host     = "localhost";
    static $db_dbname   = "mysite";
    static $db_user     = "mysite";
    static $db_password = "change-me";
    static $db_prefix   = "CRM";                    // חייב להישאר CRM

    // נתיבים וניתוב
    static $core_path      = "system/core";         // יחסי: index.php הופך אותו למוחלט
    static $models_folder  = "application/models";
    static $cache_folder   = "cache";
    static $admin_url      = "wizzocms";
    static $default_module = "home";

    // התנהגות
    static $allow_cache         = true;
    static $use_smarty          = true;
    static $minify_html         = true;
    static $ignore_domain_check = false;

    // אחסון מקומי
    static $storage_remote = "";

    // דואר: PHP mail()
    static $mail_queue   = false;
    static $mail_is_smtp = false;
}

דוגמה לייצור: S3, SMTP ואופציות#

אתר ייצור עם הסביבה מוגדרת, SMTP, הסוואה, והגבלת מדינות. כל הערכים שבדוגמה הם מקומות שמורים, ולא ערכים אמיתיים.

<?php
// system/config.php (מוגן ע"י system/.htaccess ואסור לשמור אותו ב-git)
class CONFIG_USER
{
    static $db_type     = "PDO";
    static $db_host     = "127.0.0.1";
    static $db_port     = 3306;
    static $db_dbname   = "prod_site";
    static $db_user     = "prod_site";
    static $db_password = "from-your-secret-store";
    static $db_prefix   = "CRM";

    static $core_path      = "system/core";
    static $models_folder  = "application/models";
    static $cache_folder   = "cache";
    static $admin_url      = "manage-7f3a";          // slug לא צפוי, אותיות ומקף בלבד
    static $default_module = "home";

    static $allow_cache         = true;
    static $use_smarty          = true;
    static $minify_html         = true;
    static $ignore_domain_check = false;
    static $environment         = "production";
    static $show_wizzo_credits  = false;
    static $set_base_domain     = ".example.com";    // cookie משותף לכל תתי-הדומיינים
    static $admin_countries     = ["IL"];
    static $mask                = true;              // הסוואת נתיבי theme / minify / system/js

    // אחסון ב-S3: המפתחות ב-MISC::$GLOBALS (ראו init.php בהמשך)
    static $storage_remote = "s3";

    // דואר דרך SMTP
    static $mail_queue         = true;
    static $mail_is_smtp       = true;
    static $mail_smtp_host     = "smtp.example.com";
    static $mail_smtp_port     = 587;
    static $mail_smtp_secure   = "tls";
    static $mail_smtp_auth     = true;
    static $mail_smtp_username = "mailer@example.com";
    static $mail_smtp_password = "from-your-secret-store";
}

<?php
// application/includes/init.php: נטען בכל בקשה אחרי CONFIG::init()
MISC::$GLOBALS["Storage_remote_s3_key"]    = "AKIA...";   // להביא ממשתנה סביבה או מכספת
MISC::$GLOBALS["Storage_remote_s3_secret"] = "...";
MISC::$GLOBALS["Storage_remote_s3_bucket"] = "my-bucket";