README

Shared data models, contracts, and enums for the OpenCAT Framework.

Every other OpenCAT package depends on this one. It contains no business logic — only the shapes that the rest of the framework passes around.

Installation

composer require opencat/core

Requires ext-intl and ext-mbstring.

What's inside

Models

Contracts (interfaces)

Enums

Exceptions

Each domain has its own exception class extending \RuntimeException:

FilterException · MtException · SegmentationException · TerminologyException · TmException

Working with Segment

A Segment holds an ordered mix of plain strings and InlineCode objects:

use CatFramework\Core\Model\Segment;
use CatFramework\Core\Model\InlineCode;
use CatFramework\Core\Enum\InlineCodeType;

$bold = new InlineCode('b1', InlineCodeType::OPENING, '<strong>');
$boldClose = new InlineCode('b1', InlineCodeType::CLOSING, '</strong>');

$segment = new Segment('seg-1', [
    'Hello ',
    $bold,
    'world',
    $boldClose,
    '!',
]);

$segment->getPlainText();    // "Hello world!"
$segment->isEmpty();         // false
$segment->getInlineCodes();  // [$bold, $boldClose]

Working with BilingualDocument

use CatFramework\Core\Model\BilingualDocument;
use CatFramework\Core\Model\SegmentPair;
use CatFramework\Core\Enum\SegmentStatus;

$doc = new BilingualDocument(
    sourceLanguage: 'en-US',
    targetLanguage: 'fr-FR',
    originalFile: 'report.docx',
    mimeType: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
);

foreach ($doc->getSegmentPairs() as $pair) {
    echo $pair->source->getPlainText();  // source text
    echo $pair->status->name;           // SegmentStatus enum name
    echo $pair->isLocked ? 'locked' : 'editable';
}

Implementing a custom file filter

use CatFramework\Core\Contract\FileFilterInterface;
use CatFramework\Core\Model\BilingualDocument;
use CatFramework\Core\Exception\FilterException;

class MyFilter implements FileFilterInterface
{
    public function supports(string $filePath, ?string $mimeType = null): bool
    {
        return str_ends_with(strtolower($filePath), '.myext');
    }

    public function extract(string $filePath, string $sourceLanguage, string $targetLanguage): BilingualDocument
    {
        // parse $filePath, create and return a BilingualDocument
    }

    public function rebuild(BilingualDocument $document, string $outputPath): void
    {
        // use $document->skeleton to reconstruct the file
    }

    public function getSupportedExtensions(): array
    {
        return ['.myext'];
    }
}

Related packages

• opencat/segmentation — sentence segmentation using SegmentationEngineInterface
• opencat/translation-memory — TM using TranslationMemoryInterface
• opencat/mt — machine translation using MachineTranslationInterface
• opencat/qa — QA checks using QualityCheckInterface
• opencat/workflow — wires all of the above into one call