umvc

إطار UMVC

الإصدار 2.0.2-2024-12-13

إطار عمل بسيط لتطبيق الويب ينفذ النمط المعماري للسيطرة على عرض النموذج (MVC).

الميزات الرئيسية

• وجهات نظر بسيطة من HTML/PHP مع تسلسل هرمي عرض
• اتصال قاعدة البيانات المستندة إلى PDO مع منشئ الاستعلام المستند إلى المصفوفة (تم تنفيذ MySQL فقط)
• فصول طراز سهلة الاستخدام
• مسار URL بسيط لترجمة وحدة التحكم/الطريقة مع مرور المعلمة التلقائية
• دعم ترحيل قاعدة البيانات
• تسجيل الدخول إلى المستخدم عبر SAML (باستخدام هذه الميزة يحتاج composer require "simplesamlphp/simplesamlphp:^2.2" )

الوحدات النمطية

يدعم UMVC الوحدات النمطية ، انظر التكوين/المكونات.

دعم الترميز

يدعم الإطار الاختبار الوظيفي باستخدام البرنامج المساعد الإطاري. يجب أن يكون الترميز المثبت عالميًا متوافقًا مع المطلوب (حاليًا v3.1.2)

سطر الأوامر

UMVC يدعم CLI. يمكنك إنشاء الأوامر الخاصة بك. الأوامر المدمجة هي:

• تهاجر

قم بتشغيل الأوامر php app $command $action $parameters

تثبيت

يمكن تضمين الإطار في مشروعك مع الملحن. composer require uhi67/umvc:dev-master . يمكن إنشاء مشروع جديد فارغ باستخدام composer create-project --prefer-dist uhi67/umvc-app name . سيوفر لك هذا تطبيقًا فارغًا جديدًا باستخدام OMVC Framework في الدليل المسماة. اختر أي اسم تفضله.

الخطوات الأولى لإنشاء تطبيقك باستخدام UMVC

تحذير: هذا الجزء قيد الإنشاء. تعرف على المزيد حول الفصول المذكورة في docblock من تعريف الفصل.

1. إنشاء composer.json من التطبيق الخاص بك ، وتضمين uh67/umvc ، مثل composer init --name myname/myapp --require uhi67/umvc:* .
2. تشغيل composer update .
3. نسخ vendor/uh67/umvc/app إلى جذر التطبيق الخاص بك. هذا هو قاذفة أوامر CLI.
4. نسخ vendor/uh67/umvc/www/index.php و .htaccess إلى دليل www الخاص بك. هذا هو جهاز التوجيه لواجهة الويب.
5. قم بإنشاء تكوين التطبيق في ملف config/config.php ، راجع القالب في vendor/uh67/umvc/config/config-template.php .
6. قم بإنشاء دليل runtime يمكن كتابته بواسطة خادم الويب لوضع ملفات مؤقتة.
7. قم بإنشاء دليل www/assets الذي يمكن كتابته بواسطة خادم الويب لوضع ملفات الأصول المخزنة مؤقتًا من مكونات مختلفة.

بناء التطبيق الخاص بك باستخدام نمط MVC

1. قم بإنشاء وحدات التحكم الخاصة بك في DIR controllers ، باستخدام مساحة اسم appcontrollers ، واستخلصها من uhi67umvcController .
2. قم بإنشاء طرق العرض في views Dir ، بتنسيق PHTML بسيط ، وقم بتنظيمها وفقًا لفيلم views/controller/action.php .
3. قم بإنشاء النماذج الخاصة بك في دليل models . نماذج قاعدة البيانات هي uhi67umvcModel ، نماذج أقل من قاعدة البيانات هي uhi67umvcBaseModel .

المبادئ الأساسية الأخرى

1. الترحيل مخصصة لإصدار تغييرات وتسجيل قاعدة بيانات في التعليمات البرمجية المصدر. وضع خطوات الهجرة في دليل migrations .
2. التصميم هو وجهة نظر خاصة لتضمين جميع المشاهدات الأخرى داخل. ضع التخطيطات في دليل views/layouts . يمكن أن تسمي المشاهدات وجهات نظر جزئية أخرى.
3. يمكنك تحديد أوامر CLI في دليل commands ، مستمدة من فئة uhi67umvcCommand . هناك بعض الأوامر المدمجة في الإطار. يسرد أوامر php app جميع الأوامر المتاحة ، سواء المدمجة والمخصصة.
4. دعم توطين بسيط قائم على الملفات مدمج. ضع ترجماتك في ملفات messges/la.php حيث "LA" هي اللغة التي تريد ترجمتها إلى.

تكوينات المكونات وخصائصها

جميع المكونات ، معظم فئات UMVC ، بما في ذلك فئة التطبيق الرئيسية نفسها ، هي uhi67umvcComponent . يطبق Component ميزات الخاصية : يستخدم Magic Getter و Setter أساليب GetProperty و SetProperty. Component قابل للتكوين : يقبل مُنشئ صفيف تكوين يحتوي على قيم للخصائص العامة.

مكونات مدمجة

1. MySqlConnection - للاتصال بقاعدة البيانات. يتضمن SQL Builder Builder. حاليا التنفيذ الوحيد Connection .
2. FileCache - التنفيذ الوحيد لـ CacheInterface .
3. SamlAuth - التنفيذ الوحيد لـ AuthManager .
4. L10n التوطين البسيط ، التلقائي التلقائي ، يترجم رسائل UMVC فقط.
5. L10nFile التعريب القائم على الملف لترجمة رسائل التطبيق الخاص بك.

الفصول الأساسية الأخرى التي يمكنك استخدامها

1. Form عنصر واجهة مستخدم مع عرض مدمج لعرض نماذج HTML ومعالجتها باستخدام النماذج الخاصة بك.
2. Grid (عنصر واجهة مستخدم ، ولكن العرض المدمج لا يزال مفقودًا)-لعرض قوائم النماذج المصفاة.
3. Query - يمثل استعلام SQL معرضة ومرنة في بنية PHP. يمكن بناء أمر SQL منه.
4. Request - يمثل طلب HTTP ، يمكن استخدامه لجلب المعلمات GET ونشرها.
5. Session - تمثل جلسة PHP الحالية ، يمكن استخدامها للحصول على المتغيرات وضبطها.

البرامج النصية للدخول وعنوان URL والتوجيه

البرنامج النصي الإدخال الفردي لتطبيق الويب هو www/index.php . على التوالي ، البرنامج النصي المفرد لتطبيق CLI هو ملف app . يجب نسخ كلاهما في دليل التطبيق الخاص بك من vendor/uhi67/umvc/ الدليل.

تقوم قواعد www/.htaccess بإعادة توجيه جميع الطلبات غير المؤهلة إلى www/index.php . ومع ذلك ، يتم تقديم الأصول الثابتة مباشرة من دليل www. تعرف على المزيد حول خدمة أصول المكتبة لاحقًا.

يقوم index.php بتهيئة Autoloader ، وتحميل التكوين الرئيسي ، ويقوم بإنشاء الكائن الرئيسي (الفئة المحددة في التكوين ، وعادة ما تكون uhi67/umvc/App أو سليلها). يتبع التكوين الرئيسي قواعد Component القابل للتكوين.

التوجيه

تتم معالجة جميع عناوين URL التي تم تشكيلها على أنها https: // myapp/acontroller/anaction بالطريقة التالية:

uhi67/umvc/App يوسع الطلب ، ويحسب فئة وحدة التحكم الفعلية (المشتقة من uhi67/umvc/Controller ) لاستخدامها ، ويقوم بإنشاء وحدة التحكم وتشغيل طريقة الإجراء المطلوبة. كما هو الحال في المثال أعلاه ، يشير Acontroller إلى فئة وحدة التحكم الخاصة بك في دليل controllers الخاصة بك باعتباره acontrollerController ، ويشير Anaction إلى طريقة الإجراء (كـ ActionAnaction ).

إذا كان اسم الإجراء مفقودًا من عنوان URL ، فسيتم تشغيل actionDefault . إذا كان اسم وحدة التحكم مفقودًا أيضًا ، فسيتم استخدام MainController المكونة. من الممكن أيضًا إنشاء عنوان URL مع اسم إجراء وحدة التحكم الافتراضية دون تحديد اسم وحدة التحكم - التقييد الوحيد الذي لا يمكن أن يكون لديك وحدة تحكم تحمل نفس الاسم مثل هذا الإجراء.

يتم معالجة أمر AL CLI على أنه php app acontroller/anaction بالطريقة التالية:

uhi67/umvc/App يوسع الطلب ، ويحسب فئة وحدة التحكم الفعلية (المشتقة من uhi67/umvc/Command ) لاستخدامها ، وتنشئ وحدة التحكم وتشغيل طريقة الإجراء المطلوبة. كما هو الحال في المثال أعلاه ، يشير Acontroller إلى فئة وحدة التحكم الخاصة بك في دليل commands الخاصة بك على أنه AcontrollerController ، ويشير Anaction إلى طريقة الإجراء (كـ ActionAnaction ). يمكن تشغيل الأوامر المدمجة بنفس الطريقة. إن الأمر الذي يحمل نفس الاسم في تطبيقنا يتجاوز الأمر المدمج.

استخدام عناوين URL في إجراء وحدة التحكم الخاصة بك

يمكن الوصول إلى أجزاء طلب عنوان URL الحالي على النحو التالي:

• المسار: تم تمرير جزء المسار إلى وحدة التحكم (تم تحويل اسم وحدة التحكم بالفعل)
• الاستعلام: جزء الاستعلام من الطلب الأصلي ، كصفيف نقابي

لإنشاء عنوان URL جديد باستخدام وحدة التحكم وأسماء الإجراءات ، ومعلمات OptioAnl Qurey ، استخدم واحدة مما يلي:

• $ this-> app-> createUrl (['controller/action' ، 'key' => 'QueryValue' ، ... ، '#' = 'fragment'])-جميع الأجزاء اختيارية
• إرجاع $ this-> app-> redirect ([...])-لإنهاء الإجراء بإعادة توجيه

خدمة أصول المكتبة

في ملفات العرض الخاصة بك ، يمكنك إحالة أصولك الثابتة الموجودة تحت دليل www بطريقة ثابتة ، على سبيل المثال <link href="/assets/css/app.css" rel="stylesheet"> . على العكس من ذلك ، إذا كنت تريد الرجوع إلى ملف الأصول الموجود في مكان ما في مكتبة البائعين التي أنشأها الملحن ، فيمكنك استخدامها بهذه الطريقة:

• <script src="<?= $this->linkAssetFile('npm-asset/bootstrap/dist', 'js/bootstrap.bundle.min.js') ?>"></script>

تقوم دالة linkAssetFile بنسخ جميع الملفات من الدليل في الوسيطة الأولى في دليل ذاكرة التخزين المؤقت للأصول تحت www ، وإنشاء عنوان URL صالح للملف int الوسيطة الثانية. ملاحظة: معرف الوسيطة الأولى حزمة الأصول. فقط المكالمة الأولى لأي حزمة تقوم بنسخ الملفات. جميع المكالمات اللاحقة إلى نفس الحزمة تنشئ الرابط للملف فقط.

يتم إفراغ ذاكرة التخزين المؤقت للأصول بواسطة أمر composer install . ذاكرة التخزين المؤقت للأصول هي دائمًا www/asset/cache ولا يمكن تكوينها.

مواضيع أخرى (قريبا)

• قطع الأشجار
• الهيكل الأساسي لتحديث نموذج باستخدام النموذج
• ترقيم الشبكة والتصفية
• التحقق من صحة النموذج
• المساعدون (فصول ذات طرق ثابتة فقط)

...

معلومات تطوير الإطار

اختبارات التثبيت المستقلة والوحدة الداخلية

يحتوي هذا المستودع على تطبيق اختبار مدمج لاختبارات وحدة الترميز الداخلية. الغرض الوحيد من تطبيق الاختبار في دليل tests هو أن تكون قادرًا على إجراء اختبارات الوحدة ، وليس تطبيق عينة للبدء به.

خطوات التثبيت المستقلة:

• git clone
• composer update
• قم بإنشاء tests/_data/test-config.php بناءً على القالب
• قم بإنشاء قاعدة بيانات umvc-test وفقًا لإعدادات قاعدة البيانات في tests/_data/test-config.php
• قم بتشغيل php vendor/bin/codecept run unit لاختبارات الوحدة

المزيد من اختبارات الوحدة قادمة ...

الاختبار في Docker

يمكن استخدام بيئة اختبار مضمّنة مقيدة للاختبار باستخدام إصدارات مختلفة من PHP وقاعدة البيانات.

خطوات:

1. قم بتكوين إصدار قاعدة البيانات المطلوب في tests/docker-compose.yml (اصنع استنساخًا من ملف القالب)
2. قم بتكوين إصدار PHP في tests/docker/Dockerfile (قد تتغير خطوات تثبيت الامتداد)
3. تكوين المنافذ المستخدمة و base-url في tests/.env
4. قم ببناء المكدس باستخدام docker compose up --build -d (في tests DIR)
5. يجب أن تكون حاوية PHP الخاصة بك الآن "UMVC-PHP-1"
6. قم بتشغيل اختبارات الوحدة مع docker exec -it umvc-php-1 php vendor/bin/codecept run unit

تغيير السجل

الإصدار 2.0.2-"2024-12-13"

• urlpath ، إصلاحات baseurl
• مصائد تصحيح الأخطاء تمت إزالتها

الإصدار 2.0.1-"2024-12-04"

• تثبيت :: creardir () حذف الآن.

الإصدار 2.0-"2024-10-11"

• يتطلب PHP 8.2
• إصلاح استخدام baseurl

الإصدار 1.4-2024-07-25

• الاستعلام :: FilterInReferRedModels () أضيفت
• ذاكرة التخزين المؤقت الفارغة: Skip .Gitignore Files
• دليل UMVC وإحالة تطبيق UMVC
• إصلاحات توافق PHP 8
• الأخطاء الأخرى

الإصدار 1.3.1-2023-03-27

• SQL Builder: استخدم Tablename كمستعار افتراضي
• Migrate/Wait
• تأجيل الاتصال بالاتصال
• عرض محلي

الإصدار 1.3-2022-12-03

• القضايا معاملة SQL للهجرة
• MySQL 8.0 التوافق ، مع الحفاظ على التوافق 5.7
• التطبيق: عرض مسار ثابت
• CLI config check
• apphelper :: waitfor ()
• إصلاح الوحدة
• يتم تضمين تطبيق اختبار مقيد بسيط مع دليل الاختبار
• Docker: في انتظار تهيئة حاوية قاعدة البيانات (نهج بسيط)
• تمت إضافة وثائق الخطوات الأولى

الإصدار 1.2.1-2022-10-02

• غصين/غصين <2.15.3 إصلاح الضعف (Composer.lock)
• Authmanager :: ActionLogin () تمت إضافته لإصلاح مشكلة إرجاع تسجيل الدخول الافتراضي

الإصدار 1.2-2022-09-20

• bugfixes ، إصلاحات phpdoc
• لقد تغير توقيع Linkbutton
• الاتصال :: يعود الاتصال
• أساليب معلومات الاتصال (getTables () ، إلخ)
• MySqlConnection طرق dropxxx
• ترحيل/إعادة ضبط الأمر
• اختبارات الوحدة ، تطبيق اختبار (مسودة)
• تم إصلاح الرسالة السابقة ShowException
• فحص المفتاح الأساسي النموذج
• Samlauth: تحديث سجل المستخدم فقط عند تسجيل الدخول
• تم إزالة ملف الإصدار

الإصدار 1.1-2022-08-30

• تحسينات سجل الأصول (Controller :: RegisterAssets () ، إلخ)
• HTML :: IMG () أضيفت
• جلسة ، طلب ، فصول fileUpload
• التوطين (التطبيق :: l () ، التطبيق :: $ locale ، l10n ، l10nfile ، إلخ)
• التطبيق: معلمة التخطيط الافتراضي
• عرض bugfixes
• samlauth :: get () ثابت

ترقية الملاحظات للإصدار 1.1

• يجب استبدال التطبيقات: