Skip to content

Latest commit

 

History

History
204 lines (133 loc) · 15.8 KB

structure.md

File metadata and controls

204 lines (133 loc) · 15.8 KB

بنية المجلد في لارافل

المقدمة

توفر لارافل بنية افتراضية تسهل عليك بداية المشاريع سواء كانت مشاريع كبيرة أو مشاريع صغيرة, وأيضا لديك الحرية بتنظيم ملفاتك بالشكل الذي تراه مناسباً.

لاتفرض لارفل أية قيد على مكان وجود أي صف Class طالما أنه يتم تحميله بشكل تلقائي (Autoload ) عن طريق Composer

المجلد الرئيسي root directory

أولا: مجلد التطبيق App

مجلد التطبيق app يحوي الكود الرئيسي لتطبيقك (Core Code), سيتم توضيح هذا المجلد بشكل مفصل في الفقرات التالية.

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

مجلد الإقلاع Bootstrap

يحوي هذا المجلد ملف app.php والذي يقوم بإقلاع إطار العمل لارافل, وأيضا يحتوي هذا المجلد على المجلد الفرعي cache والذي يحوي ملفات الذاكرة المخبئية التي يتم توليدها بشكل تلقائي من خلال اطار العمل لتحسين الأداء على سبيل المثال ملفات مخبئية تخص المسارات (Routes) أو ملفات مخبئية خاصة بالخدمات (Services).

بأغلب الحالات ومن المستحسن ألا تقوم بتعديل أي ملف ضمن هذا المجلد

مجلد الإعدادات Config

مجلد الاعدادات (config) كما يشير الاسم, يحوي جميع ملفات الاعدادات الخاصة بالتطبيق.

ومن المهم جدا الاطلاع على هذه الملفات بُغية معرفة كافة الخيارات المتاحة ضمنها والتغيير فيها عند الحاجة بحسب طبيعة التطبيق الخاص بك.

مجلد قاعدة البيانات Database

يحوي هذا المجلد ملفات ترحيل قاعدة البيانات (migrations), مصانع البيانات (Factories) وملفات (Seeds).

وأيضا يمكن استخدام هذا المجلد لتخزين قواعد البيانات من النوع SQLite.

مجلد اللغة Lang

يحوي هذا المجلد جميع ملفات اللغة الخاصة بالتطبيق.

المجلد العام Public

يحوي هذا المجلد الملف index.php والذي يعتبر نقطة الانطلاق لجميع الطلبات الواردة للتطبيق ويضبط أيضا عملية التحميل التلقائي للصفوف (Classes Autoloading).

كما يستخدم هذا المجلد لتخزين ملفات الأصول (Assets) كالصور وملفات جافاسكريبت أو ملفات CSS.

مجلد الموارد Resources

يحوي هذا المجلد ملفات الواجهات views كما يحوي الملفات الخام, والغير مترجمة من ملفات جافاسكريبت أو CSS.

مجلد المسارات Routes

مجلد routes يحوي تعريف كل المسارات في التطبيق افتراضياً يوجد عدة ملفات ضمن هذا الملف وهي web.php و api.php وconsole.php و channels.php.

ملف web.php يحوي المسارات التي يصنفها RouteServiceProvider ضمن مجموعة البرمجيات الوسيطة(Middlewares) الخاصة بالـWeb, والتي تزود حالة الجلسة (Session State), حماية CSRF وتشفير ملفات تعريف الارتباط (Cookies). في حال كان تطبيقك لا يقدم خدمات عديمة الحالة Stateless أو RESTful APIs فإنه من الشائع جداً تعريف جميع المسارات الخاصة بالتطبيق في هذا الملف.

ملف api.php يحوي جميع المسارات التي يصنفها RoutueServiceProvider ضمن مجموعة البرمجيات الوسيطة (Middlewares) الخاصة بالـAPI. تكون هذه المسارات عديمة الحالة (Stateless) والذي يعني أن الطلبات الواردة للتطبيق لا تملك وصول لحالة الجلسة ويمكن مصادقتها (Authenticate) من خلال tokens

ملف console.php هو الملف الذي يتم تعريف أوامر التحكم Console Commands والمعتمدة على Closures. كل منها يتم ربطه بأمر Command بحيث تقدم طريقة بسيطة للتفاعل الدخل والخرج الخاص بهذا الأمر.

يجب ملاحظة أن هذه المسارات في هذا الملف هي ليست مسارات HTTP وإنما هي مسارات يمكن التفاعل بها مع التطبيق من خلال Console.

ملف channels.php يتم تخزين جميع قنوات أحداث البث العام event broadcasting التي يدعمها تطبيقك.

مجلد التخزين Storage

مجلد التخزين storage يحوي جميع ملفات السجلات (logs), قوالب Blade المترجمة, ملفات الجلسات, ملفات الذاكرة المخبئية, والعديد من الملفات الأخرى التي يتم توليدها من قبل إطار العمل لارافل. هذا المجلد مقسم الى المجلدات الفرعية التالية app و framework و logs.

مجلد app يستخدم لتخزين الملفات التي يولدها التطبيق

مجلد framework يستخدم لتخزين الملفات المولدة من قبل اطار العمل وملفات الذاكرة المخبئية.

وأخيرا مجلد logs يستخدم لتخزين السجلات الخاصة بتطبيقك كسجلات الطلبات أو سجلات الأخطاء وغيرها.

مجلد storage/app/public يستخدم لتخزينن الملفات التي يقوم المستخدم بتوليدها أو رفعها على سبيل المثال الصور الشخصية Avatars, يجب أن يكون هذا المجلد قابل للوصول بشكل عام Publicly Accessible من خلال اضافة وصلة رمزية Symbolic Link في public/storage تشير لهذا المجلد.

يمكن انشاء هذه الوصلة من خلال أمر Artisan التالي php artisan storage:link

The Tests Directory

The tests directory contains your automated tests. Example PHPUnit unit tests and feature tests are provided out of the box. Each test class should be suffixed with the word Test. You may run your tests using the phpunit or php vendor/bin/phpunit commands. Or, if you would like a more detailed and beautiful representation of your test results, you may run your tests using the php artisan test Artisan command.

The Vendor Directory

The vendor directory contains your Composer dependencies.

The App Directory

The majority of your application is housed in the app directory. By default, this directory is namespaced under App and is autoloaded by Composer using the PSR-4 autoloading standard.

The app directory contains a variety of additional directories such as Console, Http, and Providers. Think of the Console and Http directories as providing an API into the core of your application. The HTTP protocol and CLI are both mechanisms to interact with your application, but do not actually contain application logic. In other words, they are two ways of issuing commands to your application. The Console directory contains all of your Artisan commands, while the Http directory contains your controllers, middleware, and requests.

A variety of other directories will be generated inside the app directory as you use the make Artisan commands to generate classes. So, for example, the app/Jobs directory will not exist until you execute the make:job Artisan command to generate a job class.

{tip} Many of the classes in the app directory can be generated by Artisan via commands. To review the available commands, run the php artisan list make command in your terminal.

The Broadcasting Directory

The Broadcasting directory contains all of the broadcast channel classes for your application. These classes are generated using the make:channel command. This directory does not exist by default, but will be created for you when you create your first channel. To learn more about channels, check out the documentation on event broadcasting.

The Console Directory

The Console directory contains all of the custom Artisan commands for your application. These commands may be generated using the make:command command. This directory also houses your console kernel, which is where your custom Artisan commands are registered and your scheduled tasks are defined.

The Events Directory

This directory does not exist by default, but will be created for you by the event:generate and make:event Artisan commands. The Events directory houses event classes. Events may be used to alert other parts of your application that a given action has occurred, providing a great deal of flexibility and decoupling.

The Exceptions Directory

The Exceptions directory contains your application's exception handler and is also a good place to place any exceptions thrown by your application. If you would like to customize how your exceptions are logged or rendered, you should modify the Handler class in this directory.

The Http Directory

The Http directory contains your controllers, middleware, and form requests. Almost all of the logic to handle requests entering your application will be placed in this directory.

The Jobs Directory

This directory does not exist by default, but will be created for you if you execute the make:job Artisan command. The Jobs directory houses the queueable jobs for your application. Jobs may be queued by your application or run synchronously within the current request lifecycle. Jobs that run synchronously during the current request are sometimes referred to as "commands" since they are an implementation of the command pattern.

The Listeners Directory

This directory does not exist by default, but will be created for you if you execute the event:generate or make:listener Artisan commands. The Listeners directory contains the classes that handle your events. Event listeners receive an event instance and perform logic in response to the event being fired. For example, a UserRegistered event might be handled by a SendWelcomeEmail listener.

The Mail Directory

This directory does not exist by default, but will be created for you if you execute the make:mail Artisan command. The Mail directory contains all of your classes that represent emails sent by your application. Mail objects allow you to encapsulate all of the logic of building an email in a single, simple class that may be sent using the Mail::send method.

The Models Directory

The Models directory contains all of your Eloquent model classes. The Eloquent ORM included with Laravel provides a beautiful, simple ActiveRecord implementation for working with your database. Each database table has a corresponding "Model" which is used to interact with that table. Models allow you to query for data in your tables, as well as insert new records into the table.

The Notifications Directory

This directory does not exist by default, but will be created for you if you execute the make:notification Artisan command. The Notifications directory contains all of the "transactional" notifications that are sent by your application, such as simple notifications about events that happen within your application. Laravel's notification feature abstracts sending notifications over a variety of drivers such as email, Slack, SMS, or stored in a database.

The Policies Directory

This directory does not exist by default, but will be created for you if you execute the make:policy Artisan command. The Policies directory contains the authorization policy classes for your application. Policies are used to determine if a user can perform a given action against a resource.

The Providers Directory

The Providers directory contains all of the service providers for your application. Service providers bootstrap your application by binding services in the service container, registering events, or performing any other tasks to prepare your application for incoming requests.

In a fresh Laravel application, this directory will already contain several providers. You are free to add your own providers to this directory as needed.

The Rules Directory

This directory does not exist by default, but will be created for you if you execute the make:rule Artisan command. The Rules directory contains the custom validation rule objects for your application. Rules are used to encapsulate complicated validation logic in a simple object. For more information, check out the validation documentation.