/app/models/ca_sets.php

Large files files are truncated, but you can click here to view the full file

<?php
/** ---------------------------------------------------------------------
 * app/models/ca_sets.php : table access class for table ca_sets
 * ----------------------------------------------------------------------
 * CollectiveAccess
 * Open-source collections management software
 * ----------------------------------------------------------------------
 *
 * Software by Whirl-i-Gig (http://www.whirl-i-gig.com)
 * Copyright 2009-2011 Whirl-i-Gig
 *
 * For more information visit http://www.CollectiveAccess.org
 *
 * This program is free software; you may redistribute it and/or modify it under
 * the terms of the provided license as published by Whirl-i-Gig
 *
 * CollectiveAccess is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTIES whatsoever, including any implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
 *
 * This source code is free and modifiable under the terms of 
 * GNU General Public License. (http://www.gnu.org/copyleft/gpl.html). See
 * the "license.txt" file for details, or visit the CollectiveAccess web site at
 * http://www.CollectiveAccess.org
 * 
 * @package CollectiveAccess
 * @subpackage models
 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License version 3
 * 
 * ----------------------------------------------------------------------
 */
 
 /**
   *
   */

require_once(__CA_LIB_DIR__."/ca/IBundleProvider.php");
require_once(__CA_LIB_DIR__."/ca/BundlableLabelableBaseModelWithAttributes.php");
require_once(__CA_APP_DIR__.'/models/ca_set_items.php');
require_once(__CA_APP_DIR__.'/models/ca_users.php');
require_once(__CA_APP_DIR__.'/helpers/htmlFormHelpers.php');

define('__CA_SET_NO_ACCESS__', 0);
define('__CA_SET_READ_ACCESS__', 1);
define('__CA_SET_EDIT_ACCESS__', 2);

BaseModel::$s_ca_models_definitions['ca_sets'] = array(
 	'NAME_SINGULAR' 	=> _t('set'),
 	'NAME_PLURAL' 		=> _t('sets'),
 	'FIELDS' 			=> array(
 		'set_id' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_HIDDEN, 
				'IDENTITY' => true, 'DISPLAY_WIDTH' => 10, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => false, 
				'DEFAULT' => '',
				'LABEL' => _t('CollectiveAccess id'), 'DESCRIPTION' => _t('Unique numeric identifier used by CollectiveAccess internally to identify this set')
		),
		'parent_id' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_OMIT, 
				'DISPLAY_WIDTH' => 10, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => true, 
				'DEFAULT' => '',
				'LABEL' => 'Parent id', 'DESCRIPTION' => 'Identifier of parent set; is null if set is root of hierarchy.'
		),
		'hier_set_id' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_OMIT, 
				'DISPLAY_WIDTH' => 10, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => false, 
				'DEFAULT' => '',
				'LABEL' => 'Set hierarchy', 'DESCRIPTION' => 'Identifier of set that is root of the set hierarchy.'
		),
		'user_id' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_OMIT, 
				'DISPLAY_WIDTH' => 40, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => true, 
				'DISPLAY_FIELD' => array('ca_users.lname', 'ca_users.fname'),
				'DEFAULT' => '',
				'LABEL' => _t('User'), 'DESCRIPTION' => _t('The user who created the set.')
		),
		'table_num' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_SELECT, 
				'DISPLAY_WIDTH' => 40, 'DISPLAY_HEIGHT' => 1,
				'DONT_USE_AS_BUNDLE' => true,
				'IS_NULL' => false, 
				'DEFAULT' => '',
				'LABEL' => _t('Set content'), 'DESCRIPTION' => _t('Determines what kind of items (objects, entities, places, etc.) are stored by the set.'),
				'BOUNDS_CHOICE_LIST' => array(
					_t('Objects') => 57,
					_t('Object lots') => 51,
					_t('Entities') => 20,
					_t('Places') => 72,
					_t('Occurrences') => 67,
					_t('Collections') => 13,
					_t('Storage locations') => 89,
					_t('Object representations') => 56
				),
				'BOUNDS_LENGTH' => array(1,100)
		),
		'type_id' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_SELECT, 
				'DISPLAY_WIDTH' => 10, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => false, 
				'DEFAULT' => '',
				'LIST_CODE' => 'set_types',
				'LABEL' => _t('Type'), 'DESCRIPTION' => _t('The type of the set determines what sorts of information the set and each item in the set can have associated with them.')
		),
		'set_code' => array(
				'FIELD_TYPE' => FT_TEXT, 'DISPLAY_TYPE' => DT_FIELD, 
				'DISPLAY_WIDTH' => 40, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => true, 
				'DEFAULT' => '',
				'LABEL' => _t('Set code'), 'DESCRIPTION' => _t('A unique alphanumeric code for this set. You will need to specify this if you are using this set in a special context (on a web front-end, for example) in which the set must be unambiguously identified.'),
				'BOUNDS_LENGTH' => array(0, 100),
				'UNIQUE_WITHIN' => array()
		),
		'access' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_SELECT, 
				'DISPLAY_WIDTH' => 40, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => false, 
				'DEFAULT' => 0,
				'BOUNDS_CHOICE_LIST' => array(
					_t('Not accessible to public') => 0,
					_t('Accessible to public') => 1
				),
				'LIST' => 'access_statuses',
				'LABEL' => _t('Access'), 'DESCRIPTION' => _t('Indicates if object is accessible to the public or not. ')
		),
		'status' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_SELECT, 
				'DISPLAY_WIDTH' => 40, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => false, 
				'DEFAULT' => 0,
				'BOUNDS_CHOICE_LIST' => array(
					_t('Newly created') => 0,
					_t('Editing in progress') => 1,
					_t('Editing complete - pending review') => 2,
					_t('Review in progress') => 3,
					_t('Completed') => 4
				),
				'LIST' => 'workflow_statuses',
				'LABEL' => _t('Status'), 'DESCRIPTION' => _t('Indicates the current state of the object record.')
		),
		'hier_left' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_OMIT, 
				'DISPLAY_WIDTH' => 10, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => false, 
				'DEFAULT' => '',
				'LABEL' => 'Hierarchical index - left bound', 'DESCRIPTION' => 'Left-side boundary for nested set-style hierarchical indexing; used to accelerate search and retrieval of hierarchical record sets.'
		),
		'hier_right' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_OMIT, 
				'DISPLAY_WIDTH' => 10, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => false, 
				'DEFAULT' => '',
				'LABEL' => 'Hierarchical index - right bound', 'DESCRIPTION' => 'Right-side boundary for nested set-style hierarchical indexing; used to accelerate search and retrieval of hierarchical record sets.'
		),
		'rank' => array(
				'FIELD_TYPE' => FT_NUMBER, 'DISPLAY_TYPE' => DT_FIELD, 
				'DISPLAY_WIDTH' => 10, 'DISPLAY_HEIGHT' => 1,
				'IS_NULL' => false, 
				'DEFAULT' => '',
				'LABEL' => _t('Sort order'), 'DESCRIPTION' => _t('Sort order'),
		)
 	)
);

class ca_sets extends BundlableLabelableBaseModelWithAttributes implements IBundleProvider {
	# ---------------------------------
	# --- Object attribute properties
	# ---------------------------------
	# Describe structure of content object's properties - eg. database fields and their
	# associated types, what modes are supported, et al.
	#

	# ------------------------------------------------------
	# --- Basic object parameters
	# ------------------------------------------------------
	# what table does this class represent?
	protected $TABLE = 'ca_sets';
	      
	# what is the primary key of the table?
	protected $PRIMARY_KEY = 'set_id';

	# ------------------------------------------------------
	# --- Properties used by standard editing scripts
	# 
	# These class properties allow generic scripts to properly display
	# records from the table represented by this class
	#
	# ------------------------------------------------------

	# Array of fields to display in a listing of records from this table
	protected $LIST_FIELDS = array('user_id');

	# When the list of "list fields" above contains more than one field,
	# the LIST_DELIMITER text is displayed between fields as a delimiter.
	# This is typically a comma or space, but can be any string you like
	protected $LIST_DELIMITER = ' ';

	# What you'd call a single record from this table (eg. a "person")
	protected $NAME_SINGULAR;

	# What you'd call more than one record from this table (eg. "people")
	protected $NAME_PLURAL;

	# List of fields to sort listing of records by; you can use 
	# SQL 'ASC' and 'DESC' here if you like.
	protected $ORDER_BY = array('user_id');

	# Maximum number of record to display per page in a listing
	protected $MAX_RECORDS_PER_PAGE = 20; 

	# How do you want to page through records in a listing: by number pages ordered
	# according to your setting above? Or alphabetically by the letters of the first
	# LIST_FIELD?
	protected $PAGE_SCHEME = 'alpha'; # alpha [alphabetical] or num [numbered pages; default]

	# If you want to order records arbitrarily, add a numeric field to the table and place
	# its name here. The generic list scripts can then use it to order table records.
	protected $RANK = 'rank';
	
	
	# ------------------------------------------------------
	# Hierarchical table properties
	# ------------------------------------------------------
	protected $HIERARCHY_TYPE				=	__CA_HIER_TYPE_ADHOC_MONO__;
	protected $HIERARCHY_LEFT_INDEX_FLD 	= 	'hier_left';
	protected $HIERARCHY_RIGHT_INDEX_FLD 	= 	'hier_right';
	protected $HIERARCHY_PARENT_ID_FLD		=	'parent_id';
	protected $HIERARCHY_DEFINITION_TABLE	=	'ca_sets';
	protected $HIERARCHY_ID_FLD				=	'hier_set_id';
	protected $HIERARCHY_POLY_TABLE			=	null;
	
	# ------------------------------------------------------
	# Change logging
	# ------------------------------------------------------
	protected $UNIT_ID_FIELD = null;
	protected $LOG_CHANGES_TO_SELF = true;
	protected $LOG_CHANGES_USING_AS_SUBJECT = array(
		"FOREIGN_KEYS" => array(
		
		),
		"RELATED_TABLES" => array(
		
		)
	);
	
	# ------------------------------------------------------
	# Group-based access control
	# ------------------------------------------------------
	protected $USERS_RELATIONSHIP_TABLE = 'ca_sets_x_users';
	protected $USER_GROUPS_RELATIONSHIP_TABLE = 'ca_sets_x_user_groups';
	
	# ------------------------------------------------------
	# Labels
	# ------------------------------------------------------
	protected $LABEL_TABLE_NAME = 'ca_set_labels';
	
	# ------------------------------------------------------
	# Attributes
	# ------------------------------------------------------
	protected $ATTRIBUTE_TYPE_ID_FLD = 'type_id';			// name of type field for this table - attributes system uses this to determine via ca_metadata_type_restrictions which attributes are applicable to rows of the given type
	protected $ATTRIBUTE_TYPE_LIST_CODE = 'set_types';		// list code (ca_lists.list_code) of list defining types for this table

	# ------------------------------------------------------
	# ID numbering
	# ------------------------------------------------------
	protected $ID_NUMBERING_ID_FIELD = 'set_code';		// name of field containing user-defined identifier
	protected $ID_NUMBERING_SORT_FIELD = null;			// name of field containing version of identifier for sorting (is normalized with padding to sort numbers properly)
	protected $ID_NUMBERING_CONTEXT_FIELD = null;		// name of field to use value of for "context" when checking for duplicate identifier values; if not set identifer is assumed to be global in scope; if set identifer is checked for uniqueness (if required) within the value of this field

	
	# ------------------------------------------------------
	# $FIELDS contains information about each field in the table. The order in which the fields
	# are listed here is the order in which they will be returned using getFields()

	protected $FIELDS;
	
	# cache for haveAccessToSet()
	static $s_have_access_to_set_cache = array();
	
	# ------------------------------------------------------
	# --- Constructor
	#
	# This is a function called when a new instance of this object is created. This
	# standard constructor supports three calling modes:
	#
	# 1. If called without parameters, simply creates a new, empty objects object
	# 2. If called with a single, valid primary key value, creates a new objects object and loads
	#    the record identified by the primary key value
	#
	# ------------------------------------------------------
	public function __construct($pn_id=null) {
		// Filter list of tables set can be used for to those enabled in current config
		BaseModel::$s_ca_models_definitions['ca_sets']['FIELDS']['table_num']['BOUNDS_CHOICE_LIST'] = caFilterTableList(BaseModel::$s_ca_models_definitions['ca_sets']['FIELDS']['table_num']['BOUNDS_CHOICE_LIST']);
		
		parent::__construct($pn_id);	# call superclass constructor
	}
	# ------------------------------------------------------
	/**
	 *
	 */
	protected function initLabelDefinitions() {
		parent::initLabelDefinitions();
		$this->BUNDLES['ca_users'] = array('type' => 'special', 'repeating' => true, 'label' => _t('User access'));
		$this->BUNDLES['ca_user_groups'] = array('type' => 'special', 'repeating' => true, 'label' => _t('Group access'));
		$this->BUNDLES['ca_set_items'] = array('type' => 'special', 'repeating' => true, 'label' => _t('Set items'));
	}
	# ------------------------------------------------------
	/**
	 * Overrides default implementation with code to ensure consistency of set contents
	 */
	public function update($pa_options=null) {
		if ($vn_rc = parent::update($pa_options)) {
			// make sure all items have the same type as the set
			$this->getDb()->query("
				UPDATE ca_set_items
				SET type_id = ?
				WHERE
					set_id = ?
			", (int)$this->get('type_id'), (int)$this->getPrimaryKey());
		}
		return $vn_rc;
	}
	# ------------------------------------------------------
	/** 
	 * Override set() to reject changes to user_id for existing rows
	 */
	public function set($pa_fields, $pm_value="", $pa_options=null) {
		if ($this->getPrimaryKey()) {
			if (is_array($pa_fields)) {
				if (isset($pa_fields['user_id'])) { unset($pa_fields['user_id']); }
				if (isset($pa_fields['table_num'])) { unset($pa_fields['table_num']); }
			} else {
				if ($pa_fields === 'user_id') { return false; }
				if ($pa_fields === 'table_num') { return false; }
			}
		}
		return parent::set($pa_fields, $pm_value, $pa_options);
	}
	# ------------------------------------------------------
	/**
	 * @param array $pa_options
	 *		duplicate_subitems
	 */
	public function duplicate($pa_options=null) {
		$vb_we_set_transaction = false;
		if (!$this->inTransaction()) {
			$this->setTransaction($o_t = new Transaction($this->getDb()));
			$vb_we_set_transaction = true;
		} else {
			$o_t = $this->getTransaction();
		}
		
		if ($t_dupe = parent::duplicate($pa_options)) {
			$vb_duplicate_subitems = isset($pa_options['duplicate_subitems']) && $pa_options['duplicate_subitems'];
		
			if ($vb_duplicate_subitems) { 
				// Try to dupe related ca_set_items rows
				$o_db = $this->getDb();
				
				$qr_res = $o_db->query("
					SELECT *
					FROM ca_set_items
					WHERE set_id = ?
				", (int)$this->getPrimaryKey());
				
				$va_items = array();
				while($qr_res->nextRow()) {
					$va_items[$qr_res->get('item_id')] = $qr_res->getRow();
				}
				
				foreach($va_items as $vn_item_id => $va_item) {
					$t_item = new ca_set_items();
					$t_item->setMode(ACCESS_WRITE);
					$va_item['set_id'] = $t_dupe->getPrimaryKey();
					$t_item->set($va_item);
					$t_item->insert();
					
					if ($t_item->numErrors()) {
						$this->errors = $t_item->errors;
						if ($vb_we_set_transaction) { $this->removeTransaction(false);}
						return false;
					}
				}
			}
		}
		
		
		if ($vb_we_set_transaction) { $this->removeTransaction(true);}
		return $t_dupe;
	}
	# ------------------------------------------------------
	# Set lists
	# ------------------------------------------------------
	/**
	 * Returns list of sets subject to options
	 *
	 * @param array $pa_options Array of options. Supported options are:
	 *			table - if set, list is restricted to sets that can contain the specified item. You can pass a table name or number. If omitted sets containing any content will be returned.
	 *			setType - Restricts returned sets to those of the specified type. You can pass a type_id or list item code for the set type. If omitted sets are returned regardless of type.
	 *			user_id - Restricts returned sets to those accessible by the current user. If omitted then all sets, regardless of access are returned.
	 *			access - Restricts returned sets to those with at least the specified access level for the specified user. If user_id is omitted then this option has no effect. If user_id is set and this option is omitted, then sets where the user has at least read access will be returned. 
	 *			checkAccess - Restricts returned sets to those with an public access level with the specified values. If omitted sets are returned regardless of public access (ca_sets.access) value. Can be a single value or array if you wish to filter on multiple public access values.
	 *			row_id = if set to an integer only sets containing the specified row are returned
	 *			setIDsOnly = if set to true only set_id values are returned, in a simple array
	 * @return array A list of sets keyed by set_id and then locale_id. Keys for the per-locale value array include: set_id, set_code, status, public access, owner user_id, content table_num, set type_id, set name, number of items in the set (item_count), set type name for display and set content type name for display. If setIDsOnly option is set then a simple array of set_id values is returned instead.
	 */
	public function getSets($pa_options=null) {
		if (!is_array($pa_options)) { $pa_options = array(); }
		$pm_table_name_or_num = isset($pa_options['table']) ? $pa_options['table'] : null;
		$pm_type = isset($pa_options['setType']) ? $pa_options['setType'] : null;
		$pn_user_id = isset($pa_options['user_id']) ? (int)$pa_options['user_id'] : null;
		$pn_access = isset($pa_options['access']) ? $pa_options['access'] : null;
		$pb_set_ids_only = isset($pa_options['setIDsOnly']) ? (bool)$pa_options['setIDsOnly'] : false;
		
		$pn_row_id = (isset($pa_options['row_id']) && ((int)$pa_options['row_id'])) ? (int)$pa_options['row_id'] : null;
		
		$pa_public_access = isset($pa_options['checkAccess']) ? $pa_options['checkAccess'] : null;
		if ($pa_public_access && is_numeric($pa_public_access) && !is_array($pa_public_access)) {
			$pa_public_access = array($pa_public_access);
		}
		for($vn_i=0; $vn_i < sizeof($pa_public_access); $vn_i++) { $pa_public_access[$vn_i] = intval($pa_public_access[$vn_i]); }
		
		
		if ($pm_table_name_or_num && !($vn_table_num = $this->_getTableNum($pm_table_name_or_num))) { return null; }
		
		$va_extra_joins = array();
		$o_db = $this->getDb();
		
		$va_sql_wheres = array();
		if ($vn_table_num) {
			$va_sql_wheres[] = "(cs.table_num = ".intval($vn_table_num).")";
		}
		
		if ($pb_set_ids_only) {
			$va_sql_selects = array('cs.set_id');
		} else {
			$va_sql_selects = array(
				'cs.set_id', 'cs.set_code', 'cs.status', 'cs.access', 'cs.user_id', 'cs.table_num', 'cs.type_id',
				'csl.label_id', 'csl.name', 'csl.locale_id', 'l.language', 'l.country', 'u.fname', 'u.lname', 'u.email'
			);
		}
		
		if ($pn_user_id) {
			$o_dm = $this->getAppDatamodel();
			$t_user = $o_dm->getInstanceByTableName('ca_users', true);
			$t_user->load($pn_user_id);
			
			if ($t_user->getPrimaryKey()) {
				$vs_access_sql = ($pn_access > 0) ? " AND (access >= ".intval($pn_access).")" : "";
				if (is_array($va_groups = $t_user->getUserGroups()) && sizeof($va_groups)) {
					$vs_sql = "(
						(cs.user_id = ".intval($pn_user_id).") OR 
						(cs.set_id IN (
								SELECT set_id 
								FROM ca_sets_x_user_groups 
								WHERE 
									group_id IN (".join(',', array_keys($va_groups)).") {$vs_access_sql}
									AND
									(
										 (sdatetime IS NULL AND edatetime IS NULL)
										 OR 
										 (
										 	sdatetime <= ".time()." AND edatetime >= ".time()."
										 )
									)
							)
						)
					)";
				} else {
					$vs_sql = "(cs.user_id = {$pn_user_id})";
				}
				
				$vs_sql .= " OR (cs.set_id IN (
										SELECT set_id 
										FROM ca_sets_x_users 
										WHERE 
											user_id = {$pn_user_id} {$vs_access_sql}
											AND
											(
												 (sdatetime IS NULL AND edatetime IS NULL)
												 OR 
												 (
													sdatetime <= ".time()." AND edatetime >= ".time()."
												 )
											)
									)
								)";
				
				
				$va_sql_wheres[] = "({$vs_sql})";
			}
		}
		
		if (!is_null($pa_public_access) && is_array($pa_public_access) && sizeof($pa_public_access)) {
			$va_sql_wheres[] = "(cs.access IN (".join(', ', $pa_public_access)."))";
		}
		
		if (isset($pm_type) && $pm_type) {
			if(is_numeric($pm_type)){
				$va_sql_wheres[] = "(cs.type_id = ".intval($pm_type).")";
			}else{
				# --- look up code of set type
				$t_list = new ca_lists();
				$vn_type_id = $t_list->getItemIDFromList("set_types", $pm_type);
				if($vn_type_id){
					$va_sql_wheres[] = "(cs.type_id = {$vn_type_id})";
				}
			}
		}
		
		if ($pn_row_id > 0) {
			$va_sql_wheres[] = "((csi.row_id = {$pn_row_id}) AND (csi.table_num = {$vn_table_num}))";
			$va_extra_joins[] = "INNER JOIN ca_set_items AS csi ON cs.set_id = csi.set_id";
			$va_sql_selects[] = 'csi.item_id';
		}
		
		if (!$pb_set_ids_only) {
			// get set item counts
			$qr_res = $o_db->query("
				SELECT cs.set_id, count(*) item_count
				FROM ca_sets cs
				INNER JOIN ca_set_items AS csi ON cs.set_id = csi.set_id
				".(sizeof($va_sql_wheres) ? 'WHERE ' : '')."
				".join(' AND ', $va_sql_wheres)."
				GROUP BY cs.set_id
			");
			$va_item_counts = array();
			while($qr_res->nextRow()) {
				$va_item_counts[(int)$qr_res->get('set_id')] = (int)$qr_res->get('item_count');
			}
		
		
			// get sets
			$qr_res = $o_db->query("
				SELECT ".join(', ', $va_sql_selects)."
				FROM ca_sets cs
				LEFT JOIN ca_set_labels AS csl ON cs.set_id = csl.set_id
				LEFT JOIN ca_locales AS l ON csl.locale_id = l.locale_id
				INNER JOIN ca_users AS u ON cs.user_id = u.user_id
				".join("\n", $va_extra_joins)."
				".(sizeof($va_sql_wheres) ? 'WHERE ' : '')."
				".join(' AND ', $va_sql_wheres)."
				ORDER BY csl.name
			");
			$va_sets = array();
			$o_dm = $this->getAppDatamodel();
			$va_type_name_cache = array();
			
			$t_list = new ca_lists();
			while($qr_res->nextRow()) {
				$vn_table_num = $qr_res->get('table_num');
				if (!isset($va_type_name_cache[$vn_table_num]) || !($vs_set_type = $va_type_name_cache[$vn_table_num])) {
					$vs_set_type = $va_type_name_cache[$vn_table_num] = $this->getSetContentTypeName($vn_table_num, array('number' => 'plural'));
				}
				
				$vs_type = $t_list->getItemFromListForDisplayByItemID('set_types', $qr_res->get('type_id'));
				
				$va_sets[$qr_res->get('set_id')][$qr_res->get('locale_id')] = array_merge($qr_res->getRow(), array('item_count' => intval($va_item_counts[$qr_res->get('set_id')]), 'set_content_type' => $vs_set_type, 'set_type' => $vs_type));
			}
			return $va_sets;
		} else {
			// get sets
			$qr_res = $o_db->query("
				SELECT ".join(', ', $va_sql_selects)."
				FROM ca_sets cs
				INNER JOIN ca_users AS u ON cs.user_id = u.user_id
				".join("\n", $va_extra_joins)."
				".(sizeof($va_sql_wheres) ? 'WHERE ' : '')."
				".join(' AND ', $va_sql_wheres)."
			");
			
			return $qr_res->getAllFieldValues("set_id");
		}
	}
	# ------------------------------------------------------
	/**
	 * Returns list of sets to which the item (as specified by $pm_table_name_or_num and $pn_row_id) can be associated and is not already part of.
	 *
	 * @param mixed $pm_table_name_or_num Name or number of table
	 * @param int $pn_row_id ID of row in table specified by $pm_table_name_or_num to check for
	 * @param array $pa_options Optional list of options. Supported options are the same as those for ca_sets::getSets() and ca_sets::getSetsForItem()
	 * @return array A list of sets keyed by set_id and then locale_id. Keys for the per-locale value array include: set_id, set_code, status, public access, owner user_id, content table_num, set type_id, set name, number of items in the set (item_count), set type name for display and set content type name for display. This is the same format as returned by ca_sets::getSets().
	 */
	public function getAvailableSetsForItem($pm_table_name_or_num, $pn_row_id, $pa_options=null) {
		if (!is_array($pa_options)) { $pa_options = array(); }
		if (!($va_full_set_list = $this->getSets(array_merge(array('table' => $pm_table_name_or_num), $pa_options)))) { return null; }
		if (!($va_current_set_list = $this->getSetsForItem($pm_table_name_or_num, $pn_row_id, $pa_options))) { return null; }
		
		$va_available_sets = array();
		foreach($va_full_set_list as $vn_set_id => $va_set_info_by_locale) {
			if (isset($va_current_set_list[$vn_set_id]) && $va_current_set_list[$vn_set_id]) { continue;}
			$va_available_sets[$vn_set_id] = $va_set_info_by_locale;
		}
		
		return $va_available_sets;
	}
	# ------------------------------------------------------
	/**
	 * Returns list of sets in which the specified item is a member
	 *
	 * @param mixed $pm_table_name_or_num Name or number of table
	 * @param int $pn_row_id ID of row in table specified by $pm_table_name_or_num to check for
	 * @param array $pa_options Optional list of options. Supported options are the same as those for ca_sets::getSets() and ca_sets::getSetsForItem()
	 * @return array A list of sets keyed by set_id and then locale_id. Keys for the per-locale value array include: set_id, set_code, status, public access, owner user_id, content table_num, set type_id, set name, number of items in the set (item_count), set type name for display and set content type name for display. This is the same format as returned by ca_sets::getSets().
	 */
	public function getSetsForItem($pm_table_name_or_num, $pn_row_id, $pa_options=null) {
		if (!is_array($pa_options)) { $pa_options = array(); }
		if (!$pn_row_id) { return array(); }
		return $this->getSets(array_merge($pa_options, array('table' => $pm_table_name_or_num, 'row_id' => $pn_row_id)));
	}
	# ------------------------------------------------------
	/**
	  * Returns list of set_ids of sets in which the specified item is a member
	 *
	 * @param mixed $pm_table_name_or_num Name or number of table
	 * @param int $pn_row_id ID of row in table specified by $pm_table_name_or_num to check for
	 * @param array $pa_options Optional list of options. Supported options are the same as those for ca_sets::getSets() and ca_sets::getSetsForItem()
	 * @return array A list of set_ids, or null if parameters are invalid
	 */
	public function getSetIDsForItem($pm_table_name_or_num, $pn_row_id, $pa_options=null) {
		if (is_array($va_sets = $this->getSetsForItem($pm_table_name_or_num, $pn_row_id, $pa_options))) {
			return array_keys($va_sets);
		}
		return null;
	}
	# ------------------------------------------------------
	/**
	 * Checks if a row of a table is in a set.
	 *
	 * @param mixed $pm_table_name_or_num Name or number of table
	 * @param int $pn_row_id ID of row in table specified by $pm_table_name_or_num to check for
	 * @param mixed $pm_set_code_or_id Set code or set_id of set to check for item
	 * @return bool True if row is in set, false if now. If the table or set are invalid null will be returned.
	 */
	public function isInSet($pm_table_name_or_num, $pn_row_id, $pm_set_code_or_id) {
		if (!($vn_table_num = $this->_getTableNum($pm_table_name_or_num))) { return null; }
		if (!($vn_set_id = $this->_getSetID($pm_set_code_or_id))) { return null; }
		$o_db = $this->getDb();
		
		$qr_res = $o_db->query("
			SELECT cs.set_id
			FROM ca_sets cs
			INNER JOIN ca_set_items AS csi ON cs.set_id = csi.set_id
			WHERE
				(cs.set_id = ?) AND (csi.row_id = ?) AND (cs.table_num = ?)
		", (int)$vn_set_id, (int)$pn_row_id, (int)$vn_table_num);
		
		if ($qr_res->numRows() > 0) {
			return true;
		}
		
		return false;
	}
	# ------------------------------------------------------
	/**
	 * Returns a random set_id from a group defined by specified options. These options are the same as those for ca_sets::getSets()
	 *
	 * @param array $pa_options Array of options. Supported options are:
	 *			table - if set, list is restricted to sets that can contain the specified item. You can pass a table name or number. If omitted sets containing any content will be returned.
	 *			setType - Restricts returned sets to those of the specified type. You can pass a type_id or list item code for the set type. If omitted sets are returned regardless of type.
	 *			user_id - Restricts returned sets to those accessible by the current user. If omitted then all sets, regardless of access are returned.
	 *			access - Restricts returned sets to those with at least the specified access level for the specified user. If user_id is omitted then this option has no effect. If user_id is set and this option is omitted, then sets where the user has at least read access will be returned. 
	 *			checkAccess - Restricts returned sets to those with an public access level with the specified values. If omitted sets are returned regardless of public access (ca_sets.access) value. Can be a single value or array if you wish to filter on multiple public access values.
	 *			row_id = if set to an integer only sets containing the specified row are returned
	 * @return int A randomly selected set_id value
	 */
	public function getRandomSetID($pa_options=null) {
		$va_set_ids = $this->getSets(array_merge($pa_options, array('setIDsOnly' => true)));
		
		return $va_set_ids[rand(0, sizeof($va_set_ids) - 1)];
	}
	# ------------------------------------------------------
	/**
	 * Determines if user has access to a set at a specified access level.
	 *
	 * @param int $pn_user_id user_id of user to check set access for
	 * @param int $pn_access type of access required. Use __CA_SET_READ_ACCESS__ for read-only access or __CA_SET_EDIT_ACCESS__ for editing (full) access
	 * @param int $pn_set_id The id of the set to check. If omitted then currently loaded set will be checked.
	 * @return bool True if user has access, false if not
	 */
	public function haveAccessToSet($pn_user_id, $pn_access, $pn_set_id=null) {
		if ($pn_set_id) { 
			$vn_set_id = $pn_set_id; 
			$t_set = new ca_sets($vn_set_id);
			$vn_set_user_id = $t_set->get('user_id');
		} else {
			$vn_set_user_id = $this->get('user_id');
		}
		if(!$vn_set_id && !($vn_set_id = $this->getPrimaryKey())) { 
			return true; // new set
		}
		if (isset(ca_sets::$s_have_access_to_set_cache[$vn_set_id.'/'.$pn_user_id.'/'.$pn_access])) {
			return ca_sets::$s_have_access_to_set_cache[$vn_set_id.'/'.$pn_user_id.'/'.$pn_access];
		}
		
		if (($vn_set_user_id == $pn_user_id)) {	// owners have all access
			return ca_sets::$s_have_access_to_set_cache[$vn_set_id.'/'.$pn_user_id.'/'.$pn_access] = true;
		}
		
		if (($this->get('access') > 0) && ($pn_access == __CA_SET_READ_ACCESS__)) {	 // public sets are readable by all
			return ca_sets::$s_have_access_to_set_cache[$vn_set_id.'/'.$pn_user_id.'/'.$pn_access] = true; 
		}
		
		$o_db =  $this->getDb();
		$qr_res = $o_db->query($vs_sql="
			SELECT sxg.set_id 
			FROM ca_sets_x_user_groups sxg 
			INNER JOIN ca_user_groups AS ug ON sxg.group_id = ug.group_id
			INNER JOIN ca_users_x_groups AS uxg ON uxg.group_id = ug.group_id
			WHERE 
				(sxg.access >= ?) AND (uxg.user_id = ?) AND (sxg.set_id = ?)
				AND
				(
					(sxg.sdatetime <= ".time()." AND sxg.edatetime >= ".time().")
					OR
					(sxg.sdatetime IS NULL and sxg.edatetime IS NULL)
				)
		", (int)$pn_access, (int)$pn_user_id, (int)$vn_set_id);
		
		if ($qr_res->numRows() > 0) { return ca_sets::$s_have_access_to_set_cache[$vn_set_id.'/'.$pn_user_id.'/'.$pn_access] = true; }
		
		$qr_res = $o_db->query("
			SELECT sxu.set_id 
			FROM ca_sets_x_users sxu
			INNER JOIN ca_users AS u ON sxu.user_id = u.user_id
			WHERE 
				(sxu.access >= ?) AND (u.user_id = ?) AND (sxu.set_id = ?)
				AND
				(
					(sxu.sdatetime <= ".time()." AND sxu.edatetime >= ".time().")
					OR
					sxu.sdatetime IS NULL and sxu.edatetime IS NULL
				)
		", (int)$pn_access, (int)$pn_user_id, (int)$vn_set_id);
		
		if ($qr_res->numRows() > 0) { return ca_sets::$s_have_access_to_set_cache[$vn_set_id.'/'.$pn_user_id.'/'.$pn_access] = true; }
		
		return ca_sets::$s_have_access_to_set_cache[$vn_set_id.'/'.$pn_user_id.'/'.$pn_access] = false;
	}
	# ------------------------------------------------------
	/**
	 * 
	 *
	 * @param int $pn_user_id user_id of user to check set access for
	 * @param int $pn_access type of access required. Use __CA_SET_READ_ACCESS__ for read-only access or __CA_SET_EDIT_ACCESS__ for editing (full) access
	 * @param int $pa_set_ids The ids of the sets to check. If omitted then currently loaded set will be checked. Can also be set to a single integer.
	 * @return int
	 */
	public function getAccessExpirationDates($pn_user_id, $pn_access, $pa_set_ids=null, $pa_options=null) {
		if (!is_array($pa_set_ids)) {
			if (!$pa_set_ids) { $pa_set_ids = $this->get('set_id'); }
			if(!$pa_set_ids) { return null; }
			$pa_set_ids = array($pa_set_ids);
		}
		
		foreach($pa_set_ids as $vn_i => $vn_set_id) {
			$pa_set_ids[$vn_i] = (int)$vn_set_id;
		}
		
		$o_db =  $this->getDb();
		$qr_res = $o_db->query("
			SELECT sxg.set_id, sxg.sdatetime, sxg.edatetime, s.user_id
			FROM ca_sets_x_user_groups sxg
			INNER JOIN ca_user_groups AS ug ON sxg.group_id = ug.group_id
			INNER JOIN ca_users_x_groups AS uxg ON uxg.group_id = ug.group_id
			INNER JOIN ca_sets AS s ON s.set_id = sxg.set_id
			WHERE 
				(sxg.access >= ?) AND (uxg.user_id = ?) AND (sxg.set_id IN (?))
				AND
				(
					sxg.sdatetime <= ".time()." AND sxg.edatetime >= ".time()."
				)
		", (int)$pn_access, (int)$pn_user_id, $pa_set_ids);
		
		$o_tep = new TimeExpressionParser();
		
		$va_expiration_times = array();
		while($qr_res->nextRow()) {
			if ($qr_res->get('user_id') == $pn_user_id) {
				$va_expiration_times[$vn_set_id] = -1;
				continue;
			}
			$vn_set_id = $qr_res->get('set_id');
			$vn_exp = $qr_res->get('edatetime');
			if (!isset($va_expiration_times[$vn_set_id]) || ($va_expiration_times[$vn_set_id] < $vn_exp)) {
				$o_tep->setUnixTimestamps($vn_exp, $vn_exp);
				$vs_text = $o_tep->getText();
				$va_expiration_times[$vn_set_id] = $vs_text;
			}
		}
		
		$qr_res = $o_db->query("
			SELECT sxu.set_id, sxu.sdatetime, sxu.edatetime, s.user_id
			FROM ca_sets_x_users sxu
			INNER JOIN ca_users AS u ON sxu.user_id = u.user_id
			INNER JOIN ca_sets AS s ON s.set_id = sxu.set_id
			WHERE 
				(sxu.access >= ?) AND (u.user_id = ?) AND (sxu.set_id IN (?))
				AND
				(
					sxu.sdatetime <= ".time()." AND sxu.edatetime >= ".time()."
				)
		", (int)$pn_access, (int)$pn_user_id, $pa_set_ids);
		
		while($qr_res->nextRow()) {
			if ($qr_res->get('user_id') == $pn_user_id) {
				$va_expiration_times[$vn_set_id] = -1;
				continue;
			}
			$vn_set_id = $qr_res->get('set_id');
			$vn_exp = $qr_res->get('edatetime');
			if (!isset($va_expiration_times[$vn_set_id]) || ($va_expiration_times[$vn_set_id] < $vn_exp)) {
				$o_tep->setUnixTimestamps($vn_exp, $vn_exp);
				$vs_text = $o_tep->getText();
				$va_expiration_times[$vn_set_id] = $vs_text;
			}
		}
		
		return $va_expiration_times;
	}
	# ------------------------------------------------------
	# Set maintenance
	# ------------------------------------------------------
	/**
	 * Add item to currently loaded set
	 *
	 * @param int $pn_row_id The row_id to add to the set. Assumed to be a key to a record in the sets's content type's table.
	 * @param array $pa_labels An array of ca_set_item label values to create. The array is keyed on locale_id; each value is an array with keys set to ca_set_item_labels fields with associated values.
	 * @param int $pn_user_id user_id of user adding the item. Used to check if the user has editing access to the set. If omitted no checking of access is done.
	 * @param int $pn_rank position in the set of the newly added item
	 * @return int Returns item_id of newly created set item entry. The item_id is a unique identifier for the row_id in the city at the specified position (rank). It is *not* the same as the row_id.
	 */
	public function addItem($pn_row_id, $pa_labels=null, $pn_user_id=null, $pn_rank=null) {
		if(!($vn_set_id = $this->getPrimaryKey())) { return null; }
		if ($pn_user_id && (!$this->haveAccessToSet($pn_user_id, __CA_SET_EDIT_ACCESS__))) { return false; }
		
		$vn_table_num = $this->get('table_num');
		
		// Verify existance of row before adding to set
		$t_instance = $this->getAppDatamodel()->getInstanceByTableNum($vn_table_num, true);
		if (!$t_instance->load($pn_row_id)) {
			$this->postError(750, _t('Item does not exist'), 'ca_sets->addItem()');
			return false;
		}
		
		// Add it to the set
		$t_item = new ca_set_items();
		$t_item->setMode(ACCESS_WRITE);
		$t_item->set('set_id', $this->getPrimaryKey());
		$t_item->set('table_num', $vn_table_num);
		$t_item->set('row_id', $pn_row_id);
		$t_item->set('type_id', $this->get('type_id'));
		
		$t_item->insert();
		if (!is_null($pn_rank)) {
			$t_item->set('rank', $pn_rank);
			$t_item->update();
		}
		
		if ($t_item->numErrors()) {
			$this->errors = $t_item->errors;
			return false;
		}
		
		if (is_array($pa_labels) && sizeof($pa_labels)) {
			foreach($pa_labels as $vn_locale_id => $va_label) {
				if (!isset($va_label['caption']) || !trim($va_label['caption'])) { continue; }
				$t_item->addLabel(
					$va_label, $vn_locale_id
				);
				if ($t_item->numErrors()) {
					$this->errors = $t_item->errors;
					return false;
				}
			}
		}
		
		return (int)$t_item->getPrimaryKey();
	}
	# ------------------------------------------------------
	/**
	 * Removes all instances of the specified item from the set as specified by the row_id
	 *
	 * @param int $pn_row_id The row_id of the item to remove
	 * @param int $pn_user_id Option user_id of user to check set access for; if no user_id is specified then no access checking is done
	 * @return bool True on success, false if an error occurred
	 */
	public function removeItem($pn_row_id, $pn_user_id=null) {
		if(!($vn_set_id = $this->getPrimaryKey())) { return null; }
		if ($pn_user_id && (!$this->haveAccessToSet($pn_user_id, __CA_SET_EDIT_ACCESS__))) { return false; }
		
		$t_item = new ca_set_items();
		$t_item->setMode(ACCESS_WRITE);
		while ($t_item->load(array('set_id' => $this->getPrimaryKey(), 'row_id' => $pn_row_id))) {
			$t_item->delete(true);
			if ($t_item->numErrors()) {
				$this->errors = $t_item->errors;
				return false;
			}
		}
		return true;
	}
	# ------------------------------------------------------
	/**
	 * Removes the specified item from the set as specified by the item_id
	 *
	 * @param int $pn_item_id The item_id of the ca_set_items row in the set
	 * @param int $pn_user_id Option user_id of user to check set access for; if no user_id is specified then no access checking is done
	 * @return bool True on success, false if an error occurred
	 */
	public function removeItemByItemID($pn_item_id, $pn_user_id=null) {
		if(!($vn_set_id = $this->getPrimaryKey())) { return null; }
		if (!$this->haveAccessToSet($pn_user_id, __CA_SET_EDIT_ACCESS__)) { return false; }
		
		$t_item = new ca_set_items();
		$t_item->setMode(ACCESS_WRITE);
		if ($t_item->load($pn_item_id)) {
			$t_item->delete(true);
			if ($t_item->numErrors()) {
				$this->errors = $t_item->errors;
				return false;
			}
			return true;
		}
		return true;
	}
	# ------------------------------------------------------
	/**
	 * Returns a list of item_ids for the current set with ranks for each, in rank order
	 *
	 * @param array $pa_options An optional array of options. Supported options are:
	 *			user_id = the user_id of the current user; used to determine which sets the user has access to
	 * @return array Array keyed on item_id with values set to ranks for each item
	 */
	public function getItemRanks($pa_options=null) {
		if(!($vn_set_id = $this->getPrimaryKey())) { return null; }
		if (!$this->haveAccessToSet($pa_options['user_id'], __CA_SET_READ_ACCESS__)) { return false; }
		
		$va_items = caExtractValuesByUserLocale($this->getItems($pa_options));
		$va_ranks = array();
		foreach($va_items as $vn_item_id => $va_item) {
			$va_ranks[$vn_item_id] = $va_item['rank'];
		}
		return $va_ranks;
	}
	# ------------------------------------------------------
	/**
 	 * Returns a list of row_ids for the current set with ranks for each, in rank order
	 *
	 * @param array $pa_options An optional array of options. Supported options are:
	 *			user_id = the user_id of the current user; used to determine which sets the user has access to
	 * @return array Array keyed on row_id with values set to ranks for each item. If the set contains duplicate row_ids then the list will only have the largest rank. If you have sets with duplicate rows use getItemRanks() instead
	 */
	public function getRowIDRanks($pa_options=null) {
		if(!($vn_set_id = $this->getPrimaryKey())) { return null; }
		if (!$this->haveAccessToSet($pa_options['user_id'], __CA_SET_READ_ACCESS__)) { return false; }
		
		$va_items = caExtractValuesByUserLocale($this->getItems($pa_options));
		$va_ranks = array();
		foreach($va_items as $vn_item_id => $va_item) {
			$va_ranks[$va_item['row_id']] = $va_item['rank'];
		}
		return $va_ranks;
	}
	# ------------------------------------------------------
	/**
	 * Sets order of items in the currently loaded set to the order of row_ids as set in $pa_row_ids
	 *
	 * @param array $pa_row_ids A list of row_ids in the set, in the order in which they should be displayed in the set
	 * @param array $pa_options An optional array of options. Supported options include:
	 *			user_id = the user_id of the current user; used to determine which sets the user has access to
	 * @return array An array of errors. If the array is empty then no errors occurred
	 */
	public function reorderItems($pa_row_ids, $pa_options=null) {
		if (!($vn_set_id = $this->getPrimaryKey())) {	
			return null;
		}
		
		$vn_user_id = isset($pa_options['user_id']) ? (int)$pa_options['user_id'] : null; 
		
		// does user have edit access to set?
		if ($vn_user_id && !$this->haveAccessToSet($vn_user_id, __CA_SET_EDIT_ACCESS__)) {
			return false;
		}
	
		$va_row_ranks = $this->getRowIDRanks($pa_options);	// get current ranks
		
		$vn_i = 0;
		$o_trans = new Transaction();
		$t_set_item = new ca_set_items();
		$t_set_item->setTransaction($o_trans);
		$t_set_item->setMode(ACCESS_WRITE);
		$va_errors = array();
		
		
		// delete rows not present in $pa_row_ids
		$va_to_delete = array();
		foreach($va_row_ranks as $vn_row_id => $va_rank) {
			if (!in_array($vn_row_id, $pa_row_ids)) {
				if ($t_set_item->load(array('set_id' => $vn_set_id, 'row_id' => $vn_row_id))) {
					$t_set_item->delete(true);
				}
			}
		}
		
		
		// rewrite ranks
		foreach($pa_row_ids as $vn_rank => $vn_row_id) {
			if (isset($va_row_ranks[$vn_row_id]) && $t_set_item->load(array('set_id' => $vn_set_id, 'row_id' => $vn_row_id))) {
				if ($va_row_ranks[$vn_row_id] != $vn_rank) {
					$t_set_item->set('rank', $vn_rank);
					$t_set_item->update();
				
					if ($t_set_item->numErrors()) {
						$va_errors[$vn_row_id] = _t('Could not reorder item %1: %2', $vn_row_id, join('; ', $t_set_item->getErrors()));
					}
				}
			} else {
				// add item to set
				$this->addItem($vn_row_id, null, $vn_user_id, $vn_rank);
			}
		}
		
		if(sizeof($va_errors)) {
			$o_trans->rollback();
		} else {
			$o_trans->commit();
		}
		
		return $va_errors;
	}
	# ------------------------------------------------------
	/**
	 * Returns row_ids on items in set, in order of appearance in set
	 * unless 'shuffle' option is set, in which case row_ids are returned
	 * in a randomized order
	 *
	 * @param array $pa_options Optional list of options.
	 * @return array List of row_ids
	 */
	public function getItemRowIDs($pa_options=null) {
		if (!is_array($pa_options)) { $pa_options = array(); }
		$pa_options['returnRowIdsOnly'] = true;
		$va_row_ids = $this->getItems($pa_options);
		
		if (isset($pa_options['shuffle']) && $pa_options['shuffle'] && isset($va_row_ids) && is_array($va_row_ids)) {
			$va_row_ids = array_keys($va_row_ids);
			shuffle($va_row_ids);
			$va_row_ids = array_flip($va_row_ids);
		}
		return $va_row_ids;
	}
	# ------------------------------------------------------
	/**
	 * Returns information on items in current set
	 *
	 * @param array $pa_options Optional array of options. Supported options are:
	 *			user_id = user_id of the current user; used to determine paintings may be shown
	 *			thumbnailVersions = A list of of a media versions to return with each item. Only used if the set content type is ca_objects.
	 *			thumbnailVersion = Same as 'thumbnailVersions' except it is a single value. (Maintained for compatibility with older code.)
	 *			limit = Limits the total number of records to be returned
	 *			checkAccess = An array of row-level access values to check set members for, often produced by the caGetUserAccessValues() helper. Set members with access values not in the list will be omitted. If this option is not set or left null no access checking is done.
	 *			returnRowIdsOnly = If true a simple array of row_ids (keys of the set members) for members of the set is returned rather than full item-level info for each set member.
	 *			returnItemIdsOnly = If true a simple array of item_ids (keys for the ca_set_items rows themselves) is returned rather than full item-level info for each set member.
	 *			returnItemAttributes = A list of attribute element codes for the ca_set_item record to return values for.
	 * @return array An array of items. The format varies depending upon the options set. If returnRowIdsOnly or returnItemIdsOnly are set then the returned array is a 
	 *			simple list of ids. The full return array is key'ed on ca_set_items.item_id and then on locale_id. The values are arrays with keys set to a number of fields including:
	 *			set_id, item_id, row_id, rank, label_id, locale_id, caption (from the ca_set_items label), all instrinsic field content from the row_id, the display label of the row
	 *			as 'set_item_label'. 
	 *			If 'thumbnailVersion' is set then additional keys will be available for the selected media version:
	 *				representation_tag, representation_url, representation_width and representation_height (the HTML tag, URL, pixel width and pixel height of the representation respectively)
	 *			If 'thumbnailVersions' is set then additional keys will be available for the selected media versions:
	 *				representation_tag_<version_name>, representation_url_<version_name>, representation_width_<version_name> and representation_height_<version_name> (the HTML tag, URL, pixel width and pixel height of the representation respectively)
	 *			If 'returnItemAttributes' is set then there will be an additional key for each element_code prefixed with 'ca_attribute_' to ensure it doesn't conflict with any other key in the array.		
	 *			
	 */
	public function getItems($pa_options=null) {
		if(!($vn_set_id = $this->getPrimaryKey())) { return null; }
		if (!is_array($pa_options)) { $pa_options = array(); }
		if ($pa_options['user_id'] && !$this->haveAccessToSet($pa_options['user_id'], __CA_SET_READ_ACCESS__)) { return false; }
		
		$o_db = $this->getDb();
		$o_dm = $this->getAppDatamodel();
		
		$t_rel_label_table = null;
		if (!($t_rel_table = $o_dm->getInstanceByTableNum($this->get('table_num'), true))) { return null; }
		if (method_exists($t_rel_table, 'getLabelTableName')) {
			if ($vs_label_table_name = $t_rel_table->getLabelTableName()) {
				$t_rel_label_table = $o_dm->getInstanceByTableName($vs_label_table_name, true);
			}
		}
		
		$vs_label_join_sql = '';
		if ($t_rel_label_table) {
			$vs_label_join_sql = "LEFT JOIN ".$t_rel_label_table->tableName()." AS rel_label ON rel.".$t_rel_table->primaryKey()." = rel_label.".$t_rel_table->primaryKey()."\n";
		}
		
		$vs_rep_join_sql = $vs_rep_where_sql = $vs_rep_select = '';
		if (($t_rel_table->tableName() === 'ca_objects') && (isset($pa_options['thumbnailVersion']) || isset($pa_options['thumbnailVersions']))) {
			$vs_rep_join_sql = "LEFT JOIN ca_objects_x_object_representations AS coxor ON rel.object_id = coxor.object_id
LEFT JOIN ca_object_representations AS cor ON coxor.representation_id = cor.representation_id\n";
			$vs_rep_where_sql = " AND (coxor.is_primary = 1 OR coxor.is_primary IS NULL)";
			
			$vs_rep_select = ', coxor.*, cor.media, cor.access rep_access';
		}
		
		$vs_limit_sql = '';
		if (isset($pa_options['limit']) && ($pa_options['limit'] > 0)) {
			$vs_limit_sql = "LIMIT ".$pa_options['limit'];
		}
		// get set items
		$vs_access_sql = '';
		if (isset($pa_options['checkAccess']) && is_array($pa_options['checkAccess']) && sizeof($pa_options['checkAccess']) && $t_rel_table->hasField('access')) {
			$vs_access_sql = ' AND rel.access IN ('.join(',', $pa_options['checkAccess']).')';
		}
		
		$vs_deleted_sql = '';
		if ($t_rel_table->hasField('deleted')) {
			$vs_deleted_sql = ' AND rel.deleted = 0';
		}
		
		// get row labels
		$qr_res = $o_db->query("
			SELECT 
				casi.set_id, casi.item_id, casi.row_id, casi.rank,
				rel_label.".$t_rel_label_table->getDisplayField().", rel_label.locale_id
			FROM ca_set_items casi
			INNER JOIN ".$t_rel_table->tableName()." AS rel ON rel.".$t_rel_table->primaryKey()." = casi.row_id
			{$vs_label_join_sql}
			WHERE
				casi.set_id = ? {$vs_access_sql} {$vs_deleted_sql}
			ORDER BY 
				casi.rank ASC
			{$vs_limit_sql}
		", (int)$vn_set_id);
		
		$va_labels = array();
		while($qr_res->nextRow()) {
			$va_labels[$qr_res->get('row_id')][$qr_res->get('locale_id')] = $qr_res->getRow();
		}
		
		$va_labels = caExtractValuesByUserLocale($va_labels);
		
		// get set items
		$vs_access_sql = '';
		if (isset($pa_options['checkAccess']) && is_array($pa_options['c…