xref: /plugin/combo/ComboStrap/Spacing.php (revision 04fd306c7c155fa133ebb3669986875d65988276)

<?php


namespace ComboStrap;


class Spacing
{
    const SPACING_ATTRIBUTE = "spacing";

    /**
     * Process the attributes that have an impact on the class
     * @param TagAttributes $attributes
     */
    public static function processSpacingAttributes(&$attributes)
    {

        // Spacing is just a class
        $spacing = self::SPACING_ATTRIBUTE;
        if ($attributes->hasComponentAttribute($spacing)) {

            $spacingValue = $attributes->getValueAndRemove($spacing);

            /**
             * Applying a padding on svg is not really recommended
             * because it makes the icon invisble
             */
            $logicalTag = $attributes->getLogicalTag();
            if ($logicalTag == SvgImageLink::CANONICAL) {
                if (StringUtility::startWiths($spacingValue, "p")) {
                    LogUtility::msg("We didn't apply the padding value ($spacingValue) on your svg or icon because it will make the icon invisible. Apply a margin or apply the spacing to the container component.", LogUtility::LVL_MSG_WARNING, SvgImageLink::CANONICAL);
                    return;
                }
            }
            if ($logicalTag == \syntax_plugin_combo_cell::TAG) {
                if (StringUtility::startWiths($spacingValue, "m")) {
                    $expectedValue = "p" . substr($spacingValue, 1);
                    LogUtility::msg("We didn't apply the margin value ($spacingValue) on your column because it will make the last column in the grid to go to the line. Apply the following padding instead ($expectedValue)", LogUtility::LVL_MSG_WARNING, GridTag::CANONICAL);
                    $spacingValue = $expectedValue;
                }
            }

            $spacingNames = preg_split("/\s/", $spacingValue);
            $bootstrapVersion = Bootstrap::getBootStrapMajorVersion();
            foreach ($spacingNames as $spacingClass) {
                if ($bootstrapVersion == Bootstrap::BootStrapFiveMajorVersion) {

                    // The sides r and l has been renamed to e and s
                    // https://getbootstrap.com/docs/5.0/migration/#utilities-2
                    //

                    // https://getbootstrap.com/docs/5.0/utilities/spacing/
                    // By default, we consider tha there is no size and breakpoint
                    $sizeAndBreakPoint = "";
                    $propertyAndSide = $spacingClass;

                    $minusCharacter = "-";
                    $minusLocation = strpos($spacingClass, $minusCharacter);
                    if ($minusLocation !== false) {
                        // There is no size or break point
                        $sizeAndBreakPoint = substr($spacingClass, $minusLocation + 1);
                        $propertyAndSide = substr($spacingClass, 0, $minusLocation);
                    }
                    $propertyAndSide = str_replace("r", "e", $propertyAndSide);
                    $propertyAndSide = str_replace("l", "s", $propertyAndSide);
                    if ($sizeAndBreakPoint === "") {
                        $spacingClass = $propertyAndSide;
                    } else {
                        $spacingClass = $propertyAndSide . $minusCharacter . $sizeAndBreakPoint;
                    }

                }
                $attributes->addClassName($spacingClass);
            }
        }

    }
}