chrico / wp-fields Goto Github PK

The Problem

In many cases, the documentation mentions method names that are incorrect.

Possible Cause

At first, the library was written using WP code standards, and the names used to be e.g. set_field(). Later, the library got re-factored to use a more modern standard, where the names are e.g. withField(); but the documentation was not updated.

Suggested Solution

Update the documentation to reflect the new names.

I noticed that hidden fields are treated like normal visible fields, so they are put within a table row when the form get rendered.

This has the disadvantage to introduce extra vertical space in the form where apparently there's nothing but the field exists, it's just hidden.

Wouldn't be ok to extract the hidden fields when the form is rendered and move them as direct childs of the form markup instead of within a table row?

The Problem

Method names such as ElementInterface#withAttribute() return the same instance. This makes them nothing more than a setter. However, a setter would be named e.g. setAttribute(). Names such as withAttribute() may mislead the consumer to think that it would return a new instance. Alas, they are simply mutable, and mutability is a bad thing most of the time.

The problem is further enhanced by the fact that these methods do not declare what they return.

Suggested Solution

Have the methods return a new instance every time, and declare the return type everywhere, including the interface. Example:

class Element implements
    ElementInterface,
    LabelAwareInterface,
    ErrorAwareInterface,
    DescriptionAwareInterface
{
  	// ...
	
	/**
	 * Creates a new element with the specified attribute value.
	 *
     * @param string $key The attribute key.
     * @param bool|int|string $value The attribute value/
     *
     * @return Element The new element which has the given value of the specified attribute.
     */
    public function withAttribute(string $key, $value): ElementInterface
    {
		$element = clone $this;
        $element->attributes[$key] = $value;

        return $element;
    }

  	// ...
}