Merge pull request #9 from benconda/field-flags

chore: add form field flags handling

Author: benconda

include/pdfium.h

@@ -734,6 +734,10 @@ FPDFAnnot_GetLinkedAnnot(FPDF_ANNOTATION annot, FPDF_BYTESTRING key);
  int
 FPDFAnnot_GetFormFieldFlags(FPDF_FORMHANDLE handle,
                             FPDF_ANNOTATION annot);
+ FPDF_BOOL
+FPDFAnnot_SetFormFieldFlags(FPDF_FORMHANDLE handle,
+                            FPDF_ANNOTATION annot,
+                            int flags);
  FPDF_ANNOTATION
 FPDFAnnot_GetFormFieldAtPoint(FPDF_FORMHANDLE hHandle,
                               FPDF_PAGE page,

src/Page/Annotation/FormField.php

@@ -60,7 +60,7 @@ public function getExportValue(): string
         return $this->getFormText('FPDFAnnot_GetFormFieldExportValue');
     }
 
-    public function isChecked()
+    public function isChecked(): bool
     {
         return (bool) $this->ffi->FPDFAnnot_IsChecked($this->getFormHandler(), $this->handler);
     }
@@ -75,6 +75,21 @@ public function getFormControlIndex(): int
         return $this->ffi->FPDFAnnot_GetFormControlIndex($this->getFormHandler(), $this->handler);
     }
 
+    public function getFieldFlags(): FormFieldFlagList
+    {
+        $flags = $this->ffi->FPDFAnnot_GetFormFieldFlags($this->getFormHandler(), $this->handler);
+
+        return new FormFieldFlagList($flags);
+    }
+
+    /**
+     * Added in pdfium version 138.0.7188.0
+     */
+    public function setFieldFlags(FormFieldFlagList $flags): bool
+    {
+        return 1 === $this->ffi->FPDFAnnot_SetFormFieldFlags($this->getFormHandler(), $this->handler, $flags->flags);
+    }
+
     private function getFormText(string $methodName): string
     {
         $formHandler = $this->getFormHandler();

src/Page/Annotation/FormFieldFlag.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BenConda\PhpPdfium\Page\Annotation;
+
+enum FormFieldFlag: int
+{
+    // Common flags
+    case READ_ONLY = (1 << 0);
+    case REQUIRED = (1 << 1);
+    case NO_EXPORT = (1 << 2);
+
+    // TextFieldFlags
+    case MULTILINE = (1 << 13);
+    case PASSWORD = (1 << 14);
+    case FILE_SELECT = (1 << 21);
+    case DO_NOT_SPELL_CHECK = (1 << 23);
+    case DO_NOT_SCROLL = (1 << 24);
+    case COMB = (1 << 25);
+    case RICH_TEXT = (1 << 26);
+}

src/Page/Annotation/FormFieldFlagList.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace BenConda\PhpPdfium\Page\Annotation;
+
+class FormFieldFlagList
+{
+
+    /**
+     * @param int $flags
+     */
+    public function __construct(
+        public int $flags,
+    )
+    {
+    }
+
+    public function hasFlag(FormFieldFlag $flag): bool
+    {
+        return ($this->flags & $flag->value) === $flag->value;
+    }
+
+    /**
+     * @return list<FormFieldFlag>
+     */
+    public function list(): array
+    {
+        if ($this->flags === 0) {
+            return [];
+        }
+
+        $flags = [];
+        foreach (FormFieldFlag::cases() as $flag) {
+            if ($this->hasFlag($flag)) {
+                $flags[] = $flag;
+            }
+        }
+
+        return $flags;
+    }
+
+    public function withFlag(FormFieldFlag $flag): self
+    {
+        return new self($this->flags | $flag->value);
+    }
+
+    public function withoutFlag(FormFieldFlag $flag): self
+    {
+        return new self($this->flags & ~$flag->value);
+    }
+}

tests/unit/AnnotationTest.php

@@ -5,8 +5,8 @@
 namespace BenCondaTest\PhpPdfium;
 
 use BenConda\PhpPdfium\DocumentSaveFlags;
-use BenConda\PhpPdfium\Page\Annotation\Annotation;
 use BenConda\PhpPdfium\Page\Annotation\FormField;
+use BenConda\PhpPdfium\Page\Annotation\FormFieldFlag;
 use BenConda\PhpPdfium\Page\Annotation\FormFieldType;
 use BenConda\PhpPdfium\Page\PageCoordRectangle;
 use PHPUnit\Framework\TestCase;
@@ -20,9 +20,21 @@ public function testGetAnnotation(): void
         $cerfaDoc = $this->loadDocument('cerfa_13750-05');
         $firstPage = $cerfaDoc->loadPage(0);
         $annot = $firstPage->loadAnnotation(13);
-        self::assertInstanceOf(Annotation::class, $annot);
+        self::assertInstanceOf(FormField::class, $annot);
         $rect = $annot->getRectangle();
         self::assertInstanceOf(PageCoordRectangle::class, $rect);
+        $flags = $annot->getFieldFlags();
+        self::assertTrue($flags->hasFlag(FormFieldFlag::DO_NOT_SPELL_CHECK));
+        self::assertContainsOnlyInstancesOf(FormFieldFlag::class, $flags->list());
+        self::assertCount(1, $flags->list());
+
+        $newFlags = $flags->withFlag(FormFieldFlag::READ_ONLY);
+        self::assertTrue($newFlags->hasFlag(FormFieldFlag::READ_ONLY));
+        self::assertNotSame($newFlags, $flags);
+
+        $annot->setFieldFlags($newFlags);
+        $updatedFlags = $annot->getFieldFlags();
+        self::assertSame($newFlags->list(), $updatedFlags->list());
     }
 
     public function testMoveAnnotation(): void