1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 
<?php
namespace Omeka\Module;

use Omeka\Api\ResourceInterface;

/**
 * A module registered in the module manager.
 */
class Module implements ResourceInterface
{
    /** @var string */
    protected $id;

    /** @var string */
    protected $state;

    /** @var array */
    protected $ini;

    /** @var array */
    protected $db;

    /**
     * Construct the module.
     *
     * @param string $id The module identifier, the directory name
     */
    public function __construct($id)
    {
        $this->id = $id;
    }

    /**
     * Get the module identifier.
     *
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Set the module state.
     *
     * @param string $state
     */
    public function setState($state)
    {
        $this->state = $state;
    }

    /**
     * Get the module state.
     *
     * @return string
     */
    public function getState()
    {
        return $this->state;
    }

    /**
     * Set the module INI data.
     *
     * @param array $ini
     */
    public function setIni($ini)
    {
        $this->ini = $ini;
    }

    /**
     * Get the module INI data, the entire array or by key.
     *
     * @param string $key
     * @return array|string|null
     */
    public function getIni($key = null)
    {
        if ($key) {
            return isset($this->ini[$key]) ? $this->ini[$key] : null;
        }
        return $this->ini;
    }

    /**
     * Set the module database data.
     *
     * @param array $db
     */
    public function setDb($db)
    {
        $this->db = $db;
    }

    /**
     * Get the module database data, the entire array or by key.
     *
     * @param string $key
     * @return array|string|null
     */
    public function getDb($key = null)
    {
        if ($key) {
            return isset($this->db[$key]) ? $this->db[$key] : null;
        }
        return $this->db;
    }

    /**
     * Check whether this module is configurable
     *
     * @return bool
     */
    public function isConfigurable()
    {
        return (bool) $this->getIni('configurable');
    }

    /**
     * Get the name of this module.
     *
     * @return string|null
     */
    public function getName()
    {
        if ($name = $this->getIni('name')) {
            return $name;
        }
        if ($name = $this->getDb('id')) {
            return $name;
        }
        if ($name = $this->getId()) {
            return $name;
        }
        // Could not find a name.
        return null;
    }
}