Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement hook to allow components to define their own display components. #1450

Closed
wants to merge 1 commit into from
Closed

Implement hook to allow components to define their own display components. #1450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions app/lib/BundlableLabelableBaseModelWithAttributes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2317,6 +2317,10 @@ public function getDisplayLabel($ps_field, $options=null) {
}
break;
# --------------------
case 'custom_display_component':
return _t('Custom Display Component: ' . $va_tmp[2]);
break;
# --------------------
default:
if ($va_tmp[0] !== $this->tableName()) {
return caUcFirstUTF8Safe($t_instance->getDisplayLabel($ps_field, $options)).$vs_suffix;
Expand Down
78 changes: 78 additions & 0 deletions app/models/ca_bundle_displays.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,9 @@ class ca_bundle_displays extends BundlableLabelableBaseModelWithAttributes {
# are listed here is the order in which they will be returned using getFields()

protected $FIELDS;

# ------------------------------------------------------
private $op_custom_display_components_dirs = [];

# cache for haveAccessToDisplay()
static $s_have_access_to_display_cache = [];
Expand Down Expand Up @@ -270,6 +273,10 @@ public function __construct($id=null, ?array $options=null) {
'description' => _t('Restrict display to use in specific contexts. If no contexts are selected the display will be shown in all contexts.')
]
]);

// Let application plugins add their own display component plugin directories
$va_tmp = $this->opo_app_plugin_manager->hookRegisterCustomDisplayComponentsDirectories(array('custom_display_components_directories' => $this->op_custom_display_components_dirs, 'instance' => $this));
$this->op_custom_display_components_dirs = $va_tmp['custom_display_components_directories'];
}
# ------------------------------------------------------
/**
Expand Down Expand Up @@ -1931,6 +1938,8 @@ public function getAvailableBundles($pm_table_name_or_num=null, $options=null) {
$this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description)
);
}

$this->getCustomDisplayComponents($va_available_bundles, $t_instance, $vs_table, $vb_show_tooltips, $vs_format);

uksort($va_available_bundles, function($a, $b) {
return strcasecmp(strip_tags($a), strip_tags($b));
Expand Down Expand Up @@ -2003,6 +2012,56 @@ public function getPlacementsInDisplay($options=null) {
return $placements_in_display;
}
# ------------------------------------------------------
private function getCustomDisplayComponents(&$va_available_bundles, $t_instance, $vs_table, $vb_show_tooltips, $vs_format) {
$va_additional_settings = [];
$va_file_list = [];
if (sizeof($this->op_custom_display_components_dirs)) {
foreach($this->op_custom_display_components_dirs as $vs_display_components_dir) {
if (is_dir($vs_display_components_dir . $vs_table)) {
$va_file_list += caGetDirectoryContentsAsList($vs_display_components_dir . $vs_table, false, false);
}
if (!array_filter($va_file_list)) {
// No matching custom display components found
return;
}
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$vo_transaction = $this->getTransaction();
$t_placement->setTransaction($vo_transaction);
}

foreach ($va_file_list as $fn_id => $filepath) {
$va_path_info = pathinfo($filepath);
$vs_re = "|{$vs_display_components_dir}{$vs_table}/?|";
$vs_directory = preg_replace($vs_re, '', $va_path_info['dirname']);
$vs_name = $va_path_info['filename'];
$vs_bundle_name = $vs_directory ? str_replace(DIRECTORY_SEPARATOR, '_', $vs_directory) . '_' . $vs_name : $vs_name;
$vs_bundle = "{$vs_table}.custom_display_component_{$vs_bundle_name}";
$vs_id = str_replace('.', '_', $vs_bundle);
$vs_settings_form = $t_placement->getHTMLSettingForm(['id' => $vs_bundle . '_0']);
$vs_label = $vs_bundle_name;
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_bundle}'><span class='bundleDisplayEditorPlacementListItemTitle'>".caUcFirstUTF8Safe($t_instance->getProperty('NAME_SINGULAR'))."</span> {$vs_label}</div>";
$vs_description = _t('Use this custom %1 display. Templates are stored in the directory %2', $t_instance->getProperty('NAME_SINGULAR'), $vs_display_components_dir);
$va_bundle = [
'bundle' => $vs_bundle,
'display' => ($vs_format == 'simple') ? $vs_label : $vs_display,
'description' => $vs_description,
'settingsForm' => $vs_settings_form,
'settings' => $va_additional_settings,
];
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = $va_bundle;

if ($vb_show_tooltips) {
TooltipManager::add(
"#bundleDisplayEditorBundle_$vs_id",
$this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description)
);
}
}
}
}
}
# ------------------------------------------------------
private function _formatBundleTooltip($ps_label, $ps_bundle, $ps_description) {
return "<div><strong>{$ps_label}</strong></div><div class='bundleDisplayElementBundleName'>{$ps_bundle}</div><br/><div>{$ps_description}</div>";
}
Expand Down Expand Up @@ -2277,6 +2336,25 @@ public function getDisplayValue($po_result, $pn_placement_id, $options=null) {
if(!($vs_template = trim($options['template'])) && (sizeof($va_bundle_bits) == 1) && ($t_instance = Datamodel::getInstanceByTableName($va_bundle_bits[0], true))) {
$vs_template = $this->getAppConfig()->get($va_bundle_bits[0]."_default_bundle_display_template");
}

if (preg_match('/^custom_display_component/', $va_bundle_bits[1])) {
$vs_component = str_replace('custom_display_component_', '', $va_bundle_bits[1]);

if (sizeof($this->op_custom_display_components_dirs)) {
foreach ( $this->op_custom_display_components_dirs as $vs_display_components_dir ) {
$vs_filename = "{$vs_display_components_dir}/{$va_bundle_bits[0]}/{$vs_component}.php";
if ( file_exists( $vs_filename ) ) {
$vs_template = file_get_contents($vs_filename);
$file_found = true;
break;
}
}
}

if (!$file_found) {
$vs_template = 'ERROR - missing display component template ' . $va_bundle_bits[1];
}
}

if ((!$vs_template) && ($t_element = ca_metadata_elements::getInstance($va_bundle_bits[sizeof($va_bundle_bits)-1]))) {
$vs_template = $t_element->getSetting('displayTemplate');
Expand Down