Matecat\SubFiltering\Commons\Pipeline

Complexity

Total Complexity

26

Size/Duplication

Total Lines	272
Duplicated Lines	0 %

Test Coverage

Coverage

94.03%

Importance

Changes	1
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getSource()	0	2	1
A	resetId()	0	2	1
A	getNextId()	0	4	1
A	realignIDs()	0	10	3
A	addLast()	0	5	1
A	addAfter()	0	10	3
A	transform()	0	7	2
A	__construct()	0	4	1
A	_register()	0	5	1
A	getTarget()	0	2	1
A	addFirst()	0	5	1
A	contains()	0	3	1
A	setSegmentContainsHtml()	0	2	1
A	remove()	0	10	3
A	addBefore()	0	10	3
A	getDataRefMap()	0	2	1
A	segmentContainsHtml()	0	2	1

<?php
/**
 * Created by PhpStorm.
 * @author domenico domenico@translated.net / ostico@gmail.com
 * Date: 05/11/18
 * Time: 14.05
 *
 */

namespace Matecat\SubFiltering\Commons;

use Matecat\SubFiltering\Enum\ConstantEnum;

/**
 * Class Pipeline
 *
 * Orchestrates a sequence of handler objects for segment transformation,
 * manages handler order, tracks transformation state, and realigns segment IDs.
 *
 * @package Matecat\SubFiltering\Commons
 */
class Pipeline {

    /**
     * Registered handler instances that make up the processing pipeline.
     *
     * @var AbstractHandler[]
     */
    protected array $handlers;

    /**
     * Tracks the current segment/internal ID number for realignment.
     *
     * @var int
     */
    protected int $id_number = -1;

    /**
     * The optional source string the Pipeline operates on.
     *
     * @var string|null
     */
    protected ?string $source;

    /**
     * The optional target string the Pipeline operates on.
     *
     * @var string|null
     */
    protected ?string $target;

    /**
     * A key/value map used for reference during segment processing.
     *
     * @var array
     */
    protected array $dataRefMap;

    /**
     * True if the processed segment contains HTML markup.
     *
     * @var bool
     */
    private bool $segmentContainsHtml = false;

    /**
     * Constructor.
     *
     * @param string|null $source     The source segment, if available.
     * @param string|null $target     The target segment, if available.
     * @param array       $dataRefMap Optional reference map relevant to the segment.
     */
    public function __construct( ?string $source = null, ?string $target = null, array $dataRefMap = [] ) {
        $this->source     = $source;
        $this->target     = $target;
        $this->dataRefMap = $dataRefMap;
    }

    /**
     * Gets and increments the next unique internal identifier for segment elements.
     *
     * @return string The generated identifier.
     */
    public function getNextId(): string {
        $this->id_number++;

        return ConstantEnum::INTERNAL_ATTR_ID_PREFIX . $this->id_number;
    }

    /**
     * Resets the internal identifier counter to its default before a new transformation.
     *
     * @return void
     */
    public function resetId(): void {
        $this->id_number = -1;
    }

    /**
     * Indicates whether the current segment contains HTML code.
     *
     * @return bool True if the segment contains HTML, otherwise false.
     */
    public function segmentContainsHtml(): bool {
        return $this->segmentContainsHtml;
    }

    /**
     * Sets the segmentContainsHtml flag for the current segment.
     *
     * @return void
     */
    public function setSegmentContainsHtml() {
        $this->segmentContainsHtml = true;
    }

    /**
     * Returns the configured source segment.
     *
     * @return string|null Source segment or null if not set.
     */
    public function getSource(): ?string {
        return $this->source;
    }

    /**
     * Returns the configured target segment.
     *
     * @return string|null Target segment or null if not set.
     */
    public function getTarget(): ?string {
        return $this->target;
    }

    /**
     * Returns the mapping array provided to the pipeline for external reference.
     *
     * @return array The data reference map.
     */
    public function getDataRefMap(): array {
        return $this->dataRefMap;
    }

    /**
     * Checks if a handler of the specified class is already registered in the pipeline.
     *
     * @param class-string<AbstractHandler> $handlerClass The handler

The doc comment class-string<AbstractHandler> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<AbstractHandler>.

     */
    public function contains( string $handlerClass ): bool {
        return !empty( array_filter( $this->handlers, function ( $handler ) use ( $handlerClass ) {
            return $handlerClass == $handler->getName();
        } ) );
    }

    /**
     * Prepends a handler instance to the beginning of the pipeline.
     *
     * @param class-string<AbstractHandler> $handler Class name (FQN) of the handler to add.

The doc comment class-string<AbstractHandler> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<AbstractHandler>.

     *
     * @return $this This pipeline instance (for method chaining).
     */
    public function addFirst( string $handler ): Pipeline {
        $handlerInstance = $this->_register( $handler );
        array_unshift( $this->handlers, $handlerInstance );

        return $this;
    }

    /**
     * Inserts a handler into the pipeline before another specified handler.
     *
     * @param class-string<AbstractHandler> $before      Class name (FQN) of the handler before which the new handler will be inserted.

The doc comment class-string<AbstractHandler> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<AbstractHandler>.

     * @param class-string<AbstractHandler> $newPipeline Class name (FQN) of the new handler to insert.
     *
     * @return $this This pipeline instance (for method chaining).
     */
    public function addBefore( string $before, string $newPipeline ): Pipeline {
        $newPipelineHandler = $this->_register( $newPipeline );
        foreach ( $this->handlers as $pos => $handler ) {
            if ( $handler->getName() == $before ) {
                array_splice( $this->handlers, $pos, 0, [ $newPipelineHandler ] );
                break;
            }
        }

        return $this;

    }

    /**
     * Inserts a handler into the pipeline after another specified handler.
     *
     * @param class-string<AbstractHandler> $after       Class name (FQN) of the handler after which the new handler will be inserted.

The doc comment class-string<AbstractHandler> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<AbstractHandler>.

     * @param class-string<AbstractHandler> $newPipeline Class name (FQN) of the new handler to insert.
     *
     * @return $this This pipeline instance (for method chaining).
     */
    public function addAfter( string $after, string $newPipeline ): Pipeline {
        $newPipelineHandler = $this->_register( $newPipeline );
        foreach ( $this->handlers as $pos => $handler ) {
            if ( $handler->getName() == $after ) {
                array_splice( $this->handlers, $pos + 1, 0, [ $newPipelineHandler ] );
                break;
            }
        }

        return $this;

    }

    /**
     * Removes the specified handler class from the pipeline.
     *
     * @param class-string<AbstractHandler> $handlerToDelete Handler class name (FQN) to remove.

The doc comment class-string<AbstractHandler> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<AbstractHandler>.

     *
     * @return $this This pipeline instance (for method chaining).
     */
    public function remove( string $handlerToDelete ): Pipeline {
        foreach ( $this->handlers as $pos => $handler ) {
            if ( $handler->getName() == $handlerToDelete ) {
                unset( $this->handlers[ $pos ] );
                $this->handlers = array_values( $this->handlers );
                break;
            }
        }

        return $this;
    }

    /**
     * Appends a handler instance to the end of the pipeline.
     *
     * @param class-string<AbstractHandler> $handler Class name (FQN) of the handler to add.

The doc comment class-string<AbstractHandler> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<AbstractHandler>.

     *
     * @return $this This pipeline instance (for method chaining).
     */
    public function addLast( string $handler ): Pipeline {
        $newHandler       = $this->_register( $handler );
        $this->handlers[] = $newHandler;

        return $this;
    }

    /**
     * Transforms the provided segment by sequentially applying all registered handlers
     * and realigns IDs afterward.
     *
     * @param string $segment The input segment string to process.
     *
     * @return string The processed segment after all transformations.
     */
    public function transform( string $segment ): string {
        $this->id_number = -1;
        foreach ( $this->handlers as $handler ) {
            $segment = $handler->transform( $segment );
        }

        return $this->realignIDs( $segment );
    }

    /**
     * Adjusts and realigns ID tags in the provided segment string,
     * so IDs are sequential and formatted as required.
     *
     * @param string $segment The input string containing ID tags to realign.
     *
     * @return string The string with realigned and updated ID tags.
     */
    protected function realignIDs( string $segment ): string {
        if ( $this->id_number > -1 ) {
            preg_match_all( '/"__mtc_[0-9]+"/', $segment, $html, PREG_SET_ORDER );
            foreach ( $html as $pos => $tag_id ) {
                //replace subsequent elements excluding already encoded
                $segment = preg_replace( '/' . $tag_id[ 0 ] . '/', '"mtc_' . ( $pos + 1 ) . '"', $segment, 1 );
            }
        }

        return $segment;
    }

    /**
     * Instantiates a handler by class name and registers this pipeline with it.
     *
     * @template T of AbstractHandler
     * @param class-string<T> $handler Handler class name to instantiate.

The doc comment class-string<T> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T>.

     *
     * @return T An instantiated handler object with the pipeline set.
     */
    protected function _register( string $handler ): AbstractHandler {
        $handler = new $handler();
        $handler->setPipeline( $this );

        return $handler;
    }

}