ROUTER ו-MODULE

ROUTER הופך כתובת בקשה לשלושה משתנים ב-$_GET (module או sys_controller, pname, id) ו-MODULE טוען את הקונטרולר המתאים וקורא למתודה. שתי המחלקות סטטיות, נטענות אוטומטית עם שאר ה-collections, והן ב-system/collections/ROUTER.php וב-system/collections/MODULE.php (system/ הוא api/core בריפו). הדף הזה הוא הרפרנס; הסיפור המלא של בקשה מופיע ב-מחזור חיי בקשה, והמדריכים ב-ניתוב, כתובות ידידותיות ו-קונטרולרים של אתר.

{admin} בדף הזה הוא CONFIG::$admin_url. הערכים CONFIG::$admin_url, CONFIG::$default_module, CONFIG::$site_url ו-CONFIG::$models_folder מוגדרים בקונפיגורציית האתר (ראו CONFIG_USER).

איך הבקשה מגיעה לכאן#

core.php קורא ל-PAGE::load($_SERVER['REQUEST_URI']), ו-PAGE::load עושה בסדר הזה:

1. ROUTER::parse_friendly_url($url): ממלא $_GET ומציב CONFIG::$system_type ("client" או "admin").
2. בדיקת דומיין (רק ב-client, אלא אם CONFIG::$ignore_domain_check === true): SERVER_NAME חייב להיות platform_data["domain"] או אחד מ-allowed_domains, אחרת die("URL ERROR"). הקונטרולרים minify ו-Tools פטורים מהבדיקה.
3. ROUTER::redirections(): הפניות 301 (client בלבד).
4. טעינת application/includes ואז LANGS::init_words().
5. client: MODULE::get_html($_GET["sys_controller"], $_GET["pname"], true) כשיש sys_controller, אחרת MODULE::get_html($_GET["module"], $_GET["pname"]). admin: AdminModule (ראו סקירת פאנל הניהול).

ROUTER#

משתנים סטטיים#

ROUTER::parse_friendly_url()#

public static function parse_friendly_url(string $url)

הלב של הניתוב. מקבל נתיב עם query string אופציונלי (בדרך כלל REQUEST_URI), לא מחזיר ערך, ומשפיע על $_GET ועל CONFIG::$system_type. הסדר, מהראשון שמתאים:

הסיומות בסעיף 13: js css jpg jpeg png gif ico svg dic txt woff2 woff otf pdf doc docx xls.

נתיבי אדמין#

CONFIG::$admin_url מוכנס לביטוי רגולרי כמו שהוא, בלי preg_quote. השתמשו בשם של אותיות ומספרים בלבד (למשל wizzocms).

אחרי ההתאמה, אם מוגדרת רשימת מדינות לאדמין (admin_countries::get_active() שונה מ-false), הבקשה נבדקת מול המדינה של ה-IP. בקשה שנדחתה מופנית ל-/ עם exit. פטורות: בקשה פנימית שבה REMOTE_ADDR == SERVER_ADDR, וכתובות ש-WIZZO_NET::is_wizzo() מזהה. ראו התחברות, סשנים ו-WIZZO ID.

נתיבי client#

1. seoUrl מדויק: שורה ב-CRM_seoUrl עם regularexp = "0" ו-sysname שווה לנתיב (או לנתיב אחרי urldecode). התוצאה היא pageurl של השורה.
2. seoUrl רגולרי: כל שורה עם regularexp = "1" לפי סדר ord. sysname הוא ביטוי PCRE מלא עם תוחמים (למשל #^blog/(\d+)$#), ו-pageurl הוא ההחלפה, כשהתו $ מומר ל-\ (כלומר $1 הופך ל-\1). ההתאמה נבדקת על הנתיב ואז על urldecode שלו. השורה הראשונה שמתאימה מנצחת. ביטוי לא תקין מושתק ב-@ ופשוט נכשל.
3. אין התאמה: pageUrl = $url, כלומר הנתיב עצמו משמש כנתיב קונטרולר.

אם pageUrl מכיל ?, הפרמטרים שאחריו נכנסים ל-$_GET עם array_merge (הם גוברים על קיימים). אז הנתיב מותאם לפי הטבלה, מהמעלה למטה, וההתאמה הראשונה מנצחת:

הכתובת 404#

כשהנתיב הוא בדיוק 404, הניתוב שולח HTTP/1.1 404 Not Found ומציב PAGE::$is_404 = true, ואז ממשיך כרגיל. כלומר דף 404 הוא module בשם 404 (או שורת seoUrl עם sysname = "404"). אם אין כזה, התוצאה היא <h1>404 - Page not found</h1>. ראו 404, 503 ושגיאות.

ROUTER::redirections()#

public static function redirections()

מריץ הפניות 301 מהטבלה CRM_redirections (עמודות url_from, url_to; ניהול בפאנל redirections, ראו הפניות 301). נקרא מ-PAGE::load רק ל-client.

// דוגמה: רשומה url_from="old-page", url_to="new-page"
// GET /old-page?x=1  ->  301 Location: /new-page?x=1

ROUTER::get_seo_tbl()#

static function get_seo_tbl()

מחזיר את כל שורות CRM_seoUrl ממוינות לפי ord ASC, מתוך מטמון (cache_engine::get("seoUrl_tbl", ...), ברירת מחדל 24 שעות, פר פלטפורמה). הפאנלים Seo, seo_center והשדות FormInput_SEO מוחקים את המפתח בשמירה. קוד שכותב ל-CRM_seoUrl ישירות צריך לקרוא cache_engine::remove("seoUrl_tbl").

ROUTER::get_by_url()#

public static function get_by_url($url)

כתובת פנימית לכתובת ידידותית. מסיר את CONFIG::$site_url מההתחלה, מחפש שורה שבה pageurl שווה למחרוזת, ומחזיר את ה-sysname שלה. אין התאמה: מחזיר את הקלט.

$friendly = ROUTER::get_by_url("pages/12");   // "about-us" אם קיימת שורה כזו, אחרת "pages/12"

ROUTER::get_by_friendly()#

public static function get_by_friendly($url)

ההפך: מקבל sysname ומחזיר pageurl. אין התאמה: מחזיר את הקלט.

ROUTER::remove_by_url()#

public static function remove_by_url($url)

מוחק מ-CRM_seoUrl את השורות שבהן pageurl שווה למחרוזת (DB::delete("seoUrl", ["pageurl" => $url])), בלי ערך החזרה. המתודה לא מנקה את מטמון seoUrl_tbl; קראו cache_engine::remove("seoUrl_tbl") אחריה.

ROUTER::is_trace_on(), trace(), trace_render()#

public static function is_trace_on()
public static function trace($stage, $detail = [])
public static function trace_render()

הפעלה: הוסיפו ?__router_trace=1 לכל כתובת. שימוש מעשי ב-דיבוג ניתוב.

MODULE#

MODULE::get_html()#

public static function get_html($module, $page = "index", $is_system = false)

מחזיר את התוכן (מחרוזת) שהמתודה החזירה אחרי $controller->wrapper($content). התהליך:

קונטרולר אתר ($is_system = false)

1. MISC::get_modules_tbl() טוען את CRM_modules ממפתח לפי moduleName (מטמון modules_lang<lang>, 168 שעות).
2. אם $modules_tbl[$module] קיים ו-active == "1": MODULE::get($module) טוען את application/controllers/<module>.php. חסר קובץ או מחלקה: ERRORPAGE.
3. אם המתודה is_callable (ציבורית ומוגדרת, כולל מתודות שירשה המחלקה) היא נקראת; אחרת ERRORPAGE.
4. מודול שלא רשום או לא פעיל: אם קיים קובץ הקונטרולר והמבקר הוא אדמין, מודפס טופס "Click here to activate this module" שמפנה ל-/{admin}/Modules/insert וההרצה נעצרת (die). בכל מקרה אחר ERRORPAGE.

קונטרולר מערכת ($is_system = true)

טוען core_path/controllers/<module>.php בלי בדיקת CRM_modules. הקובץ צריך להתקיים והמחלקה להיקרא בדיוק כמו הקובץ; אחרת ERRORPAGE.

ערכי ההחזרה המיוחדים של מתודת קונטרולר#

פרמטר ה-pmode ב-$_GET: empg או inner גורמים ל-PAGE::output() להחזיר את התוכן בלי ה-theme (שימושי ל-AJAX ולנקודות קצה). קונטרולרי מערכת רבים מציבים $_GET["pmode"] = "empg" בעצמם בתחילת המתודה.

MODULE::get()#

public static function get($module, $is_system = false)

טוען את קובץ הקונטרולר (require_once) ומחזיר new $module(). מחזיר false כשהקובץ חסר או שאין מחלקה בשם הזה. שימושי לטעינת קונטרולר אחר מתוך קוד:

$mdl = MODULE::get("news");
if ($mdl) $html = $mdl->latest();

MODULE::get_controller_file_src()#

public static function get_controller_file_src($controller, $is_system = false)

מחזיר את הנתיב לקובץ: CONFIG::$core_path . "/controllers/<name>.php" כש-$is_system, אחרת CONFIG::$base_path . "/application/controllers/<name>.php". מחזיר false אם הקובץ לא קיים (is_file).

MODULE::errorpage()#

static function errorpage()

נקראת כשקונטרולר מחזיר "ERRORPAGE". לא להפעיל ישירות (ההחזרה "ERRORPAGE" היא הדרך). הסדר:

1. אם DB::had_error() (שאילתה נכשלה בבקשה הזו): MISC::service_unavailable("routing tables unavailable: ..."), כלומר HTTP 503 עם Retry-After: 120. הסיבה: טבלאות הניתוב (seoUrl, modules) מחזירות ריקות כשה-DB נחנק, וכל עמוד תקין היה מקבל 404 ונמחק מהאינדקס של גוגל.
2. ROUTER::parse_friendly_url("404"): שולח את כותרת 404, מציב PAGE::$is_404, ומציב מחדש את $_GET לפי הכתובת 404.
3. PAGE::$cache_this_page = false: דף שגיאה לא נכנס למטמון העמודים.
4. אם module שהתקבל פעיל ויש בו המתודה המבוקשת, היא נקראת (כך דף 404 מעוצב שנמצא ב-module).
5. אחרת מוחזר <h1>404 - Page not found</h1>.

סיכום קודי תגובה של הניתוב#

פירוט נוסף ב-הודעות שגיאה.

wz_controller והמחלקות הקשורות#

הקובץ MODULE.php מגדיר גם את מחלקות הבסיס. bgl_controller, bgl_model ו-bgl_loader הם כינויים ריקים לשמות הקודמים (class bgl_controller extends wz_controller {}); bgl_theme (ב-collections/theme.php) יורש מ-bgl_controller. קוד חדש יכול להשתמש בכל אחד מהשמות.

wz_controller#

class wz_controller
{
    var $load;                // bgl_loader
    static $loader;           // bgl_loader (המופע האחרון שנוצר)
    function __construct()
    function wrapper($pageContent)
    function view($tpl, $vars = array())
    function system_view($tpl, $vars = array())
    public function __get($name)
    public function __set($name, $value)
}

// application/controllers/news.php
class news extends wz_controller
{
    function index()
    {
        $rows = DB::query("news", ["is_active" => 1], "id DESC")->get_all();
        return $this->view("news/list", ["rows" => $rows]);   // application/views/news/list.tpl
    }

    // לא נגיש כתובת: private
    private function format($row) { return $row; }
}

wz_loader ($this->load)#

class wz_loader
{
    var $parent;
    function __construct(&$parent = null)
    function model($path)
    function library($path)
}

class news extends wz_controller
{
    function index()
    {
        $this->load->model("m_news");                 // application/models/m_news.php, class m_news
        $rows = $this->m_news->latest(10);
        return $this->view("news/list", ["rows" => $rows]);
    }
}

wz_model#

class wz_model extends wz_controller
{
    function __construct()
    static function merge(&$settings, $m_settings)
}

wz_model יורש את כל wz_controller (כולל view).

merge(&$settings, $m_settings) ממזג הגדרות לתוך מערך ברירות מחדל: רק מפתחות שכבר קיימים ב-$settings נדרסים; מחרוזות עוברות trim; ערך ריק ("", שאינו bool) נדלג, כך שלא דורס ברירת מחדל; מערכים ואובייקטים מועתקים כמות שהם.

$settings = ["limit" => 10, "order" => "id DESC"];
wz_model::merge($settings, ["limit" => 25, "order" => "", "unknown" => 1]);
// $settings == ["limit" => 25, "order" => "id DESC"]

bgl_theme#

המחלקה bgl_theme (ב-system/collections/theme.php) יורשת מ-bgl_controller ולכן יש לה view, load ו-wrapper. כך ערכת נושא משתמשת ב-$this->view() בדיוק כמו קונטרולר. ראו ערכות נושא.

ראו גם#

• ניתוב (ROUTER) ו-כתובות ידידותיות: המדריכים
• קונטרולרים של אתר ו-קונטרולרי מערכת
• דיבוג ניתוב ו-404, 503 ושגיאות
• מחזור חיי בקשה
• PAGE ו-cache_engine