1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 |
- <?php
- /**
- * Abstract class for the transformations plugins
- */
- declare(strict_types=1);
- namespace PhpMyAdmin\Plugins;
- use stdClass;
- /**
- * Provides a common interface that will have to
- * be implemented by all of the transformations plugins.
- */
- abstract class TransformationsPlugin implements TransformationsInterface
- {
- /**
- * Does the actual work of each specific transformations plugin.
- *
- * @param array $options transformation options
- *
- * @return void
- */
- public function applyTransformationNoWrap(array $options = [])
- {
- }
- /**
- * Does the actual work of each specific transformations plugin.
- *
- * @param string $buffer text to be transformed
- * @param array $options transformation options
- * @param stdClass|null $meta meta information
- *
- * @return string the transformed text
- */
- abstract public function applyTransformation(
- $buffer,
- array $options = [],
- ?stdClass $meta = null
- );
- /**
- * Returns passed options or default values if they were not set
- *
- * @param string[] $options List of passed options
- * @param string[] $defaults List of default values
- *
- * @return array List of options possibly filled in by defaults.
- */
- public function getOptions(array $options, array $defaults)
- {
- $result = [];
- foreach ($defaults as $key => $value) {
- if (isset($options[$key]) && $options[$key] !== '') {
- $result[$key] = $options[$key];
- } else {
- $result[$key] = $value;
- }
- }
- return $result;
- }
- }
|