Skip to content

v3.0.0-rc v1 Shim Removal & Project Plan Update

Pre-release
Pre-release

Choose a tag to compare

@rbraunm rbraunm released this 29 Jun 23:02

First release candidate for 3.0.0. This release removes the deprecated v1 compatibility shim: the global procedural surface (dicom_tag, dicom_convert, dicom_net, and the is_dcm / Execute helpers) that the 2.x line carried so existing v1 code could keep running unchanged. The namespaced object API (DICOM\*, PACS\*) introduced in 2.0 is now the only surface.

Nothing else changes for the namespaced API. The library still wraps the DCMTK command-line toolkit, still targets PHP 8.5, and is still Apache-2.0. If you are already on the 2.x namespaced API, there is nothing to do.

Breaking change

The v1 global API is gone. Code still calling it will fail to autoload. The removed symbols and their namespaced replacements:

Removed (v1) Use instead
dicom_tag DICOM\File (open plus typed accessors) or DICOM\Dataset (raw group/element)
dicom_convert DICOM\Convert (JPEG, thumbnail, JPEG/PDF import, multiframe video) and DICOM\Compress
dicom_net PACS\EchoSCU, PACS\SCU, PACS\SCP (with Peer, Association, TransferSyntaxProposal)
is_dcm() DICOM\File::isDICOM()
Execute() removed; it was an internal toolkit-invocation helper with no public replacement

The examples/ directory shows the current API for every operation.

Installing the pre-release

Composer treats this as a pre-release, so stable installs will not pick it up. To try it:

composer require "rbraunm/class_dicom:^3.0@RC"

Existing ^2.0 consumers are unaffected and will not be upgraded automatically.

Unchanged

  • PHP 8.5 and a DCMTK install remain the only runtime requirements.
  • The DICOM\* and PACS\* API and its behavior are identical to 2.0.0.
  • License stays Apache-2.0; provenance is recorded in NOTICE.

Status

This is a release candidate. The namespaced API is unchanged from 2.0.0, so the surface area of this release is just the shim removal. Barring a blocker, it ships as the final 3.0.0 after a soak period. Please report anything that breaks against the RC.

Full history is in the CHANGELOG; the complete diff from the last stable is v2.0.0...v3.0.0-RC1.