קונטרולרים של אתר

קונטרולר של אתר הוא קובץ PHP אחד ב-application/controllers/<name>.php עם מחלקה באותו שם, שיורשת מ-wz_controller. כל מתודה ציבורית שלו היא כתובת: /<name> מריץ את index(), ו-/<name>/<method> מריץ את המתודה. הקונטרולר מחזיר מחרוזת HTML, וה-theme עוטף אותה בעמוד.

system/ בעמוד הזה הוא תיקיית הליבה הפרוסה (api/core בריפו), ו-{admin} הוא CONFIG::$admin_url. קונטרולרים של הליבה עצמה מתוארים ב-קונטרולרי מערכת.

שלושה תנאים כדי שכתובת תגיע לקונטרולר#

1. קובץ ומחלקה. application/controllers/news.php שמגדיר class news. שם הקובץ והמחלקה זהים לחלוטין (רגישים לאותיות גדולות וקטנות ב-Linux).
2. שורה פעילה ב-CRM_modules. MODULE::get_html מחפש את moduleName ב-MISC::get_modules_tbl() ודורש active == "1". בלי שורה, או עם active = 0, התשובה היא 404.
3. מתודה ציבורית. is_callable([$mdl, $page]) חייב להצליח. מתודה פרטית או שלא קיימת מובילה ל-404.

INSERT INTO CRM_modules (moduleName, active) VALUES ('news', 1);

אחרי הוספה ידנית ב-SQL נקו את המטמון של הטבלה: cache_engine::remove("modules");. הטבלה נשמרת תחת modules_lang<מזהה פלטפורמה> ל-7 ימים, והמפתח modules תופס אותה לפי קידומת. כשמוסיפים מודול מפאנל {admin}/Modules הניקוי נעשה אוטומטית.

קונטרולר מינימלי#

<?php
// application/controllers/news.php
class news extends wz_controller
{
    // GET /news          => index()
    // GET /news/12       => index() עם $_GET["id"] = "12"
    // GET /news/archive  => archive()
    function index()
    {
        PAGE::$cache_this_page = true;          // מטמון עמוד מלא (ראו page-cache)
        PAGE::$cache_this_page_hours = 6;

        $id = (int)($_GET["id"] ?? 0);
        if ($id > 0)
        {
            $row = DB::query("news", ["id" => $id])->get_row();
            if (!$row) return "ERRORPAGE";      // 404
            SEO::set_var("title", $row["title"]);
            return $this->view("news/item", ["row" => $row]);
        }

        SEO::set_var("title", "חדשות");
        $rows = DB::query("news", ["is_active" => "1"], "id DESC", "", "0,20")->get_all();
        return $this->view("news/list", ["rows" => $rows]);
    }

    function archive()
    {
        return $this->view("news/archive");
    }
}

תבנית ה-Smarty של הדוגמה, application/views/news/list.tpl:

<ul class="news-list">
{foreach $rows as $row}
    <li><a href="/news/{$row.id}">{$row.title|escape}</a></li>
{/foreach}
</ul>

מה הקונטרולר מחזיר#

המחלקה wz_controller#

הקובץ system/collections/MODULE.php מגדיר את הבסיס (bgl_controller הוא כינוי ל-wz_controller, והוא נפוץ בקוד הליבה ובקוד ישן):

view() מקבל נתיב בלי סיומת ובלי / בהתחלה. הרינדור עצמו מתואר ב-תבניות Smarty.

$this->load: מודלים וספריות#

function index()
{
    $this->load->model("m_articles");     // application/models/m_articles.php, ויוצר $this->m_articles
    $this->load->library("mail_tpl");      // system/libraries/mail_tpl.php (require_once בלבד)

    $rows = $this->m_articles->latest(10);
    return $this->view("news/list", ["rows" => $rows]);
}

מודל הוא קלאס רגיל, בדרך כלל extends bgl_model (כינוי ל-wz_model, שיורש מ-wz_controller ומוסיף את static merge(&$settings, $m_settings) למיזוג הגדרות ברירת מחדל):

<?php
// application/models/m_articles.php
class m_articles extends bgl_model
{
    function latest($count)
    {
        return DB::query("articles", ["is_active" => "1"], "id DESC", "", "0," . (int)$count)->get_all();
    }
}

נקודות סיום בלי עמוד: JSON, הפניה, קובץ#

הקונבנציה בליבה: להגדיר $_GET["pmode"] = "empg" בתוך המתודה, ואז PAGE::output() מדלג על ה-theme ועל ה-<html> ומדפיס רק את מה שהוחזר.

<?php
// application/controllers/news_api.php
class news_api extends wz_controller
{
    // GET /news_api/latest
    function latest()
    {
        $_GET["pmode"] = "empg";
        header("Content-Type: application/json; charset=utf-8");

        $rows = DB::query("news", ["is_active" => "1"], "id DESC", "", "0,5")->get_all();
        return json_encode($rows ?: [], JSON_UNESCAPED_UNICODE);
    }

    // GET /news_api/go/12
    function go()
    {
        $_GET["pmode"] = "empg";
        $id = (int)($_GET["id"] ?? 0);
        header("Location: /news/" . $id);
        exit;
    }
}

לפלט אחיד לכל המתודות, דורסים את wrapper(): analytics של הליבה מגדיר pmode=empg ועוטף כל תוצאה ב-json_encode(["data" => $content]).

קוד שרץ בכל בקשה: application/includes#

קבצי *.php ב-application/includes נכללים (FILES::include_dir, לפי סדר שם הקובץ, פעם אחת לבקשה) בכל בקשת לקוח, אחרי שהניתוב נקבע ולפני שהקונטרולר רץ. זה המקום לרשום אירועים (PAGE::bind), להוסיף נכסים גלובליים ולהגדיר PAGE::$parse_page_func. ראו PAGE: נכסים, מטא ואירועים.

מלכודות#

ראו גם#

• ניתוב (ROUTER): איך module, pname ו-id נקבעים
• תבניות Smarty: מה view() עושה
• קונטרולרי מערכת: ה-system/ prefix
• ערכות נושא: מי עוטף את הפלט
• 404, 503 ושגיאות
• ROUTER ו-MODULE (רפרנס)