حاشیه نویسی اطلاعات اضافی در مورد هر بخش خاصی از سند ارائه می دهد. ما می توانیم اسناد را با بازخورد و بررسی با استفاده از حاشیه نویسی علامت گذاری کنیم. می‌توانیم تصاویر، نظرات، یادداشت‌ها یا انواع دیگر اظهارات خارجی را به عنوان حاشیه‌نویسی به اسناد PDF اضافه کنیم. در این مقاله نحوه حاشیه نویسی اسناد PDF با استفاده از REST API در PHP را یاد می گیریم.
موضوعات زیر در این مقاله پوشش داده خواهد شد:
- PDF Annotation REST API و PHP SDK
- با استفاده از یک REST API در PHP، اسناد PDF را حاشیه نویسی کنید
- با استفاده از PHP حاشیه نویسی کنید
- Add Image Annotation با استفاده از PHP
- اضافه کردن حاشیه نویسی فیلد متنی با استفاده از PHP
PDF Annotation REST API و PHP SDK
برای حاشیه نویسی اسناد PDF، از PHP SDK of GroupDocs.Annotation Cloud API استفاده خواهیم کرد. این امکان افزودن حاشیه نویسی، همپوشانی واترمارک، جایگزینی متن، ویرایش و نشانه گذاری متن را به [فرمت های سند پشتیبانی شده] می دهد. لطفا با استفاده از دستور زیر در کنسول آن را نصب کنید:
composer require groupdocscloud/groupdocs-annotation-cloud
پس از نصب، لطفاً از Composers’ autoload برای استفاده از SDK مطابق شکل زیر استفاده کنید:
require_once('vendor/autoload.php');
لطفاً قبل از انجام مراحل ذکر شده [شناسه مشتری و راز خود را از داشبورد 5 دریافت کنید. هنگامی که شناسه و راز خود را دریافت کردید، کد را مطابق شکل زیر اضافه کنید:
// این مثال کد نحوه اضافه کردن شناسه مشتری و رمز را در کد نشان می دهد.
static $ClientId = '659fe7da-715b-4744-a0f7-cf469a392b73';
static $ClientSecret = 'b377c36cfa28fa69960ebac6b6e36421';
static $ApiBaseUrl = 'https://api.groupdocs.cloud';
static $MyStorage = '';
// اولیه کردن پیکربندی
$configuration = new GroupDocs\Annotation\Configuration();
// تنظیم تنظیمات
$configuration->setAppSid(self::$ClientId);
$configuration->setAppKey(self::$ClientSecret);
$configuration->setApiBaseUrl(self::$ApiBaseUrl);
با استفاده از REST API در PHP، اسناد PDF را حاشیه نویسی کنید
با دنبال کردن مراحل ساده زیر می‌توانیم اسناد PDF را در فضای ابری حاشیه‌نویسی کنیم:
- آپلود فایل PDF در ابر
- یادداشت سند PDF
- دانلود فایل مشروح
سند را آپلود کنید
ابتدا فایل PDF را با استفاده از نمونه کد زیر در فضای ابری آپلود می کنیم:
// این مثال کد نحوه آپلود یک فایل PDF را در فضای ابری نشان می دهد.
// یک نمونه از API را راه اندازی کنید
$apiInstance = new GroupDocs\Annotation\FileApi($configuration);
// مسیر فایل
$file = "C:\\Files\\Annotation\\sample.pdf";
// درخواست فایل آپلود ایجاد کنید
$request = new GroupDocs\Annotation\Model\Requests\UploadFileRequest("sample.pdf", $file, self::$MyStorage, null);
// آپلود فایل
$response = $apiInstance->uploadFile($request);
در نتیجه، فایل PDF آپلود شده در بخش فایل ها داشبورد در فضای ابری در دسترس خواهد بود.
حاشیه نویسی سند PDF با استفاده از PHP
اکنون، با دنبال کردن مراحل زیر، چندین حاشیه‌نویسی را به صورت برنامه‌نویسی به سند PDF آپلود شده اضافه می‌کنیم:
- ابتدا یک نمونه از AnnotateApi ایجاد کنید.
- سپس، ویژگی های حاشیه نویسی را تنظیم کنید، مانند موقعیت، نوع، متن و غیره.
- سپس، مرحله بالا را برای افزودن چندین حاشیه نویسی تکرار کنید.
- در مرحله بعد، مسیر فایل ورودی را ارائه دهید.
- سپس، شی AnnotateOptions را مقداردهی اولیه کنید و مسیر فایل خروجی را تنظیم کنید.
- پس از آن، AnnotateRequest را با AnnotateOptions به عنوان آرگومان ایجاد کنید.
- در نهایت، PDF را با استفاده از روش AnnotateApi.annotate() حاشیه نویسی کنید.
نمونه کد زیر نشان می دهد که چگونه می توان چندین حاشیه نویسی را با استفاده از REST API در PHP به یک سند PDF اضافه کرد.
// این مثال کد نشان می دهد که چگونه می توان چندین حاشیه نویسی را به PDF اضافه کرد.
// نمونه AnnotationAPI را راه اندازی کنید
$apiInstance = new GroupDocs\Annotation\حاشیه نویسی کنیدApi($configuration);
// اضافه کردن حاشیه نویسی فاصله
$a = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt = new GroupDocs\Annotation\Model\Point();
$pt->setX(1);
$pt->setY(1);
$a->setAnnotationPosition($pt);
$box = new GroupDocs\Annotation\Model\Rectangle();
$box->setX(100);
$box->setY(100);
$box->setWidth(200);
$box->setHeight(100);
$a->setBox($box);
$a->setPageNumber(0);
$a->setPenColor(1201033);
$a->setPenStyle(GroupDocs\Annotation\Model\AnnotationInfo::PEN_STYLE_SOLID);
$a->setPenWidth(1);
$a->setOpacity(0.7);
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_DISTANCE);
$a->setText("This is distance annotation");
$a->setCreatorName("Anonym A.");
// اضافه کردن حاشیه نویسی منطقه
$a1 = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt1 = new GroupDocs\Annotation\Model\Point();
$pt1->setX(1);
$pt1->setY(1);
$a1->setAnnotationPosition($pt1);
$box1 = new GroupDocs\Annotation\Model\Rectangle();
$box1->setX(80);
$box1->setY(400);
$box1->setWidth(200);
$box1->setHeight(100);
$a1->setBox($box1);
$a1->setPageNumber(0);
$a1->setPenColor(1201033);
$a1->setPenStyle(GroupDocs\Annotation\Model\AnnotationInfo::PEN_STYLE_SOLID);
$a1->setPenWidth(1);
$a1->setOpacity(0.7);
$a1->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_AREA);
$a1->setText("This is area annotation");
$a1->setCreatorName("Anonym A.");
// اضافه کردن حاشیه نویسی نقطه
$a2 = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt2 = new GroupDocs\Annotation\Model\Point();
$pt2->setX(100);
$pt2->setY(100);
$a2->setAnnotationPosition($pt2);
$box2 = new GroupDocs\Annotation\Model\Rectangle();
$box2->setX(450);
$box2->setY(150);
$box2->setWidth(100);
$box2->setHeight(30);
$a2->setBox($box2);
$a2->setPageNumber(0);
$a2->setOpacity(0.7);
$a2->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_POINT);
$a2->setText("This is point annotation");
$a2->setCreatorName("Anonym A.");
// اضافه کردن حاشیه نویسی فلش
$a3 = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt3 = new GroupDocs\Annotation\Model\Point();
$pt3->setX(1);
$pt3->setY(1);
$a3->setAnnotationPosition($pt3);
$box3 = new GroupDocs\Annotation\Model\Rectangle();
$box3->setX(350);
$box3->setY(350);
$box3->setWidth(200);
$box3->setHeight(100);
$a3->setBox($box3);
$a3->setPageNumber(0);
$a3->setPenColor(1201033);
$a3->setPenStyle(GroupDocs\Annotation\Model\AnnotationInfo::PEN_STYLE_SOLID);
$a3->setPenWidth(1);
$a3->setOpacity(0.7);
$a3->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_ARROW);
$a3->setText("This is arrow annotation");
$a3->setCreatorName("Anonym A.");
// مسیر فایل ورودی
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");
// گزینه های حاشیه نویسی را تعریف کنید
$options = new GroupDocs\Annotation\Model\حاشیه نویسی کنیدOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a, $a1, $a2, $a3]);
$options->setOutputPath("MultipleAnnotation.pdf");
// درخواست حاشیه نویسی ایجاد کنید
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);
// حاشیه نویسی کنید
$result = $apiInstance->annotate($request);
echo "AddMultipleAnnotations: Multiple Annotations added: " . $result->getHref();
حاشیه نویسی سند PDF با استفاده از PHP.
می‌توانید در مورد انواع حاشیه‌نویسی پشتیبانی شده در بخش افزودن حاشیه‌نویسی در مستندات بیشتر بخوانید.
فایل حاشیه نویسی را دانلود کنید
نمونه کد بالا فایل پی‌دی‌اف مشروح‌شده را در فضای ابری ذخیره می‌کند. با استفاده از نمونه کد زیر قابل دانلود است:
// این مثال کد نحوه بارگیری یک فایل PDF از ابر را نشان می دهد.
// اولیه سازی یک نمونه از API
$apiInstance = new GroupDocs\Annotation\FileApi($configuration);
// درخواست فایل دانلود را ایجاد کنید
$request = new GroupDocs\Annotation\Model\Requests\DownloadFileRequest("MultipleAnnotation.pdf", self::$MyStorage, null);
// دریافت فایل
$response = $apiInstance->downloadFile($request);
با استفاده از PHP حاشیه نویسی کنید
همچنین می‌توانیم با دنبال کردن مراحل زیر، حاشیه‌نویسی هایپرلینک را در سند PDF اضافه کنیم:
- ابتدا یک نمونه از AnnotateApi ایجاد کنید.
- سپس، ویژگی های حاشیه نویسی را تنظیم کنید، مانند موقعیت، متن، و غیره.
- سپس، نوع حاشیه نویسی را به عنوان پیوند تنظیم کنید.
- در مرحله بعد، مسیر فایل ورودی را ارائه دهید.
- سپس، شی AnnotateOptions را مقداردهی اولیه کنید و مسیر فایل خروجی را تنظیم کنید.
- پس از آن، AnnotateRequest را با AnnotateOptions به عنوان آرگومان ایجاد کنید.
- در نهایت، PDF را با استفاده از روش AnnotateApi.annotate() حاشیه نویسی کنید.
نمونه کد زیر نحوه اضافه کردن حاشیه نویسی هایپرلینک را در سند PDF با استفاده از REST API نشان می دهد. لطفاً برای آپلود و دانلود یک فایل مراحل ذکر شده را دنبال کنید.
// این مثال کد نحوه اضافه کردن حاشیه نویسی پیوند به PDF را نشان می دهد
// نمونه AnnotationAPI را راه اندازی کنید
$apiInstance = new GroupDocs\Annotation\حاشیه نویسی کنیدApi($configuration);
// اضافه کردن حاشیه نویسی لینک
$a = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt1 = new GroupDocs\Annotation\Model\Point();
$pt1->setX(80);
$pt1->setY(710);
$pt2 = new GroupDocs\Annotation\Model\Point();
$pt2->setX(240);
$pt2->setY(710);
$pt3 = new GroupDocs\Annotation\Model\Point();
$pt3->setX(80);
$pt3->setY(650);
$pt4 = new GroupDocs\Annotation\Model\Point();
$pt4->setX(240);
$pt4->setY(650);
$a->setPoints([$pt1, $pt2, $pt3, $pt4]);
$a->setUrl("https://www.groupdocs.com/");
$a->setPageNumber(0);
$a->setFontColor(1201033);
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_LINK);
$a->setText("This is link annotation");
$a->setCreatorName("Anonym A.");
// مسیر فایل ورودی
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");
// گزینه های حاشیه نویسی را تعریف کنید
$options = new GroupDocs\Annotation\Model\حاشیه نویسی کنیدOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddLinkAnnotation.pdf");
// درخواست حاشیه نویسی ایجاد کنید
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);
// حاشیه نویسی کنید
$result = $apiInstance->annotate($request);
echo "AddLinkAnnotation: Link Annotation added: " . $result->getHref();
با استفاده از PHP حاشیه نویسی کنید.
اضافه کردن حاشیه نویسی تصویر با استفاده از PHP
با دنبال کردن مراحلی که قبلا ذکر شد می‌توانیم حاشیه‌نویسی تصویر را در سند PDF اضافه کنیم. با این حال، فقط باید نوع حاشیه نویسی را مانند تصویر زیر تنظیم کنیم:
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_IMAGE);
نمونه کد زیر نحوه اضافه کردن حاشیه نویسی تصویر را در سند PDF با استفاده از REST API در PHP نشان می دهد. لطفاً برای آپلود و دانلود یک فایل مراحل ذکر شده را دنبال کنید.
// این مثال کد نحوه اضافه کردن حاشیه نویسی تصویر به PDF را نشان می دهد
// نمونه AnnotationAPI را راه اندازی کنید
$apiInstance = new GroupDocs\Annotation\حاشیه نویسی کنیدApi($configuration);
// اضافه کردن حاشیه نویسی تصویر
$a = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt = new GroupDocs\Annotation\Model\Point();
$pt->setX(1);
$pt->setY(1);
$a->setAnnotationPosition($pt);
$box = new GroupDocs\Annotation\Model\Rectangle();
$box->setX(200);
$box->setY(0);
$box->setWidth(200);
$box->setHeight(100);
$a->setBox($box);
$a->setPageNumber(0);
$a->setImagePath("groupdocs.png");
$a->setPenStyle(GroupDocs\Annotation\Model\AnnotationInfo::PEN_STYLE_SOLID);
$a->setOpacity(0.7);
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_IMAGE);
$a->setText("This is image annotation");
$a->setCreatorName("Anonym A.");
// مسیر فایل ورودی
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");
// گزینه های حاشیه نویسی را تعریف کنید
$options = new GroupDocs\Annotation\Model\حاشیه نویسی کنیدOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddImageAnnotation.pdf");
// درخواست حاشیه نویسی ایجاد کنید
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);
// حاشیه نویسی کنید
$result = $apiInstance->annotate($request);
echo "AddImageAnnotation: Image Annotation added: " . $result->getHref();
اضافه کردن حاشیه نویسی تصویر با استفاده از PHP.
اضافه کردن حاشیه نویسی فیلد متنی با استفاده از PHP
همچنین می‌توانیم با دنبال کردن مراحلی که قبلاً ذکر شد، حاشیه‌نویسی فیلد متنی را در سند PDF اضافه کنیم. با این حال، ما فقط باید نوع حاشیه نویسی را مطابق شکل زیر در قسمت متن تنظیم کنیم:
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_TEXT_FIELD);
نمونه کد زیر نحوه اضافه کردن حاشیه نویسی فیلد متنی در سند PDF را با استفاده از REST API نشان می دهد. لطفاً برای آپلود و دانلود یک فایل مراحل ذکر شده را دنبال کنید.
// این مثال کد نحوه اضافه کردن حاشیه نویسی فیلد متنی را به PDF نشان می دهد
// نمونه AnnotationAPI را راه اندازی کنید
$apiInstance = new GroupDocs\Annotation\حاشیه نویسی کنیدApi($configuration);
// حاشیه نویسی TextField را اضافه کنید
$a = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt = new GroupDocs\Annotation\Model\Point();
$pt->setX(1);
$pt->setY(1);
$a->setAnnotationPosition($pt);
$box = new GroupDocs\Annotation\Model\Rectangle();
$box->setX(380);
$box->setY(300);
$box->setWidth(100);
$box->setHeight(50);
$a->setBox($box);
$a->setPageNumber(0);
$a->setFontColor(1201033);
$a->setFontSize(12);
$a->setOpacity(0.7);
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_TEXT_FIELD);
$a->setText("Text field text");
$a->setCreatorName("Anonym A.");
// مسیر فایل ورودی
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");
// گزینه های حاشیه نویسی را تعریف کنید
$options = new GroupDocs\Annotation\Model\حاشیه نویسی کنیدOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddTextFieldAnnotation.pdf");
// درخواست حاشیه نویسی ایجاد کنید
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);
// حاشیه نویسی کنید
$result = $apiInstance->annotate($request);
echo "AddTextFieldAnnotation: Text Field Annotation added: " . $result->getHref();
اضافه کردن حاشیه نویسی فیلد متنی با استفاده از PHP.
آنلاین را امتحان کنید
لطفاً ابزار حاشیه نویسی PDF آنلاین رایگان زیر را که با استفاده از API بالا ایجاد شده است، امتحان کنید. https://products.groupdocs.app/annotation/pdf
نتیجه
در این مقاله یاد گرفتیم که چگونه:
- اضافه کردن حاشیه نویسی های متعدد به PDF با استفاده از PHP.
- حاشیه نویسی PDF با حاشیه نویسی فیلد پیوند، تصویر و متن در PHP.
- به صورت برنامه نویسی فایل PDF را در فضای ابری آپلود کنید.
- فایل پی دی اف مشروح را از ابر دانلود کنید.
علاوه بر این، می‌توانید با استفاده از مستندات درباره GroupDocs.Annotation Cloud API اطلاعات بیشتری کسب کنید. ما همچنین یک بخش API Reference ارائه می دهیم که به شما امکان می دهد API های ما را مستقیماً از طریق مرورگر تجسم کنید و با آنها تعامل داشته باشید. در صورت وجود هرگونه ابهام، لطفاً با ما در [تالار] تماس حاصل فرمایید15.