راه‌اندازی - PHP
پیش‌نیازها
- در صورتی که با سرویس فایل آشنایی ندارید، به معرفی سرویس فایل مراجعه کنید.
- در صورتی که هنوز در پنل توسعه‌دهنده خود تنظیمات لازم برای سرویس فایل خود را انجام نداده‌اید، به تنظیمات پنل مراجعه کنید.
- در صورتی که با سرویس کاربران بکتوری آشنایی ندارید، به معرفی سرویس کاربران مراجعه کنید.
معرفی
SDK PHP بکتوری برای سهولت کار کاربران این پلتفرم تدارک دیده شده است؛ و شامل امکاناتی برای استفاده از سرویس فایل بکتوری می‌باشد. در این مستند با نحوه راه‌اندازی SDK برای یک پروژه PHP آشنا می‌شویم. برای راه‌اندازی SDK از Composer استفاده می‌کنیم. Composer یک Dependency Manager برای PHP است.
نصب Composer
قدم اول نصب کردن Composer است، در صورتی که قبلاً Composer را روی سیستم خود نصب کرده‌اید به قدم بعدی بروید.
نصب در MAC OS با استفاده از HomeBrew:
دستور زیر را در ترمینال اجرا نمایید:
brew install composer
سپس برای اطمینان از نصب شدن صحیح Composer دستور
composer --version
را اجرا کنید؛ باید ورژن نصب شده از composer به شما نمایش داده‌شود.
نصب در LINUX :
دستورات زیر را به ترتیب در ترمینال اجرا کنید:
sudo apt-get update
sudo apt-get install curl
sudo curl -s https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer
در صورتی که کاربر ویندوز هستید یا به طریقه نصب دیگری نیاز دارید به getcomposer.org مراجعه نمایید.
نصب SDK
قدم بعدی پس از نصب composer، نصب SDK می‌باشد. داخل ترمینال سیستم خود به مسیری که پروژه شما در آن قرار دارد بروید و دستور زیر را اجرا نمایید:
composer require backtory/storage-php:dev-master
یا در صورتی که composer را به PATH اضافه نکرده‌اید:
php composer.phar require backtory/storage-php:dev-master
سپس منتظر بمانید تا SDK نصب شود. پس از اتمام نصب باید دو فایل composer.json و composer.lock و همچنین پوشه vendor برای شما ایجاد شده‌باشد. تبریک! شما SDK PHP بکتوری را با موفقیت نصب کرده‌اید. در ادامه نحوه آماده‌سازی SDK را مختصراً شرح می‌دهیم. توضیحات درمورد نحوه استفاده از SDK را می‌توانید در مستند بعدی دنبال کنید.
آماده‌سازی SDK
include کردن
برای استفاده از SDK در فایل‌‌های php پروژه خود، باید ابتدا فایل autoload.php، واقع در پوشه Vendor را include کنید. برای مثال اگر در پروژه خود یک پوشه Classes داشته باشید و داخل آن فایل php شما قرار داشته‌باشد که در آن میخواهید از SDK استفاده‌کنید، باید به صورت زیر بنویسید:
include "../vendor/autoload.php";
یعنی همواره آدرس را نسبت به مکان فایل php خود می‌دهید. سپس نیاز است مشخص کنید که از چه کتابخانه‌ای میخواهید استفاده کنید؛ برای این کار باید یه صورت زیر عمل کنید:
use Backtory\Storage\Core\Facade\BacktoryStorage;
راه‌اندازی اولیه
برای ارتباط SDK با پروژه شما، نیاز است که کلیدهای مربوطه را به SDK بدهید. این کلیدها شامل کلید سرویس فایل ، کلید Master سرویس کاربران و ID سرویس کاربران پروژه شما می‌باشد. از آنجایی که کد php شما روی سرور خودتان اجرا خواهد شد و در اختیار کاربران محصول شما نخواهد بود، در SDK ما از کلید Master پروژه شما، برای سهولت کار، استفاده می‌کنیم. برای دادن این کلیدها به SDK دو راه وجود دارد، دادن کلیدها به صورت مستقیم به SDK، یا دادن فایل حاوی کلیدها، با فرمت مناسب.
برای دادن مستقیم کلیدها از تابع init استفاده می‌کنیم:
BacktoryStorage::init(
"<X-Backtory-Authentication-Id>",
"<X-Backtory-Authentication-Key-(Master)>",
"<X-Backtory-Storage-Id>"
);
و در صورتی که میخواهید از فایل استفاده کنید از تابع initWithConfigFile باید استفاده کنید:
BacktoryStorage::initWithConfigFile("FILENAME");
نکته: نوع فایل‌هایی که توسط SDK پشتیبانی می‌شوند عبارت‌اند از: .ini, .php, .xml, .json, .yml
در فایل کلیدها را مطابق زیر قرار داده باشید:
X-Backtory-Authentication-Id: <X-Backtory-Authentication-Id>
X-Backtory-Authentication-Key: <X-Backtory-Authentication-Key-(Master)>
X-Backtory-Object-Storage-Id: <X-Backtory-Storage-Id>
حال می‌توانید از توابع موجود در SDK استفاده کنید. در مستند بعدی به شرح این توابع می‌پردازیم.