fieldwork\components\Checkbox

Complexity

Total Complexity

11

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	6
Bugs	1	Features	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	2
A	getClasses()	0	6	1
A	setChecked()	0	4	2
A	isChecked()	0	4	1
A	getAttributes()	0	10	2
A	getHTML()	0	5	2
A	getRestoreDefault()	0	5	1

<?php

namespace fieldwork\components;

class Checkbox extends Field
{

    const CHECKED = 'checked';

    const ON = 'on';

    /**
     * Constructs a new checkbox
     *
     * @param string $slug
     * @param string $label   The string to display next to the checkbox
     * @param bool   $checked Whether the checkbox should be checked initially. Defaults to false
     * @param int    $storeValueLocally
     */
    public function __construct ($slug, $label, $checked = false, $storeValueLocally = 0)
    {
        parent::__construct($slug, $label, $checked ? self::ON : '', $storeValueLocally);
    }

    public function getClasses ()
    {
        return array_merge(
            parent::getClasses(), array('checkbox')
        );
    }

    /**
     * Set the "checked" state of this box
     * @param bool $checked
     */
    public function setChecked ($checked = true)
    {
        $this->value = $checked ? self::ON : '';
    }

    /**
     * Is the checkbox checked in its current state?
     * @return bool
     */
    public function isChecked ()
    {
        return $this->value === self::ON;
    }

    public function getAttributes ()
    {
        $attrs = array(
            'type'  => 'checkbox',
            'value' => self::ON
        );
        if ($this->isChecked())
            $attrs[self::CHECKED] = self::CHECKED;
        return array_merge(parent::getAttributes(), $attrs);
    }

    public function getHTML ($showLabel = true)
    {
        $label = $showLabel ? "<label for=\"" . $this->getId() . "\">" . $this->label . "</label>" : "";
        return "<div class=\"checkbox-wrapper\"><input " . $this->getAttributesString() . ">" . $label . "</div>";
    }

    protected function getRestoreDefault ()
    {
        return '';
        // override this so that the checkbox is not read as "checked" when the post var is not sent along
    }
}