PHPFUI/InstaDoc
 
Copied!
Abstract
Methods
public Maknz\Slack\Payload::__construct(array $attributes)
 

Instantiate a new payload.

  • param array $attributes
public addOption( $option)
 

Add an option to the block.

  • param mixed $option
  • return $this
  • throws \InvalidArgumentException
public addOptionGroup( $group)
 

Add an option group to the block.

  • param mixed $group
  • return $this
  • throws \InvalidArgumentException
public clearAllOptions()
 

Clear options and option groups.

  • return $this
public clearOptionGroups()
 

Clear option groups in the block.

  • return $this
public Maknz\Slack\BlockElement\Options::clearOptions()
 

Clear options available within the block.

  • return $this
public static Maknz\Slack\BlockElement::factory( $attributes)
 

Create a Block element from a keyed array of attributes.

  • param mixed $attributes
  • return \BlockElement
  • throws \InvalidArgumentException
public Maknz\Slack\BlockElement\Confirmable::getActionId()
 

Get the element's action identifier.

  • return string
public Maknz\Slack\BlockElement\Confirmable::getConfirm()
 

Get the confirmation object.

  • return \Maknz\Slack\Object\Confirmation
public getOptionGroups()
 

Get the option groups.

  • return \Maknz\Slack\Object\OptionGroup[]
public getOptionGroupsAsArrays()
 

Get the option groups in array format.

  • return array
public Maknz\Slack\BlockElement\Options::getOptions()
 

Get options available within the block.

  • return \Maknz\Slack\Object\Option[]
public Maknz\Slack\BlockElement\Options::getOptionsAsArrays()
 

Get options available within the block in array format.

  • return array
public getPlaceholder()
 

Get the placeholder.

  • return \Maknz\Slack\BlockElement\Text
public Maknz\Slack\BlockElement::getType()
 

Get the block type.

  • return string
public Maknz\Slack\BlockElement::isValidFor(Maknz\Slack\Block $block)
 

Check if an element is valid for a Block.

  • param \Block $block
  • return bool
public Maknz\Slack\BlockElement\Confirmable::setActionId( $actionId)
 

Set the element's action identifier.

  • param string $actionId
  • return $this
public Maknz\Slack\BlockElement\Confirmable::setConfirm( $confirm)
 

Set the confirmation object.

  • param mixed $confirm
  • return $this
  • throws \InvalidArgumentException
public setOptionGroups(array $groups)
 

Set the option groups.

  • param array $groups
  • return $this
  • throws \InvalidArgumentException
public setOptions(array $options)
 

Set options available within the block.

  • param array $options
  • return $this
  • throws \InvalidArgumentException
public setPlaceholder( $placeholder)
 

Set the placeholder.

  • param mixed $placeholder
  • return $this
  • throws \InvalidArgumentException
public abstract Maknz\Slack\Payload::toArray()
 

Convert this payload to its array representation.

  • return array
Properties
protected Maknz\Slack\BlockElement\Confirmable::$action_id = NULL
 

Action triggered when the element is interacted with.

  • var string
protected static Maknz\Slack\Payload::$availableAttributes = []
 

Internal attribute to property map.

  • var array
protected Maknz\Slack\BlockElement\Confirmable::$confirm = NULL
 

Confirmation object.

  • var \Maknz\Slack\Object\Confirmation
protected $option_groups = []
 

Select option groups.

  • var \Maknz\Slack\Object\OptionGroup[]
protected Maknz\Slack\BlockElement\Options::$options = []
 

Options available within the block.

  • var \Maknz\Slack\Object\Option[]
protected $placeholder = NULL
 

Select placeholder.

  • var \Maknz\Slack\BlockElement\Text
protected Maknz\Slack\BlockElement::$type = NULL
 

Element type.

  • var string
protected static Maknz\Slack\BlockElement::$validFor = ['button' => ['Button', ['section', 'actions']], 'checkboxes' => ['Checkboxes', ['section', 'actions', 'input']], 'datepicker' => ['DatePicker', ['section', 'actions', 'input']], 'timepicker' => ['Timepicker', ['section', 'actions', 'input']], 'image' => ['Image', ['section', 'context']], 'multi_static_select' => ['MultiStaticSelect', ['section', 'input']], 'multi_external_select' => ['MultiExternalSelect', ['section', 'input']], 'multi_users_select' => ['MultiUsersSelect', ['section', 'input']], 'multi_conversations_select' => ['MultiConversationsSelect', ['section', 'input']], 'multi_channels_select' => ['MultiChannelsSelect', ['section', 'input']], 'overflow' => ['Overflow', ['section', 'actions']], 'plain_text_input' => ['TextInput', ['input']], 'radio_buttons' => ['RadioButtons', ['section', 'actions', 'input']], 'static_select' => ['StaticSelect', ['section', 'actions', 'input']], 'external_select' => ['ExternalSelect', ['section', 'actions', 'input']], 'users_select' => ['UsersSelect', ['section', 'actions', 'input']], 'conversations_select' => ['ConversationsSelect', ['section', 'actions', 'input']], 'channels_select' => ['ChannelsSelect', ['section', 'actions', 'input']], 'plain_text' => ['Text', ['context']], 'mrkdwn' => ['Text', ['context']]]
 

List of blocks each element is valid for.

  • var array
Methods
protected Maknz\Slack\Payload::fillProperties(array $attributes) : self
 
  • param array $attributes
  • return $this
Properties
protected static Maknz\Slack\Payload::$availableAttributes = []
 

Internal attribute to property map.

  • var array
protected static Maknz\Slack\BlockElement::$validFor = ['button' => ['Button', ['section', 'actions']], 'checkboxes' => ['Checkboxes', ['section', 'actions', 'input']], 'datepicker' => ['DatePicker', ['section', 'actions', 'input']], 'timepicker' => ['Timepicker', ['section', 'actions', 'input']], 'image' => ['Image', ['section', 'context']], 'multi_static_select' => ['MultiStaticSelect', ['section', 'input']], 'multi_external_select' => ['MultiExternalSelect', ['section', 'input']], 'multi_users_select' => ['MultiUsersSelect', ['section', 'input']], 'multi_conversations_select' => ['MultiConversationsSelect', ['section', 'input']], 'multi_channels_select' => ['MultiChannelsSelect', ['section', 'input']], 'overflow' => ['Overflow', ['section', 'actions']], 'plain_text_input' => ['TextInput', ['input']], 'radio_buttons' => ['RadioButtons', ['section', 'actions', 'input']], 'static_select' => ['StaticSelect', ['section', 'actions', 'input']], 'external_select' => ['ExternalSelect', ['section', 'actions', 'input']], 'users_select' => ['UsersSelect', ['section', 'actions', 'input']], 'conversations_select' => ['ConversationsSelect', ['section', 'actions', 'input']], 'channels_select' => ['ChannelsSelect', ['section', 'actions', 'input']], 'plain_text' => ['Text', ['context']], 'mrkdwn' => ['Text', ['context']]]
 

List of blocks each element is valid for.

  • var array
Methods
public static Maknz\Slack\BlockElement::factory( $attributes)
 

Create a Block element from a keyed array of attributes.

  • param mixed $attributes
  • return \BlockElement
  • throws \InvalidArgumentException
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration