platform/api/symfony/Component/HttpKernel/Fragment/AbstractSurrogateFragmentRenderer.yaml
2024-09-02 10:44:11 -07:00

101 lines
2.4 KiB
YAML

name: AbstractSurrogateFragmentRenderer
class_comment: null
dependencies:
- name: Request
type: class
source: Symfony\Component\HttpFoundation\Request
- name: Response
type: class
source: Symfony\Component\HttpFoundation\Response
- name: UriSigner
type: class
source: Symfony\Component\HttpFoundation\UriSigner
- name: ControllerReference
type: class
source: Symfony\Component\HttpKernel\Controller\ControllerReference
- name: SurrogateInterface
type: class
source: Symfony\Component\HttpKernel\HttpCache\SurrogateInterface
properties: []
methods:
- name: __construct
visibility: public
parameters:
- name: surrogate
- name: inlineStrategy
- name: signer
default: 'null'
comment: '# * Implements Surrogate rendering strategy.
# *
# * @author Fabien Potencier <fabien@symfony.com>
# */
# abstract class AbstractSurrogateFragmentRenderer extends RoutableFragmentRenderer
# {
# /**
# * The "fallback" strategy when surrogate is not available should always be an
# * instance of InlineFragmentRenderer.
# *
# * @param FragmentRendererInterface $inlineStrategy The inline strategy to use
when the surrogate is not supported'
- name: render
visibility: public
parameters:
- name: uri
- name: request
- name: options
default: '[]'
comment: '# * Note that if the current Request has no surrogate capability, this
method
# * falls back to use the inline rendering strategy.
# *
# * Additional available options:
# *
# * * alt: an alternative URI to render in case of an error
# * * comment: a comment to add when returning the surrogate tag
# * * absolute_uri: whether to generate an absolute URI or not. Default is false
# *
# * Note, that not all surrogate strategies support all options. For now
# * ''alt'' and ''comment'' are only supported by ESI.
# *
# * @see Symfony\Component\HttpKernel\HttpCache\SurrogateInterface'
- name: generateSignedFragmentUri
visibility: private
parameters:
- name: uri
- name: request
- name: absolute
comment: null
- name: containsNonScalars
visibility: private
parameters:
- name: values
comment: null
traits:
- Symfony\Component\HttpFoundation\Request
- Symfony\Component\HttpFoundation\Response
- Symfony\Component\HttpFoundation\UriSigner
- Symfony\Component\HttpKernel\Controller\ControllerReference
- Symfony\Component\HttpKernel\HttpCache\SurrogateInterface
interfaces: []