Documentation

TagComparator
in package

This class is responsible for comparing tags to see if they should be kept together, or kept apart.

Tags
author

Graham Campbell graham@alt-three.com

final

Table of Contents

$groups  : array<string|int, mixed>
Groups of tags that should be allowed to immediately follow each other.
shouldBeTogether()  : bool
Should the given tags be kept together, or kept apart?

Properties

$groups

Groups of tags that should be allowed to immediately follow each other.

private static array<string|int, mixed> $groups = [['deprecated', 'link', 'see', 'since'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write']]

Methods

shouldBeTogether()

Should the given tags be kept together, or kept apart?

public static shouldBeTogether(Tag $first, Tag $second) : bool
Parameters
$first : Tag
$second : Tag
Return values
bool

Search results