Added the artefactchooser pieform element, smarty templates and javascript...

Added the artefactchooser pieform element, smarty templates and javascript file. Really rough first drafts.

htdocs/lib/form/elements/artefactchooser.php

+<?php
+/**
+ * This program is part of Mahara
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ *
+ * @package    mahara
+ * @subpackage form-element
+ * @author     Nigel McNie <nigel@catalyst.net.nz>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
+ * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
+ *
+ */
+
+defined('INTERNAL') || die();
+
+/**
+ * Provides a mechanism for choosing one or more artefacts from a list of them.
+ *
+ * @param Pieform  $form    The form to render the element for
+ * @param array    $element The element to render
+ * @return string           The HTML for the element
+ */
+function pieform_element_artefactchooser(Pieform $form, $element) {
+    global $USER;
+
+    $smarty = smarty_core();
+    $value = $form->get_value($element);
+
+    // internal configuration
+    $offsetname = $form->get_name() . '_' . $element['name'] . '_o';
+    $offset = param_integer($offsetname, 0);
+
+    $select = 'owner = ' . $USER->get('id');
+    if (!empty($element['artefacttypes'])) {
+        $select .= ' AND artefacttype IN(' . implode(',', array_map('db_quote', $element['artefacttypes'])) . ')';
+    }
+    $artefacts = get_records_select_array('artefact', $select, null, 'title', '*', $offset, $element['limit']);
+    $totalartefacts = count_records_select('artefact', $select);
+
+    foreach ($artefacts as &$artefact) {
+        safe_require('artefact', get_field('artefact_installed_type', 'plugin', 'name', $artefact->artefacttype));
+        $artefact->icon = call_static_method(generate_artefact_class_name($artefact->artefacttype), 'get_icon', $artefact->id);
+        $artefact->hovertitle =  ($artefact->artefacttype == 'profileicon') ? $artefact->note : $artefact->title;
+        $artefact->description = ($artefact->artefacttype == 'profileicon') ? $artefact->title : $artefact->description;
+    }
+
+    $smarty->assign('elementname', $element['name']);
+    $smarty->assign('artefacts', $artefacts);
+    $smarty->assign('count', $totalartefacts);
+    //$smarty->assign('limit', $element['limit']);
+    //$smarty->assign('offset', $offset);
+    //$smarty->assign('offsetname', $offsetname);
+    $smarty->assign('selectone', $element['selectone']);
+    $smarty->assign('value', $value);
+    $smarty->assign('datatable', $element['name'] . '_data');
+    $baseurl = View::make_base_url();
+    $pagination = build_pagination(array(
+        'id' => $element['name'] . '_pagination',
+        'url' => View::make_base_url(),
+        'count' => $totalartefacts,
+        'limit' => $element['limit'],
+        'offset' => $offset,
+        'offsetname' => $offsetname,
+        'datatable' => $element['name'] . '_data',
+        'jsonscript' => 'view/artefactchooser.json.php',
+        'firsttext' => '',
+        'previoustext' => '',
+        'nexttext' => '',
+        'lasttext' => '',
+        'numbersincludefirstlast' => false,
+    ));
+    $smarty->assign('pagination', $pagination['html']);
+
+    return $smarty->fetch('form/artefactchooser.tpl');
+}
+
+function pieform_element_artefactchooser_get_value(Pieform $form, $element) {
+    $name = $element['name'];
+
+    $global = ($form->get_property('method') == 'get') ? $_GET : $_POST;
+
+    if (isset($global[$name])) {
+        $value = $global[$name];
+
+        if ($value == '') {
+            return ($element['selectone']) ? null : array();
+        }
+
+        if (preg_match('/^(\d+(,\d+)*)$/',$value)) {
+            return ($element['selectone']) ? intval($value) : array_map('intval', explode(',', $value));
+        }
+
+        throw new PieformException("Invalid value for artefactchooser form element '$name' = '$value'");
+    }
+
+    if (isset($element['defaultvalue'])) {
+        return $element['defaultvalue'];
+    }
+
+    return null;
+}
+
+//function pieform_element_artefactchooser_rule_required(Pieform $form, $value, $element) {
+//    if (is_array($value) && count($value)) {
+//        return null;
+//    }
+//
+//    return $form->i18n('rule', 'required', 'required', $element);
+//}
+
+function pieform_element_artefactchooser_set_attributes($element) {
+    if (!isset($element['selectone'])) {
+        $element['selectone'] = true;
+    }
+    if (!isset($element['limit'])) {
+        $element['limit'] = 10;
+    }
+    return $element;
+}
+
+/*
+function pieform_element_artefactchooser_get_headdata() {
+    return array('paginator');
+}
+*/
+/**
+ * Extension by Mahara. This api function returns the javascript required to set up the element, assuming the element has been placed in the page using javascript. This feature is used in the views interface.
+ *
+ * In theory, this could go upstream to pieforms itself
+ *
+ * @param Pieform $form     The form
+ * @param array   $element  The element
+ * @param string  $key      The name of the element (might be available as $element['name'], should check that)
+ */
+function pieform_element_artefactchooser_views_js(Pieform $form, $element) {
+    log_debug('pieform_element_artefactchooser_views_js');
+    log_debug($element);
+    return 'new Paginator(' . json_encode($element['name'] . '_pagination') . ', ' . json_encode($element['name'] . '_data') . ', "view/artefactchooser.json.php");';
+}
+
+?>

htdocs/theme/default/templates/form/artefactchooser-element.tpl

+    <tr title="{$artefact->hovertitle|escape}">
+        <td style="width: 20px;">{if $selectone}<input type="radio" class="radio"id="{$elementname}_{$artefact->id}" name="{$elementname}" value="{$artefact->id|escape}"{if $value == $artefact->id} checked="checked"{/if}>{else}<input type="checkbox">{/if}</td>
+        <td style="width: 22px;"><img src="{$artefact->icon|escape}" alt="*"></td>
+        <th><label for="{$elementname}_{$artefact->id}">{if $artefact->description}{$artefact->description|escape}{else}{$artefact->title|escape}{/if}</label></th>
+    </tr>

htdocs/theme/default/templates/form/artefactchooser.tpl

+{if $artefacts}
+<table id="{$datatable}">
+    <tbody>
+{foreach from=$artefacts item=artefact}
+        <tr title="{$artefact->hovertitle|escape}">
+            <td style="width: 20px;">{if $selectone}<input type="radio" class="radio"id="{$elementname}_{$artefact->id}" name="{$elementname}" value="{$artefact->id|escape}"{if $value == $artefact->id} checked="checked"{/if}>{else}<input type="checkbox">{/if}</td>
+            <td style="width: 22px;"><img src="{$artefact->icon|escape}" alt="*"></td>
+            <th><label for="{$elementname}_{$artefact->id}">{if $artefact->description}{$artefact->description|escape}{else}{$artefact->title|escape}{/if}</label></th>
+        </tr>
+{/foreach}
+    </tbody>
+</table>
+<div class="ac-pagination">{$pagination}{* mahara_pagelinks url=$baseurl count=$count limit=$limit offset=$offset offsetname=$offsetname datatable=$datatable json_script=view/artefactchooser.json.php firsttext='' previoustext='' nexttext='' lasttext='' numbersincludefirstlast=false *}</div>
+<div class="ac-results">{$count} results</div>
+{else}
+<p>Sorry, no artefacts to choose from</p>
+{/if}

htdocs/view/artefactchooser.json.php

+<?php
+/**
+ * This program is part of Mahara
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ *
+ * @package    mahara
+ * @subpackage core
+ * @author     Nigel McNie <nigel@catalyst.net.nz>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
+ * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
+ *
+ */
+
+define('INTERNAL', 1);
+define('JSON', 1);
+require(dirname(dirname(__FILE__)) . '/init.php');
+require('view.php');
+
+// TODO how should this script work this out?
+$artefacttypes = array('image', 'profileicon'); // can be passed to the js
+$offset = param_integer('cb_2_artefactid_o', 0); // already have the id of the form so this isn't too bad
+$limit = 3; // can be passed to the js
+
+// TODO stolen from lib/form/elements/artefactchooser.php, should be in one place
+$select = 'owner = ' . $USER->get('id');
+if (!empty($artefacttypes)) {
+    $select .= ' AND artefacttype IN(' . implode(',', array_map('db_quote', $artefacttypes)) . ')';
+}
+$artefacts = get_records_select_array('artefact', $select, null, 'title', '*', $offset, $limit);
+$totalartefacts = count_records_select('artefact', $select);
+
+$result = '';
+foreach ($artefacts as &$artefact) {
+    safe_require('artefact', get_field('artefact_installed_type', 'plugin', 'name', $artefact->artefacttype));
+    $artefact->icon = call_static_method(generate_artefact_class_name($artefact->artefacttype), 'get_icon', $artefact->id);
+    $artefact->hovertitle =  ($artefact->artefacttype == 'profileicon') ? $artefact->note : $artefact->title;
+    $artefact->description = ($artefact->artefacttype == 'profileicon') ? $artefact->title : $artefact->description;
+
+    $smarty = smarty_core();
+    $smarty->assign('artefact', $artefact);
+    $result .= $smarty->fetch('form/artefactchooser-element.tpl') . "\n";
+}
+
+// How to get this??
+$pagination = build_pagination(array(
+    'id' => 'artefactid_pagination',
+    'url' => View::make_base_url(),
+    'count' => $totalartefacts,
+    'limit' => $limit,
+    'offset' => $offset,
+    'offsetname' => 'cb_2_artefactid_o',
+    'datatable' => 'artefactid_data',
+    'jsonscript' => 'view/artefactchooser.json.php',
+    'firsttext' => '',
+    'previoustext' => '',
+    'nexttext' => '',
+    'lasttext' => '',
+    'numbersincludefirstlast' => false,
+));
+
+json_reply(false, array('message' => null, 'data' => array('tablerows' => $result, 'pagination' => $pagination['html'], 'pagination_js' => $pagination['js'])));
+
+
+//$view = new View(param_integer('id'));
+//$change = param_boolean('change', false);
+//$action = param_alphanumext('action', '');
+//
+//// we actually ned to process stuff
+//if ($change) {
+//    try {
+//        $returndata = $view->process_changes();
+//        json_reply(false, $returndata);
+//    }
+//    catch (Exception $e) {
+//        json_reply(true, $e->getMessage());
+//    }
+//}
+//// else we're just reading data...
+//switch ($action) {
+//case 'blocktype_list':
+//    $category = param_alpha('c');
+//    $data = View::build_blocktype_list($category, true);
+//    json_reply(false, array('message' => false, 'data' => $data));
+//    break;
+//}
+//
+//json_reply(true, get_string('noviewcontrolaction', 'error', $action));
+
+?>