/**
* Return set of random rows (up to $pn_limit) subject to access restriction in $pn_access
* Set $pn_access to null or omit to return items regardless of access control status
*
* @param int $pn_limit Limit list to the specified number of items. Defaults to 10 if not specified.
* @param array $pa_options Supported options are:
* restrictToTypes = array of type names or type_ids to restrict to. Only items with a type_id in the list will be returned.
* hasRepresentations = if set when model is for ca_objects views are only returned when the object has at least one representation.
* checkAccess = an array of access values to filter only. Items will only be returned if the item's access setting is in the array.
* @return bool True on success, false on error
*/
public function getRandomItems($pn_limit = 10, $pa_options = null)
{
$o_db = $this->getDb();
$vs_limit_sql = '';
if ($pn_limit > 0) {
$vs_limit_sql = "LIMIT " . intval($pn_limit);
}
$vs_primary_key = $this->primaryKey();
$vs_table_name = $this->tableName();
$va_wheres = array();
if (is_array($pa_options['checkAccess']) && sizeof($pa_options['checkAccess']) && $this->hasField('access')) {
$va_wheres[] = $vs_table_name . '.access IN (' . join(',', $pa_options['checkAccess']) . ')';
}
if (method_exists($this, 'getTypeFieldName') && ($vs_type_field_name = $this->getTypeFieldName())) {
$va_type_ids = caMergeTypeRestrictionLists($this, $pa_options);
if (is_array($va_type_ids) && sizeof($va_type_ids)) {
$va_wheres[] = "({$vs_table_name}.{$vs_type_field_name} IN (" . join(',', $va_type_ids) . ')' . ($this->getFieldInfo($vs_type_field_name, 'IS_NULL') ? " OR {$vs_table_name}.{$vs_type_field_name} IS NULL" : '') . ')';
}
}
if (method_exists($this, 'getSourceFieldName') && ($vs_source_id_field_name = $this->getSourceFieldName())) {
$va_source_ids = caMergeSourceRestrictionLists($this, $pa_options);
if (is_array($va_source_ids) && sizeof($va_source_ids)) {
$va_wheres[] = $vs_table_name . '.' . $vs_source_id_field_name . ' IN (' . join(',', $va_source_ids) . ')';
}
}
$vs_join_sql = '';
if (isset($pa_options['hasRepresentations']) && $pa_options['hasRepresentations'] && $this->tableName() == 'ca_objects') {
$vs_join_sql = ' INNER JOIN ca_objects_x_object_representations ON ca_objects_x_object_representations.object_id = ' . $vs_table_name . '.object_id';
}
if ($this->hasField('deleted')) {
$va_wheres[] = "{$vs_table_name}.deleted = 0";
}
$vs_sql = "\n\t\t\tSELECT {$vs_table_name}.* \n\t\t\tFROM (\n\t\t\t\tSELECT {$vs_table_name}.{$vs_primary_key} FROM {$vs_table_name}\n\t\t\t\t{$vs_join_sql}\n\t\t\t" . (sizeof($va_wheres) ? " WHERE " : "") . join(" AND ", $va_wheres) . "\n\t\t\t\tORDER BY RAND() \n\t\t\t\t{$vs_limit_sql}\n\t\t\t) AS random_items \n\t\t\tINNER JOIN {$vs_table_name} ON {$vs_table_name}.{$vs_primary_key} = random_items.{$vs_primary_key}\n\t\t";
$qr_res = $o_db->query($vs_sql);
$va_random_items = array();
while ($qr_res->nextRow()) {
$va_random_items[$qr_res->get($this->primaryKey())] = $qr_res->getRow();
}
return $va_random_items;
}
/**
* Generates detail detail. Will use a view named according to the following convention:
* <table_name>_<type_code>_detail_html.php
*
* So for example, the detail for objects of type 'artwork' (where 'artwork' is the type code for the artwork object type)
* the view would be named "ca_objects_artwork_detail_html.php
*
* If the type specific view does not exist, then Show() will attemp to use a generic table-wide view name like this:
* <table_name>_detail_html.php
*
* For example: "ca_objects_detail_html.php"
*
* In general you should always have the table wide views defined. Then you can define type-specific views for your
* application on an as-needed basis.
*/
public function Show($pa_options = null)
{
JavascriptLoadManager::register('viz');
JavascriptLoadManager::register("ca", "panel");
JavascriptLoadManager::register("jit");
JavascriptLoadManager::register('browsable');
JavascriptLoadManager::register('imageScroller');
JavascriptLoadManager::register('jquery', 'expander');
$va_access_values = caGetUserAccessValues($this->request);
$this->view->setVar('access_values', $va_access_values);
if (!($t_item = $this->opo_datamodel->getInstanceByTableName($this->ops_tablename, true))) {
die("Invalid table name " . $this->ops_tablename . " for detail");
// shouldn't happen
}
if (!($vn_item_id = $this->request->getParameter($t_item->primaryKey(), pInteger))) {
$this->notification->addNotification(_t("Invalid ID"), "message");
$this->response->setRedirect(caNavUrl($this->request, "", "", "", ""));
return;
}
if (!$t_item->load($vn_item_id)) {
$this->notification->addNotification(_t("ID does not exist"), "message");
$this->response->setRedirect(caNavUrl($this->request, "", "", "", ""));
return;
}
if ($t_item->hasField('deleted') && $t_item->get('deleted')) {
$this->notification->addNotification(_t("ID has been deleted"), "message");
$this->response->setRedirect(caNavUrl($this->request, "", "", "", ""));
return;
}
// Check if item conforms to any configured display type restrictions
if (method_exists($t_item, "getTypeID")) {
$va_types = caMergeTypeRestrictionLists($t_item, array());
if (is_array($va_types) && sizeof($va_types) && !in_array($t_item->getTypeID(), $va_types)) {
$this->notification->addNotification(_t("This item is not viewable"), "message");
$this->response->setRedirect(caNavUrl($this->request, "", "", "", ""));
return;
}
}
#
# Enforce access control
#
if (sizeof($va_access_values) && !in_array($t_item->get("access"), $va_access_values)) {
$this->notification->addNotification(_t("This item is not available for view"), "message");
$this->response->setRedirect(caNavUrl($this->request, "", "", "", ""));
return;
}
//
// In-detail browsing of objects - limited to object linked to the item being displayed
//
if (($vs_browse_for_table = $this->request->config->get('allow_browse_within_detail_for_' . $this->ops_tablename)) && is_object($this->opo_browse)) {
// set browse context for controller
$this->setContext($this->opo_browse->getContext());
//
// Restrict facets to specific group for refine browse (if set in app.conf config)
//
if ($vs_facet_group = $this->request->config->get('ca_objects_refine_facet_group')) {
$this->opo_browse->setFacetGroup($vs_facet_group);
}
$t_table = $this->opo_datamodel->getInstanceByTableName($this->ops_tablename, true);
if ($this->request->session->getVar($this->ops_tablename . '_' . $this->ops_appname . '_detail_current_item_id') != $vn_item_id) {
$this->opo_browse->removeAllCriteria();
}
// look for 'authority' facet for current detail table type so we can limit the object browse to the currently displayed item
//$vs_limit_facet_name = null;
//foreach($this->opo_browse->getInfoForFacets() as $vs_facet_name => $va_facet_info) {
// if (($va_facet_info['type'] === 'authority') && ($va_facet_info['table'] === $this->ops_tablename)) {
// $vs_limit_facet_name = $vs_facet_name;
// break;
// }
//}
$this->opo_browse->addFacetConfiguration($vs_limit_facet_name = '_detail_browse_' . $this->ops_tablename, array('type' => 'authority', 'table' => $this->ops_tablename, 'relationship_table' => 'ca_objects_x_entities', 'restrict_to_types' => array(), 'restrict_to_relationship_types' => array(), 'label_singular' => 'Detail browse by ' . $this->ops_tablename, 'label_plural' => 'Detail browse by ' . $this->ops_tablename, 'group_mode' => 'none', 'indefinite_article' => 'a'));
if ($vs_limit_facet_name) {
if (($va_configured_type_restrictions = $this->request->config->getList($this->ops_tablename . '_detail_browse_type_restrictions')) && is_array($va_configured_type_restrictions)) {
$this->opo_browse->setTypeRestrictions($va_configured_type_restrictions, array('includeChildren' => false));
}
$this->opo_browse->addCriteria($vs_limit_facet_name, array($vn_item_id));
$this->opo_browse->execute(array('checkAccess' => $va_access_values));
$this->request->session->setVar($this->ops_tablename . '_' . $this->ops_appname . '_detail_current_browse_id', $this->opo_browse->getBrowseID());
$this->view->setVar('show_browse', true);
//
// Browse paging
//
$vn_items_per_page = $this->request->config->get("objects_per_page_for_detail_pages");
if (!$vn_items_per_page) {
$vn_items_per_page = 12;
}
$this->view->setVar('page', ($vn_p = $this->request->getParameter('page', pInteger)) ? $vn_p : 1);
$qr_hits = null;
if ($this->opo_browse) {
$va_sort = array();
if ($vs_sort = $this->request->config->get('sort_browse_within_detail_for_' . $this->ops_tablename)) {
$va_sort = array('sort' => $vs_sort);
}
$qr_hits = $this->opo_browse->getResults($va_sort);
$vn_num_pages = ceil($qr_hits->numHits() / $vn_items_per_page);
$qr_hits->seek(($vn_p - 1) * $vn_items_per_page);
} else {
$vn_num_pages = 0;
}
$this->view->setVar('browse_results', $qr_hits);
$this->view->setVar('num_pages', (int) $vn_num_pages);
$this->view->setVar('items_per_page', (int) $vn_items_per_page);
$this->view->setVar('opo_browse', $this->opo_browse);
$this->view->setVar('sorts', $this->opa_sorts);
// supported sorts for the object browse
// browse criteria in an easy-to-display format
$va_browse_criteria = array();
foreach ($this->opo_browse->getCriteriaWithLabels() as $vs_facet_code => $va_criteria) {
$va_facet_info = $this->opo_browse->getInfoForFacet($vs_facet_code);
$va_criteria_list = array();
foreach ($va_criteria as $vn_criteria_id => $vs_criteria_label) {
$va_criteria_list[] = $vs_criteria_label;
}
$va_browse_criteria[$va_facet_info['label_singular']] = join('; ', $va_criteria_list);
}
$this->view->setVar('browse_criteria', $va_browse_criteria);
} else {
// not configured for browse
$this->request->session->setVar($this->ops_tablename . '_' . $this->ops_appname . '_detail_current_browse_id', null);
$this->view->setVar('show_browse', false);
}
}
$this->request->session->setVar($this->ops_tablename . '_' . $this->ops_appname . '_detail_current_item_id', $vn_item_id);
# Next and previous navigation
$opo_result_context = new ResultContext($this->request, $this->ops_tablename, ResultContext::getLastFind($this->request, $this->ops_tablename));
$this->view->setVar('next_id', $opo_result_context->getNextID($vn_item_id));
$this->view->setVar('previous_id', $opo_result_context->getPreviousID($vn_item_id));
# Is the item we're show details for in the result set?
$this->view->setVar('is_in_result_list', $opo_result_context->getIndexInResultList($vn_item_id) != '?');
# Item instance and id
$this->view->setVar('t_item', $t_item);
$this->view->setVar($t_item->getPrimaryKey(), $vn_item_id);
# Item - preferred
$this->view->setVar('label', $t_item->getLabelForDisplay());
# Item - nonpreferred
$this->view->setVar('nonpreferred_labels', caExtractValuesByUserLocale($t_item->getNonPreferredLabels()));
# Item timestamps (creation and last change)
if ($va_entry_info = $t_item->getCreationTimestamp()) {
$this->view->setVar('date_of_entry', date('m/d/Y', $va_entry_info['timestamp']));
}
if ($va_last_change_info = $t_item->getLastChangeTimestamp()) {
$this->view->setVar('date_of_last_change', date('m/d/Y', $va_last_change_info['timestamp']));
}
# Media representations to display (objects only)
if (method_exists($t_item, 'getPrimaryRepresentationInstance')) {
if ($t_primary_rep = $t_item->getPrimaryRepresentationInstance()) {
if (!sizeof($va_access_values) || in_array($t_primary_rep->get('access'), $va_access_values)) {
// check rep access
$this->view->setVar('t_primary_rep', $t_primary_rep);
$va_rep_display_info = caGetMediaDisplayInfo('detail', $t_primary_rep->getMediaInfo('media', 'INPUT', 'MIMETYPE'));
$this->view->setVar('primary_rep_display_version', $va_rep_display_info['display_version']);
unset($va_display_info['display_version']);
$va_rep_display_info['poster_frame_url'] = $t_primary_rep->getMediaUrl('media', $va_rep_display_info['poster_frame_version']);
unset($va_display_info['poster_frame_version']);
$this->view->setVar('primary_rep_display_options', $va_rep_display_info);
}
}
}
#
# User-generated comments, tags and ratings
#
$va_user_comments = $t_item->getComments(null, true);
$va_comments = array();
if (is_array($va_user_comments)) {
foreach ($va_user_comments as $va_user_comment) {
if ($va_user_comment["comment"] || $va_user_comment["media1"] || $va_user_comment["media2"] || $va_user_comment["media3"] || $va_user_comment["media4"]) {
# TODO: format date based on locale
$va_user_comment["date"] = date("n/j/Y", $va_user_comment["created_on"]);
# -- get name of commenter
$t_user = new ca_users($va_user_comment["user_id"]);
$va_user_comment["author"] = $t_user->getName();
$va_comments[] = $va_user_comment;
}
}
}
$this->view->setVar('comments', $va_comments);
$va_user_tags = $t_item->getTags(null, true);
$va_tags = array();
if (is_array($va_user_tags)) {
foreach ($va_user_tags as $va_user_tag) {
if (!in_array($va_user_tag["tag"], $va_tags)) {
$va_tags[] = $va_user_tag["tag"];
}
}
}
$this->view->setVar('tags_array', $va_tags);
$this->view->setVar('tags', implode(", ", $va_tags));
$this->view->setVar('result_context', $opo_result_context);
# -- get average user ranking
$this->view->setVar('ranking', $t_item->getAverageRating(null));
// null makes it ignore moderation status
# -- get number of user rankings
$this->view->setVar('numRankings', $t_item->getNumRatings(null));
// null makes it ignore moderation status
#
# Miscellaneous useful information
#
$this->view->setVar('t_relationship_types', new ca_relationship_types());
// relationship types object - used for displaying relationship type of related authority information
if (method_exists($t_item, 'getTypeName')) {
$this->view->setVar('typename', $t_item->getTypeName());
}
// Record view
$t_item->registerItemView($this->request->getUserID());
//
// Render view
//
if (isset($pa_options['view']) && $pa_options['view']) {
$this->render($pa_options['view']);
} else {
if ($this->getView()->viewExists($this->ops_tablename . '_' . $t_item->getTypeCode() . '_detail_html.php')) {
$this->render($this->ops_tablename . '_' . $t_item->getTypeCode() . '_detail_html.php');
} else {
$this->render($this->ops_tablename . '_detail_html.php');
}
}
}
/**
* Return array containing information about all hierarchies, including their root_id's
* For non-adhoc hierarchies such as places, this call returns the contents of the place_hierarchies list
* with some extra information such as the # of top-level items in each hierarchy.
*
* For an ad-hoc hierarchy like that of an collection, there is only ever one hierarchy to display - that of the current collection.
* So for adhoc hierarchies we just return a single entry corresponding to the root of the current collection hierarchy
*/
public function getHierarchyList($pb_dummy = false)
{
$vs_hier_fld = $this->getProperty('HIERARCHY_ID_FLD');
$vs_parent_fld = $this->getProperty('HIERARCHY_PARENT_ID_FLD');
if (!$vs_parent_fld) {
return;
}
$o_dm = Datamodel::load();
$vs_pk = $this->primaryKey();
$vn_id = $this->getPrimaryKey();
$vs_table = $this->tableName();
$vs_template = $this->getAppConfig()->get($vs_table . '_hierarchy_browser_display_settings');
$va_type_ids = caMergeTypeRestrictionLists($this, array());
$va_source_ids = caMergeSourceRestrictionLists($this, array());
$vs_type_fld = $this->getTypeFieldName();
$vs_source_fld = $this->getSourceFieldName();
if (!$vn_id) {
$o_db = $this->getDb();
$va_wheres = array("(o.{$vs_parent_fld} IS NULL)");
$va_params = array();
if (is_array($va_type_ids) && sizeof($va_type_ids)) {
$va_params[] = $va_type_ids;
$va_wheres[] = "(o.{$vs_type_fld} IN (?)" . ($this->getFieldInfo($vs_type_fld, 'IS_NULL') ? " OR o.{$vs_type_fld} IS NULL" : "") . ")";
}
if (is_array($va_source_ids) && sizeof($va_source_ids)) {
$va_params[] = $va_source_ids;
$va_wheres[] = "(o.{$vs_source_fld} IN (?))";
}
$qr_res = $o_db->query("\n\t\t\t\tSELECT o.{$vs_pk}, count(*) c\n\t\t\t\tFROM {$vs_table} o\n\t\t\t\tINNER JOIN {$vs_table} AS p ON p.{$vs_parent_fld} = o.{$vs_pk}\n\t\t\t\tWHERE " . join(" AND ", $va_wheres) . "\n\t\t\t\tGROUP BY o.{$vs_pk}\n\t\t\t", $va_params);
$va_hiers = array();
$va_ids = $qr_res->getAllFieldValues($vs_pk);
$qr_res->seek(0);
$va_labels = $this->getPreferredDisplayLabelsForIDs($va_ids);
while ($qr_res->nextRow()) {
$va_hiers[$vn_id = $qr_res->get($vs_pk)] = array('item_id' => $vn_id, $vs_pk => $vn_id, 'name' => caProcessTemplateForIDs($vs_template, $vs_table, array($vn_id)), 'hierarchy_id' => $vn_id, 'children' => (int) $qr_res->get('c'));
}
return $va_hiers;
} else {
// return specific collection as root of hierarchy
$vs_label = $this->getLabelForDisplay(false);
$vn_hier_id = $this->get($vs_hier_fld);
if ($this->get($vs_parent_fld)) {
// currently loaded row is not the root so get the root
$va_ancestors = $this->getHierarchyAncestors();
if (!is_array($va_ancestors) || sizeof($va_ancestors) == 0) {
return null;
}
$t_instance = $o_dm->getInstanceByTableName($va_ancestors[0], true);
} else {
$t_instance =& $this;
}
$va_children = $t_instance->getHierarchyChildren(null, array('idsOnly' => true));
$va_hierarchy_root = array($t_instance->get($vs_hier_fld) => array('item_id' => $vn_id, $vs_pk => $vn_id, 'name' => caProcessTemplateForIDs($vs_template, $vs_table, array($vn_id)), 'hierarchy_id' => $vn_hier_id, 'children' => sizeof($va_children)));
return $va_hierarchy_root;
}
}
/**
* Return array containing information about all hierarchies, including their root_id's
* For non-adhoc hierarchies such as places, this call returns the contents of the place_hierarchies list
* with some extra information such as the # of top-level items in each hierarchy.
*
* For an ad-hoc hierarchy like that of an object, there is only ever one hierarchy to display - that of the current object.
* So for adhoc hierarchies we just return a single entry corresponding to the root of the current object hierarchy
*/
public function getHierarchyList($pb_dummy = false)
{
$vn_pk = $this->getPrimaryKey();
$vs_template = $this->getAppConfig()->get('ca_objects_hierarchy_browser_display_settings');
if (!$vn_pk) {
$o_db = new Db();
if (is_array($va_type_ids = caMergeTypeRestrictionLists($this, array())) && sizeof($va_type_ids)) {
$qr_res = $o_db->query("\n\t\t\t\t\tSELECT o.object_id, count(*) c\n\t\t\t\t\tFROM ca_objects o\n\t\t\t\t\tINNER JOIN ca_objects AS p ON p.parent_id = o.object_id\n\t\t\t\t\tWHERE o.parent_id IS NULL AND o.type_id IN (?)\n\t\t\t\t\tGROUP BY o.object_id\n\t\t\t\t", array($va_type_ids));
} else {
$qr_res = $o_db->query("\n\t\t\t\t\tSELECT o.object_id, count(*) c\n\t\t\t\t\tFROM ca_objects o\n\t\t\t\t\tINNER JOIN ca_objects AS p ON p.parent_id = o.object_id\n\t\t\t\t\tWHERE o.parent_id IS NULL\n\t\t\t\t\tGROUP BY o.object_id\n\t\t\t\t");
}
$va_hiers = array();
$va_object_ids = $qr_res->getAllFieldValues('object_id');
$qr_res->seek(0);
$va_labels = $this->getPreferredDisplayLabelsForIDs($va_object_ids);
while ($qr_res->nextRow()) {
$va_hiers[$vn_object_id = $qr_res->get('object_id')] = array('object_id' => $vn_object_id, 'item_id' => $vn_object_id, 'name' => caProcessTemplateForIDs($vs_template, 'ca_objects', array($vn_object_id)), 'hierarchy_id' => $vn_object_id, 'children' => (int) $qr_res->get('c'));
}
return $va_hiers;
} else {
// return specific object as root of hierarchy
$vs_label = $this->getLabelForDisplay(false);
$vs_hier_fld = $this->getProperty('HIERARCHY_ID_FLD');
$vs_parent_fld = $this->getProperty('PARENT_ID_FLD');
$vn_hier_id = $this->get($vs_hier_fld);
if ($this->get($vs_parent_fld)) {
// currently loaded row is not the root so get the root
$va_ancestors = $this->getHierarchyAncestors();
if (!is_array($va_ancestors) || sizeof($va_ancestors) == 0) {
return null;
}
$t_object = new ca_objects($va_ancestors[0]);
} else {
$t_object =& $this;
}
$va_children = $t_object->getHierarchyChildren(null, array('idsOnly' => true));
$va_object_hierarchy_root = array($t_object->get($vs_hier_fld) => array('object_id' => $vn_pk, 'item_id' => $vn_pk, 'name' => $vs_name = caProcessTemplateForIDs($vs_template, 'ca_objects', array($vn_pk)), 'hierarchy_id' => $vn_hier_id, 'children' => sizeof($va_children)));
return $va_object_hierarchy_root;
}
}
/**
* Returns list of items in the specified table related to the currently loaded row.
*
* @param $pm_rel_table_name_or_num - the table name or table number of the item type you want to get a list of (eg. if you are calling this on an ca_objects instance passing 'ca_entities' here will get you a list of entities related to the object)
* @param $pa_options - array of options. Supported options are:
*
* restrict_to_type = restricts returned items to those of the specified type; only supports a single type which can be specified as a list item_code or item_id
* restrictToType = synonym for restrict_to_type
* restrict_to_types = restricts returned items to those of the specified types; pass an array of list item_codes or item_ids
* restrictToTypes = synonym for restrict_to_types
* dont_include_subtypes_in_type_restriction = if set subtypes are not included when enforcing restrict_to_types. Note that restrict_to_relationship_types always includes subtypes in its restriction.
* dontIncludeSubtypesInTypeRestriction = synonym for dont_include_subtypes_in_type_restriction
* restrict_to_relationship_types = restricts returned items to those related to the current row by the specified relationship type(s). You can pass either an array of types or a single type. The types can be relationship type_code's or type_id's.
* restrictToRelationshipTypes = synonym for restrict_to_relationship_types
*
* exclude_relationship_types = omits any items related to the current row with any of the specified types from the returned set of ids. You can pass either an array of types or a single type. The types can be relationship type_code's or type_id's.
* excludeRelationshipTypes = synonym for exclude_relationship_types
* exclude_type = excludes returned items of the specified type; only supports a single type which can be specified as a list item_code or item_id
* excludeType = synonym for exclude_type
* exclude_types = omits any items related to the current row that are of any of the specified types from the returned set of ids. You can pass either an array of types or a single type. The types can be type_code's or type_id's.
* excludeTypes = synonym for exclude_types
*
* restrict_to_lists = when fetching related ca_list_items restricts returned items to those that are in the specified lists; pass an array of list list_codes or list_ids
* restrictToLists = synonym for restrict_to_lists
*
* fields = array of fields (in table.fieldname format) to include in returned data
* return_non_preferred_labels = if set to true, non-preferred labels are included in returned data
* returnNonPreferredLabels = synonym for return_non_preferred_labels
* checkAccess = array of access values to filter results by; if defined only items with the specified access code(s) are returned
* return_labels_as_array = if set to true then all labels associated with row are returned in an array, otherwise only a text value in the current locale is returned; default is false - return single label in current locale
* returnLabelsAsArray = synonym for return_labels_as_array
* row_ids = array of primary key values to use when fetching related items; if omitted or set to a null value the 'row_id' option (single value) will be used; if row_id is also not set then the currently loaded primary key value will be used
* row_id = primary key value to use when fetching related items; if omitted or set to a false value (eg. null, false, 0) then the currently loaded primary key value is used [default]
* start = item to start return set at; first item is numbered zero; default is 0
* limit = number of items to limit return set to; default is 1000
* sort = optional array of bundles to sort returned values on. Currently only supported when getting related values via simple related <table_name> and <table_name>.related invokations. Eg. from a ca_objects results you can use the 'sort' option got get('ca_entities'), get('ca_entities.related') or get('ca_objects.related'). The bundle specifiers are fields with or without tablename. Only those fields returned for the related tables (intrinsics, label fields and attributes) are sortable.
* sortDirection = direction of sort. Valid values as "ASC" (ascending) and "DESC" (descending). Default is ASC.
* showDeleted = if set to true, related items that have been deleted are returned. Default is false.
* where = optional array of fields and field values to filter returned values on. The fields must be intrinsic and in the same table as the field being "get()'ed" Can be used to filter returned values from primary and related tables. This option can be useful when you want to fetch certain values from a related table. For example, you want to get the relationship source_info values, but only for relationships going to a specific related record. Note that multiple fields/values are effectively AND'ed together - all must match for a row to be returned - and that only equivalence is supported (eg. field equals value).
* user_id = If set item level access control is performed relative to specified user_id, otherwise defaults to logged in user
* groupFields = Groups together fields in an arrangement that is easier for import to another system. Used by the ItemInfo web service when in "import" mode. Default is false.
* returnLocaleCodes = Return locale values as codes (Ex. en_US) rather than numeric database-specific locale_ids. Default is false.
* @return array - list of related items
*/
public function getRelatedItems($pm_rel_table_name_or_num, $pa_options = null)
{
global $AUTH_CURRENT_USER_ID;
$vn_user_id = isset($pa_options['user_id']) && $pa_options['user_id'] ? $pa_options['user_id'] : (int) $AUTH_CURRENT_USER_ID;
$vb_show_if_no_acl = (bool) ($this->getAppConfig()->get('default_item_access_level') > __CA_ACL_NO_ACCESS__);
// convert options
if (isset($pa_options['restrictToType']) && (!isset($pa_options['restrict_to_type']) || !$pa_options['restrict_to_type'])) {
$pa_options['restrict_to_type'] = $pa_options['restrictToType'];
}
if (isset($pa_options['restrictToTypes']) && (!isset($pa_options['restrict_to_types']) || !$pa_options['restrict_to_types'])) {
$pa_options['restrict_to_types'] = $pa_options['restrictToTypes'];
}
if (isset($pa_options['restrictToRelationshipTypes']) && (!isset($pa_options['restrict_to_relationship_types']) || !$pa_options['restrict_to_relationship_types'])) {
$pa_options['restrict_to_relationship_types'] = $pa_options['restrictToRelationshipTypes'];
}
if (isset($pa_options['excludeType']) && (!isset($pa_options['exclude_type']) || !$pa_options['exclude_type'])) {
$pa_options['exclude_type'] = $pa_options['excludeType'];
}
if (isset($pa_options['excludeTypes']) && (!isset($pa_options['exclude_types']) || !$pa_options['exclude_types'])) {
$pa_options['exclude_types'] = $pa_options['excludeTypes'];
}
if (isset($pa_options['excludeRelationshipTypes']) && (!isset($pa_options['exclude_relationship_types']) || !$pa_options['exclude_relationship_types'])) {
$pa_options['exclude_relationship_types'] = $pa_options['excludeRelationshipTypes'];
}
if (isset($pa_options['dontIncludeSubtypesInTypeRestriction']) && (!isset($pa_options['dont_include_subtypes_in_type_restriction']) || !$pa_options['dont_include_subtypes_in_type_restriction'])) {
$pa_options['dont_include_subtypes_in_type_restriction'] = $pa_options['dontIncludeSubtypesInTypeRestriction'];
}
if (isset($pa_options['returnNonPreferredLabels']) && (!isset($pa_options['return_non_preferred_labels']) || !$pa_options['return_non_preferred_labels'])) {
$pa_options['return_non_preferred_labels'] = $pa_options['returnNonPreferredLabels'];
}
if (isset($pa_options['returnLabelsAsArray']) && (!isset($pa_options['return_labels_as_array']) || !$pa_options['return_labels_as_array'])) {
$pa_options['return_labels_as_array'] = $pa_options['returnLabelsAsArray'];
}
if (isset($pa_options['restrictToLists']) && (!isset($pa_options['restrict_to_lists']) || !$pa_options['restrict_to_lists'])) {
$pa_options['restrict_to_lists'] = $pa_options['restrictToLists'];
}
if (isset($pa_options['groupFields'])) {
$pa_options['groupFields'] = (bool) $pa_options['groupFields'];
} else {
$pa_options['groupFields'] = false;
}
$o_db = $this->getDb();
$t_locale = new ca_locales();
$o_tep = new TimeExpressionParser();
$vb_uses_effective_dates = false;
$va_get_where = isset($pa_options['where']) && is_array($pa_options['where']) && sizeof($pa_options['where']) ? $pa_options['where'] : null;
$va_row_ids = isset($pa_options['row_ids']) && is_array($pa_options['row_ids']) ? $pa_options['row_ids'] : null;
$vn_row_id = isset($pa_options['row_id']) && $pa_options['row_id'] ? $pa_options['row_id'] : $this->getPrimaryKey();
if (isset($pa_options['sort']) && !is_array($pa_options['sort'])) {
$pa_options['sort'] = array($pa_options['sort']);
}
$va_sort_fields = isset($pa_options['sort']) && is_array($pa_options['sort']) ? $pa_options['sort'] : null;
$vs_sort_direction = isset($pa_options['sortDirection']) && $pa_options['sortDirection'] ? $pa_options['sortDirection'] : null;
if (!$va_row_ids && $vn_row_id > 0) {
$va_row_ids = array($vn_row_id);
}
if (!$va_row_ids || !is_array($va_row_ids) || !sizeof($va_row_ids)) {
return array();
}
$vb_return_labels_as_array = isset($pa_options['return_labels_as_array']) && $pa_options['return_labels_as_array'] ? true : false;
$vn_limit = isset($pa_options['limit']) && (int) $pa_options['limit'] > 0 ? (int) $pa_options['limit'] : 1000;
$vn_start = isset($pa_options['start']) && (int) $pa_options['start'] > 0 ? (int) $pa_options['start'] : 0;
if (is_numeric($pm_rel_table_name_or_num)) {
$vs_related_table_name = $this->getAppDataModel()->getTableName($pm_rel_table_name_or_num);
} else {
$vs_related_table_name = $pm_rel_table_name_or_num;
}
if (!is_array($pa_options)) {
$pa_options = array();
}
switch (sizeof($va_path = array_keys($this->getAppDatamodel()->getPath($this->tableName(), $vs_related_table_name)))) {
case 3:
$t_item_rel = $this->getAppDatamodel()->getTableInstance($va_path[1]);
$t_rel_item = $this->getAppDatamodel()->getTableInstance($va_path[2]);
$vs_key = $t_item_rel->primaryKey();
//'relation_id';
break;
case 2:
$t_item_rel = null;
$t_rel_item = $this->getAppDatamodel()->getTableInstance($va_path[1]);
$vs_key = $t_rel_item->primaryKey();
break;
default:
// bad related table
return null;
break;
}
// check for self relationship
$vb_self_relationship = false;
if ($this->tableName() == $vs_related_table_name) {
$vb_self_relationship = true;
$t_rel_item = $this->getAppDatamodel()->getTableInstance($va_path[0]);
$t_item_rel = $this->getAppDatamodel()->getTableInstance($va_path[1]);
}
$va_wheres = array();
$va_selects = array();
$va_joins_post_add = array();
$vs_related_table = $t_rel_item->tableName();
if ($t_rel_item->hasField('type_id')) {
$va_selects[] = $vs_related_table . '.type_id item_type_id';
}
// TODO: get these field names from models
if ($t_item_rel) {
//define table names
$vs_linking_table = $t_item_rel->tableName();
$va_selects[] = $vs_related_table . '.' . $t_rel_item->primaryKey();
// include dates in returned data
if ($t_item_rel->hasField('effective_date')) {
$va_selects[] = $vs_linking_table . '.sdatetime';
$va_selects[] = $vs_linking_table . '.edatetime';
$vb_uses_effective_dates = true;
}
if ($t_rel_item->hasField('is_enabled')) {
$va_selects[] = $vs_related_table . '.is_enabled';
}
if ($t_item_rel->hasField('type_id')) {
$va_selects[] = $vs_linking_table . '.type_id relationship_type_id';
require_once __CA_MODELS_DIR__ . '/ca_relationship_types.php';
$t_rel = new ca_relationship_types();
$vb_uses_relationship_types = true;
}
// limit related items to a specific type
if ($vb_uses_relationship_types && isset($pa_options['restrict_to_relationship_types']) && $pa_options['restrict_to_relationship_types']) {
if (!is_array($pa_options['restrict_to_relationship_types'])) {
$pa_options['restrict_to_relationship_types'] = array($pa_options['restrict_to_relationship_types']);
}
if (sizeof($pa_options['restrict_to_relationship_types'])) {
$va_rel_types = array();
foreach ($pa_options['restrict_to_relationship_types'] as $vm_type) {
if (!$vm_type) {
continue;
}
if (!($vn_type_id = $t_rel->getRelationshipTypeID($vs_linking_table, $vm_type))) {
$vn_type_id = (int) $vm_type;
}
if ($vn_type_id > 0) {
$va_rel_types[] = $vn_type_id;
if (is_array($va_children = $t_rel->getHierarchyChildren($vn_type_id, array('idsOnly' => true)))) {
$va_rel_types = array_merge($va_rel_types, $va_children);
}
}
}
if (sizeof($va_rel_types)) {
$va_wheres[] = '(' . $vs_linking_table . '.type_id IN (' . join(',', $va_rel_types) . '))';
}
}
}
if ($vb_uses_relationship_types && isset($pa_options['exclude_relationship_types']) && $pa_options['exclude_relationship_types']) {
if (!is_array($pa_options['exclude_relationship_types'])) {
$pa_options['exclude_relationship_types'] = array($pa_options['exclude_relationship_types']);
}
if (sizeof($pa_options['exclude_relationship_types'])) {
$va_rel_types = array();
foreach ($pa_options['exclude_relationship_types'] as $vm_type) {
if ($vn_type_id = $t_rel->getRelationshipTypeID($vs_linking_table, $vm_type)) {
$va_rel_types[] = $vn_type_id;
if (is_array($va_children = $t_rel->getHierarchyChildren($vn_type_id, array('idsOnly' => true)))) {
$va_rel_types = array_merge($va_rel_types, $va_children);
}
}
}
if (sizeof($va_rel_types)) {
$va_wheres[] = '(' . $vs_linking_table . '.type_id NOT IN (' . join(',', $va_rel_types) . '))';
}
}
}
}
// limit related items to a specific type
if (isset($pa_options['restrict_to_type']) && $pa_options['restrict_to_type']) {
if (!isset($pa_options['restrict_to_types']) || !is_array($pa_options['restrict_to_types'])) {
$pa_options['restrict_to_types'] = array();
}
$pa_options['restrict_to_types'][] = $pa_options['restrict_to_type'];
}
$va_ids = caMergeTypeRestrictionLists($t_rel_item, $pa_options);
if (is_array($va_ids) && sizeof($va_ids) > 0) {
$va_wheres[] = '(' . $vs_related_table . '.type_id IN (' . join(',', $va_ids) . '))';
}
if (isset($pa_options['exclude_type']) && $pa_options['exclude_type']) {
if (!isset($pa_options['exclude_types']) || !is_array($pa_options['exclude_types'])) {
$pa_options['exclude_types'] = array();
}
$pa_options['exclude_types'][] = $pa_options['exclude_type'];
}
if (isset($pa_options['exclude_types']) && is_array($pa_options['exclude_types'])) {
$va_ids = caMakeTypeIDList($t_rel_item->tableName(), $pa_options['exclude_types']);
if (is_array($va_ids) && sizeof($va_ids) > 0) {
$va_wheres[] = '(' . $vs_related_table . '.type_id NOT IN (' . join(',', $va_ids) . '))';
}
}
if ($this->getAppConfig()->get('perform_item_level_access_checking')) {
$t_user = new ca_users($vn_user_id, true);
if (is_array($va_groups = $t_user->getUserGroups()) && sizeof($va_groups)) {
$va_group_ids = array_keys($va_groups);
} else {
$va_group_ids = array();
}
// Join to limit what browse table items are used to generate facet
$va_joins_post_add[] = 'LEFT JOIN ca_acl ON ' . $t_rel_item->tableName() . '.' . $t_rel_item->primaryKey() . ' = ca_acl.row_id AND ca_acl.table_num = ' . $t_rel_item->tableNum() . "\n";
$va_wheres[] = "(\n\t\t\t\t((\n\t\t\t\t\t(ca_acl.user_id = " . (int) $vn_user_id . ")\n\t\t\t\t\t" . (sizeof($va_group_ids) > 0 ? "OR\n\t\t\t\t\t(ca_acl.group_id IN (" . join(",", $va_group_ids) . "))" : "") . "\n\t\t\t\t\tOR\n\t\t\t\t\t(ca_acl.user_id IS NULL and ca_acl.group_id IS NULL)\n\t\t\t\t) AND ca_acl.access >= " . __CA_ACL_READONLY_ACCESS__ . ")\n\t\t\t\t" . ($vb_show_if_no_acl ? "OR ca_acl.acl_id IS NULL" : "") . "\n\t\t\t)";
}
if (is_array($va_get_where)) {
foreach ($va_get_where as $vs_fld => $vm_val) {
if ($t_rel_item->hasField($vs_fld)) {
$va_wheres[] = "({$vs_related_table_name}.{$vs_fld} = " . (!is_numeric($vm_val) ? "'" . $this->getDb()->escape($vm_val) . "'" : $vm_val) . ")";
}
}
}
if ($vs_idno_fld = $t_rel_item->getProperty('ID_NUMBERING_ID_FIELD')) {
$va_selects[] = $t_rel_item->tableName() . '.' . $vs_idno_fld;
}
if ($vs_idno_sort_fld = $t_rel_item->getProperty('ID_NUMBERING_SORT_FIELD')) {
$va_selects[] = $t_rel_item->tableName() . '.' . $vs_idno_sort_fld;
}
$va_selects[] = $va_path[1] . '.' . $vs_key;
if (isset($pa_options['fields']) && is_array($pa_options['fields'])) {
$va_selects = array_merge($va_selects, $pa_options['fields']);
}
// if related item is labelable then include the label table in the query as well
$vs_label_display_field = null;
if (method_exists($t_rel_item, "getLabelTableName")) {
if ($vs_label_table_name = $t_rel_item->getLabelTableName()) {
// make sure it actually has a label table...
$va_path[] = $vs_label_table_name;
$t_rel_item_label = $this->getAppDatamodel()->getTableInstance($vs_label_table_name);
$vs_label_display_field = $t_rel_item_label->getDisplayField();
if ($vb_return_labels_as_array || is_array($va_sort_fields) && sizeof($va_sort_fields)) {
$va_selects[] = $vs_label_table_name . '.*';
} else {
$va_selects[] = $vs_label_table_name . '.' . $vs_label_display_field;
$va_selects[] = $vs_label_table_name . '.locale_id';
if ($t_rel_item_label->hasField('surname')) {
// hack to include fields we need to sort entity labels properly
$va_selects[] = $vs_label_table_name . '.surname';
$va_selects[] = $vs_label_table_name . '.forename';
}
}
if ($t_rel_item_label->hasField('is_preferred') && (!isset($pa_options['return_non_preferred_labels']) || !$pa_options['return_non_preferred_labels'])) {
$va_wheres[] = "(" . $vs_label_table_name . '.is_preferred = 1)';
}
}
}
// return source info in returned data
if ($t_item_rel && $t_item_rel->hasField('source_info')) {
$va_selects[] = $vs_linking_table . '.source_info';
}
if (isset($pa_options['checkAccess']) && is_array($pa_options['checkAccess']) && sizeof($pa_options['checkAccess']) && $t_rel_item->hasField('access')) {
$va_wheres[] = "(" . $t_rel_item->tableName() . '.access IN (' . join(',', $pa_options['checkAccess']) . '))';
}
if ((!isset($pa_options['showDeleted']) || !$pa_options['showDeleted']) && $t_rel_item->hasField('deleted')) {
$va_wheres[] = "(" . $t_rel_item->tableName() . '.deleted = 0)';
}
if ($vb_self_relationship) {
//
// START - self relation
//
$va_rel_info = $this->getAppDatamodel()->getRelationships($va_path[0], $va_path[1]);
if ($vs_label_table_name) {
$va_label_rel_info = $this->getAppDatamodel()->getRelationships($va_path[0], $vs_label_table_name);
}
$va_rels = array();
$vn_i = 0;
foreach ($va_rel_info[$va_path[0]][$va_path[1]] as $va_possible_keys) {
$va_joins = array();
$va_joins[] = "INNER JOIN " . $va_path[1] . " ON " . $va_path[1] . '.' . $va_possible_keys[1] . ' = ' . $va_path[0] . '.' . $va_possible_keys[0] . "\n";
if ($vs_label_table_name) {
$va_joins[] = "INNER JOIN " . $vs_label_table_name . " ON " . $vs_label_table_name . '.' . $va_label_rel_info[$va_path[0]][$vs_label_table_name][0][1] . ' = ' . $va_path[0] . '.' . $va_label_rel_info[$va_path[0]][$vs_label_table_name][0][0] . "\n";
}
$vs_other_field = $vn_i == 0 ? $va_rel_info[$va_path[0]][$va_path[1]][1][1] : $va_rel_info[$va_path[0]][$va_path[1]][0][1];
$vs_direction = preg_match('!left!', $vs_other_field) ? 'ltor' : 'rtol';
$va_selects['row_id'] = $va_path[1] . '.' . $vs_other_field . ' AS row_id';
$vs_order_by = '';
$vs_sort_fld = '';
if ($t_item_rel && $t_item_rel->hasField('rank')) {
$vs_order_by = ' ORDER BY ' . $t_item_rel->tableName() . '.rank';
$vs_sort_fld = 'rank';
$va_selects[] = $t_item_rel->tableName() . ".rank";
} else {
if ($t_rel_item && ($vs_sort = $t_rel_item->getProperty('ID_NUMBERING_SORT_FIELD'))) {
$vs_order_by = " ORDER BY " . $t_rel_item->tableName() . ".{$vs_sort}";
$vs_sort_fld = $vs_sort;
$va_selects[] = $t_rel_item->tableName() . ".{$vs_sort}";
}
}
$vs_sql = "\n\t\t\t\t\tSELECT " . join(', ', $va_selects) . "\n\t\t\t\t\tFROM " . $va_path[0] . "\n\t\t\t\t\t" . join("\n", array_merge($va_joins, $va_joins_post_add)) . "\n\t\t\t\t\tWHERE\n\t\t\t\t\t\t" . join(' AND ', array_merge($va_wheres, array('(' . $va_path[1] . '.' . $vs_other_field . ' IN (' . join(',', $va_row_ids) . '))'))) . "\n\t\t\t\t\t{$vs_order_by}";
//print "<pre>$vs_sql</pre>\n";
$qr_res = $o_db->query($vs_sql);
if ($vb_uses_relationship_types) {
$va_rel_types = $t_rel->getRelationshipInfo($va_path[1]);
}
$vn_c = 0;
if ($vn_start > 0) {
$qr_res->seek($vn_start);
}
while ($qr_res->nextRow()) {
if ($vn_c >= $vn_limit) {
break;
}
$va_row = $qr_res->getRow();
$vn_id = $va_row[$vs_key] . '/' . $va_row['row_id'];
$vs_sort_key = $qr_res->get($vs_sort_fld);
$vs_display_label = $va_row[$vs_label_display_field];
//unset($va_row[$vs_label_display_field]);
if (!$va_rels[$vs_sort_key][$vn_id]) {
$va_rels[$vs_sort_key][$vn_id] = $qr_res->getRow();
}
if ($vb_uses_effective_dates) {
// return effective dates as display/parse-able text
if ($va_rels[$vs_sort_key][$vn_id]['sdatetime'] || $va_rels[$vs_sort_key][$vn_id]['edatetime']) {
$o_tep->setHistoricTimestamps($va_rels[$vs_sort_key][$vn_id]['sdatetime'], $va_rels[$vs_sort_key][$vn_id]['edatetime']);
$va_rels[$vs_sort_key][$vn_id]['effective_date'] = $o_tep->getText();
}
}
$vn_locale_id = $qr_res->get('locale_id');
if (isset($pa_options['returnLocaleCodes']) && $pa_options['returnLocaleCodes']) {
$va_rels[$vs_v]['locale_id'] = $vn_locale_id = $t_locale->localeIDToCode($vn_locale_id);
}
$va_rels[$vs_sort_key][$vn_id]['labels'][$vn_locale_id] = $vb_return_labels_as_array ? $va_row : $vs_display_label;
$va_rels[$vs_sort_key][$vn_id]['_key'] = $vs_key;
$va_rels[$vs_sort_key][$vn_id]['direction'] = $vs_direction;
$vn_c++;
if ($vb_uses_relationship_types) {
$va_rels[$vs_sort_key][$vn_id]['relationship_typename'] = $vs_direction == 'ltor' ? $va_rel_types[$va_row['relationship_type_id']]['typename'] : $va_rel_types[$va_row['relationship_type_id']]['typename_reverse'];
$va_rels[$vs_sort_key][$vn_id]['relationship_type_code'] = $va_rel_types[$va_row['relationship_type_id']]['type_code'];
}
//
// Return data in an arrangement more convenient for the data importer
//
if ($pa_options['groupFields']) {
$vs_rel_pk = $t_rel_item->primaryKey();
if ($t_rel_item_label) {
foreach ($t_rel_item_label->getFormFields() as $vs_field => $va_field_info) {
if (!isset($va_rels[$vs_v][$vs_field]) || $vs_field == $vs_rel_pk) {
continue;
}
$va_rels[$vs_v]['preferred_labels'][$vs_field] = $va_rels[$vs_v][$vs_field];
unset($va_rels[$vs_v][$vs_field]);
}
}
foreach ($t_rel_item->getFormFields() as $vs_field => $va_field_info) {
if (!isset($va_rels[$vs_v][$vs_field]) || $vs_field == $vs_rel_pk) {
continue;
}
$va_rels[$vs_v]['intrinsic'][$vs_field] = $va_rels[$vs_v][$vs_field];
unset($va_rels[$vs_v][$vs_field]);
}
unset($va_rels[$vs_v]['_key']);
unset($va_rels[$vs_v]['row_id']);
}
}
$vn_i++;
}
ksort($va_rels);
// sort by sort key... we'll remove the sort key in the next loop while we add the labels
// Set 'label' entry - display label in current user's locale
$va_sorted_rels = array();
foreach ($va_rels as $vs_sort_key => $va_rels_by_sort_key) {
foreach ($va_rels_by_sort_key as $vn_id => $va_rel) {
$va_tmp = array(0 => $va_rel['labels']);
$va_sorted_rels[$vn_id] = $va_rel;
$va_values_filtered_by_locale = caExtractValuesByUserLocale($va_tmp);
$va_sorted_rels[$vn_id]['label'] = array_shift($va_values_filtered_by_locale);
}
}
$va_rels = $va_sorted_rels;
//
// END - self relation
//
} else {
//
// BEGIN - non-self relation
//
$va_wheres[] = "(" . $this->tableName() . '.' . $this->primaryKey() . " IN (" . join(",", $va_row_ids) . "))";
$vs_cur_table = array_shift($va_path);
$va_joins = array();
// Enforce restrict_to_lists for related list items
if ($vs_related_table_name == 'ca_list_items' && is_array($pa_options['restrict_to_lists'])) {
$va_list_ids = array();
foreach ($pa_options['restrict_to_lists'] as $vm_list) {
if ($vn_list_id = ca_lists::getListID($vm_list)) {
$va_list_ids[] = $vn_list_id;
}
}
if (sizeof($va_list_ids)) {
$va_wheres[] = "(ca_list_items.list_id IN (" . join(",", $va_list_ids) . "))";
}
}
foreach ($va_path as $vs_join_table) {
$va_rel_info = $this->getAppDatamodel()->getRelationships($vs_cur_table, $vs_join_table);
if ($vs_join_table == "ca_set_item_labels") {
// hack to have label-less set items appear in "ca_set_items" queries for ca_sets
$va_joins[] = 'LEFT JOIN ' . $vs_join_table . ' ON ' . $vs_cur_table . '.' . $va_rel_info[$vs_cur_table][$vs_join_table][0][0] . ' = ' . $vs_join_table . '.' . $va_rel_info[$vs_cur_table][$vs_join_table][0][1] . "\n";
} else {
$va_joins[] = 'INNER JOIN ' . $vs_join_table . ' ON ' . $vs_cur_table . '.' . $va_rel_info[$vs_cur_table][$vs_join_table][0][0] . ' = ' . $vs_join_table . '.' . $va_rel_info[$vs_cur_table][$vs_join_table][0][1] . "\n";
}
$vs_cur_table = $vs_join_table;
}
$va_selects[] = $this->tableName() . '.' . $this->primaryKey() . ' AS row_id';
$vs_order_by = '';
if ($t_item_rel && $t_item_rel->hasField('rank')) {
$vs_order_by = ' ORDER BY ' . $t_item_rel->tableName() . '.rank';
} else {
if ($t_rel_item && ($vs_sort = $t_rel_item->getProperty('ID_NUMBERING_SORT_FIELD'))) {
$vs_order_by = " ORDER BY " . $t_rel_item->tableName() . ".{$vs_sort}";
}
}
$vs_sql = "\n\t\t\t\tSELECT " . join(', ', $va_selects) . "\n\t\t\t\tFROM " . $this->tableName() . "\n\t\t\t\t" . join("\n", array_merge($va_joins, $va_joins_post_add)) . "\n\t\t\t\tWHERE\n\t\t\t\t\t" . join(' AND ', $va_wheres) . "\n\t\t\t\t{$vs_order_by}\n\t\t\t";
//print "<pre>$vs_sql</pre>\n";
$qr_res = $o_db->query($vs_sql);
if ($vb_uses_relationship_types) {
$va_rel_types = $t_rel->getRelationshipInfo($t_item_rel->tableName());
$vs_left_table = $t_item_rel->getLeftTableName();
$vs_direction = $vs_left_table == $this->tableName() ? 'ltor' : 'rtol';
}
$va_rels = array();
$vn_c = 0;
if ($vn_start > 0) {
$qr_res->seek($vn_start);
}
while ($qr_res->nextRow()) {
if ($vn_c >= $vn_limit) {
break;
}
if (isset($pa_options['returnAsSearchResult']) && $pa_options['returnAsSearchResult']) {
$va_rels[] = $qr_res->get($t_rel_item->primaryKey());
continue;
}
$va_row = $qr_res->getRow();
$vs_v = $va_row[$vs_key];
$vs_display_label = $va_row[$vs_label_display_field];
//unset($va_row[$vs_label_display_field]);
if (!isset($va_rels[$vs_v]) || !$va_rels[$vs_v]) {
$va_rels[$vs_v] = $va_row;
}
if ($vb_uses_effective_dates) {
// return effective dates as display/parse-able text
if ($va_rels[$vs_v]['sdatetime'] || $va_rels[$vs_v]['edatetime']) {
$o_tep->setHistoricTimestamps($va_rels[$vs_v]['sdatetime'], $va_rels[$vs_v]['edatetime']);
$va_rels[$vs_v]['effective_date'] = $o_tep->getText();
}
}
$vn_locale_id = $qr_res->get('locale_id');
if (isset($pa_options['returnLocaleCodes']) && $pa_options['returnLocaleCodes']) {
$va_rels[$vs_v]['locale_id'] = $vn_locale_id = $t_locale->localeIDToCode($vn_locale_id);
}
$va_rels[$vs_v]['labels'][$vn_locale_id] = $vb_return_labels_as_array ? $va_row : $vs_display_label;
$va_rels[$vs_v]['_key'] = $vs_key;
$va_rels[$vs_v]['direction'] = $vs_direction;
$vn_c++;
if ($vb_uses_relationship_types) {
$va_rels[$vs_v]['relationship_typename'] = $vs_direction == 'ltor' ? $va_rel_types[$va_row['relationship_type_id']]['typename'] : $va_rel_types[$va_row['relationship_type_id']]['typename_reverse'];
$va_rels[$vs_v]['relationship_type_code'] = $va_rel_types[$va_row['relationship_type_id']]['type_code'];
}
if ($pa_options['groupFields']) {
$vs_rel_pk = $t_rel_item->primaryKey();
if ($t_rel_item_label) {
foreach ($t_rel_item_label->getFormFields() as $vs_field => $va_field_info) {
if (!isset($va_rels[$vs_v][$vs_field]) || $vs_field == $vs_rel_pk) {
continue;
}
$va_rels[$vs_v]['preferred_labels'][$vs_field] = $va_rels[$vs_v][$vs_field];
unset($va_rels[$vs_v][$vs_field]);
}
}
foreach ($t_rel_item->getFormFields() as $vs_field => $va_field_info) {
if (!isset($va_rels[$vs_v][$vs_field]) || $vs_field == $vs_rel_pk) {
continue;
}
$va_rels[$vs_v]['intrinsic'][$vs_field] = $va_rels[$vs_v][$vs_field];
unset($va_rels[$vs_v][$vs_field]);
}
unset($va_rels[$vs_v]['_key']);
unset($va_rels[$vs_v]['row_id']);
}
}
if (!isset($pa_options['returnAsSearchResult']) || !$pa_options['returnAsSearchResult']) {
// Set 'label' entry - display label in current user's locale
foreach ($va_rels as $vs_v => $va_rel) {
$va_tmp = array(0 => $va_rel['labels']);
$va_tmp2 = caExtractValuesByUserLocale($va_tmp);
$va_rels[$vs_v]['label'] = array_shift($va_tmp2);
}
}
//
// END - non-self relation
//
}
//
// Sort on fields if specified
//
if (is_array($va_sort_fields) && sizeof($va_rels)) {
$va_ids = array();
$vs_rel_pk = $t_rel_item->primaryKey();
foreach ($va_rels as $vn_i => $va_rel) {
$va_ids[] = $va_rel[$vs_rel_pk];
}
// Handle sorting on attribute values
$vs_rel_pk = $t_rel_item->primaryKey();
foreach ($va_sort_fields as $vn_x => $vs_sort_field) {
if ($vs_sort_field == 'relation_id') {
// sort by relationship primary key
if ($t_item_rel) {
$va_sort_fields[$vn_x] = $vs_sort_field = $t_item_rel->tableName() . '.' . $t_item_rel->primaryKey();
}
continue;
}
$va_tmp = explode('.', $vs_sort_field);
if ($va_tmp[0] == $vs_related_table_name) {
$qr_rel = $t_rel_item->makeSearchResult($va_tmp[0], $va_ids);
$vs_table = array_shift($va_tmp);
$vs_key = join(".", $va_tmp);
while ($qr_rel->nextHit()) {
$vn_pk_val = $qr_rel->get($vs_table . "." . $vs_rel_pk);
foreach ($va_rels as $vn_rel_id => $va_rel) {
if ($va_rel[$vs_rel_pk] == $vn_pk_val) {
$va_rels[$vn_rel_id][$vs_key] = $qr_rel->get($vs_sort_field, array("delimiter" => ";", 'sortable' => 1));
break;
}
}
}
}
}
// Perform sort
$va_rels = caSortArrayByKeyInValue($va_rels, $va_sort_fields, $vs_sort_direction);
}
return $va_rels;
}
/**
* Implementation of primary get() functionality
*/
private function _get($ps_field, $pa_options = null)
{
if (!is_array($pa_options)) {
$pa_options = array();
}
if (isset($pa_options['restrictToType']) && (!isset($pa_options['restrict_to_type']) || !$pa_options['restrict_to_type'])) {
$pa_options['restrict_to_type'] = $pa_options['restrictToType'];
}
if (isset($pa_options['restrictToTypes']) && (!isset($pa_options['restrict_to_types']) || !$pa_options['restrict_to_types'])) {
$pa_options['restrict_to_types'] = $pa_options['restrictToTypes'];
}
if (isset($pa_options['restrictToRelationshipTypes']) && (!isset($pa_options['restrict_to_relationship_types']) || !$pa_options['restrict_to_relationship_types'])) {
$pa_options['restrict_to_relationship_types'] = $pa_options['restrictToRelationshipTypes'];
}
if (isset($pa_options['excludeType']) && (!isset($pa_options['exclude_type']) || !$pa_options['exclude_type'])) {
$pa_options['exclude_type'] = $pa_options['excludeType'];
}
if (isset($pa_options['excludeTypes']) && (!isset($pa_options['exclude_types']) || !$pa_options['exclude_types'])) {
$pa_options['exclude_types'] = $pa_options['excludeTypes'];
}
if (isset($pa_options['excludeRelationshipTypes']) && (!isset($pa_options['exclude_relationship_types']) || !$pa_options['exclude_relationship_types'])) {
$pa_options['exclude_relationship_types'] = $pa_options['excludeRelationshipTypes'];
}
$vb_return_as_array = caGetOption('returnAsArray', $pa_options, false, array('castTo' => 'bool'));
$vb_return_all_locales = caGetOption('returnAllLocales', $pa_options, false, array('castTo' => 'bool'));
$vb_return_as_link = caGetOption('returnAsLink', $pa_options, false, array('castTo' => 'bool'));
$vs_return_as_link_text = caGetOption('returnAsLinkText', $pa_options, '');
$vs_return_as_link_target = caGetOption('returnAsLinkTarget', $pa_options, '');
$vs_return_as_link_attributes = caGetOption('returnAsLinkAttributes', $pa_options, array(), array('castTo' => 'array'));
$va_original_path_components = $va_path_components = $this->getFieldPathComponents($ps_field);
if ($va_path_components['table_name'] != $this->ops_table_name) {
$vs_access_chk_key = $va_path_components['table_name'] . ($va_path_components['field_name'] ? '.' . $va_path_components['field_name'] : '');
} else {
$vs_access_chk_key = $va_path_components['field_name'];
}
if (caGetBundleAccessLevel($this->ops_table_name, $vs_access_chk_key) == __CA_BUNDLE_ACCESS_NONE__) {
return null;
}
$vo_request = caGetOption('request', $pa_options, null);
unset($pa_options['request']);
// first see if the search engine can provide the field value directly (fastest)
if (!(($vs_value = $this->opo_engine_result->get($ps_field, $pa_options)) === false)) {
if ($vb_return_as_array) {
if ($vb_return_all_locales) {
return array(1 => $vs_value);
} else {
return array($vs_value);
}
} else {
return $vs_value;
}
}
$vs_template = caGetOption('template', $pa_options, null);
$vs_delimiter = caGetOption('delimiter', $pa_options, ' ');
$vs_hierarchical_delimiter = caGetOption('hierarchicalDelimiter', $pa_options, ' ');
if ($vb_return_all_locales && !$vb_return_as_array) {
$vb_return_as_array = true;
}
if (isset($pa_options['sort']) && !is_array($pa_options['sort'])) {
$pa_options['sort'] = array($pa_options['sort']);
}
if (is_array($va_sort_fields = isset($pa_options['sort']) && is_array($pa_options['sort']) ? $pa_options['sort'] : null)) {
foreach ($va_sort_fields as $vn_i => $vs_sort_fld) {
if (!trim($vs_sort_fld)) {
unset($va_sort_fields[$vn_i]);
}
}
}
$vn_row_id = $this->opo_engine_result->get($this->ops_table_pk);
// try to lazy load (slower)...
//
// Are we getting timestamp (created on or last modified) info?
//
if ($va_path_components['table_name'] == $this->ops_table_name && $va_path_components['field_name'] == 'created') {
if (!isset($this->opa_timestamp_cache['created_on'][$this->ops_table_name][$vn_row_id])) {
$this->prefetchChangeLogData($this->ops_table_name, $this->opo_engine_result->currentRow(), $this->getOption('prefetch'));
}
if ($vb_return_as_array) {
return $this->opa_timestamp_cache['created_on'][$this->ops_table_name][$vn_row_id];
} else {
$vs_subfield = $va_path_components['subfield_name'] ? $va_path_components['subfield_name'] : 'timestamp';
$vm_val = $this->opa_timestamp_cache['created_on'][$this->ops_table_name][$vn_row_id][$vs_subfield];
if ($vs_subfield == 'timestamp') {
$o_tep = new TimeExpressionParser();
$o_tep->setUnixTimestamps($vm_val, $vm_val);
$vm_val = $o_tep->getText($pa_options);
}
return $vm_val;
}
}
if ($va_path_components['table_name'] == $this->ops_table_name && $va_path_components['field_name'] == 'lastModified') {
if (!isset($this->opa_timestamp_cache['last_changed'][$this->ops_table_name][$vn_row_id])) {
$this->prefetchChangeLogData($this->ops_table_name, $this->opo_engine_result->currentRow(), $this->getOption('prefetch'));
}
if ($vb_return_as_array) {
return $this->opa_timestamp_cache['last_changed'][$this->ops_table_name][$vn_row_id];
} else {
$vs_subfield = $va_path_components['subfield_name'] ? $va_path_components['subfield_name'] : 'timestamp';
$vm_val = $this->opa_timestamp_cache['last_changed'][$this->ops_table_name][$vn_row_id][$vs_subfield];
if ($vs_subfield == 'timestamp') {
$o_tep = new TimeExpressionParser();
$o_tep->setUnixTimestamps($vm_val, $vm_val);
$vm_val = $o_tep->getText($pa_options);
}
return $vm_val;
}
}
if (!($t_instance = $this->opo_datamodel->getInstanceByTableName($va_path_components['table_name'], true))) {
return null;
}
// Bad table
$t_original_instance = $t_instance;
// $t_original_instance will always be the as-called subject; optimizations may results in $t_instance being transformed into a different model
//
// Simple related table get:
// <table>
// <table>.related
// <table>.hierarchy
// <table>.related.hierarchy
//
if ($va_path_components['num_components'] == 1 && $va_path_components['table_name'] !== $this->ops_table_name || $va_path_components['num_components'] == 2 && $va_path_components['field_name'] == 'related' || $va_path_components['num_components'] == 2 && $va_path_components['field_name'] == 'hierarchy' || $va_path_components['num_components'] == 3 && $va_path_components['field_name'] == 'related' && $va_path_components['subfield_name'] == 'hierarchy') {
if (!($t_table = $this->opo_datamodel->getInstanceByTableName($this->ops_table_name, true))) {
return null;
}
$vb_show_hierarachy = (bool) ($va_path_components['field_name'] == 'hierarchy' && $t_instance->isHierarchical());
if ($va_path_components['num_components'] == 2) {
$va_path_components['num_components'] = 1;
$va_path_components['field_name'] = null;
}
$vs_opt_md5 = caMakeCacheKeyFromOptions($pa_options);
if (!isset($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5])) {
$this->prefetchRelated($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch'), $pa_options);
}
$va_related_items = $this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5];
if (!is_array($va_related_items)) {
return null;
}
if (is_array($va_sort_fields) && sizeof($va_sort_fields)) {
$va_related_items = caSortArrayByKeyInValue($va_related_items, $va_sort_fields);
}
// Return as array
if ($vs_template) {
return caProcessTemplateForIDs($vs_template, $this->opo_subject_instance->tableName(), array($vn_row_id), array_merge($pa_options, array('placeholderPrefix' => $va_path_components['field_name'])));
}
if ($vb_return_as_array || $vb_return_all_locales) {
if ($vb_return_all_locales) {
$va_related_tmp = array();
foreach ($va_related_items as $vn_i => $va_related_item) {
$va_related_tmp[$vn_i][$va_related_item['locale_id']] = $va_related_item;
}
return $va_related_tmp;
} else {
if (!$vs_template && !$va_path_components['field_name']) {
return $va_related_items;
}
$vs_pk = $t_instance->primaryKey();
$va_links = array();
foreach ($va_related_items as $vn_relation_id => $va_relation_info) {
$va_relation_info['labels'] = caExtractValuesByUserLocale(array(0 => $va_relation_info['labels']));
if ($vb_return_as_link) {
$va_template_opts = array();
$va_template_opts['relationshipValues'][$va_relation_info[$vs_pk]][$va_relation_info['relation_id']]['relationship_typename'] = $va_relation_info['relationship_typename'];
$vs_text = $vs_template ? caProcessTemplateForIDs($vs_template, $t_instance->tableName(), array($va_relation_info[$vs_pk]), $va_template_opts) : join("; ", $va_relation_info['labels']);
$va_link = caCreateLinksFromText(array($vs_text), $va_original_path_components['table_name'], array($va_relation_info[$vs_pk]), $vs_return_as_link_class, $vs_return_as_link_target);
$va_links[$vn_relation_id] = array_pop($va_link);
} else {
$va_related_items[$vn_relation_id]['labels'] = $va_relation_info['labels'];
}
}
if ($vb_return_as_link) {
return $va_links;
}
return $va_related_items;
}
} else {
// Return scalar
$va_proc_labels = array();
$va_row_ids = array();
$vs_rel_pk = $t_instance->primaryKey();
$va_relationship_values = array();
foreach ($va_related_items as $vn_relation_id => $va_relation_info) {
$va_row_ids[] = $va_relation_info[$vs_rel_pk];
$va_relationship_values[$va_relation_info[$vs_rel_pk]][$vn_relation_id] = array('relationship_typename' => $va_relation_info['relationship_typename'], 'relationship_type_id' => $va_relation_info['relationship_type_id'], 'relationship_type_code' => $va_relation_info['relationship_type_code'], 'relationship_typecode' => $va_relation_info['relationship_type_code'], 'label' => $va_relation_info['label']);
}
if (!sizeof($va_row_ids)) {
return '';
}
if (!$vs_template) {
$vs_template = "^label";
}
$va_template_opts = $pa_options;
unset($va_template_opts['request']);
unset($va_template_opts['template']);
$va_template_opts['returnAsLink'] = false;
$va_template_opts['returnAsArray'] = true;
$va_text = caProcessTemplateForIDs($vs_template, $t_instance->tableNum(), $va_row_ids, array_merge($va_template_opts, array('relationshipValues' => $va_relationship_values, 'showHierarchicalLabels' => $vb_show_hierarachy)));
if ($vb_return_as_link) {
$va_links = caCreateLinksFromText($va_text, $va_original_path_components['table_name'], $va_row_ids, $vs_return_as_link_class, $vs_return_as_link_target);
return join($vs_delimiter, $va_links);
}
return join($vs_delimiter, $va_text);
}
}
$vb_need_parent = false;
$vb_need_children = false;
//
// Transform "preferred_labels" into tables for pre-fetching
//
$vb_is_get_for_labels = $vb_return_all_label_values = $vb_get_preferred_labels_only = $vb_get_nonpreferred_labels_only = false;
if (in_array($va_path_components['field_name'], array('preferred_labels', 'nonpreferred_labels'))) {
if ($t_instance->getProperty('LABEL_TABLE_NAME')) {
$vb_get_preferred_labels_only = $va_path_components['field_name'] == 'preferred_labels' ? true : false;
$vb_get_nonpreferred_labels_only = $va_path_components['field_name'] == 'nonpreferred_labels' ? true : false;
if ($va_path_components['num_components'] == 2) {
// if it's just <table_name>.preferred_labels then return an array of fields from the label table
$vb_return_all_label_values = true;
}
$va_path_components['table_name'] = $t_instance->getLabelTableName();
$t_label_instance = $t_instance->getLabelTableInstance();
if (!$va_path_components['subfield_name'] || !$t_label_instance->hasField($va_path_components['subfield_name'])) {
$va_path_components['field_name'] = $t_instance->getLabelDisplayField();
} else {
$va_path_components['field_name'] = $va_path_components['subfield_name'];
}
$va_path_components['subfield_name'] = null;
$va_path_components = $this->getFieldPathComponents($va_path_components['table_name'] . '.' . $va_path_components['field_name']);
// Ok, convert the table instance to the label table since that's the table we'll be grabbing data from
$t_instance = $t_label_instance;
$vb_is_get_for_labels = true;
}
}
//
// Handle modifiers (parent, children, related, hierarchy) with and without fields
//
if ($va_path_components['num_components'] >= 2) {
switch ($va_path_components['field_name']) {
case 'parent':
if ($t_instance->isHierarchical() && ($vn_parent_id = $this->get($va_path_components['table_name'] . '.' . $t_instance->getProperty('HIERARCHY_PARENT_ID_FLD')))) {
//
// TODO: support some kind of prefetching of parents?
//
unset($va_path_components['components'][1]);
if ($t_instance->load($vn_parent_id)) {
return $t_instance->get(join('.', array_values($va_path_components['components'])), $pa_options);
}
return null;
}
break;
case 'children':
if ($t_instance->isHierarchical()) {
//unset($va_path_components['components'][1]); // remove 'children' from field path
$vs_field_spec = join('.', array_values($va_path_components['components']));
if ($vn_id = $this->get($va_path_components['table_name'] . '.' . $t_instance->primaryKey(), array('returnAsArray' => false))) {
if ($t_instance->load($vn_id)) {
return $t_instance->get($vs_field_spec, $pa_options);
}
}
return null;
}
break;
case 'related':
// Regular related table call
if ($va_path_components['table_name'] != $this->ops_table_name) {
// just remove "related" from name and be on our way
$va_tmp = $va_path_components['components'];
array_splice($va_tmp, 1, 1);
return $this->get(join('.', $va_tmp), $pa_options);
}
// Self-relations need special handling
$vs_opt_md5 = caMakeCacheKeyFromOptions($pa_options);
if (!isset($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5])) {
$this->prefetchRelated($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch'), $pa_options);
}
$va_related_items = $this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5];
if (!($t_table = $this->opo_datamodel->getInstanceByTableName($va_path_components['table_name'], true))) {
return null;
}
$va_ids = array();
foreach ($va_related_items as $vn_relation_id => $va_item) {
$va_ids[] = $va_item[$t_table->primaryKey()];
}
$va_vals = array();
if ($qr_res = $t_table->makeSearchResult($va_path_components['table_name'], $va_ids)) {
$va_tmp = $va_path_components['components'];
unset($va_tmp[1]);
$vs_rel_field = join('.', $va_tmp);
while ($qr_res->nextHit()) {
if ($vb_return_as_array) {
$va_vals = array_merge($va_vals, $qr_res->get($vs_rel_field, $pa_options));
} else {
$va_vals[] = $qr_res->get($vs_rel_field, $pa_options);
}
}
}
//if (is_array($va_sort_fields) && sizeof($va_sort_fields)) {
// $va_vals = caSortArrayByKeyInValue($va_vals, $va_sort_fields);
//}
if ($vb_return_as_link) {
if (!$vb_return_all_locales) {
$va_vals = caCreateLinksFromText($va_vals, $va_original_path_components['table_name'], $va_ids, $vs_return_as_link_class, $vs_return_as_link_target);
}
}
if ($vb_return_as_array) {
return $va_vals;
} else {
return join($vs_delimiter, $va_vals);
}
break;
case 'hierarchy':
$vn_max_levels_from_bottom = caGetOption('maxLevelsFromBottom', $pa_options, caGetOption('maxLevels', $pa_options, null));
$vn_max_levels_from_top = caGetOption('maxLevelsFromTop', $pa_options, null);
if ($t_instance->isHierarchical()) {
$vs_field_spec = join('.', array_values($va_path_components['components']));
$vs_hier_pk_fld = $t_instance->primaryKey();
if ($va_ids = $this->get($va_path_components['table_name'] . '.' . $vs_hier_pk_fld, array_merge($pa_options, array('returnAsArray' => true, 'returnAsLink' => false, 'returnAllLocales' => false)))) {
$va_vals = array();
if ($va_path_components['subfield_name'] == $vs_hier_pk_fld) {
foreach ($va_ids as $vn_id) {
// TODO: This is too slow
if ($t_instance->load($vn_id)) {
$va_vals = array_merge($va_vals, $t_instance->get($va_path_components['table_name'] . ".hierarchy." . $vs_hier_pk_fld, array_merge($pa_options, array('returnAsArray' => true))));
}
}
} else {
foreach ($va_ids as $vn_id) {
// TODO: This is too slow
if ($t_instance->load($vn_id)) {
$va_vals = $t_instance->get($vs_field_spec, array_merge($pa_options, array('returnAsArray' => true)));
if (is_array($va_vals)) {
$va_vals = array_reverse($va_vals);
}
// Add/replace hierarchy name
if ($t_instance->getProperty('HIERARCHY_TYPE') == __CA_HIER_TYPE_MULTI_MONO__ && $t_instance->getHierarchyName()) {
$vn_first_key = array_shift(array_keys($va_vals));
if ($vb_return_all_locales) {
$va_vals[$vn_first_key] = array(0 => array($t_instance->getHierarchyName()));
} else {
$va_vals[$vn_first_key] = $t_instance->getHierarchyName();
}
}
if ($vn_max_levels_from_bottom > 0) {
if (($vn_start = sizeof($va_vals) - $vn_max_levels_from_bottom) < 0) {
$vn_start = 0;
}
$va_vals = array_slice($va_vals, $vn_start, $vn_max_levels_from_bottom, true);
} elseif ($vn_max_levels_from_top > 0) {
$va_vals = array_slice($va_vals, 0, $vn_max_levels_from_top, true);
}
}
}
}
if ($vb_return_as_array) {
return $va_vals;
} else {
return join($vs_hierarchical_delimiter, $va_vals);
}
}
return null;
}
break;
}
}
// If the requested table was not added to the query via SearchEngine::addTable()
// then auto-add it here. It's better to explicitly add it with addTables() as that call
// gives you precise control over which fields are autoloaded and also lets you specify limiting criteria
// for selection of related field data; and it also lets you explicitly define the tables used to join the
// related table. Autoloading guesses and usually does what you want, but not always.
if (!isset($this->opa_tables[$va_path_components['table_name']]) || !$this->opa_tables[$va_path_components['table_name']]) {
$va_join_tables = $this->opo_datamodel->getPath($this->ops_table_name, $va_path_components['table_name']);
array_shift($va_join_tables);
// remove subject table
array_pop($va_join_tables);
// remove content table (we only need linking tables here)
$va_join_criteria = array();
if (is_array($va_primary_ids)) {
foreach ($va_primary_ids as $vs_t => $va_t_ids) {
if (isset($va_join_tables[$vs_t]) && sizeof($va_t_ids) > 0) {
$vs_t_pk = $this->opo_datamodel->getTablePrimaryKeyName($vs_t);
$va_join_criteria[] = "{$vs_t}.{$vs_t_pk} NOT IN (" . join(",", $va_t_ids) . ")";
}
}
}
$this->opa_tables[$va_path_components['table_name']] = array('fieldList' => array($va_path_components['table_name'] . '.*'), 'joinTables' => array_keys($va_join_tables), 'criteria' => $va_join_criteria);
}
if ($va_path_components['table_name'] === $this->ops_table_name && !$t_instance->hasField($va_path_components['field_name']) && method_exists($t_instance, 'getAttributes')) {
//
// Return attribute values for primary table
//
if ($va_path_components['field_name'] && ($t_element = $t_instance->_getElementInstance($va_path_components['field_name']))) {
$vn_element_id = $t_element->getPrimaryKey();
} else {
$vn_element_id = null;
}
if (!isset(ca_attributes::$s_get_attributes_cache[$this->opn_table_num . '/' . $vn_row_id][$vn_element_id])) {
ca_attributes::prefetchAttributes($this->opo_db, $this->opn_table_num, $this->getRowIDsToPrefetch($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch')), $vn_element_id ? array($vn_element_id) : null, array('dontFetchAlreadyCachedValues' => true));
}
if (!$vb_return_as_array && !$vb_return_all_locales) {
// return scalar
//
// Handle "hierarchy" modifier on list elements
//
if ($va_hier = $this->_getElementHierarchy($t_instance, $va_path_components)) {
return join($vs_hierarchical_delimiter, $va_hier);
}
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && $va_path_components['field_name']) {
$vs_template = null;
if ($va_path_components['subfield_name']) {
$va_values = $t_instance->getAttributeDisplayValues($va_path_components['field_name'], $vn_row_id, $pa_options);
$va_value_list = array();
foreach ($va_values as $vn_id => $va_attr_val_list) {
foreach ($va_attr_val_list as $vn_value_id => $va_value_array) {
$va_value_list[] = $va_value_array[$va_path_components['subfield_name']];
}
}
return join(" ", $va_value_list);
} else {
if (isset($pa_options['template'])) {
$vs_template = $pa_options['template'];
}
}
unset($pa_options['template']);
if (!$vs_template) {
$vs_template = "^" . $va_path_components['subfield_name'] ? $va_path_components['subfield_name'] : $va_path_components['field_name'];
}
return $t_instance->getAttributesForDisplay($va_path_components['field_name'], $vs_template, array_merge(array('row_id' => $vn_row_id), $pa_options));
}
if ($t_element && !$va_path_components['subfield_name'] && $t_element->get('datatype') == 0) {
return $t_instance->getAttributesForDisplay($va_path_components['field_name'], $vs_template, array_merge($pa_options, array('row_id' => $vn_row_id)));
} else {
if (!$vs_template) {
return $t_instance->getRawValue($vn_row_id, $va_path_components['field_name'], $va_path_components['subfield_name'], ',', $pa_options);
} else {
return caProcessTemplateForIDs($vs_template, $va_path_components['table_name'], array($vn_row_id), array());
}
}
} else {
// return array
//
// Handle "hierarchy" modifier on list elements
//
if ($va_hier = $this->_getElementHierarchy($t_instance, $va_path_components)) {
return $va_hier;
}
$va_values = $t_instance->getAttributeDisplayValues($va_path_components['field_name'], $vn_row_id, $pa_options);
if ($vs_template && !$vb_return_all_locales) {
$va_values_tmp = array();
foreach ($va_values as $vn_i => $va_value_list) {
foreach ($va_value_list as $vn_attr_id => $va_attr_data) {
$va_values_tmp[] = caProcessTemplateForIDs($vs_template, $va_path_components['table_name'], array($vn_row_id), array_merge($pa_options, array('placeholderPrefix' => $va_path_components['field_name'])));
}
}
$va_values = $va_values_tmp;
} else {
if ($va_path_components['subfield_name']) {
if ($vb_return_all_locales) {
foreach ($va_values as $vn_row_id => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_value_list) {
foreach ($va_value_list as $vn_attr_id => $va_attr_data) {
$va_values[$vn_row_id][$vn_locale_id][$vn_attr_id] = $va_attr_data[$va_path_components['subfield_name']];
}
}
}
} else {
$va_processed_value_list = array();
foreach ($va_values as $vn_row_id => $va_value_list) {
foreach ($va_value_list as $vn_attr_id => $va_attr_data) {
$va_processed_value_list[$vn_attr_id] = $va_attr_data[$va_path_components['subfield_name']];
}
}
$va_values = $va_processed_value_list;
}
} else {
if (!$vb_return_all_locales) {
$va_values = array_shift($va_values);
}
}
}
return $va_values;
}
} else {
// Prefetch intrinsic fields in primary and related tables
if (!isset($this->opa_prefetch_cache[$va_path_components['table_name']][$vn_row_id])) {
$this->prefetch($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch'), $pa_options);
// try to prefetch ahead (usually doesn't hurt and very often helps performance)
}
}
$va_return_values = array();
if ($va_path_components['table_name'] !== $this->ops_table_name && $va_path_components['field_name'] !== 'relationship_typename' && !$t_instance->hasField($va_path_components['field_name']) && method_exists($t_instance, 'getAttributes')) {
//
// Return metadata attributes in a related table
//
$vs_pk = $t_instance->primaryKey();
$vb_is_related = $this->ops_table_name !== $va_path_components['table_name'];
$va_ids = array();
$vs_opt_md5 = caMakeCacheKeyFromOptions($pa_options);
if (!isset($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5])) {
$this->prefetchRelated($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch'), $pa_options);
}
if (is_array($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5])) {
foreach ($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5] as $vn_i => $va_values) {
//$vn_locale_id => $va_values_by_locale) {
$va_ids[] = $va_values[$vs_pk];
if (!$vb_return_as_array) {
$vs_val = $t_instance->getAttributesForDisplay($va_path_components['field_name'], $vs_template, array_merge(array('row_id' => $va_values[$vs_pk]), $pa_options));
} else {
$vs_val = $t_instance->getAttributeDisplayValues($va_path_components['field_name'], $va_values[$vs_pk], $pa_options);
}
if ($vs_val) {
if ($vb_return_as_array) {
if (!$vb_return_all_locales) {
foreach ($vs_val as $vn_i => $va_values_list) {
foreach ($va_values_list as $vn_j => $va_values) {
$va_return_values[] = $va_values;
}
}
} else {
foreach ($vs_val as $vn_i => $va_values_list) {
$va_return_values[] = $va_values_list;
}
}
} else {
$va_return_values[] = $vs_val;
}
}
}
}
if ($vb_return_as_array || $vb_return_all_locales) {
// return array
if ($vb_return_as_link && $vb_is_related) {
$vs_table_name = $t_instance->tableName();
$vs_fld_key = $va_path_components['subfield_name'] ? $va_path_components['subfield_name'] : $va_path_components['field_name'];
if (!$vb_return_all_locales) {
$va_return_values_tmp = array();
foreach ($va_return_values as $vn_i => $va_value) {
if ($vs_template) {
$vs_value = caProcessTemplateForIDs($vs_template, $va_path_components['table_name'], array($va_ids[$vn_i][$vs_pk]), array('returnAsArray' => false));
} else {
$vs_value = $va_value[$vs_fld_key];
}
if ($vb_return_as_link) {
$va_return_values_tmp[$vn_i] = array_pop(caCreateLinksFromText(array($vs_value), $va_original_path_components['table_name'], array($va_ids[$vn_i]), $vs_return_as_link_class, $vs_return_as_link_target));
} else {
$va_return_values_tmp[$vn_i] = $vs_value;
}
}
$va_return_values = $va_return_values_tmp;
}
}
return $va_return_values;
} else {
// return scalar
if ($vb_return_as_link && $vb_is_related) {
$va_return_values = caCreateLinksFromText($va_return_values, $va_original_path_components['table_name'], $va_ids, $vs_return_as_link_class, $vs_return_as_link_target);
}
if (isset($pa_options['convertLineBreaks']) && $pa_options['convertLineBreaks']) {
return caConvertLineBreaks(join($vs_delimiter, $va_return_values));
} else {
return join($vs_delimiter, $va_return_values);
}
}
} else {
if ($vs_template) {
return caProcessTemplateForIDs($vs_template, $this->opo_subject_instance->tableName(), array($vn_row_id), array_merge($pa_options, array('placeholderPrefix' => $va_path_components['field_name'])));
}
//
// Return fields (intrinsics, labels) in primary or related table
//
$t_list = $this->opo_datamodel->getInstanceByTableName('ca_lists', true);
$va_value_list = array($vn_row_id => $this->opa_prefetch_cache[$va_path_components['table_name']][$vn_row_id]);
// Restrict to relationship types (related)
if (isset($pa_options['restrict_to_relationship_types']) && $pa_options['restrict_to_relationship_types']) {
if (!is_array($pa_options['restrict_to_relationship_types'])) {
$pa_options['restrict_to_relationship_types'] = array($pa_options['restrict_to_relationship_types']);
}
if (sizeof($pa_options['restrict_to_relationship_types'])) {
$t_rel_type = $this->opo_datamodel->getInstanceByTableName('ca_relationship_types', true);
$va_rel_types = array();
$va_rel_path = array_keys($this->opo_datamodel->getPath($this->ops_table_name, $va_path_components['table_name']));
foreach ($pa_options['restrict_to_relationship_types'] as $vm_type) {
if (!$vm_type) {
continue;
}
if ($vn_type_id = $t_rel_type->getRelationshipTypeID($va_rel_path[1], $vm_type)) {
$va_rel_types[] = $vn_type_id;
if (is_array($va_children = $t_rel_type->getHierarchyChildren($vn_type_id, array('idsOnly' => true)))) {
$va_rel_types = array_merge($va_rel_types, $va_children);
}
}
}
if (sizeof($va_rel_types)) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!$va_value['rel_type_id'] || in_array($va_value['rel_type_id'], $va_rel_types)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
}
}
// Exclude relationship types (related)
if (isset($pa_options['exclude_relationship_types']) && $pa_options['exclude_relationship_types']) {
if (!is_array($pa_options['exclude_relationship_types'])) {
$pa_options['exclude_relationship_types'] = array($pa_options['exclude_relationship_types']);
}
if (sizeof($pa_options['exclude_relationship_types'])) {
$t_rel_type = $this->opo_datamodel->getInstanceByTableName('ca_relationship_types', true);
$va_rel_types = array();
$va_rel_path = array_keys($this->opo_datamodel->getPath($this->ops_table_name, $va_path_components['table_name']));
foreach ($pa_options['exclude_relationship_types'] as $vm_type) {
if ($vn_type_id = $t_rel_type->getRelationshipTypeID($va_rel_path[1], $vm_type)) {
$va_rel_types[] = $vn_type_id;
if (is_array($va_children = $t_rel_type->getHierarchyChildren($vn_type_id, array('idsOnly' => true)))) {
$va_rel_types = array_merge($va_rel_types, $va_children);
}
}
}
if (sizeof($va_rel_types)) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!in_array($va_value['rel_type_id'], $va_rel_types)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
}
}
// Restrict to types (related)
$va_type_ids = $vs_type_fld = null;
if (method_exists($t_instance, "getTypeFieldName")) {
$va_type_ids = caMergeTypeRestrictionLists($t_instance, $pa_options);
$vs_type_fld = $t_instance->getTypeFieldName();
} else {
if (method_exists($t_instance, "getSubjectTableInstance")) {
$t_label_subj_instance = $t_instance->getSubjectTableInstance();
if (method_exists($t_label_subj_instance, "getTypeFieldName")) {
$va_type_ids = caMergeTypeRestrictionLists($t_label_subj_instance, $pa_options);
$vs_type_fld = 'item_type_id';
}
}
}
if (is_array($va_type_ids) && sizeof($va_type_ids)) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!$va_value[$vs_type_fld ? $vs_type_fld : 'item_type_id'] || in_array($va_value[$vs_type_fld ? $vs_type_fld : 'item_type_id'], $va_type_ids)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
// Restrict to sources (related)
$va_source_ids = $vs_source_id_fld = null;
if (method_exists($t_instance, "getSourceFieldName")) {
$va_source_ids = caMergeSourceRestrictionLists($t_instance, $pa_options);
$vs_source_id_fld = $t_instance->getSourceFieldName();
} else {
if (method_exists($t_instance, "getSubjectTableInstance")) {
$t_label_subj_instance = $t_instance->getSubjectTableInstance();
if (method_exists($t_label_subj_instance, "getSourceFieldName")) {
$va_source_ids = caMergeSourceRestrictionLists($t_label_subj_instance, $pa_options);
$vs_source_id_fld = 'item_source_id';
}
}
}
if (is_array($va_source_ids) && sizeof($va_source_ids)) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!$va_value[$vs_source_id_fld ? $vs_source_id_fld : 'item_source_id'] || in_array($va_value[$vs_source_id_fld ? $vs_source_id_fld : 'item_source_id'], $va_source_ids)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
// Exclude types (related)
if (isset($pa_options['exclude_type']) && $pa_options['exclude_type']) {
if (!isset($pa_options['exclude_types']) || !is_array($pa_options['exclude_types'])) {
$pa_options['exclude_types'] = array();
}
$pa_options['exclude_types'][] = $pa_options['exclude_type'];
}
if (isset($pa_options['exclude_types']) && is_array($pa_options['exclude_types'])) {
$va_ids = caMakeTypeIDList($va_path_components['table_name'], $pa_options['exclude_types']);
if (is_array($va_ids) && sizeof($va_ids) > 0) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!in_array($va_value[$vs_type_fld ? $vs_type_fld : 'item_type_id'], $va_type_ids)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
}
// Handle 'relationship_typename' (related)
$vb_get_relationship_typename = false;
if ($va_path_components['field_name'] == 'relationship_typename') {
$va_path_components['field_name'] = 'rel_type_id';
$vb_get_relationship_typename = true;
}
if ($vb_return_as_array) {
// return array (intrinsics or labels in primary or related table)
if ($t_instance->hasField($va_path_components['field_name']) && $va_path_components['table_name'] === $t_instance->tableName()) {
// Intrinsic
$va_field_info = $t_instance->getFieldInfo($va_path_components['field_name']);
$vs_pk = $t_original_instance->primaryKey();
// Handle specific intrinsic types
switch ($va_field_info['FIELD_TYPE']) {
case FT_DATERANGE:
case FT_HISTORIC_DATERANGE:
foreach ($va_value_list as $vn_id => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $va_value[$vs_pk];
if (caGetOption('GET_DIRECT_DATE', $pa_options, false) || caGetOption('getDirectDate', $pa_options, false)) {
if (caGetOption('sortable', $pa_options, false)) {
$vs_prop = $va_value[$va_field_info['START']] . '/' . $va_value[$va_field_info['END']];
} else {
$vs_prop = $va_value[$va_field_info['START']];
}
} else {
$this->opo_tep->init();
if ($va_field_info['FIELD_TYPE'] == FT_DATERANGE) {
$this->opo_tep->setUnixTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
} else {
$this->opo_tep->setHistoricTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
}
$vs_prop = $this->opo_tep->getText($pa_options);
}
if ($vb_return_all_locales) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $vs_prop;
} else {
$va_return_values[] = $vs_prop;
}
}
}
}
break;
case FT_MEDIA:
if (!($vs_version = $va_path_components['subfield_name'])) {
$vs_version = "largeicon";
}
foreach ($va_value_list as $vn_id => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $va_value[$vs_pk];
if (isset($pa_options['unserialize']) && $pa_options['unserialize']) {
$vs_prop = caUnserializeForDatabase($va_value[$va_path_components['field_name']]);
if ($vb_return_all_locales) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $vs_prop;
} else {
$va_return_values[] = $vs_prop;
}
} else {
$o_media_settings = new MediaProcessingSettings($va_path_components['table_name'], $va_path_components['field_name']);
$va_versions = $o_media_settings->getMediaTypeVersions('*');
if (!isset($va_versions[$vs_version])) {
$va_tmp = array_keys($va_versions);
$vs_version = array_shift($va_tmp);
}
// See if an info element was passed, eg. ca_object_representations.media.icon.width should return the width of the media rather than a tag or url to the media
$vs_info_element = $va_path_components['num_components'] == 4 ? $va_path_components['components'][3] : null;
if ($vb_return_all_locales) {
if ($vs_info_element) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $this->getMediaInfo($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $vs_info_element, $pa_options);
} elseif (isset($pa_options['returnURL']) && $pa_options['returnURL']) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $this->getMediaUrl($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
} else {
$va_return_values[$vn_row_id][$vn_locale_id][] = $this->getMediaTag($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
}
} else {
if ($vs_info_element) {
$va_return_values[] = $this->getMediaInfo($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $vs_info_element, $pa_options);
} elseif (isset($pa_options['returnURL']) && $pa_options['returnURL']) {
$va_return_values[] = $this->getMediaUrl($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
} else {
$va_return_values[] = $this->getMediaTag($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
}
}
}
}
}
}
break;
default:
// is intrinsic field in primary table
$vb_supports_preferred = (bool) $t_instance->hasField('is_preferred');
foreach ($va_value_list as $vn_id => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $vn_id = $va_value[$vs_pk];
if ($vb_get_preferred_labels_only && $vb_supports_preferred && !$va_value['is_preferred']) {
continue;
}
if ($vb_get_nonpreferred_labels_only && $vb_supports_preferred && $va_value['is_preferred']) {
continue;
}
$vs_prop = $va_value[$va_path_components['field_name']];
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST_CODE"))) {
$vs_prop = $t_list->getItemFromListForDisplayByItemID($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST"))) {
$vs_prop = $t_list->getItemFromListForDisplayByItemValue($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && $va_path_components['field_name'] === 'locale_id' && (int) $vs_prop > 0) {
$t_locale = new ca_locales($vs_prop);
$vs_prop = $t_locale->getName();
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && is_array($va_list = $t_instance->getFieldInfo($va_path_components['field_name'], "BOUNDS_CHOICE_LIST"))) {
foreach ($va_list as $vs_option => $vs_value) {
if ($vs_value == $vs_prop) {
$vs_prop = $vs_option;
break;
}
}
}
}
}
}
if ($vb_return_all_locales) {
$va_return_values[$vn_id][$vn_locale_id][] = $vs_prop;
} else {
$va_return_values[$vn_id][$vn_locale_id] = $vs_prop;
}
}
}
}
if (!$vb_return_all_locales) {
$va_return_values = array_values(caExtractValuesByUserLocale($va_return_values));
}
break;
}
} else {
// Attributes
$vs_pk = $t_original_instance->primaryKey();
$vb_is_related = $this->ops_table_name !== $va_path_components['table_name'];
$va_ids = array();
$t_instance = $this->opo_datamodel->getInstanceByTableName($va_path_components['table_name'], true);
foreach ($va_value_list as $vn_i => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if ($vb_is_related) {
$va_ids[] = $va_value[$vs_pk];
}
if ($vb_get_preferred_labels_only && !$va_value['is_preferred']) {
continue;
}
if ($vb_get_nonpreferred_labels_only && $va_value['is_preferred']) {
continue;
}
// do we need to translate foreign key and choice list codes to display text?
$vs_prop = $vb_return_all_label_values && !$vb_return_as_link ? $va_value : $va_value[$va_path_components['field_name']];
if ($vb_get_relationship_typename) {
if (!$t_rel_type) {
$t_rel_type = $this->opo_datamodel->getInstanceByTableName('ca_relationship_types', true);
}
if (is_array($va_labels = $t_rel_type->getDisplayLabels(false, array('row_id' => (int) $vs_prop)))) {
$va_label = array_shift($va_labels);
$vs_prop = $va_label[0]['typename'];
} else {
$vs_prop = "?";
}
} else {
// Decode list items to text
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST_CODE"))) {
$vs_prop = $t_list->getItemFromListForDisplayByItemID($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST"))) {
$vs_prop = $t_list->getItemFromListForDisplayByItemValue($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && $va_path_components['field_name'] === 'locale_id' && (int) $vs_prop > 0) {
$t_locale = new ca_locales($vs_prop);
$vs_prop = $t_locale->getName();
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && is_array($va_list = $t_instance->getFieldInfo($va_path_components['field_name'], "BOUNDS_CHOICE_LIST"))) {
foreach ($va_list as $vs_option => $vs_value) {
if ($vs_value == $vs_prop) {
$vs_prop = $vs_option;
break;
}
}
}
}
}
}
}
if ($vb_return_all_locales) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $vs_prop;
} else {
if ($vb_get_nonpreferred_labels_only && is_array($vs_prop)) {
// non-preferred labels are lists of lists because they can repeat
$va_return_values[][] = $vs_prop;
} else {
$va_return_values[] = $vs_prop;
}
}
}
}
}
}
if ($vb_return_as_link) {
if (!$vb_return_all_locales) {
$va_return_values = caCreateLinksFromText($va_return_values, $va_original_path_components['table_name'], $va_ids, $vs_return_as_link_class, $vs_return_as_link_target);
}
}
return $va_return_values;
} else {
// Return scalar (intrinsics or labels in primary or related table)
if ($vb_get_preferred_labels_only || $vb_get_nonpreferred_labels_only) {
// We have to distinguish between preferred and non-preferred labels here
// so that only appropriate labels are passed for output.
$va_filtered_values = array();
foreach ($va_value_list as $vn_label_id => $va_labels_by_locale) {
foreach ($va_labels_by_locale as $vn_locale_id => $va_labels) {
foreach ($va_labels as $vn_i => $va_label) {
if ($vb_get_preferred_labels_only && (!isset($va_label['is_preferred']) || $va_label['is_preferred']) || $vb_get_nonpreferred_labels_only && !$va_label['is_preferred']) {
$va_filtered_values[$vn_label_id][$vn_locale_id][] = $va_label;
}
}
}
}
$va_value_list = $va_filtered_values;
}
$va_value_list = caExtractValuesByUserLocale($va_value_list);
// do we need to translate foreign key and choice list codes to display text?
$t_instance = $this->opo_datamodel->getInstanceByTableName($va_path_components['table_name'], true);
$va_field_info = $t_instance->getFieldInfo($va_path_components['field_name']);
$vs_pk = $t_instance->primaryKey();
$vb_is_related = $this->ops_table_name !== $va_path_components['table_name'];
$va_ids = array();
foreach ($va_value_list as $vn_i => $va_values) {
if (!is_array($va_values)) {
continue;
}
// Handle specific intrinsic types
$vs_template_value = $vs_template;
foreach ($va_values as $vn_j => $va_value) {
switch ($va_field_info['FIELD_TYPE']) {
case FT_BIT:
if ($pa_options['convertCodesToDisplayText']) {
$va_value[$va_path_components['field_name']] = (bool) $vs_prop ? _t('yes') : _t('no');
}
break;
case FT_DATERANGE:
if (caGetOption('GET_DIRECT_DATE', $pa_options, false) || caGetOption('getDirectDate', $pa_options, false)) {
if (isset($pa_options['sortable']) && $pa_options['sortable']) {
$va_value[$va_path_components['field_name']] = $va_value[$va_field_info['START']] . '/' . $va_value[$va_field_info['END']];
} else {
$va_value[$va_path_components['field_name']] = $va_value[$va_field_info['START']];
}
} else {
$this->opo_tep->init();
$this->opo_tep->setUnixTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
$va_value[$va_path_components['field_name']] = $this->opo_tep->getText($pa_options);
}
break;
case FT_HISTORIC_DATERANGE:
if (caGetOption('GET_DIRECT_DATE', $pa_options, false) || caGetOption('getDirectDate', $pa_options, false)) {
if (caGetOption('sortable', $pa_options, false)) {
$va_value[$va_path_components['field_name']] = $va_value[$va_field_info['START']] . '/' . $va_value[$va_field_info['END']];
} else {
$va_value[$va_path_components['field_name']] = $va_value[$va_field_info['START']];
}
} else {
$this->opo_tep->init();
$this->opo_tep->setHistoricTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
$va_value[$va_path_components['field_name']] = $this->opo_tep->getText($pa_options);
}
break;
case FT_MEDIA:
if (!($vs_version = $va_path_components['subfield_name'])) {
$vs_version = "largeicon";
}
// See if an info element was passed, eg. ca_object_representations.media.icon.width should return the width of the media rather than a tag or url to the media
$vs_info_element = $va_path_components['num_components'] == 4 ? $va_path_components['components'][3] : null;
if (isset($pa_options['unserialize']) && $pa_options['unserialize']) {
return caUnserializeForDatabase($va_value[$va_path_components['field_name']]);
} else {
$o_media_settings = new MediaProcessingSettings($va_path_components['table_name'], $va_path_components['field_name']);
$va_versions = $o_media_settings->getMediaTypeVersions('*');
if (!isset($va_versions[$vs_version])) {
$va_tmp = array_keys($va_versions);
$vs_version = array_shift($va_tmp);
}
if ($vs_info_element) {
// Return media info
$va_value[$va_path_components['field_name']] = $this->getMediaInfo($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $vs_info_element, $pa_options);
} elseif (isset($pa_options['returnURL']) && $pa_options['returnURL']) {
$va_value[$va_path_components['field_name']] = $this->getMediaUrl($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
} else {
$va_value[$va_path_components['field_name']] = $this->getMediaTag($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
}
}
break;
default:
// noop
break;
}
$vs_prop = $va_value[$va_path_components['field_name']];
// Decode list items to text
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST_CODE"))) {
$va_value[$va_path_components['field_name']] = $t_list->getItemFromListForDisplayByItemID($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST"))) {
$va_value[$va_path_components['field_name']] = $t_list->getItemFromListForDisplayByItemValue($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && $va_path_components['field_name'] === 'locale_id' && (int) $vs_prop > 0) {
$t_locale = new ca_locales($vs_prop);
$va_value[$va_path_components['field_name']] = $t_locale->getName();
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && is_array($va_list = $t_instance->getFieldInfo($va_path_components['field_name'], "BOUNDS_CHOICE_LIST"))) {
foreach ($va_list as $vs_option => $vs_value) {
if ($vs_value == $vs_prop) {
$va_value[$va_path_components['field_name']] = $vs_option;
break;
}
}
}
}
}
}
$vs_pk = $this->opo_datamodel->getTablePrimaryKeyName($va_original_path_components['table_name']);
if ($vs_template) {
foreach ($va_value_list as $vn_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
$vs_prop = caProcessTemplateForIDs($vs_template, $va_original_path_components['table_name'], array($va_value[$vs_pk]), array('returnAsArray' => false));
$va_return_values[] = $vs_prop;
$va_ids[] = $va_value[$vs_pk];
}
}
} else {
$vs_prop = $va_value[$va_path_components['field_name']];
$va_return_values[] = $vs_prop;
if ($vb_is_related) {
$va_ids[] = $va_value[$vs_pk];
}
}
}
}
if ($vb_return_as_link && $vb_is_related) {
$va_return_values = caCreateLinksFromText($va_return_values, $va_original_path_components['table_name'], $va_ids, $vs_return_as_link_class, $vs_return_as_link_target);
}
if (isset($pa_options['convertLineBreaks']) && $pa_options['convertLineBreaks']) {
return caConvertLineBreaks(join($vs_delimiter, $va_return_values));
} else {
return join($vs_delimiter, $va_return_values);
}
}
}
return null;
}
