configuration.md

Configuration

• Introduction
• Accessing Configuration Values
• Environment Configuration
  • Determining The Current Environment
• Configuration Caching
• Maintenance Mode

Introduction

Laravel Framework ရဲ့ configuration files တွေအကုန်လုံးကို config directory ထဲမှာတွေ့နိုင်ပါတယ်။ option တစ်ခုတိုင်းဆီက document လုပ်ပြီးသားပါ၊ ဒါကြောင့်မလို့ files တွေကိုဖွင့်ကြည့်ပြီးတော့ သင့်အတွက် available ဖြစ်တဲ့ options တွေနဲ့ familiar ဖြစ်အောင်လုပ်နိုင်ပါတယ်။

Accessing Configuration Values

Global config helper function ကိုသုံးပြီးတော့ configuration values တွေကို application ရဲ့မည်သည့်နေရာကမဆို access လုပ်နိုင်ပါတယ်။ configuration values တွေကို "dot" syntax ကိုအသုံးပြုပြီးတော့ file name နဲ့ ကိုယ်အသုံးပြုချင်တဲ့ access ကိုအသုံးပြုပြီးတော့ access လုပ်နိုင်ပါတယ်။ Default value သတ်မှတ်ပေးထားရင် configuration option မရှိရင် default value ကို return ပြန်ပါလိမ့်မယ်။

$value = config('app.timezone');

Runtime မှာ configuration values တွေကို set လုပ်ချင်တယ်ဆိုရင် config helper မှာ array တစ်ခု pass ပေးရပါမယ်။

config(['app.timezone' => 'America/Chicago']);

Environment Configuration

မတူညီတဲ့ configuration values တွေက မတူညီတဲ့ environment application တွေ run နေတဲ့အခါ အဲ့ဒါတွေကတော်တော်အသုံးဝင်ပါလိမ့်မယ်။ ဉပမာ သင့်အနေနဲ့ cache driver ကို သင့်စက်မှာတစ်ခုသုံးပေမယ့် production မှာတစ်ခုသုံးချင်ရင်သုံးချင်မှာပေါ့။ အဲ့လိုလုပ်ချင်ရင် environment based configuration ကလွယ်ကူစေပါလိမ့်မယ်။

ဒါကိုလွယ်ကူစေရန်အတွက် Laravel က Vance Lucas ရဲ့ DotEnv PHP library ကိုအသုံးပြုထားပါတယ်။ Fresh install လုပ်ထားတဲ့ Laravel မှာဆိုရင် သင့် application ရဲ့ root directory မှာ .env.example ဆိုတဲ့ file တစ်ခုပါဝင်ပါလိမ့်မယ်။ Laravel ကို Composer ကနေ install လုပ်ထားတယ်ဆိုရင် အဲ့ဒီ့ file ကို .env ဆိုပြီးအလိုအလျောက်အမည်ပြောင်းပေးပါလိမ့်မယ်။ အဲ့လိုမှမဖြစ်ဘူးဆိုရင် သင်ကိုယ်တိုင်ပြောင်းပေးသင့်ပါတယ်။

Retrieving Environment Configuration

သင့် application က request တစ်ခုလက်ခံရှိတဲ့အခါမှာ ဒီ file မှာ listed လုပ်ထားတဲ့ variables တွေအကုန်လုံးက $_ENV PHP super-global မှာ loaded ဖြစ်သွားမှာပါ။ ဒါပေမယ့် ဒီ variables တွေထဲက values တွေကိုပြန်လည်ရယူဖို့ env helper ကိုအသုံးပြုနိုင်ပါတယ်။ တကယ်တော့ Laravel configuration ကို review လုပ်လိုက်ရင်ဒီ helper ကို options တော်တော်များများမှာအသုံးပြုပြီးတာတွေ့ရပါလိမ့်မယ်။

'debug' => env('APP_DEBUG', false),

env function ကို pass ပေးတဲ့ဒုတိယ value က "default value" ဖြစ်ပါတယ်။ ပေးထားတဲ့ key အတွက် environment variable မရှိလို့ရှိရင် အဲ့ဒီ့ value ကိုသုံးပါလိမ့်တယ်။

သင့်ရဲ့ .env file ကိုသင့် application ရဲ့ source control မှာ commit မလုပ်သင့်ပါဘူး။ ဘာကြောင့်လည်းဆိုရင် developer/ server တိုင်းမှာမတူညီတဲ့ configuration တွေကိုလိုအပ်နိုင်လို့ပါ။

သင်က team နဲ့ developing လုပ်နေတဲ့သူဆိုရင် .env.example ကိုတော့သင့် application နဲ့တစ်ပါးတည်းပါစေချင်မှာပါ။ configuration file values တွေမှာ place-holder values တွေကိုထည့်ပြီးတော့ပေါ့၊ သင့် team ကအခြား developer တွေက application ကို run ဖို့ရာအတွက်ဘယ် environment variables ကိုလိုအပ်တယ်ဆိုတာရှင်းရှင်းလင်းလင်းသိဖို့ရာအတွက်ဖြစ်ပါတယ်။

Determining The Current Environment

လက်ရှိ application environment ကို .env file ရဲ့ APP_ENV variable ကနေသတ်မှတ်ပေးပါတယ်။ App facade environment method ကနေပြီးတော့အဲ့ဒီ့ value တွေကို access လုပ်နိုင်ပါတယ်။

$environment = App::environment();

environment method ကို arguments pass လုပ်ပြီးတော့ environment ကပေးထားတဲ့ value နဲ့ညီလားဆိုတာကိုစစ်နိုင်ပါတယ်။ environment ကပေးထားတဲ့ value နဲ့ညီတယ်ဆိုရင် method က true ပြန်ပါလိမ့်မယ်။

if (App::environment('local')) {
    // The environment is local
}

if (App::environment('local', 'staging')) {
    // The environment is either local OR staging...
}

Configuration Caching

သင့် application ကိုလျင်မြန်စွာ boost လုပ်ရန်အတွက် သင့် configuration files တွေအကုန်လုံးကို file တစ်ခုထဲမှာ Artisan command config:cache လုပ်ပြီး cache လုပ်ထားသင့်ပါတယ်။ အဲ့လိုလုပ်လိုက်မယ်ဆိုရင် သင့် application ရဲ့ configuration options တွေကို file တစ်ခုထဲပေါင်းလိုက်တဲ့အတွက် framework ကလျင်မြန်စွာ load လုပ်ပါလိမ့်မယ်။

ပုံမှန်အားဖြင့် php artisan config:cache command ကိုသင့် application deployment routine မှာ run သင့်ပါတယ်။ ဒီ command ကို local development မှာဆိုမ run သင့်ပါဘူး local development configuration options တွေမကြာခဏပြောင်းနိုင်တဲ့အတွက်ကြောင့်မလို့ပါ။

Maintenance Mode

Application maintenance mode မှာဆိုရင် သင့် application က application ဆီဝင်လာသမျှ requests တွေကို custom view တစ်ခုကိုပြမှာပါ။ ဒါက သင့် application ကို maintenance လုပ်နေတဲ့အချိန်မှာသင့် application ကို "disable" လုပ်ဖို့လွယ်ကူစေပါတယ်။ Maintenance mode check က သင့် application default middleware stack မှာပါဝင်ပြီးသားပါ။ Application maintenance mode မှာဆိုရင် 503 status code တစ်ခုနဲ့ MaintenanceModeException ကို thrown လုပ်ပါလိမ့်မယ်။

Maintenance mode ကိုဖွင့်ဖို့ရာအတွက် Artisan down command ကိုလွကူစွာ execute လုပ်လိုက်ပါ။

php artisan down

down command အတွက် message နဲ့ retry options တွေကို provide လုပ်နိုင်ပါတယ်။ message value က display သို့မဟုတ် custom message log အတွက်အသုံးပြုပြီးတော့ retry value က Retry-After HTTP header ရဲ့ value မှာ set လုပ်မှာပါ။

php artisan down --message='Upgrading Database' --retry=60

Maintenance mode ကိုရပ်တန့်ဖို့ရာအတွက် up command ကိုအသုံးပြုနိုင်ပါတယ်။

php artisan up

Maintenance Mode Response Template

Maintenance mode responses page ရဲ့ default template က resources/views/errors/503.blade.php ဖြစ်ပါတယ်။ ဒီ view ကိုသင့် application အတွက်လိုအပ်သလိုပြင်ဆင်နိုင်ပါတယ်။

Maintenance Mode & Queues

သင့် Application က Maintenance mode မှာဆိုရင် မည်သည့် queued jobs ကိုမှ handle လုပ်မှာမဟုတ်ပါ။ သင့် application က maintenance mode မဟုတ်မှ jobs တွေကိုပုံမှန်အတိုင်း handle လုပ်မှာပါ။

Alternatives To Maintenance Mode

Maintenance mode ကသင့် application ကို seconds ပေါင်းများစွာ downtime ဖြစ်နိုင်တဲ့အတွက် တစ်ခြား alternatives ဖြစ်တဲ့ Envoyer ကို zero-downtime deployment အတွက်အသုံးပြုနိုင်ပါတယ်။