..  include:: /Includes.rst.txt

..  _data-processor-object-access:

=============
object-access
=============

**Class:** :php:`CPSIT\Typo3Handlebars\DataProcessing\ObjecAccessProcessor`

Resolves a property (or nested property path) from an object and stores the
resulting value in the processed data. This is useful for pulling individual
properties out of an Extbase domain object (or any other object) that was
placed into the data processing chain by a preceding processor or controller,
without having to expose the whole object to the template.

..  contents::
    :local:
    :depth: 1

..  _data-processor-object-access-data-sources:

Data sources
============

:typoscript:`object` references the source object, e.g. the output of a
preceding processor or a variable assigned by an Extbase controller
(:typoscript:`processedData:post`). See :ref:`usage-data-sources-payload`
for the syntax and :ref:`usage-data-sources-current` for how to access the
current item inside :ref:`data-processor-process-each`.

..  _data-processor-object-access-usage:

Usage
=====

:typoscript:`dataProcessing` also runs for Extbase plugins whose controller
extends :ref:`extbase-plugin-handlebars-controller`, since :php:`HandlebarsView`
renders through the same :typoscript:`HANDLEBARSTEMPLATE` content object under
the hood. An action that assigns a domain object to the view makes that object
available to :typoscript:`object-access` under the assigned key:

..  code-block:: php
    :caption: EXT:my_extension/Classes/Controller/BlogController.php

    final class BlogController extends HandlebarsController
    {
        public function showAction(Post $post): ResponseInterface
        {
            $this->view->assign('post', $post);

            return $this->htmlResponse($this->renderView());
        }
    }

..  code-block:: typoscript

    plugin.tx_myextension_blog.handlebars {
        Blog::show {
            dataProcessing {
                # Pull the related category's title off the assigned "post" object
                10 = object-access
                10 {
                    object = processedData:post
                    path = category.title
                    as = categoryTitle
                }
            }
        }
    }

..  _data-processor-object-access-properties:

Properties
==========

:typoscript:`object`
    Data source reference(s) the source object is read from (see
    :ref:`data-processor-object-access-data-sources`). Required.

:typoscript:`path`
    Property path to resolve. Supports plain property names as well as
    dot-separated nested paths (e.g. :typoscript:`category.title`). Paths are
    resolved the same way as :ref:`variable paths in Fluid templates <fluid:variable-access-objects>`,
    including getter methods. Required.

:typoscript:`as`
    Target key in the processed data array the resolved value is stored
    under. Default: :typoscript:`result`.

If :typoscript:`object` is not configured, or the resolved value is not an
object, or :typoscript:`path` is missing, or :typoscript:`path` is not a
gettable property on the resolved object, a warning is logged and the
processed data is returned unchanged.

When the resolved value is itself an array, it is run through the standard
TYPO3 :typoscript:`dataProcessing` chain configured on this processor, just
like TYPO3's own :typoscript:`menu` or :typoscript:`database-query`
processors do for their items.