سازگاری API

ابزار از نام‌گذاری نسخه‌های Semantic Versioning استفاده می‌کند، اما هنوز در سری 0.x است. نسخه 0.8.1 پسوند prerelease ندارد. نسخه minor می‌تواند تغییر ناسازگار داشته باشد. محدوده ^0.8.1 قبل از 0.9 می‌ماند. قبل از ارتقا CHANGELOG و UPGRADE را بخوانید.

نتیجه و exception

validatorها با validate() نتیجه، با tryFrom() یک object یا null و با from() یک object یا ValidationException می‌دهند. هشدار lookup مانع ساخت object نمی‌شود. سازنده‌های BillId هر دو شناسه قبض و پرداخت را لازم دارند؛ امضای متدها و قواعد پذیرش در اعتبارسنجی آمده است.

شکل نتیجه و سلسله‌مراتب exceptionها که پایین آمده بخشی از API عمومی است. نمونه کد، معنی هشدارها و روش مدیریت خطای formatter و خود PHP را در مدیریت خطا ببینید. جدول کدهای خطا کدها و پیام‌های دقیق را دارد.

بخش‌های API با تعهد کامل سازگاری از 1.0

• نام کلاس‌ها، namespaceها و امضای متدهای عمومی.
• شکل عمومی ValidationResult: متدهای isValid()، isStrictlyValid()، errors()، errorCodes()، warnings()، warningCodes()، detail() و خروجی JSON.
• accessorهای value objectها و نام propertyهای readonly در DTOهای ValidationDetail.
• سلسله‌مراتب exceptionهای کتابخانه.
• قرارداد نوع ورودی: validatorها ارقام فارسی و عربی را می‌پذیرند. NumberFormatter و Currency::format() string عددی را هم یکسان‌سازی می‌کنند. Amount و ordinalها integer و NumberToWords ورودی int|float می‌گیرند؛ همه APIها string فارسی نمی‌پذیرند.

مقدار string کدهای ErrorCode از 0.3 بخشی از API شناخته می‌شود. حذف یا تغییر نام case تغییر ناسازگار است و اضافه شدن case جدید در minor ممکن است. این سیاست به معنی تضمین کامل سازگاری قبل از نسخه 1.0 نیست.

بخش‌هایی که ممکن است تغییر کنند

متن فارسی خطا، نام بانک و شهر و اپراتور، محتوای جدول‌ها و کدهای داخلی تضمین ثابت ماندن ندارند. برای شرط برنامه از کد خطا استفاده کنید. اگر به خروجی lookup دقیقا تکرارپذیر نیاز دارید، مقدار مورد نیاز را در داده برنامه خود ثبت کنید. اعضای private و protected و موارد @internal API عمومی نیستند.

سیاست حذف از 1.0 به بعد

قابلیت منسوخ‌شده در minor با @deprecated و changelog اعلام می‌شود، تا پایان همان major کار می‌کند و فقط در major بعد حذف می‌شود. به‌روزرسانی جدول‌های بانک و شهر ممکن است در minor یا patch و بدون دوره deprecation باشد. تغییر در معتبر یا نامعتبر شدن ورودی در changelog اعلام می‌شود.

نسخه مستندات

وب‌سایت عمومی فقط release منتشرشده را از commit دقیق مرتبط با tag آن وارد می‌کند. مستندات شاخه اصلی ممکن است جلوتر از پکیج نصب‌شده باشند. نسخه مستندات را با نسخه برنامه هماهنگ کنید؛ نمایش در سایت تضمین کامل سازگاری برنامه‌ریزی‌شده برای 1.0 را اضافه نمی‌کند.

مطالب مرتبط: نصب، مدیریت خطا.