From 4db9603285b406b4e400a4f1323cecc086fbac88 Mon Sep 17 00:00:00 2001 From: Will Hall Date: Thu, 10 Dec 2015 15:34:50 +0000 Subject: [PATCH] Fix coding standard errors in core of module --- sheetnode.install | 29 ++++--- sheetnode.module | 238 +++++++++++++++++++++++++++++++----------------------- 2 files changed, 157 insertions(+), 110 deletions(-) diff --git a/sheetnode.install b/sheetnode.install index d0fa591..8e6de2b 100644 --- a/sheetnode.install +++ b/sheetnode.install @@ -1,5 +1,4 @@ array('vid'), 'unique keys' => array( - 'nid_vid' => array('nid', 'vid'), + 'nid_vid' => array('nid', 'vid'), ), 'foreign keys' => array( 'node_revision' => array( - 'table' => 'node_revision', + 'table' => 'node_revision', 'columns' => array('vid' => 'vid'), - ), + ), 'node' => array( - 'table' => 'node', + 'table' => 'node', 'columns' => array('nid' => 'nid'), ), - ), + ), ); $schema['sheetnode_template'] = array( 'description' => 'The table for sheetnode templates.', @@ -55,7 +54,7 @@ function sheetnode_schema_7001() { 'description' => 'The primary identifier for the template.', 'type' => 'serial', 'unsigned' => TRUE, - 'not null' => TRUE + 'not null' => TRUE, ), 'name' => array( 'type' => 'varchar', @@ -84,14 +83,17 @@ function sheetnode_schema_7001() { ), 'foreign keys' => array( 'node_revision' => array( - 'table' => 'node_revision', + 'table' => 'node_revision', 'columns' => array('vid' => 'vid'), - ), + ), ), ); return $schema; } +/** + * Schema function. + */ function sheetnode_schema_7003() { $schema = sheetnode_schema_7001(); $schema['sheetnode_view'] = array( @@ -139,6 +141,9 @@ function sheetnode_field_schema($field) { return sheetnode_field_schema_7002($field); } +/** + * Schema function. + */ function sheetnode_field_schema_7001($field) { $columns = array( 'value' => array( @@ -155,6 +160,9 @@ function sheetnode_field_schema_7001($field) { ); } +/** + * Schema function. + */ function sheetnode_field_schema_7002($field) { $columns = array( 'value' => array( @@ -182,6 +190,7 @@ function sheetnode_field_schema_7002($field) { /** * Implements hook_update_N(). + * * Add 'name' field to sheetfields. */ function sheetnode_update_7002(&$sandbox) { @@ -204,10 +213,10 @@ function sheetnode_update_7002(&$sandbox) { /** * Implements hook_update_N(). + * * Add 'sheetnode_view' table. */ function sheetnode_update_7003(&$sandbox) { $schema = sheetnode_schema_7003(); db_create_table('sheetnode_view', $schema['sheetnode_view']); } - diff --git a/sheetnode.module b/sheetnode.module index 7ba14d2..3c25052 100644 --- a/sheetnode.module +++ b/sheetnode.module @@ -1,5 +1,4 @@ vid; - $nodes[$node->nid]->sheetnode = array('nid' => $node->nid, 'vid' => $node->vid, 'value' => NULL); + $nodes[$node->nid]->sheetnode = array( + 'nid' => $node->nid, + 'vid' => $node->vid, + 'value' => NULL, + ); + } + if (empty($vids)) { + return; } - if (empty($vids)) return; $sheetnodes = db_query("SELECT * FROM {sheetnode} WHERE vid IN (:vids)", array(':vids' => $vids)); foreach ($sheetnodes as $sheetnode) { - $nodes[$sheetnode->nid]->sheetnode = (array)$sheetnode; + $nodes[$sheetnode->nid]->sheetnode = (array) $sheetnode; } } @@ -95,10 +102,10 @@ function sheetnode_view($node, $view_mode) { // SocialCalc sheet. if ($view_mode == 'full') { $output = _sheetnode_inject( - drupal_clean_css_identifier('sheetnode-' . $node->nid), + drupal_clean_css_identifier('sheetnode-' . $node->nid), 'sheetnode', - $node->sheetnode['value'], - FALSE, + $node->sheetnode['value'], + FALSE, array('entity-type' => 'node', 'oid' => $node->nid) ); $node->content['sheetnode'] = array('#markup' => $output, '#weight' => -1); @@ -136,30 +143,31 @@ function sheetnode_form($node, &$form_state) { // Generate the default title. $form = node_content_form(!empty($node) ? $node : 'sheetnode', $form_state); - + // SocialCalc sheet. if (!empty($form_state['input']['sheetnode']['value'])) { $value = $form_state['input']['sheetnode']['value']; $nid = @$node->nid; } - else if (!empty($node->nid)) { + elseif (!empty($node->nid)) { $value = $node->sheetnode['value']; $nid = $node->nid; } - else if (!empty($node->clone_from_original_nid)) { // support node_clone.module + elseif (!empty($node->clone_from_original_nid)) { + // Support node_clone module. $original_node = node_load($node->clone_from_original_nid); $value = $original_node->sheetnode['value']; $nid = $node->clone_from_original_nid; - } + } else { $value = ''; $nid = NULL; } $output = _sheetnode_inject( - drupal_clean_css_identifier('sheetnode-' . (empty($node->nid) ? 'new' : $node->nid)), + drupal_clean_css_identifier('sheetnode-' . (empty($node->nid) ? 'new' : $node->nid)), 'sheetnode', - $value, - drupal_clean_css_identifier('edit-sheetnode-value'), + $value, + drupal_clean_css_identifier('edit-sheetnode-value'), array('entity-type' => 'node', 'oid' => $nid) ); $form['sheetnode'] = array( @@ -189,12 +197,12 @@ function sheetnode_validate($node, $form, &$form_state) { $errors = form_get_errors(); if (!empty($errors)) { _sheetnode_inject( - drupal_clean_css_identifier('sheetnode-' . (empty($form['nid']['#value']) ? 'new' : $form['nid']['#value'])), + drupal_clean_css_identifier('sheetnode-' . (empty($form['nid']['#value']) ? 'new' : $form['nid']['#value'])), 'sheetnode', - $form['sheetnode']['value']['#value'], - drupal_clean_css_identifier('edit-sheetnode-value'), + $form['sheetnode']['value']['#value'], + drupal_clean_css_identifier('edit-sheetnode-value'), array('entity-type' => 'node', 'oid' => $form['nid']['#value']) - ); + ); } } @@ -220,23 +228,26 @@ function _sheetnode_inject($sheet_id, $sheet_aliases, $value, $save_element, $co module_invoke_all('sheetnode_plugins', $value, $save_element, $context); // Lower-case sheet aliases. - $sheet_aliases = array_map('strtolower', (array)$sheet_aliases); + $sheet_aliases = array_map('strtolower', (array) $sheet_aliases); static $sheets = NULL; if (!isset($sheets[$sheet_id])) { - drupal_add_js(array('sheetnode' => array($sheet_id => array( - 'aliases' => $sheet_aliases, - 'value' => $value, - 'imagePrefix' => base_path() . $path . '/images/sc-', - 'containerElement' => $sheet_id, - 'saveElement' => $save_element, - 'viewMode' => variable_get('sheetnode_view_mode', SHEETNODE_VIEW_FIDDLE), - 'showToolbar' => variable_get('sheetnode_view_toolbar', FALSE), - 'permissions' => array( - 'edit sheetnode settings' => user_access('edit sheetnode settings'), - ), - 'context' => $context, - ))), 'setting'); + drupal_add_js(array( + 'sheetnode' => array( + $sheet_id => array( + 'aliases' => $sheet_aliases, + 'value' => $value, + 'imagePrefix' => base_path() . $path . '/images/sc-', + 'containerElement' => $sheet_id, + 'saveElement' => $save_element, + 'viewMode' => variable_get('sheetnode_view_mode', SHEETNODE_VIEW_FIDDLE), + 'showToolbar' => variable_get('sheetnode_view_toolbar', FALSE), + 'permissions' => array( + 'edit sheetnode settings' => user_access('edit sheetnode settings'), + ), + 'context' => $context, + ), + )), 'setting'); $sheets[$sheet_id] = TRUE; } return '
'; @@ -261,8 +272,8 @@ function sheetnode_update($node) { if (!empty($node->sheetnode['value'])) { _sheetnode_save($node->nid, $node->vid, $node->sheetnode['value']); } - else if (!empty($node->revision)) { - // reverting a revision + elseif (!empty($node->revision)) { + // Reverting a revision. $value = db_query("SELECT value FROM {sheetnode} WHERE vid = :old", array(':old' => $node->old_vid))->fetchField(); db_insert('sheetnode') ->fields(array( @@ -314,15 +325,18 @@ function _sheetnode_update_index($value) { $socialcalc = socialcalc_parse($value); $sc = $socialcalc['sheet']; $row = -1; - if (!empty($sc['cells'])) foreach ($sc['cells'] as $c) { - if ($c['pos'][1] > $row) { // new row? - this assumes cells are ordered by col/row - if ($row != -1) { - $output .= ''; + if (!empty($sc['cells'])) { + foreach ($sc['cells'] as $c) { + if ($c['pos'][1] > $row) { + // New row? - this assumes cells are ordered by col/row. + if ($row != -1) { + $output .= ''; + } + $row = $c['pos'][1]; + $output .= ''; } - $row = $c['pos'][1]; - $output .= ''; + $output .= '' . (isset($c['datavalue']) ? $c['datavalue'] : ' ') . (isset($c['comment']) ? ' (' . check_plain($c['comment']) . ')' : '') . ''; } - $output .= ''. (isset($c['datavalue']) ? $c['datavalue'] : ' ') . (isset($c['comment']) ? ' ('. check_plain($c['comment']) .')' : '') .''; } if ($row != -1) { $output .= ''; @@ -430,7 +444,7 @@ function sheetnode_tokens_alter(array &$replacements, array $context) { */ function sheetnode_menu() { $items = array(); - + $items['sheetnode/load'] = array( 'type' => MENU_CALLBACK, 'page callback' => '_sheetnode_ajax_load', @@ -471,8 +485,8 @@ function sheetnode_menu() { } define('SHEETNODE_VIEW_READONLY', 0); -define('SHEETNODE_VIEW_FIDDLE', 1); -define('SHEETNODE_VIEW_HTML', 2); +define('SHEETNODE_VIEW_FIDDLE', 1); +define('SHEETNODE_VIEW_HTML', 2); /** * Form function for admin/settings/sheetnode. @@ -516,7 +530,7 @@ function sheetnode_import_template($form, &$form_state, $tid = NULL) { '#type' => 'select', '#title' => t('Template'), '#description' => t('Please select the template to load into your new sheetnode.'), - '#options' => $options, + '#options' => $options, '#default_value' => 0, ); $form['submit'] = array( @@ -599,7 +613,9 @@ function sheetnode_theme($existing, $type, $theme, $path) { function theme_sheetnode_range($variables) { $range = $variables['range']; $labels = $variables['labels']; - if (empty($range)) return ''; + if (empty($range)) { + return ''; + } require_once(drupal_get_path('module', 'sheetnode') . '/socialcalc.inc'); list($c, $r) = socialcalc_coord_to_cr(key($range)); $row = array(); @@ -641,7 +657,7 @@ function sheetnode_field_extra_fields() { 'label' => t('Spreadsheet'), 'description' => t('Spreadsheet control'), 'weight' => -1, - ) + ), ), 'display' => array( 'sheetnode' => array( @@ -676,17 +692,19 @@ function sheetnode_field_info() { */ function sheetnode_node_validate($node, $form, &$form_state) { $errors = form_get_errors(); - if (!empty($errors) && !empty($form_state['field'])) foreach ($form_state['field'] as $field_name => $field) { - if ($field[LANGUAGE_NONE]['field']['type'] == 'sheetfield' && !empty($form_state['input'][$field_name])) { - foreach ($form_state['input'][$field_name][LANGUAGE_NONE] as $delta => $item) { - $element_id = drupal_clean_css_identifier('edit-' . $field_name . '-' . LANGUAGE_NONE . '-' . $delta); - $output = _sheetnode_inject( - drupal_clean_css_identifier('sheetfield-' . $element_id), - _sheetnode_sheetfield_aliases($field_name, $field[LANGUAGE_NONE]['instance']['label'], $item, $delta), - $item['value'], - $element_id, - array('entity-type' => 'node', 'oid' => @$node->nid) - ); + if (!empty($errors) && !empty($form_state['field'])) { + foreach ($form_state['field'] as $field_name => $field) { + if ($field[LANGUAGE_NONE]['field']['type'] == 'sheetfield' && !empty($form_state['input'][$field_name])) { + foreach ($form_state['input'][$field_name][LANGUAGE_NONE] as $delta => $item) { + $element_id = drupal_clean_css_identifier('edit-' . $field_name . '-' . LANGUAGE_NONE . '-' . $delta); + $output = _sheetnode_inject( + drupal_clean_css_identifier('sheetfield-' . $element_id), + _sheetnode_sheetfield_aliases($field_name, $field[LANGUAGE_NONE]['instance']['label'], $item, $delta), + $item['value'], + $element_id, + array('entity-type' => 'node', 'oid' => @$node->nid) + ); + } } } } @@ -696,7 +714,9 @@ function sheetnode_node_validate($node, $form, &$form_state) { * Implements hook_field_is_empty(). */ function sheetnode_field_is_empty($item, $field) { - if (empty($item['value'])) return TRUE; + if (empty($item['value'])) { + return TRUE; + } require_once(drupal_get_path('module', 'sheetnode') . '/socialcalc.inc'); $sc = socialcalc_parse($item['value']); return empty($sc['sheet']['cells']); @@ -734,7 +754,7 @@ function _sheetnode_devel_generate($object, $field, $instance, $bundle) { ); $sc['sheet']['cells'][] = array( 'pos' => array(2, $row), - 'datavalue' => _sheetnode_lcg_randf(-100, 100), + 'datavalue' => _sheetnode_lcg_randf(-100, 100), 'datatype' => 'v', 'valuetype' => 'n', ); @@ -786,12 +806,13 @@ function sheetnode_field_formatter_view($entity_type, $entity, $field, $instance drupal_clean_css_identifier('sheetfield-' . $field['field_name'] . '-' . $langcode . '-' . $delta), _sheetnode_sheetfield_aliases($field['field_name'], $instance['label'], $item, $delta), $item['value'], - FALSE, + FALSE, isset($entity) && $entity == 'node' ? array('entity-type' => $entity_type, 'oid' => @$entity->nid) : NULL ); $element[$delta] = array('#markup' => $output); } break; + case 'socialcalc_date': require_once(drupal_get_path('module', 'sheetnode') . '/socialcalc.inc'); foreach ($items as $delta => $item) { @@ -811,7 +832,7 @@ function sheetnode_field_formatter_view($entity_type, $entity, $field, $instance return $element; } -/** +/** * Implements hook_field_widget_info(). */ function sheetnode_field_widget_info() { @@ -845,10 +866,13 @@ function sheetnode_field_widget_form(&$form, &$form_state, $field, $instance, $l '#title' => t('Title'), '#default_value' => @$defaults['name'], ); - $widget['value'] = array('#type' => 'hidden', '#attributes' => array('id' => $element_id), '#prefix' => $output); + $widget['value'] = array( + '#type' => 'hidden', + '#attributes' => array('id' => $element_id), '#prefix' => $output), + ); break; } - + return $widget; } @@ -868,7 +892,7 @@ function sheetnode_form_alter(&$form, $form_state, $form_id) { '#type' => 'select', '#title' => t('Template'), '#description' => t('The template to load into your new sheetfield. This setting will override the sheet above but will be overridden by the PHP code below, if any.'), - '#options' => $options, + '#options' => $options, '#default_value' => variable_get('sheetfield_template_' . $form['#field']['field_name'], 0), '#weight' => 1, ); @@ -884,7 +908,7 @@ function _sheetnode_field_ui_field_edit_form_submit($form, &$form_state) { $template = _sheetnode_template_load($form_state['values']['sheetfield_template']); if (!empty($template)) { // WARNING: LANGUAGE_NONE is an assumption. - $form_state['values'][ $form['#field']['field_name'] ][LANGUAGE_NONE][0]['value'] = $template->value; + $form_state['values'][$form['#field']['field_name']][LANGUAGE_NONE][0]['value'] = $template->value; } } variable_set('sheetfield_template_' . $form['#field']['field_name'], $form_state['values']['sheetfield_template']); @@ -908,16 +932,16 @@ function sheetnode_element_info() { function _sheetnode_spreadsheet_process($element, &$form_state, $form) { $value = $element['#value']; $output = _sheetnode_inject( - drupal_clean_css_identifier('sheetfield-' . $element['#id']), + drupal_clean_css_identifier('sheetfield-' . $element['#id']), array($element['#name'], $element['#title']), $value, - drupal_clean_css_identifier($element['#id']), + drupal_clean_css_identifier($element['#id']), NULL ); $element['#tree'] = TRUE; $element['value'] = array( - '#type' => 'hidden', - '#attributes' => array('id' => drupal_clean_css_identifier($element['#id'])), + '#type' => 'hidden', + '#attributes' => array('id' => drupal_clean_css_identifier($element['#id'])), '#prefix' => $output, ); return $element; @@ -942,7 +966,7 @@ function sheetnode_find_sheet($sheetname) { $node = node_load(intval($sheetname)); } else { - $nid = db_query("SELECT nid FROM {node} WHERE title = :title LIMIT 1", + $nid = db_query("SELECT nid FROM {node} WHERE title = :title LIMIT 1", array(':title' => $sheetname) )->fetchField(); if ($nid) { @@ -969,8 +993,8 @@ function sheetnode_find_sheet($sheetname) { // Check that it's the field we want: // * It's accessible to this user // * Its label matches the input - // * Its delta matches the input - if (field_access('view', $field_info, 'node', $node) && + // * Its delta matches the input. + if (field_access('view', $field_info, 'node', $node) && ( !$target_field || 0 === strcasecmp($target_field, $field_name) || @@ -994,22 +1018,24 @@ function sheetnode_find_sheet($sheetname) { } // Is it a sheetview? - if (!$value && module_exists('views')) { // Try a view feed with our SocialCalc output plugin style + if (!$value && module_exists('views')) { + // Try a view feed with our SocialCalc output plugin style. $view = views_get_view($sheetname); - if ($view) foreach (array_keys($view->display) as $display_id) { - $display = $view->display[$display_id]; - if (isset($display->display_options['style_plugin']) && - $display->display_options['style_plugin'] === 'sheet_raw' && - $view->access($display_id) - ) { - if (!empty($args)) { - $view->set_arguments($args); + if ($view) { + foreach (array_keys($view->display) as $display_id) { + $display = $view->display[$display_id]; + if (isset($display->display_options['style_plugin']) && + $display->display_options['style_plugin'] === 'sheet_raw' && + $view->access($display_id)) { + if (!empty($args)) { + $view->set_arguments($args); + } + $value = $view->render($display_id); + $title = $display->handler->get_option('title'); + // Our style plugin sets this to text/plain, so reset it. + drupal_add_http_header('Content-type', 'text/html; charset=utf-8'); } - $value = $view->render($display_id); - $title = $display->handler->get_option('title'); - // Our style plugin sets this to text/plain, so reset it. - drupal_add_http_header('Content-type', 'text/html; charset=utf-8'); - } + } } } @@ -1021,8 +1047,9 @@ function sheetnode_find_sheet($sheetname) { */ function _sheetnode_ajax_load($sheetname = NULL) { // Parse the sheetname which might contain extra args separated by forward-slash. - if (empty($sheetname)) $sheetname = $_REQUEST['sheetname']; - + if (empty($sheetname)) { + $sheetname = $_REQUEST['sheetname']; + } // Look for the sheet. list($value, $title) = sheetnode_find_sheet($sheetname); @@ -1041,10 +1068,15 @@ function _sheetnode_ajax_load($sheetname = NULL) { * AJAX function to return a token value. */ function _sheetnode_ajax_token($oid = NULL, $entity_type = NULL, $token = NULL) { - if (!$oid) $oid = $_REQUEST['oid']; - if (!$entity_type) $entity_type = $_REQUEST['entity_type']; - if (!$token) $token = $_REQUEST['token']; - + if (!$oid) { + $oid = $_REQUEST['oid']; + } + if (!$entity_type) { + $entity_type = $_REQUEST['entity_type']; + } + if (!$token) { + $token = $_REQUEST['token']; + } $value = NULL; $entity = _sheetnode_entity_load($entity_type, $oid); if ($entity) { @@ -1068,9 +1100,15 @@ function _sheetnode_ajax_token($oid = NULL, $entity_type = NULL, $token = NULL) * AJAX function to return a field value. */ function _sheetnode_ajax_field($oid = NULL, $entity_type = NULL, $field = NULL) { - if (!$oid) $oid = $_REQUEST['oid']; - if (!$entity_type) $entity_type = $_REQUEST['entity_type']; - if (!$field) $field = $_REQUEST['field']; + if (!$oid) { + $oid = $_REQUEST['oid']; + } + if (!$entity_type) { + $entity_type = $_REQUEST['entity_type']; + } + if (!$field) { + $field = $_REQUEST['field']; + } $value = NULL; $entity = _sheetnode_entity_load($entity_type, $oid); @@ -1131,7 +1169,7 @@ function _sheetnode_save($nid, $vid, $value) { ->fields(array( 'nid' => $nid, 'vid' => $vid, - 'value' => $value + 'value' => $value, )) ->execute(); } @@ -1158,11 +1196,12 @@ function _sheetnode_template_load($tid) { ->condition('tid', $tid, '=') ->execute() ->fetchAssoc(); - return (object)$template; + return (object) $template; } /** * Helper function to load a Drupal entity. + * * Also checks for access right. */ function _sheetnode_entity_load($entity_type, $oid, $op = 'view', $account = NULL) { @@ -1209,4 +1248,3 @@ function _sheetnode_sheetfield_aliases($field_name, $label, $value, $delta) { } return $names; } - -- 1.9.1