AmFormsPlugin.php

<?php
/**
 * Forms for Craft.
 *
 * @package   Am Forms
 * @author    Hubert Prein
 */
namespace Craft;

class AmFormsPlugin extends BasePlugin
{
    /**
     * @return null|string
     */
    public function getName()
    {
        if (craft()->plugins->getPlugin('amforms')) {
            $pluginName = craft()->amForms_settings->getSettingsByHandleAndType('pluginName', AmFormsModel::SettingGeneral);
            if ($pluginName && $pluginName->value) {
                return $pluginName->value;
            }
        }
        return Craft::t('a&m forms');
    }

    /**
     * @return string
     */
    public function getVersion()
    {
        return '1.2.8';
    }

    /**
     * @return string
     */
    public function getDeveloper()
    {
        return 'a&m impact';
    }

    /**
     * @return string
     */
    public function getDeveloperUrl()
    {
        return 'http://www.am-impact.nl';
    }

    /**
     * @return string
     */
    public function getSettingsUrl()
    {
        return 'amforms/settings';
    }

    /**
     * @return Model
     */
    public function getSettings()
    {
        $settings = craft()->amForms_settings->getAllSettings();
        $settings = array_map(function (AmForms_SettingModel $settings) {
            return  $settings->value;
        }, $settings);

        $settingsModel = new Model($settings);
        $settingsModel->setAttributes($settings);

        return $settingsModel;
    }

    /**
     * @inheritDoc
     *
     * @param array|BaseModel $values
     *
     * @return null
     */
    public function setSettings($values)
    {
        if ($values) {
            if ($values instanceof BaseModel) {
                $values = $values->attributes;
            }

            // Get all available settings for this type
            $availableSettings = craft()->amForms_settings->getAllSettings();

            // Save each available setting
            foreach ($availableSettings as $setting) {
                // Find new settings
                if (array_key_exists($setting->handle, $values)) {
                    $setting->value = $values[$setting->handle];
                    craft()->amForms_settings->saveSettings($setting);
                }
            }
        }
    }

    /**
     * @inheritdoc
     * @param array $values
     * @return Model
     */
    public function prepSettings($values)
    {
        $settingsModel = new Model($values);
        $settingsModel->setAttributes($values);
        return $settingsModel;
    }

    /**
     * Plugin has control panel section.
     *
     * @return boolean
     */
    public function hasCpSection()
    {
        return true;
    }

    /**
     * Plugin has Control Panel routes.
     *
     * @return array
     */
    public function registerCpRoutes()
    {
        return array(
            'amforms/forms' => array(
                'action' => 'amForms/forms/index'
            ),
            'amforms/forms/new' => array(
                'action' => 'amForms/forms/editForm'
            ),
            'amforms/forms/edit/(?P<formId>\d+)' => array(
                'action' => 'amForms/forms/editForm'
            ),

            'amforms/submissions' => array(
                'action' => 'amForms/submissions/index'
            ),
            'amforms/submissions/edit/(?P<submissionId>\d+)' => array(
                'action' => 'amForms/submissions/editSubmission'
            ),

            'amforms/submissions/edit/(?P<submissionId>\d+)/notes' => array(
                'action' => 'amForms/notes/displayNotes'
            ),

            'amforms/fields' => array(
                'action' => 'amForms/fields/index'
            ),
            'amforms/fields/new' => array(
                'action' => 'amForms/fields/editField'
            ),
            'amforms/fields/edit/(?P<fieldId>\d+)' => array(
                'action' => 'amForms/fields/editField'
            ),

            'amforms/exports' => array(
                'action' => 'amForms/exports/index'
            ),
            'amforms/exports/new' => array(
                'action' => 'amForms/exports/editExport'
            ),
            'amforms/exports/edit/(?P<exportId>\d+)' => array(
                'action' => 'amForms/exports/editExport'
            ),

            'amforms/settings' => array(
                'action' => 'amForms/settings/index'
            ),
            'amforms/settings/exports' => array(
                'action' => 'amForms/settings/exports'
            ),
            'amforms/settings/antispam' => array(
                'action' => 'amForms/settings/antispam'
            ),
            'amforms/settings/recaptcha' => array(
                'action' => 'amForms/settings/recaptcha'
            ),
            'amforms/settings/templates' => array(
                'action' => 'amForms/settings/templates'
            )
        );
    }

    /**
     * Plugin has user permissions.
     *
     * @return array
     */
    public function registerUserPermissions()
    {
        return array(
            'accessAmFormsExports' => array(
                'label' => Craft::t('Access to exports')
            ),
            'accessAmFormsFields' => array(
                'label' => Craft::t('Access to fields')
            ),
            'accessAmFormsForms' => array(
                'label' => Craft::t('Access to forms')
            ),
            'accessAmFormsSettings' => array(
                'label' => Craft::t('Access to settings')
            )
        );
    }

    /**
     * Install essential information after installing the plugin.
     */
    public function onAfterInstall()
    {
        craft()->amForms_install->install();
    }

    /**
     * Uninstall information that is no longer required.
     */
    public function onBeforeUninstall()
    {
        // Override Craft's default context and content
        craft()->content->fieldContext = AmFormsModel::FieldContext;
        craft()->content->contentTable = AmFormsModel::FieldContent;

        // Delete our own context fields
        $fields = craft()->fields->getAllFields('id', AmFormsModel::FieldContext);
        foreach ($fields as $field) {
            craft()->fields->deleteField($field);
        }

        // Delete content table
        craft()->db->createCommand()->dropTable('amforms_content');
    }

    /**
     * Register migration service for Schematic plugin.
     *
     * @return array
     */
    public function registerMigrationService()
    {
        return array(
            'amforms' => craft()->amForms_schematic,
        );
    }
}