donquixote / drupal-cfr Goto Github PK

Look at

• ArgDefToConfiguratorInterface
• ArgDefToConfigurator_Callback
• ArgDefToConfigurator_ConfiguratorObject
• ArgDefToConfigurator_FixedValue
• DefinitionToConfigurator_Mappers
• ServiceFactoryUtil
• ValueToCallbackInterface

Maybe this just needs better docs, or a better name.

Currently marked deprecated, but still in use (from #21):

• OptionableConfiguratorInterface
• OptionalConfigurator_FromOptionable
• OptionableConfToFormInterface

Identify interfaces that have only one implementation.
These could be flattened. But don't have to. It's a case by case decision.

Possibly too many interfaces? Too fine-grained?

Look at

• ConfiguratorMapInterface
• DefinitionMapInterface
• DefinitionsByIdInterface
• DefinitionToConfiguratorInterface
• DefinitionToLabelInterface
• DefmapToCfrFamilyInterface
• DefmapToCfrmapInterface
• DefmapToContainerInterface
• DefmapToLegendInterface
• IdToDefinitionInterface
• IdToLegendInterface
• DefinitionsByTypeAndIdInterface

Also the realm and family containers:

• CfrPluginRealmContainerInterface
• CfrRealmContainerInterface
• TypeToCfrFamilyInterface
• TypeToConfiguratorInterface
• TypeToContainerInterface
• TypeToDefinitionsbyidInterface
• TypeToDefmapInterface

Look at

• CallbackToConfiguratorInterface
• ClosureToConfiguratorInterface
• ParamToConfiguratorInterface
• ParamToLabelInterface

Related:

• InterfaceToConfiguratorInterface

We only need to keep

• CfrPluginHub*
• TypeToConfigurator*

But we can discard the InterfaceToConfigurator*.

A lot of the methods don't have the "public" keyword.
It is technically not necessary, but it is standard in PSR-something and elsewhere. So let's just add it hmkay?

Look at:

• CfrFamilyContainerInterface
• CfrFamilyContainerBase
• CfrFamilyContainer_FromDefmap

Propertie, public:

• @Property \Drupal\cfrfamily\ConfiguratorMap\ConfiguratorMapInterface $configuratorMap
  -> DefmapToCfrmap_ViaContainer::defmapGetCfrmap()
• @Property \Drupal\cfrfamily\CfrLegend\CfrLegendInterface $cfrLegend
  -> _cfrpreset_interface_page()

Properties, internal:

• @Property \Drupal\cfrapi\ConfEmptyness\ConfEmptynessInterface $confEmptyness
  -> to construct Configurator_CompositeOptional in get_optionalConfigurator().

Properties, unused:

• @Property \Drupal\cfrapi\Configurator\ConfiguratorInterface $configurator
• @Property \Drupal\cfrapi\Configurator\Optional\OptionalConfiguratorInterface $optionalConfigurator
• @Property \Drupal\cfrfamily\IdToConfigurator\IdToConfiguratorInterface $idToConfigurator

Properties, unused, no factory:

• @Property \Drupal\cfrapi\Legend\LegendInterface $legend
  (was previously used to construct Configurator_IdConfAdvanced)

Look at

• CfrFamilyInterface
• CfrFamilyContainerInterface

Look at

• ValueToValueInterface
• Configurator_GroupReparentV2V
• Configurator_ObjectSetterMethod
• ValueToValue_Callback
• ValueToValue_FieldEntityDisplay

Implemented in ElementProcessor_ReparentChildren.
Used in Configurator_GroupReparent.

In fact this is used as a #process callback for form API. But this needs to be clarified more! And maybe belongs in a different module?

Look at

• ValueProviderInterface
• ValueProvider_FromCfrConf
• Configurator_FromValueProvider

Add ConfToForm::formValueGetConf(). This will allow form values to be cleaned up or transformed before they go to the database.

namespace Drupal\cfrapi\ConfToForm;

interface ConfToFormInterface {

  /**
   * @param mixed $conf
   *   Configuration from a form, config file or storage.
   * @param string|null $label
   *   Label for the form element, specifying the purpose where it is used.
   *
   * @return array
   */
  public function confGetForm($conf, $label);

  /**
   * @param mixed $formValue
   *
   * @return mixed
   */
  public function formValueGetConf($formValue);

}

E.g. like this

cfrplugin()->getInterfaces();
cfrplugin()->getCfrFamilies();
cfrplugin()->getDefinitions();
cfrplugin()->interfaceGetConfigurator($interface, $context = null);
cfrplugin()->interfaceGetOptionalConfigurator($interface, $context = null, $defaultValue = null);

cfrplugin()->interfaceGetCfrFamily($interface)->getConfigurator();
cfrplugin()->interfaceGetCfrFamily($interface)->getOptionalConfigurator();
cfrplugin()->interfaceGetCfrFamily($interface)->getLabels();
cfrplugin()->interfaceGetCfrFamily($interface)->getLegend();
cfrplugin()->interfaceGetCfrFamily($interface)->getPluginIds();  // Filtered or not?
cfrplugin()->interfaceGetCfrFamily($interface)->getDefinitions();  // Only in sub-interface
cfrplugin()->interfaceGetCfrFamily($interface)->idGetConfigurator($id);

cfrplugin()->interfaceGetCfrFamily($interface)->idGetPlugin($id)->getLabel();
cfrplugin()->interfaceGetCfrFamily($interface)->idGetPlugin($id)->getGroupLabel();
cfrplugin()->interfaceGetCfrFamily($interface)->idGetPlugin($id)->getDefinition();  // Only in sub-interface.
cfrplugin()->interfaceGetCfrFamily($interface)->idGetPlugin($id)->getConfigurator();
cfrplugin()->interfaceGetCfrFamily($interface)->idGetPlugin($id)->getCfrLegend();  // Only if exists.

Look at

• IdConfToSummaryInterface -> not used at all.
• IdConfToValueInterface -> used many times.
• IdValueToValueInterface -> used many times.

E.g.

   * @see \Drupal\cfrrealm\Container\CfrRealmContainerInterface::$typeToCfrFamily

can be replaced with

   * @see $typeToCfrFamily

Also why do we need LegendItemInterface?
And why does it need ::withLabels() method? Can this live in the class instead?

What the hell is this?

Look at

• CfrLegendInterface
• CfrLegendItemInterface
• ParentLegendItemInterface
• CfrLegendProviderInterface
• CfrLegendToConfiguratorInterface

Also look at

• SummaryBuilderGroupInterface
• SummaryBuilderInlineInterface

Candidates for removal:

• BooleanConfiguratorInterface
• IdConfiguratorInterface
• GroupConfiguratorInterface
• SequenceConfiguratorInterface
• ConfiguratorFilterInterface

Instead think of a way that configurators / ConfToValue* / ValueProvider* can report about their value type.

This is for performance..

Look at

• InlineableConfiguratorInterface
• ...

Usage, but no implementation:

• InlineConfiguratorInterface used in Legend_FromDefmapAdvanced

Candidates for removal:

• ConfiguratorFilterInterface
• Configurator_ObjectSetterMethod
• ConfToIdOptionsInterface
• OptionableConfToSummaryInterface

More:

• BrokenOptionableConfigurator.
• BrokenOptionalConfigurator.
• Configurator_OptionableComposite
• Configurator_IdConfAdvanced
• TypeToConfigurator_ViaContainer

More unused:

• Legend_FromDefmapAdvanced
• Legend_FromDefmap
• Legend_FromDefmapRaw
• InlineConfiguratorInterface now unused after deleting the Legend_FromDefmap* classes.

More unused:

• Configurator_CallbackMono
• StructuredLegendInterface falsely used in a doc in Configurator_CallbackMono

More unused:

• IdConfToSummaryInterface
• IdToLegendInterface

Marked "deprecated", but still in use, follow-up in #2:

• OptionableConfToFormInterface
• OptionableConfiguratorInterface
• OptionalConfigurator_FromOptionable

$form['id'] = [
  '#type' => 'select',
  '#options' => ['a' => 'A', 'b' => 'B'],
  '#default_value' => 'c',
];

Afaik, this will give us "An illegal choice has been detected.".

Create an alternative form element type, where instead an extra option is added.