pdfinject

README

pdfinject-go

Inject Value into Adobe PDF Form with GoLang. You can create FDF Data with values to fill in the PDF Form you create from Adobe Acrobat Pro DC.

This library is support for text field, radio button, check box and also support for pdf overlay on pdf function

Inspiration from : https://github.com/desertbit/fillpdf

Usage:

Define you form with pdfinject.Form (type map[string]interface{})

input your source file name replace in "sample.pdf" and define your output file name replace in "filled.pdf"

form := pdfinject.Form{
		"location": "Hello",
		"function": "World",
		"reason": "Kim",
		"headcountAddition": "Yes",
		"directors.0": "Yo",
		"kazekim_checkbox": "Yes",
	}

	pdfInject := pdfinject.New()
	err := pdfInject.FillWithDestFile(form, "sample.pdf", "filled.pdf")
	if err != nil {
		panic(err)
	}

You can see example in sample directory

Documentation

Index

• type FDFGenerator
  • func NewFDFGenerator(dir, prefix string) (*FDFGenerator, error)
  • func (t *FDFGenerator) CreateFDFFile(form Form) (string, error)
  • func (t *FDFGenerator) GetTempOutputFile() string
  • func (t *FDFGenerator) Remove()
• type Form
• type InputType
• type PDFInject
  • func New() PDFInject
  • func NewWithDestFile(destPDFFile string) PDFInject
  • func (pdf PDFInject) Fill(form Form, formPDFFile string) (*string, error)
  • func (pdf PDFInject) FillModel(model interface{}, formPDFFile string) (*string, error)
  • func (pdf PDFInject) FillModelWithDestFile(model interface{}, formPDFFile string, destPDFFile string) (*string, error)
  • func (pdf PDFInject) FillWithDestFile(form Form, formPDFFile, destPDFFile string) (*string, error)
  • func (pdf PDFInject) SetInputType(in InputType)
  • func (pdf PDFInject) SetOverWrite(canOverwrited bool)
  • func (pdf PDFInject) Stamp(stampPDFFile, srcPDFFile string) error
  • func (pdf PDFInject) StampWithDestFile(stampPDFFile, srcPDFFile, destPDFFile string) error
• type ShellCommand
  • func NewShellCommand(name string) ShellCommand
  • func (s *ShellCommand) RunInPath(dir string, args ...string) error
• type TempFile
  • func NewTempFile(dir, prefix string) (*TempFile, error)
  • func (t *TempFile) GetTempOutputFilePath() string
  • func (t *TempFile) Remove()
• type XFDFGenerator
  • func NewXFDFGenerator(dir, prefix string) (*XFDFGenerator, error)
  • func (t *XFDFGenerator) CreateXFDFFile(form Form) (string, error)
  • func (t *XFDFGenerator) GetTempOutputFile() string
  • func (t *XFDFGenerator) Remove()

Types

type FDFGenerator

type FDFGenerator struct {
	// contains filtered or unexported fields
}

TempPDFDir manage PDF Inject process

func NewFDFGenerator

func NewFDFGenerator(dir, prefix string) (*FDFGenerator, error)

NewFDFGenerator Create a FDF Generator.

func (*FDFGenerator) CreateFDFFile

func (t *FDFGenerator) CreateFDFFile(form Form) (string, error)

CreateFDFFile Create a temporary fdf file

func (*FDFGenerator) GetTempOutputFile

func (t *FDFGenerator) GetTempOutputFile() string

GetTempOutputFile get temp output file for pdf

func (*FDFGenerator) Remove

func (t *FDFGenerator) Remove()

Remove delete temp directory when finish process

type Form

type Form map[string]interface{}

Form represents fields from the PDF form. define in key value map.

type InputType

type InputType int

const (
	XFDF InputType = 0
	FDF            = 1
)

type PDFInject

type PDFInject struct {
	// contains filtered or unexported fields
}

func New

func New() PDFInject

func NewWithDestFile

func NewWithDestFile(destPDFFile string) PDFInject

func (PDFInject) Fill

func (pdf PDFInject) Fill(form Form, formPDFFile string) (*string, error)

func (PDFInject) FillModel

func (pdf PDFInject) FillModel(model interface{}, formPDFFile string) (*string, error)

func (PDFInject) FillModelWithDestFile

func (pdf PDFInject) FillModelWithDestFile(model interface{}, formPDFFile string, destPDFFile string) (*string, error)

func (PDFInject) FillWithDestFile

func (pdf PDFInject) FillWithDestFile(form Form, formPDFFile, destPDFFile string) (*string, error)

func (PDFInject) SetInputType

func (pdf PDFInject) SetInputType(in InputType)

func (PDFInject) SetOverWrite

func (pdf PDFInject) SetOverWrite(canOverwrited bool)

SetOverWrite allow overWrite to Destination file

func (PDFInject) Stamp

func (pdf PDFInject) Stamp(stampPDFFile, srcPDFFile string) error

func (PDFInject) StampWithDestFile

func (pdf PDFInject) StampWithDestFile(stampPDFFile, srcPDFFile, destPDFFile string) error

type ShellCommand

type ShellCommand struct {
	// contains filtered or unexported fields
}

func NewShellCommand

func NewShellCommand(name string) ShellCommand

func (*ShellCommand) RunInPath

func (s *ShellCommand) RunInPath(dir string, args ...string) error

runCommandInPath runs a command and waits for it to exit. The working directory is also set. The stderr error message is returned on error.

type TempFile

type TempFile struct {
	// contains filtered or unexported fields
}

func NewTempFile

func NewTempFile(dir, prefix string) (*TempFile, error)

NewTempFile Create a FDF Generator.

func (*TempFile) GetTempOutputFilePath

func (t *TempFile) GetTempOutputFilePath() string

GetTempOutputFilePath Get a temporary output file path

func (*TempFile) Remove

func (t *TempFile) Remove()

Remove delete temp directory when finish process

type XFDFGenerator

type XFDFGenerator struct {
	// contains filtered or unexported fields
}

TempPDFDir manage PDF Inject process

func NewXFDFGenerator

func NewXFDFGenerator(dir, prefix string) (*XFDFGenerator, error)

NewXFDFGenerator Create a XFDF Generator.

func (*XFDFGenerator) CreateXFDFFile

func (t *XFDFGenerator) CreateXFDFFile(form Form) (string, error)

CreateXFDFFile Create a temporary fdf file

func (*XFDFGenerator) GetTempOutputFile

func (t *XFDFGenerator) GetTempOutputFile() string

GetTempOutputFile get temp output file for pdf

func (*XFDFGenerator) Remove

func (t *XFDFGenerator) Remove()

Remove all temp file when finish process