/**
* Return the generated form output.
* @param array $args List of parameter values passed through to the form depending on how the form has been configured.
* This array always contains a value for language.
* @param object $node The Drupal node object.
* @param array $response When this form is reloading after saving a submission, contains the response from the service call.
* Note this does not apply when redirecting (in this case the details of the saved object are in the $_GET data).
* @return Form HTML.
* @todo: Implement this method
*/
public static function get_form($args, $node, $response = null)
{
global $user;
$checks = self::check_prerequisites();
$args = self::getArgDefaults($args);
if ($checks !== true) {
return $checks;
}
iform_load_helpers(array('map_helper'));
data_entry_helper::add_resource('jquery_form');
self::$ajaxFormUrl = iform_ajaxproxy_url($node, 'location');
self::$ajaxFormSampleUrl = iform_ajaxproxy_url($node, 'sample');
$auth = data_entry_helper::get_read_write_auth($args['website_id'], $args['password']);
$typeTerms = array(empty($args['transect_type_term']) ? 'Transect' : $args['transect_type_term'], empty($args['section_type_term']) ? 'Section' : $args['section_type_term']);
$settings = array('locationTypes' => helper_base::get_termlist_terms($auth, 'indicia:location_types', $typeTerms), 'locationId' => isset($_GET['id']) ? $_GET['id'] : null, 'canEditBody' => true, 'canEditSections' => true, 'canAllocBranch' => $args['managerPermission'] == "" || user_access($args['managerPermission']), 'canAllocUser' => $args['managerPermission'] == "" || user_access($args['managerPermission']));
$settings['attributes'] = data_entry_helper::getAttributes(array('id' => $settings['locationId'], 'valuetable' => 'location_attribute_value', 'attrtable' => 'location_attribute', 'key' => 'location_id', 'fieldprefix' => 'locAttr', 'extraParams' => $auth['read'], 'survey_id' => $args['survey_id'], 'location_type_id' => $settings['locationTypes'][0]['id'], 'multiValue' => true));
$settings['section_attributes'] = data_entry_helper::getAttributes(array('valuetable' => 'location_attribute_value', 'attrtable' => 'location_attribute', 'key' => 'location_id', 'fieldprefix' => 'locAttr', 'extraParams' => $auth['read'], 'survey_id' => $args['survey_id'], 'location_type_id' => $settings['locationTypes'][1]['id'], 'multiValue' => true));
if ($args['allow_user_assignment']) {
if (false == ($settings['cmsUserAttr'] = extract_cms_user_attr($settings['attributes']))) {
return 'This form is designed to be used with the CMS User ID attribute setup for locations in the survey, or the "Allow users to be assigned to transects" option unticked.';
}
// keep a copy of the cms user ID attribute so we can use it later.
self::$cmsUserAttrId = $settings['cmsUserAttr']['attributeId'];
}
// need to check if branch allocation is active.
if ($args['branch_assignment_permission'] != '') {
if (false == ($settings['branchCmsUserAttr'] = self::extract_attr($settings['attributes'], "Branch CMS User ID"))) {
return '<br />This form is designed to be used with either<br />1) the Branch CMS User ID attribute setup for locations in the survey, or<br />2) the "Permission name for Branch Manager" option left blank.<br />';
}
// keep a copy of the branch cms user ID attribute so we can use it later.
self::$branchCmsUserAttrId = $settings['branchCmsUserAttr']['attributeId'];
}
data_entry_helper::$javascript .= "indiciaData.sections = {};\n";
$settings['sections'] = array();
$settings['numSectionsAttr'] = "";
$settings['maxSectionCount'] = $args['maxSectionCount'];
$settings['autocalcSectionLengthAttrId'] = empty($args['autocalc_section_length_attr_id']) ? 0 : $args['autocalc_section_length_attr_id'];
$settings['defaultSectionGridRef'] = empty($args['default_section_grid_ref']) ? 'parent' : $args['default_section_grid_ref'];
if ($settings['locationId']) {
data_entry_helper::load_existing_record($auth['read'], 'location', $settings['locationId']);
$settings['walks'] = data_entry_helper::get_population_data(array('table' => 'sample', 'extraParams' => $auth['read'] + array('view' => 'detail', 'location_id' => $settings['locationId'], 'deleted' => 'f'), 'nocache' => true));
// Work out permissions for this user: note that canAllocBranch setting effectively shows if a manager.
if (!$settings['canAllocBranch']) {
// Check whether I am a normal user and it is allocated to me, and also if I am a branch manager and it is allocated to me.
$settings['canEditBody'] = false;
$settings['canEditSections'] = false;
if ($args['allow_user_assignment'] && count($settings['walks']) == 0 && isset($settings['cmsUserAttr']['default']) && !empty($settings['cmsUserAttr']['default'])) {
foreach ($settings['cmsUserAttr']['default'] as $value) {
// multi value
if ($value['default'] == $user->uid) {
// comparing string against int so no triple equals
$settings['canEditBody'] = true;
$settings['canEditSections'] = true;
break;
}
}
}
// If a Branch Manager and not a main manager, then can't edit the number of sections
if ($args['branch_assignment_permission'] != '' && user_access($args['branch_assignment_permission']) && isset($settings['branchCmsUserAttr']['default']) && !empty($settings['branchCmsUserAttr']['default'])) {
foreach ($settings['branchCmsUserAttr']['default'] as $value) {
// now multi value
if ($value['default'] == $user->uid) {
// comparing string against int so no triple equals
$settings['canEditBody'] = true;
$settings['canAllocUser'] = true;
break;
}
}
}
}
// for an admin user the defaults apply, which will be can do everything.
// find the number of sections attribute.
foreach ($settings['attributes'] as $attr) {
if ($attr['caption'] === 'No. of sections') {
$settings['numSectionsAttr'] = $attr['fieldname'];
for ($i = 1; $i <= $attr['displayValue']; $i++) {
$settings['sections']["S{$i}"] = null;
}
$existingSectionCount = empty($attr['displayValue']) ? 1 : $attr['displayValue'];
data_entry_helper::$javascript .= "\$('#" . str_replace(':', '\\\\:', $attr['id']) . "').attr('min',{$existingSectionCount}).attr('max'," . $args['maxSectionCount'] . ");\n";
if (!$settings['canEditSections']) {
data_entry_helper::$javascript .= "\$('#" . str_replace(':', '\\\\:', $attr['id']) . "').attr('readonly','readonly').css('color','graytext');\n";
}
}
}
$sections = data_entry_helper::get_population_data(array('table' => 'location', 'extraParams' => $auth['read'] + array('view' => 'detail', 'parent_id' => $settings['locationId'], 'deleted' => 'f', 'orderby' => 'id'), 'nocache' => true));
foreach ($sections as $section) {
$code = $section['code'];
data_entry_helper::$javascript .= "indiciaData.sections.{$code} = {'geom':'" . $section['boundary_geom'] . "','id':'" . $section['id'] . "','sref':'" . $section['centroid_sref'] . "','system':'" . $section['centroid_sref_system'] . "'};\n";
$settings['sections'][$code] = $section;
}
} else {
// not an existing site therefore no walks. On initial save, no section data is created.
foreach ($settings['attributes'] as $attr) {
if ($attr['caption'] === 'No. of sections') {
$settings['numSectionsAttr'] = $attr['fieldname'];
data_entry_helper::$javascript .= "\$('#" . str_replace(':', '\\\\:', $attr['id']) . "').attr('min',1).attr('max'," . $args['maxSectionCount'] . ");\n";
}
}
$settings['walks'] = array();
}
if ($settings['numSectionsAttr'] === '') {
for ($i = 1; $i <= $settings['maxSectionCount']; $i++) {
$settings['sections']["S{$i}"] = null;
}
}
$r = '<div id="controls">';
$headerOptions = array('tabs' => array('#site-details' => lang::get('Site Details')));
if ($settings['locationId']) {
$headerOptions['tabs']['#your-route'] = lang::get('Your Route');
if ($args['always_show_section_details'] || count($settings['section_attributes']) > 0) {
$headerOptions['tabs']['#section-details'] = lang::get('Section Details');
}
}
if (count($headerOptions['tabs'])) {
$r .= data_entry_helper::tab_header($headerOptions);
data_entry_helper::enable_tabs(array('divId' => 'controls', 'style' => 'Tabs', 'progressBar' => isset($args['tabProgress']) && $args['tabProgress'] == true));
}
$r .= self::get_site_tab($auth, $args, $settings);
if ($settings['locationId']) {
$r .= self::get_your_route_tab($auth, $args, $settings);
if ($args['always_show_section_details'] || count($settings['section_attributes']) > 0) {
$r .= self::get_section_details_tab($auth, $args, $settings);
}
}
$r .= '</div>';
// controls
data_entry_helper::enable_validation('input-form');
if (function_exists('drupal_set_breadcrumb')) {
$breadcrumb = array();
$breadcrumb[] = l(lang::get('Home'), '<front>');
$breadcrumb[] = l(lang::get('Sites'), $args['sites_list_path']);
if ($settings['locationId']) {
$breadcrumb[] = data_entry_helper::$entity_to_load['location:name'];
} else {
$breadcrumb[] = lang::get('New Site');
}
drupal_set_breadcrumb($breadcrumb);
}
// Inform JS where to post data to for AJAX form saving
data_entry_helper::$javascript .= 'indiciaData.ajaxFormPostUrl="' . self::$ajaxFormUrl . "\";\n";
data_entry_helper::$javascript .= 'indiciaData.ajaxFormPostSampleUrl="' . self::$ajaxFormSampleUrl . "\";\n";
data_entry_helper::$javascript .= 'indiciaData.website_id="' . $args['website_id'] . "\";\n";
data_entry_helper::$javascript .= "indiciaData.indiciaSvc = '" . data_entry_helper::$base_url . "';\n";
data_entry_helper::$javascript .= "indiciaData.readAuth = {nonce: '" . $auth['read']['nonce'] . "', auth_token: '" . $auth['read']['auth_token'] . "'};\n";
data_entry_helper::$javascript .= "indiciaData.currentSection = '';\n";
data_entry_helper::$javascript .= "indiciaData.sectionTypeId = '" . $settings['locationTypes'][1]['id'] . "';\n";
data_entry_helper::$javascript .= "indiciaData.sectionDeleteConfirm = \"" . lang::get('Are you sure you wish to delete section') . "\";\n";
data_entry_helper::$javascript .= "indiciaData.sectionInsertConfirm = \"" . lang::get('Are you sure you wish to insert a new section after section') . "\";\n";
data_entry_helper::$javascript .= "indiciaData.sectionChangeConfirm = \"" . lang::get('Do you wish to save the currently unsaved changes you have made to the Section Details?') . "\";\n";
data_entry_helper::$javascript .= "indiciaData.numSectionsAttrName = \"" . $settings['numSectionsAttr'] . "\";\n";
data_entry_helper::$javascript .= "indiciaData.maxSectionCount = \"" . $settings['maxSectionCount'] . "\";\n";
data_entry_helper::$javascript .= "indiciaData.autocalcSectionLengthAttrId = " . $settings['autocalcSectionLengthAttrId'] . ";\n";
data_entry_helper::$javascript .= "indiciaData.defaultSectionGridRef = '" . $settings['defaultSectionGridRef'] . "';\n";
if ($settings['locationId']) {
data_entry_helper::$javascript .= "selectSection('S1', true);\n";
}
return $r;
}
