platform/api/symfony/Component/Form/AbstractRendererEngine.yaml
2024-09-02 10:44:11 -07:00

72 lines
2.5 KiB
YAML

name: AbstractRendererEngine
class_comment: null
dependencies:
- name: ResetInterface
type: class
source: Symfony\Contracts\Service\ResetInterface
properties: []
methods:
- name: __construct
visibility: public
parameters:
- name: defaultThemes
default: '[]'
comment: "# * Default implementation of {@link FormRendererEngineInterface}.\n#\
\ *\n# * @author Bernhard Schussek <bschussek@gmail.com>\n# */\n# abstract class\
\ AbstractRendererEngine implements FormRendererEngineInterface, ResetInterface\n\
# {\n# /**\n# * The variable in {@link FormView} used as cache key.\n# */\n# public\
\ const CACHE_KEY_VAR = 'cache_key';\n# \n# /**\n# * @var array[]\n# */\n# protected\
\ array $themes = [];\n# \n# /**\n# * @var bool[]\n# */\n# protected array $useDefaultThemes\
\ = [];\n# \n# /**\n# * @var array[]\n# */\n# protected array $resources = [];\n\
# \n# /**\n# * @var array<array<int|false>>\n# */\n# private array $resourceHierarchyLevels\
\ = [];\n# \n# /**\n# * Creates a new renderer engine.\n# *\n# * @param array\
\ $defaultThemes The default themes. The type of these\n# * \
\ themes is open to the implementation."
- name: setTheme
visibility: public
parameters:
- name: view
- name: themes
- name: useDefaultThemes
default: 'true'
comment: null
- name: getResourceForBlockName
visibility: public
parameters:
- name: view
- name: blockName
comment: null
- name: getResourceForBlockNameHierarchy
visibility: public
parameters:
- name: view
- name: blockNameHierarchy
- name: hierarchyLevel
comment: null
- name: getResourceHierarchyLevel
visibility: public
parameters:
- name: view
- name: blockNameHierarchy
- name: hierarchyLevel
comment: null
- name: loadResourceForBlockNameHierarchy
visibility: private
parameters:
- name: cacheKey
- name: view
- name: blockNameHierarchy
- name: hierarchyLevel
comment: "# * Loads the cache with the resource for a given block name.\n# *\n#\
\ * @see getResourceForBlock()\n# */\n# abstract protected function loadResourceForBlockName(string\
\ $cacheKey, FormView $view, string $blockName): bool;\n# \n# /**\n# * Loads the\
\ cache with the resource for a specific level of a block hierarchy.\n# *\n# *\
\ @see getResourceForBlockHierarchy()"
- name: reset
visibility: public
parameters: []
comment: null
traits:
- Symfony\Contracts\Service\ResetInterface
interfaces:
- FormRendererEngineInterface