Skip to content

Commit

Permalink
[TASK] Regenerate ViewHelper documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NamelessCoder committed May 9, 2024
1 parent cc08a08 commit 907b7ab
Show file tree
Hide file tree
Showing 49 changed files with 5,318 additions and 5,609 deletions.
155 changes: 79 additions & 76 deletions Documentation/ViewHelpers/Content/Get.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
.. This reStructured text file has been automatically generated, do not change.
.. Source: fluidtypo3/flux/development/Content/GetViewHelper.php
:edit-on-github-link: Content/GetViewHelper.php
:navigation-title: content.get
.. include:: /Includes.rst.txt

.. _fluidtypo3-flux-content-get:

===========
content.get
===========

===========================================
Content.get ViewHelper `<flux:content.get>`
===========================================

Gets all child content of a record based on area.

Expand Down Expand Up @@ -33,132 +37,131 @@ Each element gets a red border:
</f:for>
</f:section>

.. _fluidtypo3-flux-content-get_source:

Source code
===========

Go to the source code of this ViewHelper: `GetViewHelper.php (GitHub) <fluidtypo3/flux/development/Content/GetViewHelper.php>`__.

.. _fluidtypo3-flux-content-get_arguments:

Arguments
=========

The following arguments are available for `<flux:content.get>`:

.. contents::
:local:


.. _content.get_area:
.. _fluidtypo3-flux-content-get-area_argument:

area
----

:aspect:`DataType`
string
.. confval:: area
:name: fluidtypo3-flux-content-get-area
:type: string
:required: true

:aspect:`Required`
true
:aspect:`Description`
Name or "colPos" value of the content area to render
Name or "colPos" value of the content area to render

.. _content.get_limit:
.. _fluidtypo3-flux-content-get-limit_argument:

limit
-----

:aspect:`DataType`
integer
.. confval:: limit
:name: fluidtypo3-flux-content-get-limit
:type: integer
:required: false

:aspect:`Required`
false
:aspect:`Description`
Optional limit to the number of content elements to render
Optional limit to the number of content elements to render

.. _content.get_offset:
.. _fluidtypo3-flux-content-get-offset_argument:

offset
------

:aspect:`DataType`
integer
.. confval:: offset
:name: fluidtypo3-flux-content-get-offset
:type: integer
:required: false

:aspect:`Required`
false
:aspect:`Description`
Optional offset to the limit
Optional offset to the limit

.. _content.get_order:
.. _fluidtypo3-flux-content-get-order_argument:

order
-----

:aspect:`DataType`
string
.. confval:: order
:name: fluidtypo3-flux-content-get-order
:type: string
:Default: 'sorting'
:required: false

:aspect:`Default`
'sorting'
Optional sort order of content elements - RAND() supported

:aspect:`Required`
false
:aspect:`Description`
Optional sort order of content elements - RAND() supported

.. _content.get_sortdirection:
.. _fluidtypo3-flux-content-get-sortdirection_argument:

sortDirection
-------------

:aspect:`DataType`
string

:aspect:`Default`
'ASC'
.. confval:: sortDirection
:name: fluidtypo3-flux-content-get-sortdirection
:type: string
:Default: 'ASC'
:required: false

:aspect:`Required`
false
:aspect:`Description`
Optional sort direction of content elements
Optional sort direction of content elements

.. _content.get_as:
.. _fluidtypo3-flux-content-get-as_argument:

as
--

:aspect:`DataType`
string
.. confval:: as
:name: fluidtypo3-flux-content-get-as
:type: string
:required: false

:aspect:`Required`
false
:aspect:`Description`
Variable name to register, then render child content and insert all results as an array of records
Variable name to register, then render child content and insert all results as an array of records

.. _content.get_loadregister:
.. _fluidtypo3-flux-content-get-loadregister_argument:

loadRegister
------------

:aspect:`DataType`
mixed
.. confval:: loadRegister
:name: fluidtypo3-flux-content-get-loadregister
:type: mixed
:required: false

:aspect:`Required`
false
:aspect:`Description`
List of LOAD_REGISTER variable
List of LOAD_REGISTER variable

.. _content.get_render:
.. _fluidtypo3-flux-content-get-render_argument:

render
------

:aspect:`DataType`
boolean

:aspect:`Default`
true
.. confval:: render
:name: fluidtypo3-flux-content-get-render
:type: boolean
:Default: true
:required: false

:aspect:`Required`
false
:aspect:`Description`
Optional returning variable as original table rows
Optional returning variable as original table rows

.. _content.get_hideuntranslated:
.. _fluidtypo3-flux-content-get-hideuntranslated_argument:

hideUntranslated
----------------

:aspect:`DataType`
boolean
.. confval:: hideUntranslated
:name: fluidtypo3-flux-content-get-hideuntranslated
:type: boolean
:required: false

:aspect:`Required`
false
:aspect:`Description`
Exclude untranslated records
Exclude untranslated records
1 change: 1 addition & 0 deletions Documentation/ViewHelpers/Content/Index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.. This reStructured text file has been automatically generated, do not change.
.. include:: /Includes.rst.txt

=======
Expand Down
Loading

0 comments on commit 907b7ab

Please sign in to comment.