83 lines
1.7 KiB
YAML
83 lines
1.7 KiB
YAML
name: FlashBagInterface
|
|
class_comment: null
|
|
dependencies:
|
|
- name: SessionBagInterface
|
|
type: class
|
|
source: Symfony\Component\HttpFoundation\Session\SessionBagInterface
|
|
properties: []
|
|
methods:
|
|
- name: add
|
|
visibility: public
|
|
parameters:
|
|
- name: type
|
|
- name: message
|
|
comment: '# * FlashBagInterface.
|
|
|
|
# *
|
|
|
|
# * @author Drak <drak@zikula.org>
|
|
|
|
# */
|
|
|
|
# interface FlashBagInterface extends SessionBagInterface
|
|
|
|
# {
|
|
|
|
# /**
|
|
|
|
# * Adds a flash message for the given type.'
|
|
- name: set
|
|
visibility: public
|
|
parameters:
|
|
- name: type
|
|
- name: messages
|
|
comment: '# * Registers one or more messages for a given type.'
|
|
- name: peek
|
|
visibility: public
|
|
parameters:
|
|
- name: type
|
|
- name: default
|
|
default: '[]'
|
|
comment: '# * Gets flash messages for a given type.
|
|
|
|
# *
|
|
|
|
# * @param string $type Message category type
|
|
|
|
# * @param array $default Default value if $type does not exist'
|
|
- name: peekAll
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Gets all flash messages.'
|
|
- name: get
|
|
visibility: public
|
|
parameters:
|
|
- name: type
|
|
- name: default
|
|
default: '[]'
|
|
comment: '# * Gets and clears flash from the stack.
|
|
|
|
# *
|
|
|
|
# * @param array $default Default value if $type does not exist'
|
|
- name: all
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Gets and clears flashes from the stack.'
|
|
- name: setAll
|
|
visibility: public
|
|
parameters:
|
|
- name: messages
|
|
comment: '# * Sets all flash messages.'
|
|
- name: has
|
|
visibility: public
|
|
parameters:
|
|
- name: type
|
|
comment: '# * Has flash messages for a given type?'
|
|
- name: keys
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Returns a list of all defined types.'
|
|
traits:
|
|
- Symfony\Component\HttpFoundation\Session\SessionBagInterface
|
|
interfaces: []
|