PHP equivalent to jQuery addClass

Question

How would you add a class named newClass to an opening tag like <a class='abc'> or <p style=display:block> using php?

For an existing file that you're parsing with PHP, or a file that you're generating using PHP? — deceze, May 19 '11 at 09:01
So, you're *not* parsing an existing file? Then the usual way is to just write `class="newClass"` where it's supposed to appear... Can you perhaps clarify your situation? — deceze, May 19 '11 at 09:22
My function generates a diff between two HTML codes. Modified strings are wrapped by a new span but modified existing elements should get an additional class. — jantimon, May 19 '11 at 09:23
@Ghommey I would really recommend to use DOM* functionality for this. If you can give a more detailed example, we'll surely can help you better. — Yoshi, May 19 '11 at 09:26
The reason for my function is similar to this so thread: http://stackoverflow.com/questions/31722/anyone-have-a-diff-algorithm-for-rendered-html — jantimon, May 19 '11 at 09:29

Yoshi · Accepted Answer · 2011-05-19T09:51:24.003

Regexp example:

<?php
function addClass($htmlString = '', $newClass) {
    $pattern = '/class="([^"]*)"/';

    // class attribute set
    if (preg_match($pattern, $htmlString, $matches)) {
        $definedClasses = explode(' ', $matches[1]);
        if (!in_array($newClass, $definedClasses)) {
            $definedClasses[] = $newClass;
            $htmlString = str_replace($matches[0], sprintf('class="%s"', implode(' ', $definedClasses)), $htmlString);
        }
    }

    // class attribute not set
    else {
        $htmlString = preg_replace('/(\<.+\s)/', sprintf('$1class="%s" ', $newClass), $htmlString);
    }

    return $htmlString;
}

echo addClass('<a class="abc">', 'newClass');
echo addClass('<p style=display:block>', 'newClass');

using http://php.net/manual/en/book.dom.php example

<?php
function addClass($node = null, $className) {
    $result = false;

    if (is_string($node)) {
        $dom = DOMDocument::loadXml($node);
        if ($dom instanceof DOMDocument) {
            $definedClasses = explode(' ', $dom->documentElement->getAttribute('class'));
            if (!in_array($className, $definedClasses)) {
                $dom->documentElement->setAttribute(
                    'class', $dom->documentElement->getAttribute('class') . ' ' . $className
                );
            }

            $result = $dom->saveXml($dom->documentElement, true);
        }
    }
    elseif ($node instanceof DOMElement) {
        // this code repetition, could of course be avoided using some more sophisticated structures 
        $definedClasses = explode(' ', $node->getAttribute('class'));
        if (!in_array($className, $definedClasses)) {
            $node->setAttribute('class', $node->getAttribute('class') . ' ' . $className);
        }

        $result = $node;
    }

    return $result;
}

// using a string as input
echo addClass('<a class="abc"></a>', 'newClass');

// using a DOMElement as input
$dom = DOMDocument::loadHtml('<div><a id="something"></a></div>');
$xpath = new DOMXPath($dom);

$node = $xpath->query('//*[@id="something"]')->item(0);
if ($node instanceof DOMElement) {
    addClass($node, 'newClass');
    echo $dom->saveXml($node, true);
}

I'm purposely not using loadHTML (inside the function) to prevent having to dive down into the autogenerated html structure to find the actual given $htmlString. This of course implies that $htmlString has to be well-formed.

Good answer, of course if the OP was doing it truly jQuery-esque, the method could be very easily modified to accept a DOMElement object directly, too. — Rudi Visser, May 19 '11 at 09:10
@rudi_visser You're right. And it would probably a lot more reusable. I'll change it ;) — Yoshi, May 19 '11 at 09:12
Is the closing tag required or does this also work `echo addClass('', 'newClass');` ? — jantimon, May 19 '11 at 09:20
It's trying to parse XML so I'd hope not :-) Surely jQuery won't allow you to do that either? — Rudi Visser, May 19 '11 at 09:21
@Ghommey I'm would not recomment that, as your previous comment suggests, you're doing quite a bit of dom manipulation. Maybe you're better of using dom for this to? — Yoshi, May 19 '11 at 09:37
I am using a diff algorithm that returns a string array and I can't change that. — jantimon, May 19 '11 at 09:41

score 2 · Answer 2 · answered May 19 '11 at 09:54

2

Html class from Nette Framework does a perfect work for generating HTML tags in PHP.

answered May 19 '11 at 09:54

Ondřej Mirtes

5,054
25
36

PHP equivalent to jQuery addClass

2 Answers2

Linked