PHAR(1) User Commands PHAR(1)

phar, phar.phar - ابزار خط فرمان PHAR (آرشیو PHP)

phar <command> [options] ...

فرمت فایل PHAR راهکاری را برای قرار دادن کل برنامه‌های PHP در یک فایل واحد به نام «phar» (آرشیو PHP) جهت توزیع و نصب آسان فراهم می‌کند.

با استفاده از دستور phar می‌توانید آرشیوهای PHP را ایجاد، به‌روزرسانی یا استخراج کنید.

دستورها: add compress delete extract help help-list info list meta-del meta-get meta-set pack sign stub-get stub-set tree version

افزودن ورودی‌ها به یک بسته PHAR.

آرگومان‌های ضروری:

-f file
فایل phar مد نظر (file) را برای کار روی آن مشخص می‌کند.
...
هر تعداد فایل و دایرکتوری ورودی. اگر -i استفاده شود، تنها فایل‌های منطبق با عبارت باقاعده داده‌شده بسته‌بندی می‌شوند. اگر -x داده شود، فایل‌های منطبق با آن عبارت باقاعده بسته‌بندی نمی‌شوند.

آرگومان‌های اختیاری:

-a alias
یک نام مستعار (alias) برای فایل phar تعیین می‌کند.
-c algo
الگوریتم فشرده‌سازی (ببینید: COMPRESSION )
-i regex
یک عبارت باقاعده برای فایل‌های ورودی مشخص می‌کند.
-l level
تعداد زیردایرکتوری‌های اولیه که باید از ورودی‌های فایل حذف شوند.
-x regex
عبارت باقاعده برای مستثنی کردن فایل‌های ورودی.

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

آرگومان‌های ضروری:

-c algo
الگوریتم فشرده‌سازی (ببینید: COMPRESSION )
-f file
فایل phar مد نظر (file) را برای کار روی آن مشخص می‌کند.

آرگومان‌های اختیاری:

-e entry
نام ورودی (entry) مد نظر برای کار (در صورت وجود، باید شامل نام دایرکتوری داخلی PHAR باشد).

حذف یک ورودی از آرشیو PHAR.

آرگومان‌های ضروری:

-e entry
نام ورودی (entry) مد نظر برای کار (در صورت وجود، باید شامل نام دایرکتوری داخلی PHAR باشد).
-f file
فایل phar مد نظر (file) را برای کار روی آن مشخص می‌کند.

استخراج یک بسته PHAR در یک دایرکتوری.

آرگومان‌های ضروری:

-f file
فایل phar مد نظر (file) را برای کار روی آن مشخص می‌کند.

آرگومان‌های اختیاری:

-i regex
یک عبارت باقاعده برای فایل‌های ورودی مشخص می‌کند.
-x regex
عبارت باقاعده برای مستثنی کردن فایل‌های ورودی.
...
دایرکتوری مقصد جهت استخراج (پیش‌فرض '.' است).

نمایش همین راهنما یا راهنمای مربوط به یک دستور انتخاب‌شده.

آرگومان‌های اختیاری:

...
دستور اختیاری جهت دریافت راهنمای مربوط به آن..SH "دستور help-list (help-list command)" فهرست دستورهای موجود را نمایش می‌دهد.

دریافت اطلاعات درباره یک بسته PHAR.

با استفاده از -k بازگرداندن یک مقدار منفرد امکان‌پذیر است.

آرگومان‌های الزامی:

-f file
فایل phar موردنظر (file) را برای پردازش مشخص می‌کند.

آرگومان‌های اختیاری:

-k index
نمایهٔ اشتراک (index) موردنظر برای پردازش.

فهرست کردن محتویات یک بایگانی PHAR.

آرگومان‌های الزامی:

-f file
فایل phar موردنظر (file) را برای پردازش مشخص می‌کند.

آرگومان‌های اختیاری:

-i regex
یک عبارت منظم (regular expression) را برای فایل‌های ورودی مشخص می‌کند.
-x regex
عبارت منظم برای مستثنی کردن فایل‌های ورودی.

حذف اطلاعات فراداده یک مدخل یا بسته PHAR.

اگر -k داده شود، انتظار می‌رود که فراداده یک آرایه (array) باشد و نمایهٔ داده‌شده حذف می‌شود.

در صورتی که چیزی حذف شود مقدار بازگشتی 0 و در غیر این صورت 1 خواهد بود.

آرگومان‌های الزامی:

-f file
فایل phar موردنظر (file) را برای پردازش مشخص می‌کند.

آرگومان‌های اختیاری:

-e entry
نام مدخل (entry) برای کار روی آن (در صورت وجود، باید شامل نام دایرکتوری داخلی PHAR باشد).
-k index
نمایهٔ اشتراک (index) موردنظر برای پردازش.

دریافت اطلاعات فراداده یک مدخل یا یک بسته PHAR به صورت سریال‌سازی‌شده (serialized). اگر هیچ فایل خروجی برای فراداده مشخص نشده باشد، از stdout استفاده خواهد شد. همچنین می‌توانید با استفاده از -k یک نمایهٔ خاص را مشخص کنید؛ در این صورت انتظار می‌رود که فراداده یک آرایه باشد و مقدار نمایهٔ ارائه‌شده به‌جای سریال‌سازی با استفاده از echo بازگردانده می‌شود. اگر آن نمایه وجود نداشته باشد یا فراداده‌ای موجود نباشد، مقدار بازگشتی 1 خواهد بود.

آرگومان‌های الزامی:

-f file
فایل phar موردنظر (file) را برای پردازش مشخص می‌کند.

آرگومان‌های اختیاری:

-e entry
نام مدخل (entry) برای کار روی آن (در صورت وجود، باید شامل نام دایرکتوری داخلی PHAR باشد).
-k index
نمایهٔ اشتراک (index) موردنظر برای پردازش.

تنظیم فراداده‌های یک مدخل یا بسته PHAR با استفاده از ورودی سریال‌سازی‌شده. اگر هیچ فایل ورودی برای فراداده مشخص نشده باشد، از stdin استفاده می‌شود. همچنین می‌توانید یک نمایهٔ خاص را با استفاده از -k مشخص کنید؛ در این حالت انتظار می‌رود فراداده یک آرایه باشد و مقدار نمایهٔ مشخص‌شده تنظیم می‌شود. اگر فراداده وجود نداشته باشد یا خالی باشد، یک آرایه جدید ایجاد خواهد شد. اگر فراداده موجود و یک مقدار ساده (flat value) باشد، مقدار بازگشتی 1 خواهد بود. همچنین با استفاده از -k، ورودی به‌جای آن‌که سریال‌سازی شود، مستقیماً دریافت می‌شود.

آرگومان‌های الزامی:

-f file
فایل phar موردنظر (file) را برای پردازش مشخص می‌کند.
-m meta
فراداده برای ذخیره همراه با مدخل (داده‌های سریال‌سازی‌شده php).

آرگومان‌های اختیاری:

-e entry
نام مدخل (entry) برای کار روی آن (در صورت وجود، باید شامل نام دایرکتوری داخلی PHAR باشد).
-k index
نمایهٔ اشتراک (index) موردنظر برای پردازش..SH "دستور pack (pack command)" بسته‌بندی فایل‌ها در یک بایگانی PHAR.

هنگام استفاده از -s <stub>، فایل stub از فهرست فایل‌ها/دایرکتوری‌های ورودی استثنا می‌شود. برای ساخت یک بایگانی که حاوی کلاس PEAR با نام PHP_Archive باشد، آرگومان -p را به PHP/Archive.php ارجاع دهید.

آرگومان‌های ضروری:

-f file
فایل phar مورد نظر (file) را برای پردازش مشخص می‌کند.
...
هر تعداد فایل و دایرکتوری ورودی. اگر -i استفاده شود، تنها فایل‌های منطبق با عبارت باقاعده داده‌شده بسته‌بندی می‌شوند. اگر -x مشخص شود، فایل‌های منطبق با آن عبارت باقاعده بسته‌بندی نمی‌شوند.

آرگومان‌های اختیاری:

-a alias
تعیین یک نام مستعار (alias) برای فایل phar.
-b bang
خط hash-bang برای آغاز بایگانی (مانند ‎#!/usr/bin/php‎). خود علامت هش «#!» و نویسه خط جدید اختیاری هستند.
-c algo
الگوریتم فشرده‌سازی (بخش COMPRESSION را ببینید)
-h hash
الگوریتم درهم‌سازی (hash) را انتخاب می‌کند (بخش HASH را ببینید)
-i regex
یک عبارت باقاعده را برای فایل‌های ورودی مشخص می‌کند.
-l level
تعداد زیرشاخه‌های پیشین برای حذف از مدخل‌های فایل.
-p loader
مکان فایل کلاس PHP_Archive (دستور pear list-files PHP_Archive). می‌توانید از «0» یا «1» برای تعیین خودکار مکان آن با دستور pear یادشده استفاده کنید. هنگام استفاده از «0»، در صورت پیدا نشدن فایل کلاس، دستور با خطا متوقف نمی‌شود. این گزینه همچنین کدی را در اطراف stub اضافه می‌کند تا در صورت نیاز، کلاس PHP_Archive به عنوان پوشش‌دهنده جریان phar:// ثبت شود. و در نهایت این گزینه فایل phar.inc را از این بسته اضافه کرده و آن را بارگذاری می‌کند تا از حضور کلاس Phar اطمینان حاصل شود.
-s stub
انتخاب فایل stub.
-x regex
عبارت باقاعده برای استثنا کردن فایل‌های ورودی.
-y key
کلید خصوصی (key) برای امضای OpenSSL.

تنظیم الگوریتم درهم‌سازی امضا.

آرگومان‌های ضروری:

-f file
فایل phar مورد نظر (file) را برای پردازش مشخص می‌کند.
-h hash
الگوریتم درهم‌سازی (hash) را انتخاب می‌کند (بخش HASH را ببینید)

آرگومان‌های اختیاری:

-y key
کلید خصوصی (key) برای امضای OpenSSL.

دریافت stub یک فایل PHAR. اگر هیچ فایل خروجی به عنوان stub تعیین نشود، stdout استفاده می‌شود.

آرگومان‌های ضروری:

-f file
فایل phar مورد نظر (file) را برای پردازش مشخص می‌کند.

آرگومان‌های اختیاری:

-s stub
انتخاب فایل stub.

تنظیم stub یک فایل PHAR. اگر هیچ فایل ورودی به عنوان stub تعیین نشود، stdin استفاده می‌شود.

آرگومان‌های ضروری:

-f file
فایل phar مورد نظر (file) را برای پردازش مشخص می‌کند.

آرگومان‌های اختیاری:

-b bang
خط hash-bang برای آغاز بایگانی (مانند ‎#!/usr/bin/php‎). خود علامت هش «#!» و نویسه خط جدید اختیاری هستند.
-p loader
مکان فایل کلاس PHP_Archive (دستور pear list-files PHP_Archive). می‌توانید از «0» یا «1» برای تعیین خودکار مکان آن با دستور pear یادشده استفاده کنید. هنگام استفاده از «0»، در صورت پیدا نشدن فایل کلاس، دستور با خطا متوقف نمی‌شود. این گزینه همچنین کدی را در اطراف stub اضافه می‌کند تا در صورت نیاز، کلاس PHP_Archive به عنوان پوشش‌دهنده جریان phar:// ثبت شود. و در نهایت این گزینه فایل phar.inc را از این بسته اضافه کرده و آن را بارگذاری می‌کند تا از حضور کلاس Phar اطمینان حاصل شود.
-s stub
انتخاب فایل stub..SH "دستور tree (tree command)" دریافت درخت دایرکتوری برای یک بایگانی PHAR.

آرگومان‌های ضروری:

-f file
file مربوط به phar را برای کار روی آن مشخص می‌کند.

آرگومان‌های اختیاری:

-i regex
یک عبارت منظم برای فایل‌های ورودی مشخص می‌کند.
-x regex
عبارت منظم برای فایل‌های ورودی که باید مستثنی شوند.

دریافت اطلاعات درباره محیط PHAR و نسخه ابزار.

الگوریتم‌ها:

0
بدون فشرده‌سازی
none
بدون فشرده‌سازی
auto
انتخاب خودکار الگوریتم فشرده‌سازی
gz
فشرده‌سازی GZip
gzip
فشرده‌سازی GZip
bz2
فشرده‌سازی BZip2
bzip2
فشرده‌سازی BZip2

الگوریتم‌ها:

md5
MD5
sha1
SHA1
sha256
SHA256
sha512
SHA512
openssl
OpenSSL با استفاده از SHA-1
openssl_sha256
OpenSSL با استفاده از SHA-256
openssl_sha512
OpenSSL با استفاده از SHA-512

برای توضیحات کمابیش کامل درباره PHAR به اینجا مراجعه کنید:

http://php.net/phar

می‌توانید فهرست باگ‌های شناخته‌شده را مشاهده کنید یا هر باگ جدیدی را که پیدا کردید گزارش دهید در:

https://github.com/php/php-src/issues

The PHP Group: Thies C. Arntzen, Stig Bakken, Andi Gutmans, Rasmus Lerdorf, Sam Ruby, Sascha Schumann, Zeev Suraski, Jim Winstead, Andrei Zmievski.

کار روی بایگانی PHP توسط Gregory Beaver و Marcus Boerger انجام شد.

فهرستی از توسعه‌دهندگان فعال را می‌توانید در اینجا بیابید:

http://www.php.net/credits.php

و در نهایت، PHP با کمک خیل عظیمی از مشارکت‌کنندگان در سراسر جهان توسعه یافته است.

این صفحه راهنما phar، نسخه 8.3.33 را توضیح می‌دهد.

کپی‌رایت © The PHP Group

این فایل منبع مشمول نسخه 3.01 از مجوز PHP است که همراه با این بسته در فایل LICENSE قرار دارد و از طریق وب جهان‌گستر در نشانی اینترنتی زیر در دسترس است:

https://www.php.net/license/3_01.txt

اگر نسخه‌ای از مجوز PHP را دریافت نکرده‌اید و قادر به دریافت آن از طریق وب جهان‌گستر نیستید، لطفاً یادداشتی به license@php.net ارسال کنید تا بلافاصله یک نسخه را با ایمیل برای شما ارسال کنیم.

2024 The PHP Group