code.php

<?php
/**
 * @package    Joomla.Component.Builder
 *
 * @created    4th September, 2022
 * @author     Llewellyn van der Merwe <https://dev.vdm.io>
 * @git        Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
 * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace VDM\Joomla\Componentbuilder\Search\Engine;


use VDM\Joomla\Componentbuilder\Search\Config;
use VDM\Joomla\Componentbuilder\Search\Interfaces\SearchTypeInterface;
use VDM\Joomla\Componentbuilder\Search\Abstraction\Engine;


/**
 * Search Type Regex
 * 
 * @since 3.2.0
 */
class Regex extends Engine implements SearchTypeInterface
{
	/**
	 * Regex Search Value
	 *
	 * @var    string
	 * @since  3.2.0
	 */
	protected string $regexValue = '';

	/**
	 * Constructor
	 *
	 * @param Config|null    $config    The search config object.
	 *
	 * @since 3.2.0
	 */
	public function __construct(?Config $config = null)
	{
		parent::__construct($config);
		$this->compileRegex();
	}

	/**
	 * Search inside a string
	 *
	 * @param   string    $value   The string value
	 *
	 * @return  string|null    The marked string if found, else null
	 * @since   3.2.0
	 */
	public function string(string $value): ?string
	{
		// we count every line
		$this->lineCounter();

		if (empty($this->searchValue) || !$this->match($value))
		{
			return null;
		}

		$result = preg_replace(
			$this->regexValue,
			$this->start . '$1' . $this->end,
			$value
		);

		return is_string($result) ? trim($result) : null;
	}

	/**
	 * Replace found instances inside string value
	 *
	 * @param   string     $value      The string value to update
	 *
	 * @return  string      The updated string
	 * @since   3.2.0
	 */
	public function replace(string $value): string
	{
		if (empty($this->searchValue) || !$this->match($value))
		{
			return $value;
		}

		$result = preg_replace(
			$this->regexValue,
			(string) $this->replaceValue,
			$value
		);

		return is_string($result) ? $result : $value;
	}

	/**
	 * Math the Regular Expression
	 *
	 * @param   string    $value  The string value
	 *
	 * @return  bool  true if match is found
	 * @since   3.0.9
	 */
	public function match(string $value): bool
	{
		return !empty($this->searchValue) && preg_match($this->regexValue, $value) === 1;
	}

	/**
	 * Compile regex pattern
	 *
	 * @return void
	 * @since  5.1.1
	 */
	protected function compileRegex(): void
	{
		if (empty($this->searchValue))
		{
			$this->regexValue = '//';
			return;
		}

		$flags = $this->matchCase === 1 ? 'm' : 'mi';
		$pattern = (string) $this->searchValue;
		$this->regexValue = "/($pattern)/$flags";
	}
}