مستندات

لیست دسته ها و محتواها

Portal.Date

Portal.Date یک آبجک در پورتال است که شامل چند متد مهم و پرکاربرد در رابطه با تاریخ است. که هرکدام از آنها توضیح داده خواهد شد.

Portal.Date.Get

از این متد برای تبدیل تاریخ میلادی به شمسی و برعکس استفاده می شود.

طریقه استفاده از متد:

Portal.Date.Get (Date, FromCalendar, ToCalendar);

ورودی های تابع

نام نوع تعریف
Date String تاریخ مورد نظر برای تبدیل
FromCalendar String نوع تاریخ مبدا
ToCalendar String نوع تاریخ مقصد

نکته

برای نوع تاریخ شمسی از
'fa'
و برای نوع تاریخ میلادی از
'en'
استفاده می کنیم.

مثال تبدیل میلادی به شمسی

Portal.Date.Get ("2022-05-14T22:18:23", 'en', 'fa');

خروجی

{
    "Calendar": "fa",
    "Culture": "fa",
    "Custom": "1401/02/24",
    "DateTime": "1401/02/24 22:18:23",
    "Date": "1401/02/24",
    "Year": "1401",
    "Month": "02",
    "MonthName": "اردیبهشت",
    "MonthNameShort": "اردیبهشت",
    "Day": "24",
    "DayOfWeek": "شنبه",
    "DayOfWeekShort": "شنبه",
    "Time": "22:18:23",
    "Hour": "22",
    "Minute": "18",
    "Second": "23"
}

مثال تبدیل شمسی به میلادی

Portal.Date.Get ("1401/02/24 22:18:23", 'fa', 'en');

خروجی

{
    "Calendar": "en",
    "Culture": "en",
    "Custom": "2022/05/14",
    "DateTime": "2022/05/14 22:18:23",
    "Date": "2022/05/14",
    "Year": "2022",
    "Month": "05",
    "MonthName": "May",
    "MonthNameShort": "May",
    "Day": "14",
    "DayOfWeek": "Saturday",
    "DayOfWeekShort": "Sat",
    "Time": "22:18:23",
    "Hour": "22",
    "Minute": "18",
    "Second": "23"
}

توضیح مقادیر

نام توضیح
Calendar نوع تقویم
Culture نوع تقویم
Custom تاریخ به صورت عددی و کامل
Date تاریخ به صورت عددی و کامل
DateTime تاریخ و زمان کامل
Day روز در ماه
DayOfWeek نام روز در هفته
DayOfWeekShort کوتاه شده نام روز در هفته
Month عدد ماه در سال
MonthName نام ماه
MonthNameShort نام کوتاه شده
Year سال
Time زمان به طور کامل
Hour ساعت
Minute دقیقه
Second ثانیه

Portal.Date.Today

این متد با توجه به نوع تقویمی که دریافت می کند، تاریخ و زمان فعلی را به ما برمیگرداند.

طریقه استفاده از متد:

Portal.Date.Today (ToCalendar);

ورودی های تابع

نام نوع تعریف
ToCalendar String نوع تقویم
شمسی:
'fa'

میلادی:
'en'

مثال

Portal.Date.Today('fa');

خروجی

{
  "Calendar": "fa",
  "Culture": "fa",
  "Custom": "1401/02/24",
  "DateTime": "1401/02/24 20:20:56",
  "Date": "1401/02/24",
  "Year": "1401",
  "Month": "02",
  "MonthName": "اردیبهشت",
  "MonthNameShort": "اردیبهشت",
  "Day": "24",
  "DayOfWeek": "شنبه",
  "DayOfWeekShort": "شنبه",
  "Time": "20:20:56",
  "Hour": "20",
  "Minute": "20",
  "Second": "56"
}

توضیح مقادیر

نام توضیح
Calendar نوع تقویم
Culture نوع تقویم
Custom تاریخ به صورت عددی و کامل
Date تاریخ به صورت عددی و کامل
DateTime تاریخ و زمان کامل
Day روز در ماه
DayOfWeek نام روز در هفته
DayOfWeekShort کوتاه شده نام روز در هفته
Month عدد ماه در سال
MonthName نام ماه
MonthNameShort نام کوتاه شده
Year سال
Time زمان به طور کامل
Hour ساعت
Minute دقیقه
Second ثانیه

Portal.Date.Format

این متد تاریخ را به صورت قالب دلخواه ما بر می گرداند.

طریقه استفاده از متد:

Portal.Date.Format (Date, Format);

ورودی های تابع

نام نوع تعریف
Date String تاریخ با فرمت YYYY/MM/DD HH:mm:ss
Format String فرمت دلخواه
YY سال دو رقمی
YYYY سال چهار رقمی

M در صورتی که عدد ماه تک رقمی باشد، به صورت تک رقمی برمی گرداند.
MMM نام ماه به اختصار
MMMM نام ماه به صورت کامل

D در صورتی که روز تک رقمی باشد، به صورت تک رقمی بر میگرداند.
DD روز به صورت دو رقمی
DDD روز در سال
d عدد روز در هفته
dd نام روز به صورت 2 حرفی
ddd نام روز به صورت 2 حرفی
dddd نام روز به صورت کامل

h در صورتی که ساعت تک رقمی باشد، به صورت تک رقمی و در قالب 12 ساعته برمیگرداند
hh ساعت را به صورت دو رقمی و در قالب 12 ساعته برمی گرداند.
H در صورتی که ساعت تک رقمی باشد، به صورت تک رقمی و در قالب 24 ساعته برمیگرداند
HH ساعت را به صورت دو رقمی و در قالب 24 ساعته برمی گرداند.

m در صورتی که دقیقه تک رقمی باشد، به صورت تک رقمی بر میگرداند.
mm دقیقه را به صورت دو رقمی بر میگرداند.

s در صورتی که ثانیه تک رقمی باشد، به صورت تک رقمی بر میگرداند.
ss ثانیه را به صورت دو رقمی بر میگرداند.

a am, pm, ق.ظ، ب.ظ
A AM, PM, ق.ظ، ب.ظ

مثال

Portal.Date.Format(Portal.Date.Today('fa'),'سال YYYY ماه MMMM روز DD در ساعت h a و دقیقه m و ثانیه s');

خروجی

{
    "Calendar": "fa",
    "Culture": "fa",
    "Custom": "سال 1401 ماه اردیبهشت روز 24 در ساعت 10 ب.ظ و دقیقه 18 و ثانیه 16",
    "DateTime": "1401/02/24 22:18:16",
    "Date": "1401/02/24",
    "Year": "1401",
    "Month": "02",
    "MonthName": "اردیبهشت",
    "MonthNameShort": "اردیبهشت",
    "Day": "24",
    "DayOfWeek": "شنبه",
    "DayOfWeekShort": "شنبه",
    "Time": "22:18:16",
    "Hour": "22",
    "Minute": "18",
    "Second": "16"
}

توضیح مقادیر

نام توضیح
Calendar نوع تقویم
Culture نوع تقویم
Custom تاریخ با فرمت دلخواه شما
Date تاریخ به صورت عددی و کامل
DateTime تاریخ و زمان کامل
Day روز در ماه
DayOfWeek نام روز در هفته
DayOfWeekShort کوتاه شده نام روز در هفته
Month عدد ماه در سال
MonthName نام ماه
MonthNameShort نام کوتاه شده
Year سال
Time زمان به طور کامل
Hour ساعت
Minute دقیقه
Second ثانیه

Portal.Date.Diff.ABS

این متد اختلاف بین دو زمان دریافتی را به صورت مطلق برمیگرداند.

طریقه استفاده از متد:

Portal.Date.Diff.ABS (StartDate, EndDate, CurrentCalendar);

ورودی های تابع

نام نوع تعریف
StartDate String تاریخ شروع
EndDate String تاریخ پایان
CurrentCalendar String نوع تقویم
شمسی:
'fa'

میلادی:
'en'

مثال

Portal.Date.Diff.ABS("2022-03-06T00:00:00", "2022-05-14T00:00:00", 'en');

خروجی

{
  "Days": 68.95833333333333,
  "Hours": 1655,
  "Minutes": 99300
}

توضیح مقادیر

نام توضیح
Days تعداد روزهای حاصل اختلاف دو تاریخ
Hours ساعت های حاصل اختلاف دو تاریخ
Minutes دقیقه های حاصل اختلاف دو تاریخ

Portal.Date.Diff.REL

این متد اختلاف بین دو زمان دریافتی را به صورت نسبی برمیگرداند.

یعنی که از تاریخ و زمان شروع چقدر روز، ساعت و دقیقه مانده به تاریخ پایان.

طریقه استفاده از متد:

Portal.Date.Diff.REL (StartDate, EndDate, CurrentCalendar);

ورودی های تابع

نام نوع تعریف
StartDate String تاریخ شروع
EndDate String تاریخ پایان
CurrentCalendar String نوع تقویم
شمسی:
'fa'

میلادی:
'en'

مثال

Portal.Date.Diff.REL("2022-03-06T00:00:00", "2022-05-14T00:00:00", 'en');

خروجی

{
    "Days": 68,
    "Hours": 23,
    "Minutes": 0
}

توضیح مقادیر

نام توضیح
Days تعداد روزهای حاصل اختلاف دو تاریخ
Hours و ساعت های حاصل اختلاف دو تاریخ
Minutes و دقیقه های حاصل اختلاف دو تاریخ

Portal.Date.Duration.ABS

از این متد می توان برای نمایش مقادیری که از متد Portal.Date.Diff.REL استفاده کرد.

طریقه استفاده از متد:

Portal.Date.Duration.ABS (Days, Hours, Minutes);

ورودی های تابع

نام نوع تعریف
Days Number تعداد روزها
Hours Number ساعت ها
Minutes Number دقیقه ها

مثال

Portal.Date.Duration.ABS(456,3,4);

خروجی

{
    "Month": "15 ماه",
    "Day": "6 روز",
    "Hour": "3 ساعت",
    "Minute": "4 دقیقه",
    "Total": "15 ماه,6 روز,3 ساعت,4 دقیقه"
}

توضیح مقادیر

نام توضیح
Month تعداد ماه ها
Day تعداد روز ها
Hour تعداد ساعت ها
Minute تعداد دقیقه ها
Total مقادیر بالا به صورت تجمیع شده