..  include:: /Includes.rst.txt
..  highlight:: php

..  _developer:

================
Developer corner
================

Use this section to provide examples of code or detail any information that would be deemed relevant to a developer.

For example explain how a certain feature was implemented.


..  _developer-api:

API
===

How to use the API...

Interfaces
----------

The following list provides information for all necessary interfaces that are
used inside of this documentation. For up to date information, please check
the source code.


..  php:namespace:: Vendor\MyExtension\Interfaces

..  php:interface:: ExampleInterface

    Has to be implemented by all ...

    ..  php:method:: methodOne()

        :returntype: string
        :returns: Something important

..  php:interface:: AnotherImportantInterface

    Used for ...

..  php:interface:: RequireJsModuleInterface

    Widgets implementing this interface will add the provided RequireJS modules.
    Those modules will be loaded in dashboard view if the widget is added at least once.

    ..  php:method:: getRequireJsModules()

        Returns a list of RequireJS modules that should be loaded, e.g.::

            return [
                'TYPO3/CMS/MyExtension/ModuleName',
                'TYPO3/CMS/MyExtension/Module2Name',
            ];

        See also :ref:`t3coreapi:requirejs` for further information regarding RequireJS
        in TYPO3 Backend.

        :returntype: array
        :returns: List of modules to require.

    ..  php:method:: setDate($year, $month, $day)

        Set the date.

        :param int $year: The year.
        :param int $month: The month.
        :param int $day: The day.
        :returns: Either false on failure, or the datetime object for method chaining.


Examples
--------

A php example::

    // use \TYPO3\CMS\Core\Utility\GeneralUtility;
    $stuff = GeneralUtility::makeInstance(
        '\\Foo\\Bar\\Utility\\Stuff'
    );
    $stuff->do();

Example in another language:

..  code-block:: javascript
    :linenos:
    :emphasize-lines: 2-4

    $(document).ready(
        function () {
            doStuff();
        }
    );

A YAML example:

..  code-block:: yaml

    services:
      Vendor\Extension\EventListener\YourListener:
        tags:
          - name: event.listener
            identifier: 'your-self-choosen-identifier'
            method: 'methodToConnectToEvent'
            event: Vendor\MyExtension\Event\MyActionEvent