This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 
<?php defined('C5_EXECUTE') or die("Access Denied.");

class Concrete5_Controller_AttributeType_Select extends AttributeTypeController  {

    private $akSelectAllowMultipleValues;
    private $akSelectAllowOtherValues;
    private $akSelectOptionDisplayOrder;

    protected $searchIndexFieldDefinition = 'X NULL';
    
    public function type_form() {
        $path1 = $this->getView()->getAttributeTypeURL('type_form.js');
        $path2 = $this->getView()->getAttributeTypeURL('type_form.css');
        $this->addHeaderItem(Loader::helper('html')->javascript($path1));
        $this->addHeaderItem(Loader::helper('html')->css($path2));
        $this->set('form', Loader::helper('form'));     
        $this->load();
        //$akSelectValues = $this->getSelectValuesFromPost();
        //$this->set('akSelectValues', $akSelectValues);
        
        if ($this->isPost()) {
            $akSelectValues = $this->getSelectValuesFromPost();
            $this->set('akSelectValues', $akSelectValues);
        } else if (isset($this->attributeKey)) {
            $options = $this->getOptions();
            $this->set('akSelectValues', $options);
        } else {
            $this->set('akSelectValues', array());
        }
    }
    
    protected function load() {
        $ak = $this->getAttributeKey();
        if (!is_object($ak)) {
            return false;
        }
        
        $db = Loader::db();
        $row = $db->GetRow('select akSelectAllowMultipleValues, akSelectOptionDisplayOrder, akSelectAllowOtherValues from atSelectSettings where akID = ?', $ak->getAttributeKeyID());
        $this->akSelectAllowMultipleValues = $row['akSelectAllowMultipleValues'];
        $this->akSelectAllowOtherValues = $row['akSelectAllowOtherValues'];
        $this->akSelectOptionDisplayOrder = $row['akSelectOptionDisplayOrder'];

        $this->set('akSelectAllowMultipleValues', $this->akSelectAllowMultipleValues);
        $this->set('akSelectAllowOtherValues', $this->akSelectAllowOtherValues);            
        $this->set('akSelectOptionDisplayOrder', $this->akSelectOptionDisplayOrder);            
    }

    public function duplicateKey($newAK) {
        $this->load();
        $db = Loader::db();
        $db->Execute('insert into atSelectSettings (akID, akSelectAllowMultipleValues, akSelectOptionDisplayOrder, akSelectAllowOtherValues) values (?, ?, ?, ?)', array($newAK->getAttributeKeyID(), $this->akSelectAllowMultipleValues, $this->akSelectOptionDisplayOrder, $this->akSelectAllowOtherValues)); 
        $r = $db->Execute('select value, displayOrder, isEndUserAdded from atSelectOptions where akID = ?', $this->getAttributeKey()->getAttributeKeyID());
        while ($row = $r->FetchRow()) {
            $db->Execute('insert into atSelectOptions (akID, value, displayOrder, isEndUserAdded) values (?, ?, ?, ?)', array(
                $newAK->getAttributeKeyID(),
                $row['value'],
                $row['displayOrder'],
                $row['isEndUserAdded']
            ));
        }
    }
    
    public function exportKey($akey) {
        $this->load();
        $db = Loader::db();
        $type = $akey->addChild('type');
        $type->addAttribute('allow-multiple-values', $this->akSelectAllowMultipleValues);
        $type->addAttribute('display-order', $this->akSelectOptionDisplayOrder);
        $type->addAttribute('allow-other-values', $this->akSelectAllowOtherValues);
        $r = $db->Execute('select value, displayOrder, isEndUserAdded from atSelectOptions where akID = ? order by displayOrder asc', $this->getAttributeKey()->getAttributeKeyID());
        $options = $type->addChild('options');
        while ($row = $r->FetchRow()) {
            $opt = $options->addChild('option');
            $opt->addAttribute('value', $row['value']);
            $opt->addAttribute('is-end-user-added', $row['isEndUserAdded']);
        }
        return $akey;
    }
    
    public function exportValue($akn) {
        $list = $this->getSelectedOptions();
        if ($list->count() > 0) {
            $av = $akn->addChild('value');
            foreach($list as $l) {
                $av->addChild('option', (string) $l);
            }
        }
    }
    
    public function importValue(SimpleXMLElement $akv) {
        if (isset($akv->value)) {
            $vals = array();
            foreach($akv->value->children() as $ch) {
                $vals[] = (string) $ch;
            }
            return $vals;
        }
    }
    
    public function importKey($akey) {
        if (isset($akey->type)) {
            $akSelectAllowMultipleValues = $akey->type['allow-multiple-values'];
            $akSelectOptionDisplayOrder = $akey->type['display-order'];
            $akSelectAllowOtherValues = $akey->type['allow-other-values'];
            $db = Loader::db();
            $db->Replace('atSelectSettings', array(
                'akID' => $this->attributeKey->getAttributeKeyID(), 
                'akSelectAllowMultipleValues' => $akSelectAllowMultipleValues, 
                'akSelectAllowOtherValues' => $akSelectAllowOtherValues,
                'akSelectOptionDisplayOrder' => $akSelectOptionDisplayOrder
            ), array('akID'), true);

            if (isset($akey->type->options)) {
                foreach($akey->type->options->children() as $option) {
                    SelectAttributeTypeOption::add($this->attributeKey, $option['value'], $option['is-end-user-added']);
                }
            }
        }
    }
    
    private function getSelectValuesFromPost() {
        $options = new SelectAttributeTypeOptionList();
        $displayOrder = 0;      
        foreach($_POST as $key => $value) {
            if( !strstr($key,'akSelectValue_') || $value=='TEMPLATE' ) continue; 
            $opt = false;
            // strip off the prefix to get the ID
            $id = substr($key, 14);
            // now we determine from the post whether this is a new option
            // or an existing. New ones have this value from in the akSelectValueNewOption_ post field
            if ($_POST['akSelectValueNewOption_' . $id] == $id) {
                $opt = new SelectAttributeTypeOption(0, $value, $displayOrder);
                $opt->tempID = $id;
            } else if ($_POST['akSelectValueExistingOption_' . $id] == $id) {
                $opt = new SelectAttributeTypeOption($id, $value, $displayOrder);
            }
            
            if (is_object($opt)) {
                $options->add($opt);
                $displayOrder++;
            }
        }
        
        return $options;
    }
    
    public function form() {
        $this->load();
        $options = $this->getSelectedOptions();
        $selectedOptions = array();
        foreach($options as $opt) {
            $selectedOptions[] = $opt->getSelectAttributeOptionID();
            $selectedOptionValues[$opt->getSelectAttributeOptionID()] = $opt->getSelectAttributeOptionValue();
        }
        $this->set('selectedOptionValues',$selectedOptionValues);
        $this->set('selectedOptions', $selectedOptions);
        $this->addFooterItem(Loader::helper('html')->javascript('jquery.ui.js'));
        $this->addHeaderItem(Loader::helper('html')->css('jquery.ui.css'));
    }
    
    public function search() {
        $this->load();  
        $selectedOptions = $this->request('atSelectOptionID');
        if (!is_array($selectedOptions)) {
            $selectedOptions = array();
        }
        $this->set('selectedOptions', $selectedOptions);
    }
    
    public function deleteValue() {
        $db = Loader::db();
        $db->Execute('delete from atSelectOptionsSelected where avID = ?', array($this->getAttributeValueID()));
    }

    public function deleteKey() {
        $db = Loader::db();
        $db->Execute('delete from atSelectSettings where akID = ?', array($this->attributeKey->getAttributeKeyID()));
        $r = $db->Execute('select ID from atSelectOptions where akID = ?', array($this->attributeKey->getAttributeKeyID()));
        while ($row = $r->FetchRow()) {
            $db->Execute('delete from atSelectOptionsSelected where atSelectOptionID = ?', array($row['ID']));
        }
        $db->Execute('delete from atSelectOptions where akID = ?', array($this->attributeKey->getAttributeKeyID()));
    }

    public function saveForm($data) {
        $this->load();
        
        if ($this->akSelectAllowOtherValues && is_array($data['atSelectNewOption'])) {
            $options = $this->getOptions();
                        
            foreach($data['atSelectNewOption'] as $newoption) {
                // check for duplicates
                $existing = false;
                foreach($options as $opt) {
                    if(strtolower(trim($newoption)) == strtolower(trim($opt->getSelectAttributeOptionValue(false)))) {
                        $existing = $opt;
                        break;
                    }
                }
                if($existing instanceof SelectAttributeTypeOption) {
                    $data['atSelectOptionID'][] = $existing->getSelectAttributeOptionID();
                } else {
                    $optobj = SelectAttributeTypeOption::add($this->attributeKey, $newoption, 1);
                    $data['atSelectOptionID'][] = $optobj->getSelectAttributeOptionID();
                }
            }
        }

        if(is_array($data['atSelectOptionID'])) {
            $data['atSelectOptionID'] = array_unique($data['atSelectOptionID']);
        }       
        $db = Loader::db();
        $db->Execute('delete from atSelectOptionsSelected where avID = ?', array($this->getAttributeValueID()));
        if (is_array($data['atSelectOptionID'])) {
            foreach($data['atSelectOptionID'] as $optID) {
                if ($optID > 0) {
                    $db->Execute('insert into atSelectOptionsSelected (avID, atSelectOptionID) values (?, ?)', array($this->getAttributeValueID(), $optID));
                    if ($this->akSelectAllowMultipleValues == false) {
                        break;
                    }
                }
            }
        }
    }
    
    // Sets select options for a particular attribute
    // If the $value == string, then 1 item is selected
    // if array, then multiple, but only if the attribute in question is a select multiple
    // Note, items CANNOT be added to the pool (even if the attribute allows it) through this process.
    // Items should now be added to the database if they don't exist already & if the allow checkbox is checked under the attribute settings
    // Code from this bug - http://www.concrete5.org/index.php?cID=595692
    public function saveValue($value) {
        $db = Loader::db();
        $this->load();
        $options = array();
        
        if ((is_array($value) || $value instanceof Traversable) && $this->akSelectAllowMultipleValues) {
            foreach($value as $v) {
                $opt = SelectAttributeTypeOption::getByValue($v, $this->attributeKey);
                if (is_object($opt)) {
                    $options[] = $opt;  
                }else if ($this->akSelectAllowOtherValues) {
                    $options[] = SelectAttributeTypeOption::add($this->attributeKey, $v, true);
                }
            }
        } else {
            if (is_array($value)) {
                $value = $value[0];
            }
            
            $opt = SelectAttributeTypeOption::getByValue($value, $this->attributeKey);
            if (is_object($opt)) {
                $options[] = $opt;  
            }
        }
        
        $db->Execute('delete from atSelectOptionsSelected where avID = ?', array($this->getAttributeValueID()));
        if (count($options) > 0) {
            foreach($options as $opt) {
                $db->Execute('insert into atSelectOptionsSelected (avID, atSelectOptionID) values (?, ?)', array($this->getAttributeValueID(), $opt->getSelectAttributeOptionID()));
                if ($this->akSelectAllowMultipleValues == false) {
                    break;
                }
            }
        }
    }

    
    public function getDisplayValue() {
        $list = $this->getSelectedOptions();
        $html = '';
        foreach($list as $l) {
            $html .= $l->getSelectAttributeOptionDisplayValue() . '<br/>';
        }
        return $html;
    }

    public function getDisplaySanitizedValue() {
        return $this->getDisplayValue();
    }
    
    public function validateForm($p) {
        $this->load();
        $options = $this->request('atSelectOptionID');
        if ($this->akSelectAllowOtherValues) {
            $options = array_filter((Array) $this->request('atSelectNewOption'));
            if (is_array($options) && count($options) > 0) {
                return true;
            } else if (array_shift($this->request('atSelectOptionID')) != null) {
                return true;
            }
        }
        if ($this->akSelectAllowMultipleValues) {
            return count($options) > 0;
        } else {
            if ($options[0] != false) {
                return $options[0] > 0;
            }
        }
        return false;
    }
    
    public function searchForm($list) {
        $options = $this->request('atSelectOptionID');
        $db = Loader::db();
        $tbl = $this->attributeKey->getIndexedSearchTable();
        if (!is_array($options)) {
            return $list;
        }
        $optionQuery = array();
        foreach($options as $id) {
            if (Loader::helper('validation/numbers')->integer($id) && $id > 0) {
                $opt = SelectAttributeTypeOption::getByID($id);
                if (is_object($opt)) {
                    $optionQuery[] = $opt->getSelectAttributeOptionValue(false);
                }
            }
        }
        if (count($optionQuery) == 0) {
            return false;
        }
        
        $i = 0;
        foreach($optionQuery as $val) {
            $val = $db->quote('%||' . $val . '||%');
            $multiString .= 'REPLACE(' . $tbl . '.ak_' . $this->attributeKey->getAttributeKeyHandle() . ', "\n", "||") like ' . $val . ' ';
            if (($i + 1) < count($optionQuery)) {
                $multiString .= 'OR ';
            }
            $i++;
        }
        $list->filter(false, '(' . $multiString . ')');
        return $list;
    }
    
    public function getValue() {
        $list = $this->getSelectedOptions();
        return $list;   
    }
    
    public function getSearchIndexValue() {
        $str = "\n";
        $list = $this->getSelectedOptions();
        foreach($list as $l) {
            $l = (is_object($l) && method_exists($l,'__toString')) ? $l->__toString() : $l;
            $str .= $l . "\n";
        }
        // remove line break for empty list
        if ($str == "\n") {
            return '';
        }
        return $str;
    }
    
    public function getSelectedOptions() {
        if (!isset($this->akSelectOptionDisplayOrder)) {
            $this->load();
        }
        $db = Loader::db();
        $sortByDisplayName = false;
        switch($this->akSelectOptionDisplayOrder) {
            case 'popularity_desc':
                $options = $db->GetAll("select ID, value, displayOrder, (select count(s2.atSelectOptionID) from atSelectOptionsSelected s2 where s2.atSelectOptionID = ID) as total from atSelectOptionsSelected inner join atSelectOptions on atSelectOptionsSelected.atSelectOptionID = atSelectOptions.ID where avID = ? order by total desc, value asc", array($this->getAttributeValueID()));
                break;
            case 'alpha_asc':
                $options = $db->GetAll("select ID, value, displayOrder from atSelectOptionsSelected inner join atSelectOptions on atSelectOptionsSelected.atSelectOptionID = atSelectOptions.ID where avID = ?", array($this->getAttributeValueID()));
                $sortByDisplayName = true;
                break;
            default:
                $options = $db->GetAll("select ID, value, displayOrder from atSelectOptionsSelected inner join atSelectOptions on atSelectOptionsSelected.atSelectOptionID = atSelectOptions.ID where avID = ? order by displayOrder asc", array($this->getAttributeValueID()));
                break;
        }
        $db = Loader::db();
        $list = new SelectAttributeTypeOptionList();
        foreach($options as $row) {
            $opt = new SelectAttributeTypeOption($row['ID'], $row['value'], $row['displayOrder']);
            $list->add($opt);
        }
        if($sortByDisplayName) {
            $list->sortByDisplayName();
        }
        return $list;
    }
    
    public function action_load_autocomplete_values() {
        $this->load();
        $values = array();
            // now, if the current instance of the attribute key allows us to do autocomplete, we return all the values
        if ($this->akSelectAllowMultipleValues && $this->akSelectAllowOtherValues) {
            $options = $this->getOptions($_GET['term'] . '%');
            foreach($options as $opt) {
                $values[] = $opt->getSelectAttributeOptionValue(false);
            }
        }
        print Loader::helper('json')->encode($values);
    }
    
    public function getOptionUsageArray($parentPage = false, $limit = 9999) {
        $db = Loader::db();
        $q = "select atSelectOptions.value, atSelectOptionID, count(atSelectOptionID) as total from Pages inner join CollectionVersions on (Pages.cID = CollectionVersions.cID and CollectionVersions.cvIsApproved = 1) inner join CollectionAttributeValues on (CollectionVersions.cID = CollectionAttributeValues.cID and CollectionVersions.cvID = CollectionAttributeValues.cvID) inner join atSelectOptionsSelected on (atSelectOptionsSelected.avID = CollectionAttributeValues.avID) inner join atSelectOptions on atSelectOptionsSelected.atSelectOptionID = atSelectOptions.ID where Pages.cIsActive = 1 and CollectionAttributeValues.akID = ? ";
        $v = array($this->attributeKey->getAttributeKeyID());
        if (is_object($parentPage)) {
            $v[] = $parentPage->getCollectionID();
            $q .= "and cParentID = ?";
        }
        $q .= " group by atSelectOptionID order by total desc limit " . $limit;
        $r = $db->Execute($q, $v);
        $list = new SelectAttributeTypeOptionList();
        $i = 0;
        while ($row = $r->FetchRow()) {
            $opt = new SelectAttributeTypeOption($row['atSelectOptionID'], $row['value'], $i, $row['total']);
            $list->add($opt);
            $i++;
        }       
        return $list;
    }
    
    /**
     * returns a list of available options optionally filtered by an sql $like statement ex: startswith%
     * @param string $like
     * @return SelectAttributeTypeOptionList
     */
    public function getOptions($like = NULL) {
        if (!isset($this->akSelectOptionDisplayOrder)) {
            $this->load();
        }
        $db = Loader::db();
        switch($this->akSelectOptionDisplayOrder) {
            case 'popularity_desc':
                if(isset($like) && strlen($like)) {
                    $r = $db->Execute('select ID, value, displayOrder, count(atSelectOptionsSelected.atSelectOptionID) as total 
                        from atSelectOptions left join atSelectOptionsSelected on (atSelectOptions.ID = atSelectOptionsSelected.atSelectOptionID) 
                        where akID = ? AND atSelectOptions.value LIKE ? group by ID order by total desc, value asc', array($this->attributeKey->getAttributeKeyID(),$like));
                } else {
                    $r = $db->Execute('select ID, value, displayOrder, count(atSelectOptionsSelected.atSelectOptionID) as total 
                        from atSelectOptions left join atSelectOptionsSelected on (atSelectOptions.ID = atSelectOptionsSelected.atSelectOptionID) 
                        where akID = ? group by ID order by total desc, value asc', array($this->attributeKey->getAttributeKeyID()));
                }
                break;
            case 'alpha_asc':
                if(isset($like) && strlen($like)) {
                    $r = $db->Execute('select ID, value, displayOrder from atSelectOptions where akID = ? AND atSelectOptions.value LIKE ? order by value asc', array($this->attributeKey->getAttributeKeyID(),$like));
                } else {
                    $r = $db->Execute('select ID, value, displayOrder from atSelectOptions where akID = ? order by value asc', array($this->attributeKey->getAttributeKeyID()));
                }
                break;
            default:
                if(isset($like) && strlen($like)) {
                    $r = $db->Execute('select ID, value, displayOrder from atSelectOptions where akID = ? AND atSelectOptions.value LIKE ? order by displayOrder asc', array($this->attributeKey->getAttributeKeyID(),$like));
                } else {
                    $r = $db->Execute('select ID, value, displayOrder from atSelectOptions where akID = ? order by displayOrder asc', array($this->attributeKey->getAttributeKeyID()));
                }
                break;
        }
        $options = new SelectAttributeTypeOptionList();
        while ($row = $r->FetchRow()) {
            $opt = new SelectAttributeTypeOption($row['ID'], $row['value'], $row['displayOrder']);
            $options->add($opt);
        }
        return $options;
    }
        
    public function saveKey($data) {
        $ak = $this->getAttributeKey();
        
        $db = Loader::db();

        $initialOptionSet = $this->getOptions();
        $selectedPostValues = $this->getSelectValuesFromPost();
        
        $akSelectAllowMultipleValues = $data['akSelectAllowMultipleValues'];
        $akSelectAllowOtherValues = $data['akSelectAllowOtherValues'];
        $akSelectOptionDisplayOrder = $data['akSelectOptionDisplayOrder'];
        
        if ($data['akSelectAllowMultipleValues'] != 1) {
            $akSelectAllowMultipleValues = 0;
        }
        if ($data['akSelectAllowOtherValues'] != 1) {
            $akSelectAllowOtherValues = 0;
        }
        if (!in_array($data['akSelectOptionDisplayOrder'], array('display_asc', 'alpha_asc', 'popularity_desc'))) {
            $akSelectOptionDisplayOrder = 'display_asc';
        }
                
        // now we have a collection attribute key object above.
        $db->Replace('atSelectSettings', array(
            'akID' => $ak->getAttributeKeyID(), 
            'akSelectAllowMultipleValues' => $akSelectAllowMultipleValues, 
            'akSelectAllowOtherValues' => $akSelectAllowOtherValues,
            'akSelectOptionDisplayOrder' => $akSelectOptionDisplayOrder
        ), array('akID'), true);
        
        // Now we add the options
        $newOptionSet = new SelectAttributeTypeOptionList();
        $displayOrder = 0;
        foreach($selectedPostValues as $option) {
            $opt = $option->saveOrCreate($ak);
            if ($akSelectOptionDisplayOrder == 'display_asc') {
                $opt->setDisplayOrder($displayOrder);
            }
            $newOptionSet->add($opt);
            $displayOrder++;
        }
        
        // Now we remove all options that appear in the 
        // old values list but not in the new
        foreach($initialOptionSet as $iopt) {
            if (!$newOptionSet->contains($iopt)) {
                $iopt->delete();
            }
        }
    }

    /**
     * Convenience methods to retrieve a select attribute key's settings
     */
    public function getAllowMultipleValues() {
        if (is_null($this->akSelectAllowMultipleValues)) {
            $this->load();
        }
        return $this->akSelectAllowMultipleValues;
    }
    
    public function getAllowOtherValues() {
        if (is_null($this->akSelectAllowOtherValues)) {
            $this->load();
        }
        return $this->akSelectAllowOtherValues;
    }
    
    public function getOptionDisplayOrder() {
        if (is_null($this->akSelectOptionDisplayOrder)) {
            $this->load();
        }
        return $this->akSelectOptionDisplayOrder;
    }
    
}

class Concrete5_Model_SelectAttributeTypeOption extends Object {

    public function __construct($ID, $value, $displayOrder, $usageCount = false) {
        $this->ID = $ID;
        $this->value = $value;
        $this->th = Loader::helper('text');
        $this->displayOrder = $displayOrder;    
        $this->usageCount = $usageCount;    
    }
    
    public function getSelectAttributeOptionID() {return $this->ID;}
    public function getSelectAttributeOptionUsageCount() {return $this->usageCount;}
    public function getSelectAttributeOptionValue($sanitize = true) {
        if (!$sanitize) {
            return $this->value;
        } else {
            return $this->th->specialchars($this->value);
        }
    }
    /** Returns the display name for this select option value (localized and escaped accordingly to $format)
    * @param string $format = 'html'
    *   Escape the result in html format (if $format is 'html').
    *   If $format is 'text' or any other value, the display name won't be escaped.
    * @return string
    */
    public function getSelectAttributeOptionDisplayValue($format = 'html') {
        $value = tc('SelectAttributeValue', $this->getSelectAttributeOptionValue(false));
        switch($format) {
            case 'html':
                return h($value);
            case 'text':
            default:
                return $value;
        }
    }
    public function getSelectAttributeOptionDisplayOrder() {return $this->displayOrder;}
    public function getSelectAttributeOptionTemporaryID() {return $this->tempID;}
    
    public function __toString() {return $this->value;}
    
    public static function add($ak, $option, $isEndUserAdded = 0) {
        $db = Loader::db();
        $th = Loader::helper('text');
        // this works because displayorder starts at zero. So if there are three items, for example, the display order of the NEXT item will be 3.
        $displayOrder = $db->GetOne('select count(ID) from atSelectOptions where akID = ?', array($ak->getAttributeKeyID()));           

        $v = array($ak->getAttributeKeyID(), $displayOrder, $th->sanitize($option), $isEndUserAdded);
        $db->Execute('insert into atSelectOptions (akID, displayOrder, value, isEndUserAdded) values (?, ?, ?, ?)', $v);
        
        return SelectAttributeTypeOption::getByID($db->Insert_ID());
    }
    
    public function setDisplayOrder($num) {
        $db = Loader::db();
        $db->Execute('update atSelectOptions set displayOrder = ? where ID = ?', array($num, $this->ID));
    }
    
    public static function getByID($id) {
        $db = Loader::db();
        $row = $db->GetRow("select ID, displayOrder, value from atSelectOptions where ID = ?", array($id));
        if (isset($row['ID'])) {
            $obj = new SelectAttributeTypeOption($row['ID'], $row['value'], $row['displayOrder']);
            return $obj;
        }
    }
    
    public static function getByValue($value, $ak = false) {
        $db = Loader::db();
        if (is_object($ak)) {
            $row = $db->GetRow("select ID, displayOrder, value from atSelectOptions where value = ? and akID = ?", array($value, $ak->getAttributeKeyID()));
        } else {
            $row = $db->GetRow("select ID, displayOrder, value from atSelectOptions where value = ?", array($value));
        }
        if (isset($row['ID'])) {
            $obj = new SelectAttributeTypeOption($row['ID'], $row['value'], $row['displayOrder']);
            return $obj;
        }
    }
    
    public function delete() {
        $db = Loader::db();
        $db->Execute('delete from atSelectOptions where ID = ?', array($this->ID));
        $db->Execute('delete from atSelectOptionsSelected where atSelectOptionID = ?', array($this->ID));
    }
    
    public function saveOrCreate($ak) {
        if ($this->tempID != false || $this->ID==0) {
            return SelectAttributeTypeOption::add($ak, $this->value);
        } else {
            $db = Loader::db();
            $th = Loader::helper('text');
            $db->Execute('update atSelectOptions set value = ? where ID = ?', array($th->sanitize($this->value), $this->ID));
            return SelectAttributeTypeOption::getByID($this->ID);
        }
    }
    
}

class Concrete5_Model_SelectAttributeTypeOptionList extends Object implements Iterator {

    private $options = array();
    
    public function add(SelectAttributeTypeOption $opt) {
        $this->options[] = $opt;
    }
    
    public function rewind() {
        reset($this->options);
    }
    
    public function current() {
        return current($this->options);
    }
    
    public function key() {
        return key($this->options);
    }
    
    public function next() {
        next($this->options);
    }
    
    public function valid() {
        return $this->current() !== false;
    }
    
    public function count() {return count($this->options);}
    
    public function contains(SelectAttributeTypeOption $opt) {
        foreach($this->options as $o) {
            if ($o->getSelectAttributeOptionID() == $opt->getSelectAttributeOptionID()) {
                return true;
            }
        }
        
        return false;
    }
    
    public function get($index) {
        return $this->options[$index];
    }
    
    public function getOptions() {
        return $this->options;
    }

    /** Sort the options by their display value. */
    public function sortByDisplayName() {
        usort($this->options, array(__CLASS__, 'displayValueSorter'));
    }
    /**
    * @param SelectAttributeTypeOption $a
    * @param SelectAttributeTypeOption $b
    * @return int
    */
    protected static function displayValueSorter($a, $b) {
        return strcasecmp($a->getSelectAttributeOptionDisplayValue('text'), $b->getSelectAttributeOptionDisplayValue('text'));
    }

    public function __toString() {
        $str = '';
        $i = 0;
        foreach($this->options as $opt) {
            $str .= $opt->getSelectAttributeOptionValue();
            $i++;
            if ($i < count($this->options)) {
                $str .= "\n";
            }
        }
        return $str;
    }


}