public/propresenter7-php-lib
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
propresenter7-php-lib/doc/internal/decisions.md
Thorsten Buss 4d10db4f17 Initial public release 
PHP 8.4 library and CLI tools to read, modify, and generate ProPresenter 7
files: songs (.pro), playlists (.proplaylist), bundles (.probundle), themes,
and the global library files (Macros, Labels, Groups, ClearGroups, CCLI,
Messages, Timers, Stage, Workspace, Props, TestPatterns, Calendar,
KeyMappings, CommunicationDevices).

Built on the MIT-licensed ProPresenter7-Proto schema by greyshirtguy
(v7.16.2). Includes 18 CLI parsers, comprehensive API docs in doc/,
binary-format specs, and a synthetic 369-test PHPUnit suite covering
RTF extraction, translation slides, ZIP64 repair, round-trip fidelity,
and end-to-end generation.
2026-05-03 22:21:01 +02:00

1.2 KiB
Raw Blame History

Architectural Decisions

Decisions Made

Proto Version Choice

  • Decision: Use greyshirtguy/ProPresenter7-Proto v7.16.2
  • Reason: Field numbers match Test.pro raw decode perfectly
  • Source: Metis analysis + typed decode validation in T2

RTF Handling

  • Getters: Plain text only (via RtfExtractor)
  • Internal: Raw RTF preserved for round-trip integrity
  • Write: Template-clone approach (preserve formatting, swap text only)

Scope Boundaries

  • IN: Read+write existing content, parse all reference files

  • OUT: Creating new slides/groups from scratch, Laravel integration, playlist formats

  • 2026-03-01 task-2 autoload decision: added GPBMetadata\ => generated/GPBMetadata/ to composer.json so generated Rv\Data classes can initialize descriptor metadata at runtime.

  • 2026-03-01 task-2 ZIP64 repair strategy: patch archive headers in-memory only (no recompression), applying deterministic EOCD/ZIP64 size corrections before any ZipArchive access.

  • 2026-03-01 21:23:59 - ProPlaylist integration tests use temp files via tempnam() tracked in class state and cleaned in tearDown() to guarantee cleanup across all test methods.