مستندات نسخه 1.3.010
تاریخ ویرایش: 1400/03/18 07:13 PM


تولید فرم در صفحات وب

این افزونه به شما امکان ایجاد فرم و نمایش فرم در صفحات تولید شده توسط افزونه های مختلف را می دهد. برای تولید فرم هایی مانند فرم تماس و یا ارسال نظرات و پیشنهادات باید مراحل زیر را دنبال کنید.

  • ابتدا در پوشه افزونه مورد نظر، باید یک پوشه با نام forms بسازید.
  • درون پوشه forms فایل JSON با کد نام فرم بسازید. مانند: contact_form.json
  • کد نام فرم ساخته شده را به بسته زبان افزونه اضافه کنید.
نمونه عبارت در بسته زبان:

{
	...,
	"contact_form": "فرم تماس"
}
	

محتوای فایل JSON فرم

هر فرم در این افزونه به صورت یک فایل JSON تعریف می شود که شما می توانید با استفاده از مقادیر قابل استفاده به فرم مورد نیاز برای وب سایت یا نرم افزار خود را تولید کنید و سپس در صفحات افزونه به کاربران نمایش دهید.

مقادیر قابل ثبت در JSON:
  • title: عنوان فرم در محل نمایش (از بسته زبان افزونه)
  • text: توضیحات فرم در محل نمایش (از بسته زبان افزونه)
  • fields: فیلد های فرم به صورت یک آرایه JSON
    مقادیر قابل ثبت:
    • title: عنوان فیلد (از بسته زبان افزونه)
    • type: نوع فیلد فرم [text, richtext, link, email, select, radio, checkbox, image, gallery, video, videos, document, documents, file, files]
    • size: سایز برای فیلد [برای متون تعداد خط، برای فایل ها سایز حجم]
    • validate: شیوه تایید صحت برای فیلد با کتابخانه HeUI
    • value: مقدار پیش فرض
      مقادیر ویژه:
      • ACTION: انجام عملکرد
        • HIDE: عدم نمایش فیلد در صورت وجود مقدار پیشفرض
          مانند: ACTION:HIDE:fullName (عدم نمایش در صورت وجود نام کامل کاربر)
  • sendTo: ایمیل مقصد برای ارسال (در صورت خالی بودن از ایمیل پیشفرض سایت استفاده می شود)
  • resend: مقدار bool برای امکان ارسال مجدد فرم
  • afterSend: در صورتی که مقدار resend برابر با false باشد می توانید آدرس فایل HTML برای نمایش به جای فرن را اینجا وارد کنید.
نمونه JSON:

{
	"title": "contact_form",
	"text": "contact_form_desc",
	"fields": [ 
		{ "title": "full_name", "type": "text", "size": 1, "validate": "req-min", "value": "ACTION:HIDE:fullName" },
		{ "title": "email", "type": "text", "size": 1, "ltr": true, "validate": "req-email", "value": "ACTION:HIDE:userMail" },
		{ "title": "subject", "type": "text", "size": 1, "validate": "req-min" },
		{ "title": "content", "type": "text", "size": 10, "validate": "req-min" }
	],
	"sendTo": "",
	"resend": false,
	"afterSend": "core/addons/test/thank_you_for_contact.html"
}
	

قراردادن فرم در صفحات وب

پس از ساختن فال JSON همه چیز آماده شده و این افزونه ظاهر و عملکرد دریافت اطلاعات توسط این فرم را برای شما آماده می کند. حالا شما می توانید با استفاده از متد PlaceForm فرم مورد نظر خود را در صفحات تولید شده توسط افزونه های برای وب سایت نمایش دهد.

PlaceForm($addon, $form, [$viewCode = 0]);
  • $addon: نام افزونه
  • $form: نام فایل JSON فرم
  • $viewCode: شیوه نمایش فرم (مقادیر: 0, 1, 2)

PlaceForm("test", "contact_form");
	
info_outline توجه داشته باشید که افزونه های استدیوی هروف الزاما توسط تیم توسعه استدیوی هروف ساخته نشده اند و تنها پایگاه ابری استدیوی هروف نگهداری این افزونه ها و مستندات مرتبط را به عهده دارد، لطفا درخواست ها و سوالات خود را در زمینه این افزونه با سازنده افزونه مطرح بفرمایید.