أدوات لالتقاط وتحويل الويب

العميل مع بيرلبيرل API

الوصف

يعالج هذا الفصل كل الاتصالات مع خدمات الويب GrabzIt screenshot.

الطرق العامة

GetResult($ معرف)

هذه الطريقة تقوم بإرجاع لقطة الشاشة نفسها. إذا لم يتم إرجاع أي شيء ، فقد حدث خطأ ما أو أن لقطة الشاشة ليست جاهزة بعد.

المعلمات

  • معرف - المعرف الفريد للشاشة
    • مطلوب:

قيمة الإرجاع

القبض


URLToAnimation($ رابط، خيارات $)

حدد عنوان URL للفيديو عبر الإنترنت الذي يجب تحويله intيا المتحركة GIF.

المعلمات

  • عنوان url - عنوان URL لتحويل الفيديو عبر الإنترنت intس المتحركة GIF.
    • مطلوب:
    • يقبل عنوان URL لفيديو Vimeo و YouTube
      • يعتمد تحذير تنشيط مقاطع فيديو Vimeo و YouTube على جهة خارجية وبالتالي قد لا يوفر نتائج متسقة.
  • الخيارات - مثيل ل GrabzItAnimationOptions فئة تحدد أي خيارات خاصة لاستخدامها عند إنشاء صورة GIF متحركة.

قيمة الإرجاع

باطل

GrabzItAnimationOptions

يمثل الفصل جميع الخيارات المتاحة عند إنشاء صورة GIF متحركة.

ممتلكات عامة

  • customId($value) - معرف مخصص يمكنك تمريره إلى خدمة الويب GIF المتحركة. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
    • الافتراضي: فارغ
  • width($value) - عرض GIF المتحركة الناتجة بالبكسل.
    • الافتراضي: 180px
    • الحد الأقصى: أقصى عرض للحزمة
    • الحجم التلقائي: -1 (تمرير -1 يعني أن عرض يتم تحجيم GIF المتحركة فيما يتعلق بارتفاعه ، إذا كان حجم العرض تلقائيًا ، فلن يتمكن الارتفاع من ذلك)
  • height($value) - ارتفاع GIF المتحركة الناتجة بالبكسل.
    • الافتراضي: 120px
    • الحد الأقصى: أقصى ارتفاع للحزمة
    • الحجم التلقائي: -1 (تمرير -1 يعني أن ارتفاع يتم تحجيم GIF المتحركة فيما يتعلق بعرضه ، إذا كان الارتفاع يتم تلقائيًا ، فلا يمكن للعرض)
  • start($value) - موضع بدء الفيديو الذي يجب تحويله intيا المتحركة GIF.
    • الافتراضي: 0 ثانية
  • duration($value) - طول ثواني الفيديو التي يجب تحويلها intيا المتحركة GIF.
    • الافتراضي: الحد الأقصى لطول الحزمة
  • speed($value) - سرعة GIF المتحركة.
    • الافتراضي: 1
    • الحد الأدنى: 0.2
    • الحد الأقصى: 10
  • framesPerSecond($value) - عدد الإطارات في الثانية التي يجب التقاطها من الفيديو.
    • الافتراضي: 10
    • الحد الأدنى: 0.2
    • الحد الأقصى: 60
  • repeat($value) - عدد مرات تكرار حلقة GIF المتحركة.
    • الافتراضي: 0
    • حلقة مستمرة: 0
  • reverse($value) - في حالة 1 ، يتم عكس إطارات GIF المتحركة
    • الافتراضي: 0
  • customWaterMarkId($value) - إضافة علامة مائية مخصصة إلى GIF المتحركة
    • الافتراضي: فارغ
  • quality($value) - ال جودة الصورة التي تم إرجاعهاالذي يحتوي على ضغط افتراضي قدره 85٪.
    • إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
    • الافتراضي: -1
    • الحد الأدنى: -1
    • الحد الأقصى: 100
  • country($value) - البلد GIF المتحركة يجب أن تؤخذ من.
    • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
    • الافتراضي: الموقع الحالي الأسرع
    • الخيارات: "SG" ، "UK" ، "US"
  • exportURL($value) - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
    • الافتراضي: فارغ
  • encryptionKey($value) - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، يتم تشفير الالتقاط عند إنشائه. بما أن بيرل لديه مرافق تشفير أصلية سيئة تحتاجها اتبع هذه التعليمات لفك تشفير التقاط المشفرة.
    • الافتراضي: فارغ
  • proxy($value) - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
    • الافتراضي: فارغ

URLToImage($ رابط، خيارات $)

يحدد عنوان URL الذي يجب تحويله intيا صورة لقطة للشاشة.

المعلمات

  • عنوان url - عنوان URL الذي يجب أن تكون لقطة الشاشة منه
    • مطلوب:
  • الخيارات - مثيل ل GrabzItImageOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء لقطة الشاشة.

قيمة الإرجاع

باطل

HTMLToImage($ أتش تي أم أل، خيارات $)

يحدد HTML الذي يجب تحويله intيا صورة.

المعلمات

  • أتش تي أم أل - HTML لتحويل intيا صورة
    • مطلوب:
  • الخيارات - مثيل ل GrabzItImageOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء صورة.

قيمة الإرجاع

باطل

FileToImage($ المسار، خيارات $)

يحدد ملف HTML الذي يجب تحويله intيا صورة.

المعلمات

  • المسار - مسار ملف ملف HTML لتحويله intيا صورة
    • مطلوب:
  • الخيارات - مثيل ل GrabzItImageOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء صورة.

قيمة الإرجاع

باطل

GrabzItImageOptions

يمثل الفصل جميع الخيارات المتاحة عند إنشاء التقاطات للصورة.

ممتلكات عامة

  • customId($value) - معرف مخصص يمكنك نقله إلى لقطة شاشة webservice. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
    • الافتراضي: فارغ
  • browserWidth($value) - عرض المتصفح بالبكسل
    • الافتراضي: 1024
    • الحد الأقصى: 10000
  • browserHeight($value) - ارتفاع المتصفح بالبكسل
    • الافتراضي: 768
    • الحد الأقصى: 10000
    • الطول الكامل: -1 (تمرير -1 يعني أنه تم التقاط صورة نصية لصفحة الويب بالكامل)
  • width($value) - عرض الصورة المصغرة الناتجة بالبكسل
    • الإفتراضي: أعلى نسبة من عرض المتصفح ممكن أن تتناسب مع الحد الأقصى للعرض لحزمة المستخدمين
    • الحد الأقصى: أقصى عرض للحزمة
    • العرض الكامل: -1 (تمرير -1 يعني أنه لا يتم تقليل عرض الصورة المصغرة)
  • height($value) - ارتفاع الصورة المصغرة الناتجة بالبكسل
    • الإفتراضي: أعلى نسبة لارتفاع المتصفح ممكن أن تتناسب مع أقصى ارتفاع لحزمة المستخدمين
    • الحد الأقصى: أقصى ارتفاع للحزمة
    • الطول الكامل: -1 (تمرير -1 يعني أنه لا يتم تقليل ارتفاع الصورة المصغرة)
  • format($value) - الشكل الذي يجب أن تكون عليه لقطة الشاشة.
    • الافتراضي: "jpg"
    • الخيارات: "bmp8" ، "bmp16" ، "bmp24" ، "bmp" ، "tiff" ، "webp" ، "jpg" ، "png"
  • delay($value) - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
    • الافتراضي: 0
    • الحد الأقصى: 30000
  • targetElement($value) - معرف أو فئة محدد CSS من عنصر HTML الوحيد على صفحة الويب المستهدفة المراد تشغيلها intoa لقطة شاشة ، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
    • الافتراضي: فارغ
  • hideElement($value) - معرف أو فئة محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
    • الافتراضي: فارغ
  • waitForElement($value) - معرف أو فئة محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
    • الافتراضي: فارغ
  • requestAs($value) - نوع وكيل المستخدم الذي ترغب في استخدامه
    • الافتراضي: 0
    • خيارات:
      • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
      • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
      • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
      • 3 = يشير إلى أنه يجب استخدام وكيل المستخدم للمتصفح الأساسي
  • customWaterMarkId($value) - أضف علامة مائية مخصصة إلى الصورة
    • الافتراضي: فارغ
  • quality($value) - ال جودة الصورة التي تم إرجاعها. يؤثر هذا حاليًا على صور JPG فقط ، والتي تحتوي على ضغط افتراضي يبلغ 85٪.
    • إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
    • الافتراضي: -1
    • الحد الأدنى: -1
    • الحد الأقصى: 100
  • transparent($value) - إذا كان 1 يجب أن يكون التقاط الصور شفافًا. هذا متوافق فقط مع صور بابوا نيو غينيا وتيف.
    • الافتراضي: 0
  • hd($value) - إذا 1 الصورة سوف يكون التقاط في عالية الوضوح هذا يضاعف حجم أبعاد الصورة.
    • الافتراضي: 0
  • country($value) - البلد لقطة ينبغي أن تؤخذ من.
    • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
    • الافتراضي: الموقع الحالي الأسرع
    • الخيارات: "SG" ، "UK" ، "US"
  • exportURL($value) - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
    • الافتراضي: فارغ
  • encryptionKey($value) - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، يتم تشفير الالتقاط عند إنشائه. بما أن بيرل لديه مرافق تشفير أصلية سيئة تحتاجها اتبع هذه التعليمات لفك تشفير التقاط المشفرة.
    • الافتراضي: فارغ
  • noAds($value) - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
    • الافتراضي: خطأ
  • noCookieNotifications($value) - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
    • الافتراضي: خطأ
  • address($value) - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا إذا كان HTML الذي يتم تحويله يستخدم عناوين URL النسبية لموارد مثل CSS والصور.
    • الافتراضي: فارغ
  • proxy($value) - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
    • الافتراضي: فارغ

الطرق العامة

  • AddPostParameter ($ name ، $ value) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
    • الاسم - اسم المعلمة HTTP Post
    • القيمة - قيمة المعلمة HTTP Post

URLToRenderedHTML($ رابط، خيارات $ = فارغة)

يحدد عنوان URL الذي يجب تحويله intس المقدمة HTML.

المعلمات

  • عنوان url - عنوان URL الذي يجب أن يتكون منه HTML
    • مطلوب:
  • الخيارات - مثيل ل GrabzItHTMLOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدم.

قيمة الإرجاع

باطل

HTMLToRenderedHTML($ أتش تي أم أل، خيارات $ = فارغة)

يحدد HTML الذي يجب تحويله intس المقدمة HTML.

المعلمات

  • أتش تي أم أل - HTML لتحويل intس المقدمة HTML
    • مطلوب:
  • الخيارات - مثيل ل GrabzItHTMLOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدمة.

قيمة الإرجاع

باطل

FileToRenderedHTML($ المسار، خيارات $ = فارغة)

يحدد ملف HTML الذي يجب تحويله intس المقدمة HTML.

المعلمات

  • المسار - مسار ملف ملف HTML لتحويله intس المقدمة HTML
    • مطلوب:
  • الخيارات - مثيل ل GrabzItHTMLOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدمة.

قيمة الإرجاع

باطل

GrabzItHTMLOptions

يمثل الفصل جميع الخيارات المتاحة عند خلق يلتقط HTML المقدمة.

ممتلكات عامة

  • customId($value) - معرف مخصص يمكنك تمريره إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
    • الافتراضي: فارغ
  • browserWidth($value) - عرض المتصفح بالبكسل
    • الافتراضي: 1024
    • الحد الأقصى: 10000
  • browserHeight($value) - ارتفاع المتصفح بالبكسل
    • الافتراضي: 768
    • الحد الأقصى: 10000
  • delay($value) - عدد المللي ثانية إلى انتظر قبل التقاط الصورة
    • الافتراضي: 0
    • الحد الأقصى: 30000
  • waitForElement($value) - معرف أو فئة محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
    • الافتراضي: فارغ
  • requestAs($value) - نوع وكيل المستخدم الذي ترغب في استخدامه
    • الافتراضي: 0
    • خيارات:
      • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
      • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
      • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
      • 3 = يشير إلى أنه يجب استخدام وكيل المستخدم للمتصفح الأساسي
  • country($value) - البلد لقطة ينبغي أن تؤخذ من.
    • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
    • الافتراضي: الموقع الحالي الأسرع
    • الخيارات: "SG" ، "UK" ، "US"
  • exportURL($value) - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
    • الافتراضي: فارغ
  • encryptionKey($value) - إذا تم تحديد مفتاح التشفير AES المشفر 64 الأساسي ، يتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
    • الافتراضي: فارغ
  • noAds($value) - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
    • الافتراضي: خطأ
  • noCookieNotifications($value) - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
    • الافتراضي: خطأ
  • address($value) - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
    • الافتراضي: فارغ
  • proxy($value) - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
    • الافتراضي: فارغ

الطرق العامة

  • AddPostParameter ($ name ، $ value) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
    • الاسم - اسم المعلمة HTTP Post
    • القيمة - قيمة المعلمة HTTP Post

URLToPDF($ رابط، خيارات $)

يحدد عنوان URL الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

  • عنوان url - عنوان URL الذي يجب تحويله intيا قوات الدفاع الشعبي
    • مطلوب:
  • الخيارات - مثيل لفئة GrabzItPDFOptions التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

HTMLToPDF($ أتش تي أم أل، خيارات $)

يحدد HTML الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

  • أتش تي أم أل - HTML لتحويل intيا قوات الدفاع الشعبي
    • مطلوب:
  • الخيارات - مثيل لفئة GrabzItPDFOptions التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

FileToPDF($ المسار، خيارات $)

يحدد ملف HTML الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

  • المسار - مسار ملف ملف HTML لتحويله intيا قوات الدفاع الشعبي
    • مطلوب:
  • الخيارات - مثيل لفئة GrabzItPDFOptions التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

GrabzItPDFOptions

يمثل الفصل جميع الخيارات المتاحة عند إنشاء ملفات PDF.

ممتلكات عامة

  • customId($value) - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
    • الافتراضي: فارغ
  • includeBackground($value) - إذا كانت 1 ، يجب تضمين خلفية صفحة الويب في PDF
    • الافتراضي: 1
  • pagesize($value) - حجم صفحة PDF
    • الافتراضي: "A4"
    • الخيارات: "A3" ، "A4" ، "A5" ، "A6" ، "B3" ، "B4" ، "B5" ، "B6" ، "قانوني" ، "خطاب"
  • orientation($value) - اتجاه وثيقة PDF
    • الافتراضي: "عمودي"
    • خيارات: "بورتريه" ، "أفقي"
  • cssMediaType($value) - ال CSS Media نوع مستند PDF
    • الشاشة الافتراضية"
    • خيارات: "الشاشة" ، "العلاقات العامةint"
  • includeLinks($value) - 1 إذا كان يجب تضمين الروابط في PDF
    • الافتراضي: 1
  • includeOutline($value) - 1 إذا قوات الدفاع الشعبي الإشارات المرجعية ينبغي أن تدرج
    • الافتراضي: 0
  • title($value) - تقديم عنوان لمستند PDF
    • الافتراضي: فارغ
  • coverURL($value) - عنوان URL لصفحة الويب التي يجب استخدامها كصفحة غلاف لملف PDF
    • الافتراضي: فارغ
  • marginTop($value) - الهامش بالمليمترات التي يجب أن تظهر في الجزء العلوي من صفحة وثيقة PDF
    • الافتراضي: 10
  • marginLeft($value) - الهامش بالمليمترات التي يجب أن تظهر على يسار صفحة مستند PDF
    • الافتراضي: 10
  • marginBottom($value) - الهامش بالمليمترات التي يجب أن تظهر في أسفل صفحة وثيقة PDF
    • الافتراضي: 10
  • marginRight($value) - الهامش بالمليمترات التي يجب أن تظهر على يمين مستند PDF
    • الافتراضي: 10
  • browserWidth($value) - ال عرض المتصفح بالبكسل
    • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
    • الافتراضي: 1024
    • الحد الأقصى: 10000
    • العرض التلقائي: -1 (تمرير -1 يعني أن عرض المستعرض يطابق عرض مستند PDF)
  • pageWidth - ال عرض مخصص لملف PDF الناتج في ملم
  • pageHeight - ال ارتفاع مخصص لقوات الدفاع الشعبي الناتجة في ملم
  • delay($value) - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
    • الافتراضي: 0
    • الحد الأقصى: 30000
  • requestAs($value) - نوع وكيل المستخدم الذي ترغب في استخدامه
    • الافتراضي: 0
    • خيارات:
      • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
      • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
      • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
      • 3 = يشير إلى أنه يجب استخدام وكيل المستخدم للمتصفح الأساسي
  • templateId($value) - أضف قالب المعرف الذي يحدد رأس وتذييل مستند PDF
    • الافتراضي: فارغ
  • targetElement($value) - معرف أو فئة محدد CSS من عنصر HTML الوحيد على صفحة الويب المستهدفة المراد تشغيلها intيا قوات الدفاع الشعبي ، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
    • الافتراضي: فارغ
  • hideElement($value) - معرف أو فئة محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
    • الافتراضي: فارغ
  • waitForElement($value) - معرف أو فئة محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
    • الافتراضي: فارغ
  • customWaterMarkId($value) - أضف علامة مائية مخصصة إلى كل صفحة من وثيقة PDF
    • الافتراضي: فارغ
  • quality($value) - ال جودة PDF عاد. يستخدم الإعداد الافتراضي الجودة الموصى بها لملف PDF.
    • إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
    • الافتراضي: -1
    • الحد الأدنى: -1
    • الحد الأقصى: 100
  • country($value) - البلد لقطة ينبغي أن تؤخذ من.
    • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
    • الافتراضي: الموقع الحالي الأسرع
    • الخيارات: "SG" ، "UK" ، "US"
  • exportURL($value) - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
    • الافتراضي: فارغ
  • encryptionKey($value) - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، يتم تشفير الالتقاط عند إنشائه. بما أن بيرل لديه مرافق تشفير أصلية سيئة تحتاجها اتبع هذه التعليمات لفك تشفير التقاط المشفرة.
    • الافتراضي: فارغ
  • noAds($value) - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
    • الافتراضي: خطأ
  • noCookieNotifications($value) - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
    • الافتراضي: خطأ
  • address($value) - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا إذا كان HTML الذي يتم تحويله يستخدم عناوين URL النسبية لموارد مثل CSS والصور.
    • الافتراضي: فارغ
  • proxy($value) - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
    • الافتراضي: فارغ
  • mergeId($value) - معرف الالتقاط الذي يجب أن يكون دمجها في بداية وثيقة PDF الجديدة
    • الافتراضي: فارغ
  • password($value) - ال كلمة مرور لحماية وثيقة PDF مع
    • الافتراضي: فارغ

الطرق العامة

  • AddPostParameter ($ name ، $ value) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
    • الاسم - اسم المعلمة HTTP Post
    • القيمة - قيمة المعلمة HTTP Post
  • AddTemplateParameter ($ name ، $ value) - تحديد قالب مخصص المعلمة والقيمة ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة.
    • اسم - اسم المعلمة قالب
    • القيمة - قيمة المعلمة القالب

URLToDOCX ($ رابط، خيارات $)

يحدد عنوان URL الذي يجب تحويله intيا DOCX.

المعلمات

  • عنوان url - عنوان URL الذي يجب تحويله intيا DOCX
    • مطلوب:
  • الخيارات - مثيل ل GrabzItDOCXOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء DOCX.

قيمة الإرجاع

باطل

HTMLToDOCX($ أتش تي أم أل، خيارات $)

يحدد HTML الذي يجب تحويله intيا DOCX.

المعلمات

  • أتش تي أم أل - HTML لتحويل intيا DOCX
    • مطلوب:
  • الخيارات - مثيل ل GrabzItDOCXOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء DOCX.

قيمة الإرجاع

باطل

FileToDOCX($ المسار، خيارات $)

يحدد ملف HTML الذي يجب تحويله intيا DOCX.

المعلمات

  • المسار - مسار ملف ملف HTML لتحويله intيا DOCX
    • مطلوب:
  • الخيارات - مثيل ل GrabzItDOCXOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء DOCX.

قيمة الإرجاع

باطل

GrabzItDOCXOptions

يمثل الفصل جميع الخيارات المتاحة عند إنشاء التقاط DOCX.

ممتلكات عامة

  • customId($value) - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
    • الافتراضي: فارغ
  • setIncludeBackground($value) - في حالة 1 ، يجب تضمين صور الخلفية لصفحة الويب في لقطة الشاشة
    • الافتراضي: 1
  • pagesize($value) - حجم صفحة DOCX
    • الافتراضي: "A4"
    • الخيارات: "A3" ، "A4" ، "A5" ، "A6" ، "B3" ، "B4" ، "B5" ، "B6" ، "قانوني" ، "خطاب"
  • orientation($value) - اتجاه وثيقة DOCX
    • الافتراضي: "عمودي"
    • خيارات: "بورتريه" ، "أفقي"
  • includeLinks($value) - 1 إذا كان ينبغي تضمين الروابط في DOCX
    • الافتراضي: 1
  • includeImages($value) - في حالة 1 ، يجب تضمين صور الخلفية لصفحة الويب في لقطة الشاشة
    • الافتراضي: 1
  • title($value) - تقديم عنوان لوثيقة DOCX
    • الافتراضي: فارغ
  • marginTop($value) - الهامش بالمليمترات التي يجب أن تظهر في أعلى صفحة مستند DOCX
    • الافتراضي: 10
  • marginLeft($value) - الهامش بالمليمترات التي يجب أن تظهر على يسار صفحة مستند DOCX
    • الافتراضي: 10
  • marginBottom($value) - الهامش بالمليمترات التي يجب أن تظهر في أسفل صفحة مستند DOCX
    • الافتراضي: 10
  • marginRight($value) - الهامش بالمليمترات التي يجب أن تظهر على يمين مستند DOCX
    • الافتراضي: 10
  • browserWidth($value) - ال عرض المتصفح بالبكسل
    • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
    • الافتراضي: 1024
    • الحد الأقصى: 10000
    • العرض التلقائي: -1 (تمرير -1 يعني أن عرض المستعرض يطابق عرض مستند DOCX)
  • pageWidth - ال عرض مخصص لل DOCX الناتجة في ملم
  • pageHeight - ال ارتفاع مخصص لل DOCX الناتجة في ملم
  • delay($value) - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
    • الافتراضي: 0
    • الحد الأقصى: 30000
  • requestAs($value) - نوع وكيل المستخدم الذي ترغب في استخدامه
    • الافتراضي: 0
    • خيارات:
      • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
      • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
      • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
      • 3 = يشير إلى أنه يجب استخدام وكيل المستخدم للمتصفح الأساسي
  • templateId($value) - أضف قالب المعرف الذي يحدد رأس وتذييل مستند DOCX
    • الافتراضي: فارغ
  • targetElement($value) - معرف أو فئة محدد CSS من عنصر HTML الوحيد على صفحة الويب المستهدفة المراد تشغيلها intيا DOCX ، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
    • الافتراضي: فارغ
  • hideElement($value) - معرف أو فئة محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
    • الافتراضي: فارغ
  • waitForElement($value) - معرف أو فئة محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
    • الافتراضي: فارغ
  • quality($value) - ال جودة DOCX عاد. الافتراضي يستخدم الجودة الموصى بها ل DOCX.
    • إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
    • الافتراضي: -1
    • الحد الأدنى: -1
    • الحد الأقصى: 100
  • country($value) - البلد لقطة ينبغي أن تؤخذ من.
    • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
    • الافتراضي: الموقع الحالي الأسرع
    • الخيارات: "SG" ، "UK" ، "US"
  • exportURL($value) - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
    • الافتراضي: فارغ
  • encryptionKey($value) - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، يتم تشفير الالتقاط عند إنشائه. بما أن بيرل لديه مرافق تشفير أصلية سيئة تحتاجها اتبع هذه التعليمات لفك تشفير التقاط المشفرة.
    • الافتراضي: فارغ
  • noAds($value) - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
    • الافتراضي: خطأ
  • noCookieNotifications($value) - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
    • الافتراضي: خطأ
  • address($value) - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا إذا كان HTML الذي يتم تحويله يستخدم عناوين URL النسبية لموارد مثل CSS والصور.
    • الافتراضي: فارغ
  • proxy($value) - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
    • الافتراضي: فارغ
  • mergeId($value) - معرف الالتقاط الذي يجب أن يكون دمجها في بداية وثيقة DOCX الجديدة
    • الافتراضي: فارغ
  • password($value) - ال كلمة المرور لحماية وثيقة DOCX مع
    • الافتراضي: فارغ

الطرق العامة

  • AddPostParameter ($ name ، $ value) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
    • الاسم - اسم المعلمة HTTP Post
    • القيمة - قيمة المعلمة HTTP Post
  • AddTemplateParameter ($ name ، $ value) - تحديد قالب مخصص المعلمة والقيمة ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة.
    • اسم - اسم المعلمة قالب
    • القيمة - قيمة المعلمة القالب

URLToTable($ رابط، خيارات $)

يحدد عنوان URL الذي يجب استخراج جداول HTML منه.

المعلمات

  • عنوان url - عنوان URL لاستخراج جداول HTML من
    • مطلوب:
  • الخيارات - مثيل ل GrabzItTableOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند تحويل جدول HTML.

قيمة الإرجاع

باطل

HTMLToTable ($ أتش تي أم أل، خيارات $)

يحدد HTML الذي يجب استخراج جداول HTML منه.

المعلمات

  • أتش تي أم أل - HTML لاستخراج جداول HTML من.
    • مطلوب:
  • الخيارات - مثيل ل GrabzItTableOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند تحويل جدول HTML.

قيمة الإرجاع

باطل

FileToTable ($ المسار، خيارات $)

يحدد ملف HTML الذي يجب استخراج جداول HTML منه.

المعلمات

  • المسار - مسار ملف ملف HTML لاستخراج جداول HTML من.
    • مطلوب:
  • الخيارات - مثيل ل GrabzItTableOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند تحويل جدول HTML.

قيمة الإرجاع

باطل

GrabzItTableOptions

يمثل الفصل جميع الخيارات المتاحة عند تحويل جداول HTML إلى CSV أو XLSX أو JSON.

ممتلكات عامة

  • customId($value) - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته
    • الافتراضي: فارغ
  • tableNumberToInclude($value) - فهرس الجدول المطلوب تحويله ، إذا كانت جميع الجداول في صفحة الويب مرتبة من أعلى صفحة الويب إلى أسفل
    • الافتراضي: 1
  • format($value) - يجب أن يكون الجدول في
    • الافتراضي: "CSV"
    • خيارات: "CSV" ، "json" ، "xlsx"
  • includeHeaderNames($value) - إذا تم إدراج أسماء رؤوس 1 في الجدول
    • الافتراضي: 1
  • includeAllTables($value) - إذا تم استخراج 1 من الجدول الموجود على صفحة الويب ، فسيظهر كل جدول في ورقة بيانات منفصلة. متوفر فقط بتنسيق XLSX
    • الافتراضي: 0
  • targetElement($value) - معرف عنصر HTML الوحيد في صفحة الويب التي يجب استخدامها لاستخراج الجداول من
    • الافتراضي: فارغ
  • requestAs($value) - نوع وكيل المستخدم الذي ترغب في استخدامه
    • الافتراضي: 0
    • خيارات:
      • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
      • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
      • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
      • 3 = يشير إلى أنه يجب استخدام وكيل المستخدم للمتصفح الأساسي
  • country($value) - البلد لقطة ينبغي أن تؤخذ من.
    • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
    • الافتراضي: الموقع الحالي الأسرع
    • الخيارات: "SG" ، "UK" ، "US"
  • exportURL($value) - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
    • الافتراضي: فارغ
  • encryptionKey($value) - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، يتم تشفير الالتقاط عند إنشائه. بما أن بيرل لديه مرافق تشفير أصلية سيئة تحتاجها اتبع هذه التعليمات لفك تشفير التقاط المشفرة.
    • الافتراضي: فارغ
  • address($value) - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا إذا كان HTML الذي يتم تحويله يستخدم عناوين URL النسبية لموارد مثل CSS والصور.
    • الافتراضي: فارغ
  • proxy($value) - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
    • الافتراضي: فارغ

الطرق العامة

  • AddPostParameter ($ name ، $ value) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
    • الاسم - اسم المعلمة HTTP Post
    • القيمة - قيمة المعلمة HTTP Post

هذه هي الطريقة الموصى بها لحفظ الملف

Save($ callBackURL = '')

Save النتيجة بشكل غير متزامن وإرجاع معرف فريد ، والتي يمكن استخدامها للحصول على لقطة مع GetResult الأسلوب.

المعلمات

  • callBackURL - معالج يجب على خدمة GrabzIt الاتصال بعد اكتمال عملها

قيمة الإرجاع

يتم طرح المعرف الفريد للشاشة وإلا إذا حدث خطأ. ويمكن استخدام هذا للحصول على لقطة مع GetResult طريقة


تحذير هذه الطريقة متزامنة ، وبالتالي ستتسبب في توقف التطبيق أثناء معالجة النتيجة

SaveTo()

Save النتيجة بشكل متزامن لمتغير يحتوي على بيانات بايت الشاشة.

قيمة الإرجاع

إرجاع بيانات البايت للملف في حالة نجاحه ، وإلا فإنه يلقي استثناء.


تحذير هذه الطريقة متزامنة ، وبالتالي ستتسبب في توقف التطبيق أثناء معالجة النتيجة

SaveTo($saveإلى ملف)

Save النتيجة بشكل متزامن إلى ملف.

المعلمات

  • saveToFile - مسار الملف الذي سيتم التقاطه سيكون saveد إلى بمجرد الانتهاء منه
    • مطلوب:

قيمة الإرجاع

إرجاع 1 إذا كان ناجحًا وإلا فإنه يلقي استثناءً.


GetStatus ($ معرف)

الحصول على الوضع الحالي للشاشة GrabzIt.

المعلمات

  • معرف - المعرف الفريد للشاشة
    • مطلوب:

قيمة الإرجاع

GrabzItStatus موضوع


GetCookies (المجال $)

احصل على جميع ملفات تعريف الارتباط التي يستخدمها GrabzIt لمجال معين. قد يشمل ذلك ملفات تعريف الارتباط المعرفة من قبل المستخدم.

المعلمات

  • المجال - المجال لإرجاع ملفات تعريف الارتباط لـ
    • مطلوب:

قيمة الإرجاع

GrabzItCookie مجموعة


SetCookie ($ name ، $ domain ، $ value = '' ، $ path = '/' ، $ httponly = 0 ، $ تنتهي الصلاحية = '')

يعين ملف تعريف ارتباط مخصص جديد على GrabzIt ، إذا كان ملف تعريف الارتباط المخصص يحمل نفس الاسم والمجال مثل ملف تعريف الارتباط العام ، يتم تجاوز ملف تعريف الارتباط العام.

قد يكون ذلك مفيدًا إذا كانت ملفات مواقع الويب تتحكم فيها ملفات تعريف الارتباط.

المعلمات

  • اسم - اسم ملف تعريف الارتباط لتعيين
    • مطلوب:
  • المجال - مجال موقع الويب لتعيين ملف تعريف الارتباط لـ
    • مطلوب:
  • القيمة - قيمة ملف تعريف الارتباط
  • المسار - مسار موقع الويب الذي يرتبط به ملف تعريف الارتباط
  • httponly - إذا 1 ، يمكن استخدام ملف تعريف الارتباط فقط مع بروتوكول HTTP
  • تنتهي صلاحيته - يحدد وقت انتهاء صلاحية ملف تعريف الارتباط. تمرير قيمة فارغة إذا كان ملف تعريف الارتباط يجب أن لا تنتهي
    • يجب أن تكون بالتنسيق yyyy-mm-dd hh: mm: ss

قيمة الإرجاع

1 إذا تم تعيين ملف تعريف الارتباط بنجاح ، وإلا 0


DeleteCookie ($ name ، $ domain)

حذف ملف تعريف ارتباط مخصص أو حظر ملف تعريف ارتباط عمومي من الاستخدام

المعلمات

  • اسم - اسم ملف تعريف الارتباط المراد حذفه
    • مطلوب:
  • المجال - مجال موقع الويب لحذف ملف تعريف الارتباط لـ
    • مطلوب:

قيمة الإرجاع

1 إذا تم حذف ملف تعريف الارتباط بنجاح ، وإلا 0


الحصول علىWaterMarks()

احصل على علامات مائية مخصصة تم تحميلها

قيمة الإرجاع

GrabzItWaterMark مجموعة


الحصول علىWaterMark($ معرف)

إرجاع العلامات المائية المخصصة التي تطابق المعرف المحدد

المعلمات

  • معرف - معرف علامة مائية مخصصة معينة تريد عرضها
    • مطلوب:

قيمة الإرجاع

GrabzItWaterMark


إضافة: WaterMark(معرف $ ، مسار $ ، $ xpos ، $ ypos)

إضافة علامة مائية مخصصة جديدة

المعلمات

  • المعرف - المعرف الذي تريد إعطاء العلامة المائية المخصصة. من المهم أن يكون هذا المعرف فريدًا.
    • مطلوب:
  • المسار - المسار المطلق للعلامة المائية على الخادم الخاص بك. على سبيل المثال ، C: / علامة مائية / 1.png
    • مطلوب:
  • xpos - الموضع الأفقي الذي تريد أن تظهر فيه لقطة الشاشة
    • مطلوب:
    • خيارات:
      • اليسار = 0
      • مركز = 1
      • اليمين = 2
  • ypos - الموضع الرأسي الذي تريد أن تظهر فيه لقطة الشاشة
    • مطلوب:
    • خيارات:
      • أعلى = 0
      • الأوسط = 1
      • أسفل = 2

قيمة الإرجاع

إرجاع 1 إذا تم تعيين العلامة المائية بنجاح


DeleteWaterMark($ معرف)

حذف علامة مائية مخصصة

المعلمات

  • المعرف - معرف العلامة المائية المخصصة التي تريد حذفها
    • مطلوب:

قيمة الإرجاع

تقوم بإرجاع 1 إذا تم حذف العلامة المائية بنجاح


UseSSL ($ قيمة)

يحدد ما إذا كانت طلبات GrabzIt يجب أن تستخدم API SSL ام لا

المعلمات

  • ذات قيمة - إذا كانت 1 جميع الطلبات إلى واجهة برمجة تطبيقات GrabzIt ستستخدم SSL
    • مطلوب:

نتيجة الطبقات

GrabzItCookie

الطرق العامة

  • getName ()
    • اسم ملف تعريف الارتباط.
  • الحصول على قيمة()
    • قيمة ملف تعريف الارتباط.
  • getDomain ()
    • المجال الذي تم تعيين ملف تعريف الارتباط عليه.
  • getPath ()
    • المسار على المجال الذي ينطبق عليه ملف تعريف الارتباط هذا.
  • getHttpOnly ()
    • إذا كان ملف تعريف الارتباط هذا صالحًا فقط عند عرض موقع الويب باستخدام بروتوكول HTTP.
  • getExpires ()
    • تاريخ انتهاء صلاحية ملف تعريف الارتباط هذا
  • getType ()
    • نوع ملف تعريف الارتباط هذا ، والذي يمكن أن يكون أحد الإجراءات التالية:
      • عالمي - هذا ملف تعريف ارتباط عالمي من إعداد GrabzIt
      • محلي - هذا ملف تعريف ارتباط محلي تم تعيينه بواسطتك
      • تجاوز - ملف تعريف ارتباط عمومي تم تجاوزه بواسطتك

GrabzItStatus

الطبقة التي تمثل الوضع الحالي للشاشة.

الطرق العامة

  • getProcessing ()
    • إذا 1 لقطة الشاشة لا تزال قيد المعالجة.
  • getCached ()
    • إذا تمت معالجة 1 لقطة الشاشة ويتم تخزينها مؤقتًا في الوقت الحالي.
  • getExpired ()
    • إذا 1 لقطة الشاشة لم تعد على نظام GrabzIt.
  • getMessage ()
    • رسالة خطأ تم إرجاعها بواسطة النظام.

GrabzItWaterMark

تمثل هذه الفئة العلامات المائية المخصصة المخزنة في GrabzIt

الطرق العامة

  • getIdentifier ()
    • معرف العلامة المائية
  • getXPosition ()
    • الموقف الأفقي للعلامة المائية
      • اليسار = 0
      • مركز = 1
      • اليمين = 2
  • getYPosition ()
    • الموقف الرأسي للعلامة المائية
      • أعلى = 0
      • الأوسط = 1
      • أسفل = 2
  • getFormat ()
    • شكل العلامة المائية