diff --git a/includes/Controller/KnowledgeGraphEntityController.php b/includes/Controller/KnowledgeGraphEntityController.php index 534852b..72ebd77 100644 --- a/includes/Controller/KnowledgeGraphEntityController.php +++ b/includes/Controller/KnowledgeGraphEntityController.php @@ -9,7 +9,8 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { } switch ($view_mode) { case 'full': - // For Field API and entity_prepare_view, the entities have to be keyed by + // For Field API and entity_prepare_view, the entities have to be keyed + // by // (numeric) id. $entities = entity_key_array_by_property($entities, $this->idKey); $output = ""; @@ -23,7 +24,8 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { foreach ($entities as $entity) { $build = entity_build_content($this->entityType, $entity, $view_mode, $langcode); $build += array( - // If the entity type provides an implementation, use this instead the + // If the entity type provides an implementation, use this instead + // the // generic one. // @see template_preprocess_entity() '#theme' => 'entity', @@ -94,11 +96,11 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { * The map entity is needed to render the fields from the schema to json. * * @param $entity - * The entity to be mapped. + * The entity to be mapped. * @param $knowledge_graph - * The schema of the map. + * The schema of the map. * @param $knowledge_graph_fields - * The fields of the schema. + * The fields of the schema. * @return array * entity: The entity which will be mapped. * properties: The properties of the entity @@ -116,7 +118,7 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { * Helper function for getMap(). * @see $this->getMap(). */ - private function _getEntityMap($entity, $knowledge_graph, $fields) { + private function _getEntityMap($entity, $knowledge_graph, $fields) { $return = array('entity' => $entity, 'properties' => array(), 'direct_fields' => array(), 'fields' => array(), 'ref' => array()); // Support field groups to allow direct fields to be in a group @@ -134,9 +136,9 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { $mapped = FALSE; // Check if the field is in a field group, if so, prepend it. if (!empty($return['field_group'])) { - foreach($return['field_group'] as $group_name => $group_settings) { + foreach ($return['field_group'] as $group_name => $group_settings) { if (in_array($field_name, $group_settings->children)) { - $group = explode("group_", $group_name,2); + $group = explode("group_", $group_name, 2); $return['direct_fields'][$group[1]][$field['label']] = $value; $mapped = TRUE; continue 2; @@ -166,25 +168,26 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { if (empty($return['ref'][$field_name])) { // Load entity of referenced field. $field_setting = field_info_field($field_name); - $ref_entity = $entity->{$field_name}->value(); + $ref_entity = $entity->{$field_name}->value(); $ref_entity = entity_metadata_wrapper($field_setting['settings']['target_type'], $ref_entity); $return['ref'][$field_name]['entity'] = $ref_entity; } // Check if the mapped field is a property or a field with a column. if ($this->_is_property($ref[1])) { $prop = $this->_get_prop($ref[1]); - $return['ref'][$field_name]['properties'][] = array('group' => $map_group, 'property' => $map_property, 'map_value' => $prop[1]); + $return['ref'][$field_name]['properties'][] = array('group' => $map_group, 'property' => $map_property, 'map_value' => $prop[1]); } - // If a field is not a reference or a property, we asume it is a normal field. + // If a field is not a reference or a property, we asume it is a normal + // field. else { $col = $this->_get_col($ref[1]); $ref_field_name_result = $this->_get_ref($field_value); $ref_field_name = $ref_field_name_result[1]; $ref_col_result = $this->_get_col($ref_field_name); $ref_col = $ref_col_result[0]; - $ref_field_name_result = "field_" . explode("_field_", $ref_col , 2); + $ref_field_name_result = "field_" . explode("_field_", $ref_col, 2); $ref_field_name = $ref_field_name_result[1]; - $return['ref'][$field_name]['fields'][$ref_field_name][] = array('group' => $map_group, 'property' => $map_property, 'map_value' => $col[1]); + $return['ref'][$field_name]['fields'][$ref_field_name][] = array('group' => $map_group, 'property' => $map_property, 'map_value' => $col[1]); } } else { @@ -195,7 +198,7 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { } else { $col = $this->_get_col($field_value); - $return['fields'][$col[0]][] =array('group' => $map_group, 'property' => $map_property, 'map_value' => $col[1]); + $return['fields'][$col[0]][] = array('group' => $map_group, 'property' => $map_property, 'map_value' => $col[1]); } } } @@ -206,7 +209,7 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { * Use the map and get all values needed to encode in json. * @param $map * @return array - * An array which can be encoded in json. + * An array which can be encoded in json. */ public function buildJson($map) { // Build json array. @@ -224,8 +227,9 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { foreach ($fields as $field_name => $field) { foreach ($field as $field_variant) { $value = $map['entity']->{$field_name}->value(); - // Handle multiple value fields by using the first value. Should be handled differently later. - $map_value= $this->_get_map_value($map, $field_variant, $field_name, $value); + // Handle multiple value fields by using the first value. Should be + // handled differently later. + $map_value = $this->_get_map_value($map, $field_variant, $field_name, $value); if (empty($field_variant['group'])) { $json_ld[$field_variant['property']] = $map_value; } @@ -233,7 +237,7 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { $json_ld[$field_variant['group']][$field_variant['property']] = $map_value; } } - } + } if (!empty($map['ref'])) { foreach ($map['ref'] as $ref_map) { $json_ld = $json_ld + $this->buildJson($ref_map); @@ -250,7 +254,7 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { * @param $value * @return string */ - private function _get_map_value($map, $field_variant, $field_name, $value) { + private function _get_map_value($map, $field_variant, $field_name, $value) { // Some fields have multiple values, some not. We need to take care of that. if (is_array($value)) { if (!empty($value[0])) { @@ -258,7 +262,7 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { $map_value = $map_value_result[0][$field_variant['map_value']]; } else { - $map_value =$value[$field_variant['map_value']]; + $map_value = $value[$field_variant['map_value']]; } } else { @@ -266,7 +270,7 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { $map_value = $value; } else { - $map_value =$value[$field_variant['map_value']]; + $map_value = $value[$field_variant['map_value']]; } } // If the field is a date field, we have to take care of the time zone. @@ -288,7 +292,7 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { } else { $field_value_result = $this->_get_col($field_value); - $field_value = explode("_field_", $field_value_result[0] , 2); + $field_value = explode("_field_", $field_value_result[0], 2); return $field_value[0]; } } @@ -309,17 +313,17 @@ class KnowledgeGraphEntityController extends EntityAPIControllerExportable { } private function _is_ref($field_value) { - if (strpos($field_value, "ref") !== FALSE ) { + if (strpos($field_value, "ref") !== FALSE) { return TRUE; } return FALSE; } private function _is_property($field_value) { - if (strpos($field_value, "prop") !== FALSE ) { + if (strpos($field_value, "prop") !== FALSE) { return TRUE; } return FALSE; } -} +} diff --git a/includes/Controller/KnowledgeGraphEntityUIController.php b/includes/Controller/KnowledgeGraphEntityUIController.php index 54ea501..4e4d235 100644 --- a/includes/Controller/KnowledgeGraphEntityUIController.php +++ b/includes/Controller/KnowledgeGraphEntityUIController.php @@ -95,7 +95,6 @@ class KnowledgeGraphEntityUIController extends EntityDefaultUIController { return $items; } - /** * Overrides entity_ui_overview_form(). */ @@ -130,12 +129,15 @@ class KnowledgeGraphEntityUIController extends EntityDefaultUIController { ); return $render; } + } + /** * @file - * Contains form and helper functions to create and edit a knowledge_graph entity. + * Contains form and helper functions to create and edit a knowledge_graph + * entity. */ /** @@ -157,7 +159,7 @@ function knowledge_graph_form($form, &$form_state, $knowledge_graph_type) { $knowledge_graph_type_direct_fields = array(); // Add fields for mapping. $knowledge_graph_type_map_fields = array(); - + // Only add fields of type "field_knowledge_graph_mapper" to the options. // Other fields will be rendered directly. foreach ($knowledge_graph_type_fields as $value => $knowledge_graph_type_field) { @@ -171,7 +173,7 @@ function knowledge_graph_form($form, &$form_state, $knowledge_graph_type) { // Sort fields by it's display order. $field_weight = array(); foreach ($knowledge_graph_type_map_fields as $key => $value) { - $field_weight[$key] = !empty($value['widget']['weight']) ? $value['widget']['weight'] : 0; + $field_weight[$key] = !empty($value['widget']['weight']) ? $value['widget']['weight'] : 0; } array_multisort($field_weight, SORT_ASC, $knowledge_graph_type_map_fields); @@ -184,7 +186,7 @@ function knowledge_graph_form($form, &$form_state, $knowledge_graph_type) { // Filter bundles - only show bundles without mapping. if (empty($form['knowledge_graph'])) { $bundles = _knowledge_graph_filter_bundles($bundles, $knowledge_graph_type->type); - } + } foreach ($bundles as $value => $bundle) { $bundle_options[$value] = $bundle['label']; } @@ -207,7 +209,7 @@ function knowledge_graph_form($form, &$form_state, $knowledge_graph_type) { if (!empty($form['knowledge_graph'])) { $form['bundles']['#disabled'] = TRUE; } - + // Load fields which will be entered directly in the form. $form['direct_fields'] = array( '#title' => t("Direct fields"), @@ -235,7 +237,7 @@ function knowledge_graph_form($form, &$form_state, $knowledge_graph_type) { if (!empty($form_state['values']['bundles'])) { $fields = field_info_instances('node', check_plain($form_state['values']['bundles'])); } - if (empty($form_state['values']['bundles']) && !empty($knowledge_graph->bundle_ref) ){ + if (empty($form_state['values']['bundles']) && !empty($knowledge_graph->bundle_ref)){ $fields = field_info_instances('node', $knowledge_graph->bundle_ref); } @@ -297,8 +299,9 @@ function knowledge_graph_form_submit($form, &$form_state) { if (!empty($knowledge_graph)) { try { $entity = entity_metadata_wrapper('knowledge_graph', $knowledge_graph); - $message = t('Knowledge graph entity updated successfully.'); + $message = t('Knowledge graph entity updated successfully.'); } + catch (EntityMetadataWrapperException $e){ drupal_set_message("Could not edit knowledge_graph entity", 'error'); } @@ -306,18 +309,19 @@ function knowledge_graph_form_submit($form, &$form_state) { else { // Create new entity and save it. $entity_new = entity_create('knowledge_graph', array( - 'type' => $knowledge_graph_type->type, - 'name' => "Map " . $knowledge_graph_type->type . '/' . $form_state['values']['bundles'], - 'entity_type_ref' => 'node', - 'bundle_ref' => check_plain($form_state['values']['bundles']), - ) + 'type' => $knowledge_graph_type->type, + 'name' => "Map " . $knowledge_graph_type->type . '/' . $form_state['values']['bundles'], + 'entity_type_ref' => 'node', + 'bundle_ref' => check_plain($form_state['values']['bundles']), + ) ); $entity = entity_metadata_wrapper('knowledge_graph', $entity_new); $message = t('Knowledge graph entity saved successfully.'); } // Save the values for our direct fields. foreach ($direct_fields as $field_name => $direct_field) { - // We need to add a separate handling for list fields to get the value of the selected item. + // We need to add a separate handling for list fields to get the value of + // the selected item. $field = current($direct_field); $field = $field['field']; if ($field['module'] == "list") { @@ -397,8 +401,8 @@ function knowledge_graph_mapping_delete_form_submit($form, &$form_state) { function knowledge_graph_get_field_form(&$form, $params = array()) { // Get field group info for page. if (module_exists('field_group')) { - $bundle = $form['knowledge_graph_type']['#value']->type; - $field_groups = field_group_info_groups('knowledge_graph', $bundle); + $bundle = $form['knowledge_graph_type']['#value']->type; + $field_groups = field_group_info_groups('knowledge_graph', $bundle); } // Build options array. $bundle_fields_option = array('' => ''); @@ -409,7 +413,7 @@ function knowledge_graph_get_field_form(&$form, $params = array()) { } // Get all field information into the field options. $bundle_fields_option = $bundle_fields_option + _knowledge_graph_build_bundle_field_options($params['knowledge_graph_fields']); - + foreach ($params['knowledge_graph_type_map_fields'] as $knowledge_graph_type_field_value => $knowledge_graph_type_field) { $group = $knowledge_graph_type_field['settings']['group']; $property = $knowledge_graph_type_field['settings']['property']; @@ -431,7 +435,8 @@ function knowledge_graph_get_field_form(&$form, $params = array()) { '#default_value' => isset($params['knowledge_graph']->{$knowledge_graph_type_field_value}) ? $params['knowledge_graph']->{$knowledge_graph_type_field_value}[LANGUAGE_NONE][0]['field_name'] : '', '#weight' => $knowledge_graph_type_field['widget']['weight'], ); - } else { + } + else { $form['fields'][$knowledge_graph_type_field_value] = array( '#title' => t('Field: ' . $knowledge_graph_type_field['label'] . ' (' . $property .')'), '#description' => isset($knowledge_graph_type_field['description']) ? t($knowledge_graph_type_field['description']) : '', @@ -448,13 +453,14 @@ function knowledge_graph_get_field_form(&$form, $params = array()) { /** * Build the option menu for the field mapper. * @param $fields - * The fields to be added to the option array. + * The fields to be added to the option array. * @param bool $load_ref - * Whether entity reference fields be loaded and the fields of the target be added to the options. + * Whether entity reference fields be loaded and the fields of the target be + * added to the options. * @param int $level - * The recursion level. + * The recursion level. * @param $parent_field - * The reference field of the reference entity. + * The reference field of the reference entity. * @return mixed */ function _knowledge_graph_build_bundle_field_options($fields, $load_ref = TRUE, $level = 0, $parent_field = "") { @@ -463,28 +469,32 @@ function _knowledge_graph_build_bundle_field_options($fields, $load_ref = TRUE, $parent_field = "ref_" . $parent_field . '_'; } foreach ($fields as $value => $field) { - $bundle_fields_option[$value] =$level_string . ' ' . $field['label']; + $bundle_fields_option[$value] = $level_string . ' ' . $field['label']; $field_info = field_info_field($value); // Add columns of field to the options. foreach ($field_info['columns'] as $column_name => $column_settings) { - // Simply add the column to the option array if reference fields should not be processed. + // Simply add the column to the option array if reference fields should + // not be processed. if (!$load_ref) { $bundle_fields_option[$parent_field . $value . '_col_' . $column_name] = $level_string . '- ' . $column_name; } else { if (isset($field_info['settings']['handler_settings']['target_bundles'])) { - // Build key prefix to make a unique identifier for this particular field. + // Build key prefix to make a unique identifier for this particular + // field. $key_prefix = "ref_" . $value . '_'; $bundle_fields_option['ref_' . $value . '_col_' . $column_name] = $level_string . '- ' . $column_name . ' ' . t("Reference"); // Add a cosmetic value to make the select item more usable. $bundle_fields_option['ref_' . $value . '_col_' . $column_name . '_invalid'] = '--- Referenced Entity Fields ---'; - // Load entity property and fields of referenced bundle. Only support the first bundle for now. + // Load entity property and fields of referenced bundle. Only support + // the first bundle for now. $ref_properties = entity_get_property_info($field_info['settings']['target_type']); $ref_fields = field_info_instances($field_info['settings']['target_type'], current($field_info['settings']['handler_settings']['target_bundles'])); foreach ($ref_properties['properties'] as $property_name => $property_settings) { $bundle_fields_option['ref_' . $value . '_prop_' . $property_name] = $level_string . '-- ' . $property_name; } - // We only load the first level of reference fields for now. Could be changed later to a variable or something else. + // We only load the first level of reference fields for now. Could be + // changed later to a variable or something else. $bundle_fields_option = $bundle_fields_option + _knowledge_graph_build_bundle_field_options($ref_fields, FALSE, ++$level, $value); $bundle_fields_option[$key_prefix . '_' . $value . '_col_' . $column_name . '_invalid_end'] = '-------------'; } @@ -506,11 +516,11 @@ function _ajax_replace_bundle_fields_callback($form, &$form_state) { /** * Filter bundles for non-mapped bundle types. - * + * * @param array $bundles - * Array of all bundles existing on page. + * Array of all bundles existing on page. * @param string $type - * Type of knowledge graph entity. + * Type of knowledge graph entity. * @return array */ function _knowledge_graph_filter_bundles($bundles, $type) { @@ -525,12 +535,11 @@ function _knowledge_graph_filter_bundles($bundles, $type) { foreach ($mappings as $mapping) { $filter[] = $mapping->bundle_ref; } - - // Filter bundles. + // Filter bundles foreach ($bundles as $key => $bundle) { if (!in_array($key, $filter)) { $bundles_filtered[$key] = $bundle; } } return $bundles_filtered; -} \ No newline at end of file +} diff --git a/includes/Controller/KnowledgeGraphTypeUIController.php b/includes/Controller/KnowledgeGraphTypeUIController.php index d0b7cd8..2ffc57e 100644 --- a/includes/Controller/KnowledgeGraphTypeUIController.php +++ b/includes/Controller/KnowledgeGraphTypeUIController.php @@ -43,7 +43,8 @@ class KnowledgeGraphTypeUIController extends EntityDefaultUIController { // Only show mapping link if any content types are available. if (count($node_types)) { $additional_col = array(l(t('Add mapping'), "admin/structure/knowledge_graph/map/" . $entity->type)); - } else { + } + else { $additional_col = array(t('No content types available')); } $rows[] = $this->overviewTableRow($conditions, entity_id($this->entityType, $entity), $entity, $additional_col); @@ -57,10 +58,12 @@ class KnowledgeGraphTypeUIController extends EntityDefaultUIController { ); return $render; } + } /** * Generates the knowledge graph type editing form. */ + function knowledge_graph_type_form($form, &$form_state, $knowledge_graph_type, $op = 'edit', $entity_type = NULL) { if ($op == 'clone') { diff --git a/knowledge_graph.info b/knowledge_graph.info index a849980..2bea0ef 100644 --- a/knowledge_graph.info +++ b/knowledge_graph.info @@ -9,4 +9,4 @@ dependencies[] = ctools dependencies[] = entity files[] = includes/Controller/KnowledgeGraphEntityController.php files[] = includes/Controller/KnowledgeGraphEntityUIController.php -files[] = includes/Controller/KnowledgeGraphTypeUIController.php \ No newline at end of file +files[] = includes/Controller/KnowledgeGraphTypeUIController.php diff --git a/knowledge_graph.install b/knowledge_graph.install index 6fd449b..00fa7f9 100644 --- a/knowledge_graph.install +++ b/knowledge_graph.install @@ -139,4 +139,3 @@ function knowledge_graph_update_7001(&$sandbox) { $schema = knowledge_graph_schema(); db_change_field('knowledge_graph', 'name', 'name', $schema['knowledge_graph']['fields']['name']); } - diff --git a/knowledge_graph.module b/knowledge_graph.module index 973ce59..0715dd7 100644 --- a/knowledge_graph.module +++ b/knowledge_graph.module @@ -148,6 +148,7 @@ function knowledge_graph_field_instance_settings_form($field, $instance) { /* * Implements hook_permission(). */ + function knowledge_graph_permission() { $permissions = array( 'administer knowledge_graph' => array( @@ -217,10 +218,12 @@ function knowledge_graph_menu_alter(&$items) { * The operation being performed. One of 'view', 'update', 'create', 'delete' * or just 'edit' (being the same as 'create' or 'update'). * @param $knowledge_graph - * (optional) A knowledge_graph to check access for. If nothing is given, access for + * (optional) A knowledge_graph to check access for. If nothing is given, + * access for * all knowledge_graphs is determined. * @param $account - * (optional) The user to check for. Leave it to NULL to check for the global user. + * (optional) The user to check for. Leave it to NULL to check for the global + $...user. * * @return boolean * Whether access is allowed or not. @@ -235,7 +238,8 @@ function knowledge_graph_type_access($op, $knowledge_graph = NULL, $account = NU * @param $type_name * If set, the type with the given name is returned. * @return KnowledgegraphType[] - * Depending whether $type isset, an array of knowledge graph types or a single one. + * Depending whether $type isset, an array of knowledge graph types or a + * single one. */ function knowledge_graph_get_types($type_name = NULL) { $types = entity_load_multiple_by_name('knowledge_graph_type', isset($type_name) ? array($type_name) : FALSE); @@ -310,6 +314,7 @@ function knowledge_graph_map_view($knowledge_graph, $id) { function knowledge_graph_map_edit($entity) { return drupal_get_form('knowledge_graph_mapping_add_form', $entity); } + /** * Menu callback for deleting an existing knowledge graph. */ @@ -337,8 +342,8 @@ function knowledge_graph_target_load($knowledge_graph, $id) { /** * View entity with additional arguments. * @param $map_content - * Entity to be mapped. - * + * Entity to be mapped. + * * @see entity_view(). */ function knowledge_graph_entity_view_modified($entity_type, $entities, $view_mode = 'full', $langcode = NULL, $page = NULL, $map_content) { @@ -365,7 +370,7 @@ function knowledge_graph_entity_view($entity, $type, $view_mode, $langcode) { ->propertyCondition('entity_type_ref', $type) ->propertyCondition('bundle_ref', $entity->type) ->propertyOrderBy('id', 'DESC') - ->range(0,1); + ->range(0, 1); $result = $query->execute(); if (!empty($result)) { // Get id of map and get the json. @@ -381,11 +386,9 @@ function knowledge_graph_entity_view($entity, $type, $view_mode, $langcode) { } } - - /** * Helper function to redirect menu page callback. */ function _knowledge_graph_page_redirect($path) { drupal_goto($path); -} \ No newline at end of file +}