mgdschema.php

<?php
/**
 * @package midgardmvc_helper_forms
 * @author The Midgard Project, http://www.midgard-project.org
 * @copyright The Midgard Project, http://www.midgard-project.org
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */
class midgardmvc_helper_forms_mgdschema
{
    private static $i18n_prefix = '';
    private static $i18n_tip_prefix = 'tip_';
    private static $reflectionproperties = array();

    public static function create(midgard_object $object, $include_metadata = true, $i18n_prefix = '', $i18n_tip_prefix = '')
    {
        self::$i18n_prefix = $i18n_prefix;
        self::$i18n_tip_prefix = $i18n_tip_prefix;

        $form_namespace = get_class($object);
        if ($object->guid)
        {
            $form_namespace = $object->guid;
        }

        $form = midgardmvc_helper_forms::create($form_namespace);
        self::object_to_form($object, $form, $include_metadata);
        return $form;
    }

    public static function object_to_form($object, midgardmvc_helper_forms_group $form, $include_metadata = true)
    {
        // Get the mvc instance for fetching i18n strings
        $mvc = midgardmvc_core::get_instance();

        // Go through object properties
        $props = get_object_vars($object);
        foreach ($props as $property => $value)
        {
            if (   $property == 'metadata'
                && !$include_metadata)
            {
                continue;
            }
            self::property_to_form(get_class($object), $property, $value, $form, null, $mvc->i18n->get(self::$i18n_prefix . $property), $mvc->i18n->get(self::$i18n_tip_prefix . $property));
        }
    }

    public static function property_to_form($class, $property, $value, midgardmvc_helper_forms_group $form, $fieldname = null, $label = null, $tip = null)
    {
        if (is_null($label))
        {
            $label = $propery;
        }

        if (is_null($fieldname))
        {
            $fieldname = $property;
        }

        if (!isset(self::$reflectionproperties[$class]))
        {
            self::$reflectionproperties[$class] = new midgard_reflection_property($class);
        }

        if (   $property == 'action'
            || $property == 'guid'
            || $property == 'id')
        {
            // TODO: Make the list of properties to not render configurable
            return;
        }

        if ($property == 'metadata')
        {
            // Metadata is to be handled as a group
            $metadata = $form->add_group($fieldname);
            $metadata->set_label('metadata');
            self::object_to_form($value, $metadata);
            return;
        }

        $required = false;
        if (self::$reflectionproperties[$class]->get_user_value($property, 'required') == 'true')
        {
            $required = true;
        }

        $type = self::$reflectionproperties[$class]->get_midgard_type($property);
        $field = null;
        switch ($type)
        {
            case MGD_TYPE_STRING:
                $field = $form->add_field($fieldname, 'html', $required);
                $field->set_value($value);
                $field->set_inline(true);
                $widget = $field->set_widget('text');
                $widget->set_label($label);
                $widget->set_title($tip);
                $widget->set_placeholder(self::$reflectionproperties[$class]->description($property));
                // TODO: maxlength to 255
                break;
            case MGD_TYPE_LONGTEXT:
                if (self::$reflectionproperties[$class]->get_user_value($property, 'contenttype') == 'html')
                {
                    $field = $form->add_field($fieldname, 'html', $required);
                    $widget = $field->set_widget('html');
                }
                else
                {
                    $field = $form->add_field($fieldname, 'text', $required);
                    $widget = $field->set_widget('textarea');
                }
                $field->set_value($value);
                $widget->set_label($label);
                $widget->set_title($tip);
                $widget->set_placeholder(self::$reflectionproperties[$class]->description($property));
                break;
            case MGD_TYPE_INT:
                $field = $form->add_field($fieldname, 'integer', $required);
                $field->set_value($value);
                $widget = $field->set_widget('number');
                $widget->set_label($label);
                $widget->set_title($tip);
                $widget->set_placeholder(self::$reflectionproperties[$class]->description($property));
                break;
            case MGD_TYPE_UINT:
                $field = $form->add_field($fieldname, 'integer', $required);
                $field->set_value($value);
                // TODO: Set minimum value to 0
                $widget = $field->set_widget('number');
                $widget->set_label($label);
                $widget->set_title($tip);
                $widget->set_placeholder(self::$reflectionproperties[$class]->description($property));
                break;
            case MGD_TYPE_BOOLEAN:
                $field = $form->add_field($fieldname, 'boolean', $required);
                $field->set_value($value);
                $widget = $field->set_widget('checkbox');
                $widget->set_label($label);
                $widget->set_title($tip);
                $widget->set_placeholder(self::$reflectionproperties[$class]->description($property));
                break;
            case MGD_TYPE_FLOAT:
                $field = $form->add_field($fieldname, 'float', $required);
                $field->set_value($value);
                $widget = $field->set_widget('number');
                $widget->set_label($label);
                $widget->set_title($tip);
                $widget->set_placeholder(self::$reflectionproperties[$class]->description($property));
                break;
            case MGD_TYPE_TIMESTAMP:
                $field = $form->add_field($fieldname, 'datetime', $required);
                $field->set_value($value);
                $widget = $field->set_widget('datetime');
                $widget->set_label($label);
                $widget->set_title($tip);
                $widget->set_placeholder(self::$reflectionproperties[$class]->description($property));
            case MGD_TYPE_GUID:
                break;
        }

        if (   $class == 'midgard_metadata'
            && !is_null($field))
        {
            // Handle read-only metadata properties
            switch ($property)
            {
                case 'approved':
                case 'approver':
                case 'created':
                case 'creator':
                case 'deleted':
                case 'exported':
                case 'imported':
                case 'isapproved':
                case 'islocked':
                case 'locked':
                case 'locker':
                case 'revised':
                case 'revision':
                case 'revisor':
                case 'size':
                    $field->set_readonly(true);
                    break;
            }
        }
    }

    public static function form_to_object(midgardmvc_helper_forms_group $form, $object)
    {
        // Go through form items and fill the object
        $items = $form->items;
        foreach ($items as $key => $item)
        {
            if (!property_exists($object, $key))
            {
                // The object has no such property
                continue;
            }

            if (   $item instanceof midgardmvc_helper_forms_group
                && $key == 'metadata')
            {
                self::form_to_object($item, $object->metadata);
                continue;
            }

            $object->$key = $item->get_value();
        }
    }
}