MOASElementsPlugin

Complexity

Total Complexity

16

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	7
Bugs	0	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	hookInstall()	0	5	1
A	hookUninstall()	0	11	2
A	hookUninstallMessage()	0	6	1
A	hookUpgrade()	0	13	2
A	_updateElements()	0	19	3
A	_updateElementSet()	0	9	1
B	_reorderElements()	0	30	4
A	_getElementSet()	0	5	1

<?php

/**
 * @package     omeka
 * @subpackage  moas-elements
 * @copyright   2015 University of Nottingham
 * @license     MIT
 * @author      Adam Cooper <adam.cooper@nottingham.ac.uk>
 */

class MOASElementsPlugin extends Omeka_Plugin_AbstractPlugin
{
    protected $_hooks = array(
        'install',
        'uninstall',
        'uninstall_message',
        'upgrade'
    );

    private $_elements;
    private $_elementSetMetadata;

    public function __construct()
    {
        parent::__construct();

        // Get the data
        include 'elements.php';
        $this->_elements = $elements;
        $this->_elementSetMetadata = $elementSetMetadata;
    }

    /**
     * Install the plugin.
     */
    public function hookInstall()
    {
        insert_element_set($this->_elementSetMetadata, $this->_elements);
        $this->_reorderElements();
    }

    /**
     * Uninstall the plugin.
     */
    public function hookUninstall()
    {
        /** @var Table_ElementSet $elementSetTable */
        $elementSetTable = $this->_db->getTable('ElementSet');

        // deleting ElementSet also deletes any attached elements.
        $est = $elementSetTable->findByName($this->_elementSetMetadata['name']);
        if ($est !== null) {
            $est->delete();
        }
    }

    /**
     * Display the uninstall message.
     */
    public function hookUninstallMessage()
    {
        echo __('%sWarning%s: This will remove all the %s elements added '
            . 'by this plugin and permanently delete all element texts entered in those '
            . 'fields.%s', '<p><strong>', '</strong>', $this->_elementSetMetadata['name'], '</p>');
    }

    public function hookUpgrade($oldVersion, $newVersion)
    {
        switch($oldVersion)
        {
            // let the plugin cascade its upgrades
            case '1.0.0':
                // code to upgrade from 1.0.0 to 1.1.0
            default :
                $this->_updateElementSet();
                $this->_updateElements();
                $this->_reorderElements();
        }
    }

    /**
     * Adds any elements that have been defined but are not present on the site.
     */
    private function _updateElements($remove = false)
    {
        $elementSet = $this->_getElementSet();
        $elements = $elementSet->getElements();

        // walk the MOAS element array and add where needed.
        array_walk($this->_elements, function($element, $index) use (&$elementSet, $elements) {
            foreach ($elements as $dbElement) {
                if ($element['name'] === $dbElement->name) {
                    return;
                }
            }

            // if we get here it means we didn't find this element in the database.
            $elementSet->addElements(array($index => $element));
        });

        $elementSet->save();
    }

    /**
     * Updates the element set information - record type and description only
     */
    private function _updateElementSet()
    {
        $elementSet = $this->_getElementSet();

        $elementSet->record_type = $this->_elementSetMetadata['record_type'];
        $elementSet->description = $this->_elementSetMetadata['description'];

        $elementSet->save();
    }


    /**
     * Updates the elements ordering within the element set
     */
    private function _reorderElements()
    {
        $elementSet = $this->_getElementSet();

        $this->_db->beginTransaction();

        try {
            // Remove the existing element ordering
            $this->_db->update(
                $this->_db->Element,
                array('order' => null),
                array('element_set_id = ?' => $elementSet->id)
            );

            $elements = $elementSet->getElements();
            // walk the MOAS element array and add where needed.
            array_walk($this->_elements, function ($element) use ($elements) {
                /** @var Element $dbElement */
                foreach ($elements as $dbElement) {
                    if ($element['name'] === $dbElement->name) {
                        $dbElement->setOrder($element['order']);
                        $dbElement->save();
                    }
                }
            });
            $this->_db->commit();
        } catch (Exception $e) {
            $this->_db->rollBack();
        }
    }

    /**
     * Get the MOAS element set
     *
     * @return ElementSet
     */
    private function _getElementSet()
    {
        $elementSetTable = $this->_db->getTable('ElementSet');
        return $elementSetTable->findByName($this->_elementSetMetadata['name']);
    }
}