Add getSegmentsByClass

[jay-knight]

This introduces a function that allows you to call:

$message->getSegmentsByClass(PID::class);

instead of

$message->getSegmentsByName("PID");

just to give a little more safety. I wanted to keep this very simple to see if this approach was seen as useful. But I could see functions like

function getFirstPIDSegmentInstance(): PID

That specifies a specific segment type as the return type, so that you could then call

$pid = $message->getFirstPIDSegmentInstance();
if (!is_null($pid)) {
    $race = $pid->getRace();
}

Because currently static analyzers like phpstan will complain that Segment doesn't have a function getRace().

Let me know if this you think this is useful and/or a good direction, and I can update docs.

[senaranya]

This is definitely useful. Thank you for the PR. Please go ahead and update the docs

[senaranya]

Rename $class to $segmentClass

[senaranya]

Rename $seg to the full word $segment

[jay-knight]

Thanks, @senaranya. I've now added:

• Message::getSegmentsByClass()
• Message::removeSegmentsByClass()
• MessasgeHelpersTrait::hasSegmentOfClass()
• MessasgeHelpersTrait::getFirstSegmentInstanceByClass()

I've made the suggested changes and ran phpdoc-md.

[senaranya]

Thanks for the changes, although it looks like the documentation changes are too big (probably because those weren't updated in the earlier PRs), and thus the actual diff for this is kind of lost in the noise. Let's revert those documentation changes please, unless you've added anything in the Readme file. We'll run phpdoc-md in a separate ticket. Also check if the Action (CI pipeline) failures are anything relevant

[jay-knight]

@senaranya I've reverted the documentation update and I've fixed the ci errors.