SelectableOptionArray class

Located in file /wire/modules/Fieldtype/FieldtypeOptions/SelectableOptionArray.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the SelectableOptionArray class also inherits all the methods and properties of: WireArray and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
SelectableOptionArray::addByID(int $id)
false SelectableOptionAdd by option ID 
SelectableOptionArray::addByTitle(string $title)
false SelectableOptionAdd by option title 
SelectableOptionArray::addByValue(string $value)
false SelectableOptionAdd by option value 
SelectableOptionArray::getByID(int $id)
SelectableOption nullGet option by ID 
SelectableOptionArray::getByTitle(string $title)
SelectableOption nullGet option by title 
SelectableOptionArray::getByValue(string $value)
SelectableOption nullGet option by value 
SelectableOptionArray::getField()
null FieldReturns Field object these options are for 
SelectableOptionArray::getItemKey($item)
None 
SelectableOptionArray::getPage()
NullPage PageReturns page these options are for, if applicable (NullPage otherwise) 
SelectableOptionArray::getProperty(string $property)
mixed nullEnables this WireArray to behave like the first item (for getting properties) 
SelectableOptionArray::hasID(int $id)
SelectableOption boolIs the given id present in these selectable options? 
SelectableOptionArray::hasTitle(string $title)
SelectableOption boolIs the given title present in these selectable options? 
SelectableOptionArray::hasValue(string $value)
SelectableOption boolIs the given value present in these selectable options? 
SelectableOptionArray::isIdentical(WireArray $items)
boolIs the given WireArray identical to this one? 
SelectableOptionArray::isValidItem($item)
None 
SelectableOptionArray::isValidKey($key)
None 
SelectableOptionArray::makeBlankItem()
None 
SelectableOptionArray::of()
boolGet or set output formatting mode 
SelectableOptionArray::removeByID(int $id)
boolRemove option by ID 
SelectableOptionArray::removeByTitle(string $title)
boolRemove option by title 
SelectableOptionArray::removeByValue(string $value)
boolRemove option by value 
SelectableOptionArray::render()
stringProvide a default string rendering of these selectable options 
SelectableOptionArray::set($key, $value)
None 
SelectableOptionArray::setField(Field $field)
NoneSet the field these options are for 
SelectableOptionArray::setPage(Page $page)
NoneSet the these options live on 
SelectableOptionArray::setProperty(string $property, mixed $value)
SelectableOption SelectableOptionArrayEnables this WireArray to behave like the first item (for setting properties) 

Properties

NameReturnSummaryDefault
SelectableOptionArray::id int 
SelectableOptionArray::title string 
SelectableOptionArray::value string 

Additional methods and properties

In addition to the methods and properties above, SelectableOptionArray also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.251