classes/XLite/Model/Attribute.php line 690

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2001-present X-Cart Holdings LLC. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace XLite\Model;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use Doctrine\ORM\PersistentCollection;
  13. use XLite\API\Endpoint\Attribute\Checkbox\DTO\AttributeCheckboxInput as InputCheckbox;
  14. use XLite\API\Endpoint\Attribute\Checkbox\DTO\AttributeCheckboxOutput as OutputCheckbox;
  15. use XLite\API\Endpoint\Attribute\Hidden\DTO\AttributeHiddenInput as InputHidden;
  16. use XLite\API\Endpoint\Attribute\Hidden\DTO\AttributeHiddenOutput as OutputHidden;
  17. use XLite\API\Endpoint\Attribute\Select\DTO\AttributeSelectInput as InputSelect;
  18. use XLite\API\Endpoint\Attribute\Select\DTO\AttributeSelectOutput as OutputSelect;
  19. use XLite\API\Endpoint\Attribute\Text\DTO\AttributeTextInput as InputText;
  20. use XLite\API\Endpoint\Attribute\Text\DTO\AttributeTextOutput as OutputText;
  21. use XLite\API\Endpoint\ProductAttribute\Checkbox\DTO\ProductAttributeCheckboxInput as ProductAttributeInputCheckbox;
  22. use XLite\API\Endpoint\ProductAttribute\Checkbox\DTO\ProductAttributeCheckboxOutput as ProductAttributeOutputCheckbox;
  23. use XLite\API\Endpoint\ProductAttribute\Select\DTO\ProductAttributeSelectInput as ProductAttributeInputSelect;
  24. use XLite\API\Endpoint\ProductAttribute\Select\DTO\ProductAttributeSelectOutput as ProductAttributeOutputSelect;
  25. use XLite\API\Endpoint\ProductAttribute\Text\DTO\ProductAttributeTextInput as ProductAttributeInputText;
  26. use XLite\API\Endpoint\ProductAttribute\Text\DTO\ProductAttributeTextOutput as ProductAttributeOutputText;
  27. use XLite\Core\Cache\ExecuteCachedTrait;
  28. use XLite\Core\Database;
  29. use XLite\Model\AttributeValue\AttributeValueSelect;
  30. use XLite\Model\Repo\ARepo;
  31. use XLite\Model\AttributeValue\AAttributeValue;
  33. /**
  34.  * @ORM\Entity
  35.  * @ORM\Table (name="attributes")
  36.  * @ApiPlatform\ApiResource(
  37.  *     itemOperations={
  38.  *          "get_text"={
  39.  *              "method"="GET",
  40.  *              "path"="/attributes_text/{id}.{_format}",
  41.  *              "identifiers"={"id"},
  42.  *              "input"=InputText::class,
  43.  *              "output"=OutputText::class,
  44.  *              "openapi_context"={
  45.  *                  "summary"="Retrieve a global textarea attribute",
  46.  *                  "parameters"={
  47.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  48.  *                  }
  49.  *              }
  50.  *          },
  51.  *          "put_text"={
  52.  *              "method"="PUT",
  53.  *              "path"="/attributes_text/{id}.{_format}",
  54.  *              "identifiers"={"id"},
  55.  *              "input"=InputText::class,
  56.  *              "output"=OutputText::class,
  57.  *              "openapi_context"={
  58.  *                  "summary"="Update a global textarea attribute",
  59.  *                  "parameters"={
  60.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  61.  *                  }
  62.  *              }
  63.  *          },
  64.  *          "delete_text"={
  65.  *              "method"="DELETE",
  66.  *              "path"="/attributes_text/{id}.{_format}",
  67.  *              "identifiers"={"id"},
  68.  *              "input"=InputText::class,
  69.  *              "output"=OutputText::class,
  70.  *              "openapi_context"={
  71.  *                  "summary"="Delete a global textarea attribute",
  72.  *                  "parameters"={
  73.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  74.  *                  }
  75.  *              }
  76.  *          },
  77.  *          "get_checkbox"={
  78.  *              "method"="GET",
  79.  *              "path"="/attributes_checkbox/{id}.{_format}",
  80.  *              "identifiers"={"id"},
  81.  *              "input"=InputCheckbox::class,
  82.  *              "output"=OutputCheckbox::class,
  83.  *              "openapi_context"={
  84.  *                  "summary"="Retrieve a global yes/no attribute",
  85.  *                  "parameters"={
  86.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  87.  *                  }
  88.  *              }
  89.  *          },
  90.  *          "put_checkbox"={
  91.  *              "method"="PUT",
  92.  *              "path"="/attributes_checkbox/{id}.{_format}",
  93.  *              "identifiers"={"id"},
  94.  *              "input"=InputCheckbox::class,
  95.  *              "output"=OutputCheckbox::class,
  96.  *              "openapi_context"={
  97.  *                  "summary"="Update a global yes/no attribute",
  98.  *                  "parameters"={
  99.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  100.  *                  }
  101.  *              }
  102.  *          },
  103.  *          "delete_checkbox"={
  104.  *              "method"="DELETE",
  105.  *              "path"="/attributes_checkbox/{id}.{_format}",
  106.  *              "identifiers"={"id"},
  107.  *              "input"=InputCheckbox::class,
  108.  *              "output"=OutputCheckbox::class,
  109.  *              "openapi_context"={
  110.  *                  "summary"="Delete a global yes/no attribute",
  111.  *                  "parameters"={
  112.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  113.  *                  }
  114.  *              }
  115.  *          },
  116.  *          "get_select"={
  117.  *              "method"="GET",
  118.  *              "path"="/attributes_select/{id}.{_format}",
  119.  *              "identifiers"={"id"},
  120.  *              "input"=InputSelect::class,
  121.  *              "output"=OutputSelect::class,
  122.  *              "openapi_context"={
  123.  *                  "summary"="Retrieve a global plain field attribute",
  124.  *                  "parameters"={
  125.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  126.  *                  }
  127.  *              }
  128.  *          },
  129.  *          "put_select"={
  130.  *              "method"="PUT",
  131.  *              "path"="/attributes_select/{id}.{_format}",
  132.  *              "identifiers"={"id"},
  133.  *              "input"=InputSelect::class,
  134.  *              "output"=OutputSelect::class,
  135.  *              "openapi_context"={
  136.  *                  "summary"="Update a global plain field attribute",
  137.  *                  "parameters"={
  138.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  139.  *                  }
  140.  *              }
  141.  *          },
  142.  *          "delete_select"={
  143.  *              "method"="DELETE",
  144.  *              "path"="/attributes_select/{id}.{_format}",
  145.  *              "identifiers"={"id"},
  146.  *              "input"=InputSelect::class,
  147.  *              "output"=OutputSelect::class,
  148.  *              "openapi_context"={
  149.  *                  "summary"="Delete a global plain field attribute",
  150.  *                  "parameters"={
  151.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  152.  *                  }
  153.  *              }
  154.  *          },
  155.  *          "get_hidden"={
  156.  *              "method"="GET",
  157.  *              "path"="/attributes_hidden/{id}.{_format}",
  158.  *              "identifiers"={"id"},
  159.  *              "input"=InputHidden::class,
  160.  *              "output"=OutputHidden::class,
  161.  *              "openapi_context"={
  162.  *                  "summary"="Retrieve a global hidden attribute",
  163.  *                  "parameters"={
  164.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  165.  *                  }
  166.  *              }
  167.  *          },
  168.  *          "put_hidden"={
  169.  *              "method"="PUT",
  170.  *              "path"="/attributes_hidden/{id}.{_format}",
  171.  *              "identifiers"={"id"},
  172.  *              "input"=InputHidden::class,
  173.  *              "output"=OutputHidden::class,
  174.  *              "openapi_context"={
  175.  *                  "summary"="Update a global hidden attribute",
  176.  *                  "parameters"={
  177.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  178.  *                  }
  179.  *              }
  180.  *          },
  181.  *          "delete_hidden"={
  182.  *              "method"="DELETE",
  183.  *              "path"="/attributes_hidden/{id}.{_format}",
  184.  *              "identifiers"={"id"},
  185.  *              "input"=InputHidden::class,
  186.  *              "output"=OutputHidden::class,
  187.  *              "openapi_context"={
  188.  *                  "summary"="Delete a global hidden attribute",
  189.  *                  "parameters"={
  190.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  191.  *                  }
  192.  *              }
  193.  *          },
  194.  *          "product_class_based_get_text"={
  195.  *              "method"="GET",
  196.  *              "path"="/product_classes/{class_id}/attributes_text/{id}.{_format}",
  197.  *              "identifiers"={"id"},
  198.  *              "input"=InputText::class,
  199.  *              "output"=OutputText::class,
  200.  *              "openapi_context"={
  201.  *                  "summary"="Retrieve a product class textarea attribute",
  202.  *                  "parameters"={
  203.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  204.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  205.  *                  }
  206.  *              }
  207.  *          },
  208.  *          "product_class_based_put_text"={
  209.  *              "method"="PUT",
  210.  *              "path"="/product_classes/{class_id}/attributes_text/{id}.{_format}",
  211.  *              "identifiers"={"id"},
  212.  *              "input"=InputText::class,
  213.  *              "output"=OutputText::class,
  214.  *              "openapi_context"={
  215.  *                  "summary"="Update a product class textarea attribute",
  216.  *                  "parameters"={
  217.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  218.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  219.  *                  }
  220.  *              }
  221.  *          },
  222.  *          "product_class_based_delete_text"={
  223.  *              "method"="DELETE",
  224.  *              "path"="/product_classes/{class_id}/attributes_text/{id}.{_format}",
  225.  *              "identifiers"={"id"},
  226.  *              "input"=InputText::class,
  227.  *              "output"=OutputText::class,
  228.  *              "openapi_context"={
  229.  *                  "summary"="Delete a product class textarea attribute",
  230.  *                  "parameters"={
  231.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  232.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  233.  *                  }
  234.  *              }
  235.  *          },
  236.  *          "product_class_based_get_checkbox"={
  237.  *              "method"="GET",
  238.  *              "path"="/product_classes/{class_id}/attributes_checkbox/{id}.{_format}",
  239.  *              "identifiers"={"id"},
  240.  *              "input"=InputCheckbox::class,
  241.  *              "output"=OutputCheckbox::class,
  242.  *              "openapi_context"={
  243.  *                  "summary"="Retrieve a product class yes/no attribute",
  244.  *                  "parameters"={
  245.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  246.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  247.  *                  }
  248.  *              }
  249.  *          },
  250.  *          "product_class_based_put_checkbox"={
  251.  *              "method"="PUT",
  252.  *              "path"="/product_classes/{class_id}/attributes_checkbox/{id}.{_format}",
  253.  *              "identifiers"={"id"},
  254.  *              "input"=InputCheckbox::class,
  255.  *              "output"=OutputCheckbox::class,
  256.  *              "openapi_context"={
  257.  *                  "summary"="Update a product class yes/no attribute",
  258.  *                  "parameters"={
  259.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  260.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  261.  *                  }
  262.  *              }
  263.  *          },
  264.  *          "product_class_based_delete_checkbox"={
  265.  *              "method"="DELETE",
  266.  *              "path"="/product_classes/{class_id}/attributes_checkbox/{id}.{_format}",
  267.  *              "identifiers"={"id"},
  268.  *              "input"=InputCheckbox::class,
  269.  *              "output"=OutputCheckbox::class,
  270.  *              "openapi_context"={
  271.  *                  "summary"="Delete a product class yes/no attribute",
  272.  *                  "parameters"={
  273.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  274.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  275.  *                  }
  276.  *              }
  277.  *          },
  278.  *          "product_class_based_get_select"={
  279.  *              "method"="GET",
  280.  *              "path"="/product_classes/{class_id}/attributes_select/{id}.{_format}",
  281.  *              "identifiers"={"id"},
  282.  *              "input"=InputSelect::class,
  283.  *              "output"=OutputSelect::class,
  284.  *              "openapi_context"={
  285.  *                  "summary"="Retrieve a product class plain field attribute",
  286.  *                  "parameters"={
  287.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  288.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  289.  *                  }
  290.  *              }
  291.  *          },
  292.  *          "product_class_based_put_select"={
  293.  *              "method"="PUT",
  294.  *              "path"="/product_classes/{class_id}/attributes_select/{id}.{_format}",
  295.  *              "identifiers"={"id"},
  296.  *              "input"=InputSelect::class,
  297.  *              "output"=OutputSelect::class,
  298.  *              "openapi_context"={
  299.  *                  "summary"="Update a product class plain field attribute",
  300.  *                  "parameters"={
  301.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  302.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  303.  *                  }
  304.  *              }
  305.  *          },
  306.  *          "product_class_based_delete_select"={
  307.  *              "method"="DELETE",
  308.  *              "path"="/product_classes/{class_id}/attributes_select/{id}.{_format}",
  309.  *              "identifiers"={"id"},
  310.  *              "input"=InputSelect::class,
  311.  *              "output"=OutputSelect::class,
  312.  *              "openapi_context"={
  313.  *                  "summary"="Delete a product class plain field attribute",
  314.  *                  "parameters"={
  315.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  316.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  317.  *                  }
  318.  *              }
  319.  *          },
  320.  *          "product_based_get_text"={
  321.  *              "method"="GET",
  322.  *              "path"="/products/{product_id}/attributes_text/{id}.{_format}",
  323.  *              "identifiers"={"id"},
  324.  *              "input"=ProductAttributeInputText::class,
  325.  *              "output"=ProductAttributeOutputText::class,
  326.  *              "openapi_context"={
  327.  *                  "summary"="Retrieve a product-specific textarea attribute",
  328.  *                  "parameters"={
  329.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  330.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  331.  *                  }
  332.  *              }
  333.  *          },
  334.  *          "product_based_put_text"={
  335.  *              "method"="PUT",
  336.  *              "path"="/products/{product_id}/attributes_text/{id}.{_format}",
  337.  *              "identifiers"={"id"},
  338.  *              "input"=ProductAttributeInputText::class,
  339.  *              "output"=ProductAttributeOutputText::class,
  340.  *              "openapi_context"={
  341.  *                  "summary"="Update a product-specific textarea attribute",
  342.  *                  "parameters"={
  343.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  344.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  345.  *                  }
  346.  *              }
  347.  *          },
  348.  *          "product_based_delete_text"={
  349.  *              "method"="DELETE",
  350.  *              "path"="/products/{product_id}/attributes_text/{id}.{_format}",
  351.  *              "identifiers"={"id"},
  352.  *              "input"=ProductAttributeInputText::class,
  353.  *              "output"=ProductAttributeOutputText::class,
  354.  *              "openapi_context"={
  355.  *                  "summary"="Delete a product-specific textarea attribute",
  356.  *                  "parameters"={
  357.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  358.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  359.  *                  }
  360.  *              }
  361.  *          },
  362.  *          "product_based_get_checkbox"={
  363.  *              "method"="GET",
  364.  *              "path"="/products/{product_id}/attributes_checkbox/{id}.{_format}",
  365.  *              "identifiers"={"id"},
  366.  *              "input"=ProductAttributeInputCheckbox::class,
  367.  *              "output"=ProductAttributeOutputCheckbox::class,
  368.  *              "openapi_context"={
  369.  *                  "summary"="Retrieve a product-specific yes/no attribute",
  370.  *                  "parameters"={
  371.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  372.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  373.  *                  }
  374.  *              }
  375.  *          },
  376.  *          "product_based_put_checkbox"={
  377.  *              "method"="PUT",
  378.  *              "path"="/products/{product_id}/attributes_checkbox/{id}.{_format}",
  379.  *              "identifiers"={"id"},
  380.  *              "input"=ProductAttributeInputCheckbox::class,
  381.  *              "output"=ProductAttributeOutputCheckbox::class,
  382.  *              "openapi_context"={
  383.  *                  "summary"="Update a product-specific yes/no attribute",
  384.  *                  "parameters"={
  385.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  386.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  387.  *                  }
  388.  *              }
  389.  *          },
  390.  *          "product_based_delete_checkbox"={
  391.  *              "method"="DELETE",
  392.  *              "path"="/products/{product_id}/attributes_checkbox/{id}.{_format}",
  393.  *              "identifiers"={"id"},
  394.  *              "input"=ProductAttributeInputCheckbox::class,
  395.  *              "output"=ProductAttributeOutputCheckbox::class,
  396.  *              "openapi_context"={
  397.  *                  "summary"="Delete a product-specific yes/no attribute",
  398.  *                  "parameters"={
  399.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  400.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  401.  *                  }
  402.  *              }
  403.  *          },
  404.  *          "product_based_get_select"={
  405.  *              "method"="GET",
  406.  *              "path"="/products/{product_id}/attributes_select/{id}.{_format}",
  407.  *              "identifiers"={"id"},
  408.  *              "input"=ProductAttributeInputSelect::class,
  409.  *              "output"=ProductAttributeOutputSelect::class,
  410.  *              "openapi_context"={
  411.  *                  "summary"="Retrieve a product-specific plain field attribute",
  412.  *                  "parameters"={
  413.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  414.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  415.  *                  }
  416.  *              }
  417.  *          },
  418.  *          "product_based_put_select"={
  419.  *              "method"="PUT",
  420.  *              "path"="/products/{product_id}/attributes_select/{id}.{_format}",
  421.  *              "identifiers"={"id"},
  422.  *              "input"=ProductAttributeInputSelect::class,
  423.  *              "output"=ProductAttributeOutputSelect::class,
  424.  *              "openapi_context"={
  425.  *                  "summary"="Update a product-specific plain field attribute",
  426.  *                  "parameters"={
  427.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  428.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  429.  *                  }
  430.  *              }
  431.  *          },
  432.  *          "product_based_delete_select"={
  433.  *              "method"="DELETE",
  434.  *              "path"="/products/{product_id}/attributes_select/{id}.{_format}",
  435.  *              "identifiers"={"id"},
  436.  *              "input"=ProductAttributeInputSelect::class,
  437.  *              "output"=ProductAttributeOutputSelect::class,
  438.  *              "openapi_context"={
  439.  *                  "summary"="Delete a product-specific plain field attribute",
  440.  *                  "parameters"={
  441.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  442.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  443.  *                  }
  444.  *              }
  445.  *          }
  446.  *     },
  447.  *     collectionOperations={
  448.  *          "get_texts"={
  449.  *              "method"="GET",
  450.  *              "path"="/attributes_text.{_format}",
  451.  *              "identifiers"={"id"},
  452.  *              "input"=InputText::class,
  453.  *              "output"=OutputText::class,
  454.  *              "openapi_context"={
  455.  *                  "summary"="Retrieve a list of global textarea attributes",
  456.  *              }
  457.  *          },
  458.  *          "post_text"={
  459.  *              "method"="POST",
  460.  *              "path"="/attributes_text.{_format}",
  461.  *              "identifiers"={"id"},
  462.  *              "input"=InputText::class,
  463.  *              "output"=OutputText::class,
  464.  *              "controller"="xcart.api.attribute.text.controller",
  465.  *              "openapi_context"={
  466.  *                  "summary"="Create a global textarea attribute",
  467.  *              }
  468.  *          },
  469.  *          "get_checkboxes"={
  470.  *              "method"="GET",
  471.  *              "path"="/attributes_checkbox.{_format}",
  472.  *              "identifiers"={"id"},
  473.  *              "input"=InputCheckbox::class,
  474.  *              "output"=OutputCheckbox::class,
  475.  *              "openapi_context"={
  476.  *                  "summary"="Retrieve a list of global yes/no attributes",
  477.  *              }
  478.  *          },
  479.  *          "post_checkbox"={
  480.  *              "method"="POST",
  481.  *              "path"="/attributes_checkbox.{_format}",
  482.  *              "identifiers"={"id"},
  483.  *              "input"=InputCheckbox::class,
  484.  *              "output"=OutputCheckbox::class,
  485.  *              "controller"="xcart.api.attribute.checkbox.controller",
  486.  *              "openapi_context"={
  487.  *                  "summary"="Create a global yes/no attribute",
  488.  *              }
  489.  *          },
  490.  *          "get_selects"={
  491.  *              "method"="GET",
  492.  *              "path"="/attributes_select.{_format}",
  493.  *              "identifiers"={"id"},
  494.  *              "input"=InputSelect::class,
  495.  *              "output"=OutputSelect::class,
  496.  *              "openapi_context"={
  497.  *                  "summary"="Retrieve a list of global plain field attributes",
  498.  *              }
  499.  *          },
  500.  *          "post_select"={
  501.  *              "method"="POST",
  502.  *              "path"="/attributes_select.{_format}",
  503.  *              "identifiers"={"id"},
  504.  *              "input"=InputSelect::class,
  505.  *              "output"=OutputSelect::class,
  506.  *              "controller"="xcart.api.attribute.select.controller",
  507.  *              "openapi_context"={
  508.  *                  "summary"="Create a global plain field attribute",
  509.  *              }
  510.  *          },
  511.  *          "get_hiddens"={
  512.  *              "method"="GET",
  513.  *              "path"="/attributes_hidden.{_format}",
  514.  *              "identifiers"={"id"},
  515.  *              "input"=InputHidden::class,
  516.  *              "output"=OutputHidden::class,
  517.  *              "openapi_context"={
  518.  *                  "summary"="Retrieve a list of global hidden attributes",
  519.  *              }
  520.  *          },
  521.  *          "post_hidden"={
  522.  *              "method"="POST",
  523.  *              "path"="/attributes_hidden.{_format}",
  524.  *              "identifiers"={"id"},
  525.  *              "input"=InputHidden::class,
  526.  *              "output"=OutputHidden::class,
  527.  *              "controller"="xcart.api.attribute.hidden.controller",
  528.  *              "openapi_context"={
  529.  *                  "summary"="Create a global hidden attribute",
  530.  *              }
  531.  *          },
  532.  *          "product_class_based_get_texts"={
  533.  *              "method"="GET",
  534.  *              "path"="/product_classes/{class_id}/attributes_text.{_format}",
  535.  *              "identifiers"={"id"},
  536.  *              "input"=InputText::class,
  537.  *              "output"=OutputText::class,
  538.  *              "openapi_context"={
  539.  *                  "summary"="Retrieve a list of product class textarea attributes",
  540.  *                  "parameters"={
  541.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  542.  *                  }
  543.  *              }
  544.  *          },
  545.  *          "product_class_based_post_text"={
  546.  *              "method"="POST",
  547.  *              "path"="/product_classes/{class_id}/attributes_text.{_format}",
  548.  *              "identifiers"={"id"},
  549.  *              "input"=InputText::class,
  550.  *              "output"=OutputText::class,
  551.  *              "controller"="xcart.api.attribute.text.product_class_based_controller",
  552.  *              "openapi_context"={
  553.  *                  "summary"="Add a textarea attribute to a product class",
  554.  *                  "parameters"={
  555.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  556.  *                  }
  557.  *              }
  558.  *          },
  559.  *          "product_class_based_get_checkboxes"={
  560.  *              "method"="GET",
  561.  *              "path"="/product_classes/{class_id}/attributes_checkbox.{_format}",
  562.  *              "identifiers"={"id"},
  563.  *              "input"=InputCheckbox::class,
  564.  *              "output"=OutputCheckbox::class,
  565.  *              "openapi_context"={
  566.  *                  "summary"="Retrieve a list of product class yes/no attributes",
  567.  *                  "parameters"={
  568.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  569.  *                  }
  570.  *              }
  571.  *          },
  572.  *          "product_class_based_post_checkbox"={
  573.  *              "method"="POST",
  574.  *              "path"="/product_classes/{class_id}/attributes_checkbox.{_format}",
  575.  *              "identifiers"={"id"},
  576.  *              "input"=InputCheckbox::class,
  577.  *              "output"=OutputCheckbox::class,
  578.  *              "controller"="xcart.api.attribute.checkbox.product_class_based_controller",
  579.  *              "openapi_context"={
  580.  *                  "summary"="Add a yes/no attribute to a product class",
  581.  *                  "parameters"={
  582.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  583.  *                  }
  584.  *              }
  585.  *          },
  586.  *          "product_class_based_get_selects"={
  587.  *              "method"="GET",
  588.  *              "path"="/product_classes/{class_id}/attributes_select.{_format}",
  589.  *              "identifiers"={"id"},
  590.  *              "input"=InputSelect::class,
  591.  *              "output"=OutputSelect::class,
  592.  *              "openapi_context"={
  593.  *                  "summary"="Retrieve a list of product class plain field attributes",
  594.  *                  "parameters"={
  595.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  596.  *                  }
  597.  *              }
  598.  *          },
  599.  *          "product_class_based_post_select"={
  600.  *              "method"="POST",
  601.  *              "path"="/product_classes/{class_id}/attributes_select.{_format}",
  602.  *              "identifiers"={"id"},
  603.  *              "input"=InputSelect::class,
  604.  *              "output"=OutputSelect::class,
  605.  *              "controller"="xcart.api.attribute.select.product_class_based_controller",
  606.  *              "openapi_context"={
  607.  *                  "summary"="Add a plain field attribute to a product class",
  608.  *                  "parameters"={
  609.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  610.  *                  }
  611.  *              }
  612.  *          },
  613.  *          "product_based_get_texts"={
  614.  *              "method"="GET",
  615.  *              "path"="/products/{product_id}/attributes_text.{_format}",
  616.  *              "identifiers"={"id"},
  617.  *              "input"=ProductAttributeInputText::class,
  618.  *              "output"=ProductAttributeOutputText::class,
  619.  *              "openapi_context"={
  620.  *                  "summary"="Retrieve a list of product-specific textarea attributes",
  621.  *                  "parameters"={
  622.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  623.  *                  }
  624.  *              }
  625.  *          },
  626.  *          "product_based_post_text"={
  627.  *              "method"="POST",
  628.  *              "path"="/products/{product_id}/attributes_text.{_format}",
  629.  *              "identifiers"={"id"},
  630.  *              "input"=ProductAttributeInputText::class,
  631.  *              "output"=ProductAttributeOutputText::class,
  632.  *              "controller"="xcart.api.attribute.text.product_based_controller",
  633.  *              "openapi_context"={
  634.  *                  "summary"="Add a textarea attribute to a product",
  635.  *                  "parameters"={
  636.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  637.  *                  }
  638.  *              }
  639.  *          },
  640.  *          "product_based_get_checkboxes"={
  641.  *              "method"="GET",
  642.  *              "path"="/products/{product_id}/attributes_checkbox.{_format}",
  643.  *              "identifiers"={"id"},
  644.  *              "input"=ProductAttributeInputCheckbox::class,
  645.  *              "output"=ProductAttributeOutputCheckbox::class,
  646.  *              "openapi_context"={
  647.  *                  "summary"="Retrieve a list of product-specific yes/no attributes",
  648.  *                  "parameters"={
  649.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  650.  *                  }
  651.  *              }
  652.  *          },
  653.  *          "product_based_post_checkbox"={
  654.  *              "method"="POST",
  655.  *              "path"="/products/{product_id}/attributes_checkbox.{_format}",
  656.  *              "identifiers"={"id"},
  657.  *              "input"=ProductAttributeInputCheckbox::class,
  658.  *              "output"=ProductAttributeOutputCheckbox::class,
  659.  *              "controller"="xcart.api.attribute.checkbox.product_based_controller",
  660.  *              "openapi_context"={
  661.  *                  "summary"="Add a yes/no attribute to a product",
  662.  *                  "parameters"={
  663.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  664.  *                  }
  665.  *              }
  666.  *          },
  667.  *          "product_based_get_selects"={
  668.  *              "method"="GET",
  669.  *              "path"="/products/{product_id}/attributes_select.{_format}",
  670.  *              "identifiers"={"id"},
  671.  *              "input"=ProductAttributeInputSelect::class,
  672.  *              "output"=ProductAttributeOutputSelect::class,
  673.  *              "openapi_context"={
  674.  *                  "summary"="Retrieve a list of product-specific plain field attributes",
  675.  *                  "parameters"={
  676.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  677.  *                  }
  678.  *              }
  679.  *          },
  680.  *          "product_based_post_select"={
  681.  *              "method"="POST",
  682.  *              "path"="/products/{product_id}/attributes_select.{_format}",
  683.  *              "identifiers"={"id"},
  684.  *              "input"=ProductAttributeInputSelect::class,
  685.  *              "output"=ProductAttributeOutputSelect::class,
  686.  *              "controller"="xcart.api.attribute.select.product_based_controller",
  687.  *              "openapi_context"={
  688.  *                  "summary"="Add a plain field attribute to a product",
  689.  *                  "parameters"={
  690.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  691.  *                  }
  692.  *              }
  693.  *          }
  694.  *     }
  695.  * )
  696.  */
  697. class Attribute extends \XLite\Model\Base\I18n
  698. {
  699.     use ExecuteCachedTrait;
  701.     /*
  702.      * Attribute types
  703.      */
  704.     public const TYPE_TEXT     = 'T';
  705.     public const TYPE_CHECKBOX = 'C';
  706.     public const TYPE_SELECT   = 'S';
  707.     public const TYPE_HIDDEN   = 'H';
  709.     /*
  710.      * Add to new products or class’s assigns automatically with select value
  711.      */
  712.     public const ADD_TO_NEW_YES    = 'Y'; // 'Yes'
  713.     public const ADD_TO_NEW_NO     = 'N'; // 'NO'
  714.     public const ADD_TO_NEW_YES_NO = 'B'; // 'YES/NO' (BOTH)
  716.     /*
  717.      * Attribute delimiter
  718.      */
  719.     public const DELIMITER = ', ';
  721.     /*
  722.      * Display modes
  723.      */
  724.     public const SELECT_BOX_MODE = 'S';
  725.     public const SPECIFICATION_MODE = 'P';
  726.     public const BLOCKS_MODE     = 'B';
  728.     /**
  729.      * @var int
  730.      *
  731.      * @ORM\Id
  732.      * @ORM\GeneratedValue (strategy="AUTO")
  733.      * @ORM\Column (type="integer", options={ "unsigned": true })
  734.      */
  735.     protected $id;
  737.     /**
  738.      * @var int
  739.      *
  740.      * @ORM\Column (type="integer")
  741.      */
  742.     protected $position = 0;
  744.     /**
  745.      * Is attribute shown above the price
  746.      *
  747.      * @var bool
  748.      *
  749.      * @ORM\Column (type="boolean", options={"default":"0"})
  750.      */
  751.     protected $displayAbove = false;
  753.     /**
  754.      * @var int
  755.      *
  756.      * @ORM\Column (type="integer", length=1)
  757.      */
  758.     protected $decimals = 0;
  760.     /**
  761.      * @var \XLite\Model\ProductClass
  762.      *
  763.      * @ORM\ManyToOne (targetEntity="XLite\Model\ProductClass", inversedBy="attributes")
  764.      * @ORM\JoinColumn (name="product_class_id", referencedColumnName="id", onDelete="CASCADE")
  765.      */
  766.     protected $productClass;
  768.     /**
  769.      * @var \XLite\Model\AttributeGroup
  770.      *
  771.      * @ORM\ManyToOne (targetEntity="XLite\Model\AttributeGroup", inversedBy="attributes")
  772.      * @ORM\JoinColumn (name="attribute_group_id", referencedColumnName="id")
  773.      */
  774.     protected $attributeGroup;
  776.     /**
  777.      * @var \Doctrine\Common\Collections\Collection
  778.      *
  779.      * @ORM\OneToMany (targetEntity="XLite\Model\AttributeOption", mappedBy="attribute", cascade={"all"})
  780.      */
  781.     protected $attribute_options;
  783.     /**
  784.      * @var \XLite\Model\Product
  785.      *
  786.      * @ORM\ManyToOne (targetEntity="XLite\Model\Product", inversedBy="attributes")
  787.      * @ORM\JoinColumn (name="product_id", referencedColumnName="product_id", onDelete="CASCADE")
  788.      */
  789.     protected $product;
  791.     /**
  792.      * Option type
  793.      *
  794.      * @var string
  795.      *
  796.      * @ORM\Column (type="string", options={"fixed": true}, length=1)
  797.      */
  798.     protected $type = self::TYPE_SELECT;
  800.     /**
  801.      * @var string
  802.      *
  803.      * @ORM\Column (type="string", options={"fixed": true}, length=1)
  804.      */
  805.     protected $displayMode = '';
  807.     /**
  808.      * Add to new products or class’s assigns automatically
  809.      *
  810.      * @var bool
  811.      *
  812.      * @ORM\Column (type="string", options={"fixed": true}, length=1)
  813.      */
  814.     protected $addToNew = '';
  816.     /**
  817.      * @var \Doctrine\Common\Collections\Collection
  818.      *
  819.      * @ORM\OneToMany (targetEntity="XLite\Model\AttributeProperty", mappedBy="attribute")
  820.      */
  821.     protected $attribute_properties;
  823.     /**
  824.      * @var \Doctrine\Common\Collections\Collection
  825.      *
  826.      * @ORM\OneToMany (targetEntity="XLite\Model\AttributeTranslation", mappedBy="owner", cascade={"all"})
  827.      */
  828.     protected $translations;
  830.     private ?string $precalculatedName = null;
  831.     private ?int $precalculatedAddToNewOptionsCount = null;
  833.     /**
  834.      * Return name of widget class
  835.      *
  836.      * @param string $type      Attribute type
  837.      * @param string $interface Interface (Admin | Customer) OPTIONAL
  838.      *
  839.      * @return string
  840.      */
  841.     public static function getWidgetClass($type, $interface = null)
  842.     {
  843.         if ($interface === null) {
  844.             $interface = \XLite::isAdminZone() ? 'Admin' : 'Customer';
  845.         }
  847.         return '\XLite\View\Product\AttributeValue\\'
  848.             . $interface
  849.             . '\\'
  850.             . static::getTypes($type, true);
  851.     }
  853.     /**
  854.      * Return name of value class
  855.      *
  856.      * @param string $type Type
  857.      *
  858.      * @return string
  859.      */
  860.     public static function getAttributeValueClass($type)
  861.     {
  862.         return '\XLite\Model\AttributeValue\AttributeValue'
  863.             . static::getTypes($type, true);
  864.     }
  866.     /**
  867.      * Constructor
  868.      *
  869.      * @param array $data Entity properties OPTIONAL
  870.      */
  871.     public function __construct(array $data = [])
  872.     {
  873.         $this->attribute_options = new \Doctrine\Common\Collections\ArrayCollection();
  875.         parent::__construct($data);
  876.     }
  878.     /**
  879.      * Return number of products associated with this attribute
  880.      *
  881.      * @return integer
  882.      */
  883.     public function getProductsCount()
  884.     {
  885.         return $this->getClass()->getProductsCount();
  886.     }
  888.     /**
  889.      * Return list of types or type
  890.      *
  891.      * @param string  $type              Type OPTIONAL
  892.      * @param boolean $returnServiceType Return service type OPTIONAL
  893.      *
  894.      * @return array | string
  895.      */
  896.     public static function getTypes($type = null, $returnServiceType = false)
  897.     {
  898.         $list = [
  899.             static::TYPE_SELECT   => static::t('Plain field'),
  900.             static::TYPE_TEXT     => static::t('Textarea'),
  901.             static::TYPE_CHECKBOX => static::t('Yes/No'),
  902.             static::TYPE_HIDDEN   => static::t('Hidden field'),
  903.         ];
  905.         $listServiceTypes = [
  906.             static::TYPE_SELECT   => 'Select',
  907.             static::TYPE_TEXT     => 'Text',
  908.             static::TYPE_CHECKBOX => 'Checkbox',
  909.             static::TYPE_HIDDEN   => 'Hidden',
  910.         ];
  912.         $list = $returnServiceType ? $listServiceTypes : $list;
  914.         return $type !== null
  915.             ? ($list[$type] ?? null)
  916.             : $list;
  917.     }
  919.     /**
  920.      * Return list of 'addToNew' types
  921.      *
  922.      * @return array
  923.      */
  924.     public static function getAddToNewTypes()
  925.     {
  926.         return [
  927.             static::ADD_TO_NEW_YES,
  928.             static::ADD_TO_NEW_NO,
  929.             static::ADD_TO_NEW_YES_NO,
  930.         ];
  931.     }
  933.     /**
  934.      * Return values associated with this attribute
  935.      *
  936.      * @return list<\Xlite\Model\AttributeValue\AAttributeValue>
  937.      */
  938.     public function getAttributeValues()
  939.     {
  940.         $cnd = new \XLite\Core\CommonCell();
  941.         $cnd->attribute = $this;
  943.         return Database::getRepo(static::getAttributeValueClass($this->getType()))
  944.             ->search($cnd);
  945.     }
  947.     /**
  948.      * Return number of values associated with this attribute
  949.      *
  950.      * @return integer
  951.      */
  952.     public function getAttributeValuesCount()
  953.     {
  954.         $cnd = new \XLite\Core\CommonCell();
  955.         $cnd->attribute = $this;
  957.         return Database::getRepo(static::getAttributeValueClass($this->getType()))
  958.             ->search($cnd, true);
  959.     }
  961.     /**
  962.      * Set 'addToNew' value
  963.      *
  964.      * @param string|array $value Value
  965.      *
  966.      * @return void
  967.      */
  968.     public function setAddToNew($value)
  969.     {
  970.         if (
  971.             is_array($value)
  972.             && $this->getType() === static::TYPE_CHECKBOX
  973.         ) {
  974.             if (count($value) === 2) {
  975.                 $value = static::ADD_TO_NEW_YES_NO;
  976.             } elseif (count($value) === 1) {
  977.                 $value = array_shift($value) ? static::ADD_TO_NEW_YES : static::ADD_TO_NEW_NO;
  978.             }
  979.         }
  981.         $this->addToNew = in_array($value, static::getAddToNewTypes()) ? $value : '';
  982.     }
  984.     /**
  985.      * Get 'addToNew' value
  986.      *
  987.      * @return array
  988.      */
  989.     public function getAddToNew()
  990.     {
  991.         $value = null;
  992.         if ($this->getType() === static::TYPE_CHECKBOX) {
  993.             switch ($this->addToNew) {
  994.                 case static::ADD_TO_NEW_YES:
  995.                     $value = [1];
  996.                     break;
  998.                 case static::ADD_TO_NEW_NO:
  999.                     $value = [0];
  1000.                     break;
  1002.                 case static::ADD_TO_NEW_YES_NO:
  1003.                     $value = [0, 1];
  1004.                     break;
  1006.                 default:
  1007.             }
  1008.         }
  1010.         return $value;
  1011.     }
  1013.     /**
  1014.      * Set type
  1015.      *
  1016.      * @param string $type Type
  1017.      *
  1018.      * @return void
  1019.      */
  1020.     public function setType($type)
  1021.     {
  1022.         $types = static::getTypes();
  1024.         if (isset($types[$type])) {
  1025.             if (
  1026.                 $this->type
  1027.                 && $type != $this->type
  1028.                 && $this->getId()
  1029.             ) {
  1030.                 foreach ($this->getAttributeOptions() as $option) {
  1031.                     Database::getEM()->remove($option);
  1032.                 }
  1033.                 foreach ($this->getAttributeValues() as $value) {
  1034.                     Database::getEM()->remove($value);
  1035.                 }
  1036.             }
  1037.             $this->type = $type;
  1038.         }
  1039.     }
  1041.     /**
  1042.      * Return product property (return new property if property does not exist)
  1043.      *
  1044.      * @param \XLite\Model\Product $product Product OPTIONAL
  1045.      *
  1046.      * @return \XLite\Model\AttributeProperty
  1047.      */
  1048.     public function getProperty($product)
  1049.     {
  1050.         return $this->executeCachedRuntime(function () use ($product) {
  1051.             $property = null;
  1052.             if ($product->getProductId()) {
  1053.                 $product = Database::getRepo(\XLite\Model\Product::class)?->find($product->getProductId());
  1054.                 $property = Database::getRepo(\XLite\Model\AttributeProperty::class)?->findOneBy([
  1055.                     'product' => $product,
  1056.                     'attribute'  => $this,
  1057.                 ]);
  1059.                 if ($property === null) {
  1060.                     $property = $this->getNewProperty($product);
  1061.                 }
  1062.             }
  1064.             return $property;
  1065.         }, ['getProperty', $this->getId(), $product->getProductId()]);
  1066.     }
  1068.     /**
  1069.      * Return new product property
  1070.      *
  1071.      * @param \XLite\Model\Product $product Product OPTIONAL
  1072.      *
  1073.      * @return \XLite\Model\AttributeProperty
  1074.      */
  1075.     protected function getNewProperty($product)
  1076.     {
  1077.         $result = new \XLite\Model\AttributeProperty();
  1078.         $result->setAttribute($this);
  1079.         $result->setProduct($product);
  1080.         $result->setDisplayAbove($this->getDisplayAbove());
  1081.         $this->addAttributeProperty($result);
  1082.         Database::getEM()->persist($result);
  1084.         return $result;
  1085.     }
  1087.     /**
  1088.      * Returns position
  1089.      *
  1090.      * @param \XLite\Model\Product $product Product OPTIONAL
  1091.      *
  1092.      * @return integer
  1093.      */
  1094.     public function getPosition($product = null)
  1095.     {
  1096.         if ($product) {
  1097.             $result = $this->getProperty($product);
  1098.             $result = $result ? $result->getPosition() : 0;
  1099.         } else {
  1100.             $result = $this->position;
  1101.         }
  1103.         return $result;
  1104.     }
  1106.     /**
  1107.      * Set the position
  1108.      *
  1109.      * @param integer|array $value
  1110.      *
  1111.      * @return void
  1112.      */
  1113.     public function setPosition($value)
  1114.     {
  1115.         if (is_array($value)) {
  1116.             $property = $this->getProperty($value['product']);
  1117.             $property->setPosition($value['position']);
  1118.         } else {
  1119.             $this->position = $value;
  1120.         }
  1121.     }
  1123.     /**
  1124.      * @param \XLite\Model\Product $product Product OPTIONAL
  1125.      *
  1126.      * @return integer
  1127.      */
  1128.     public function getDisplayAbove($product = null)
  1129.     {
  1130.         if ($product) {
  1131.             $result = $this->getProperty($product);
  1132.             $result = $result ? $result->getDisplayAbove() : $this->displayAbove;
  1133.         } else {
  1134.             $result = $this->displayAbove;
  1135.         }
  1137.         return $result;
  1138.     }
  1140.     /**
  1141.      * @param boolean|array $value
  1142.      *
  1143.      * @return void
  1144.      */
  1145.     public function setDisplayAbove($value)
  1146.     {
  1147.         if (is_array($value)) {
  1148.             $property = $this->getProperty($value['product']);
  1149.             $property->setDisplayAbove($value['displayAbove']);
  1150.         } else {
  1151.             $this->displayAbove = $value;
  1152.         }
  1153.     }
  1155.     /**
  1156.      * Add to new product
  1157.      *
  1158.      * @param \XLite\Model\Product $product Product
  1159.      *
  1160.      * @return void
  1161.      */
  1162.     public function addToNewProduct(\XLite\Model\Product $product)
  1163.     {
  1164.         $displayAbove = $this->getDisplayAbove();
  1166.         if ($this->getAddToNew()) {
  1167.             $displayAbove = count($this->getAddToNew()) > 1 ?: $displayAbove;
  1169.             foreach ($this->getAddToNew() as $value) {
  1170.                 $av = $this->createAttributeValue($product);
  1171.                 if ($av) {
  1172.                     $av->setValue($value);
  1173.                 }
  1174.             }
  1175.         } elseif ($this->getType() === static::TYPE_SELECT) {
  1176.             $attributeOptions = Database::getRepo(AttributeOption::class)->findBy(
  1177.                 [
  1178.                     'attribute' => $this,
  1179.                     'addToNew'  => true,
  1180.                 ],
  1181.                 ['position' => 'ASC']
  1182.             );
  1184.             $displayAbove = count($attributeOptions) > 1 ?: $displayAbove;
  1186.             foreach ($attributeOptions as $attributeOption) {
  1187.                 $av = $this->createAttributeValue($product);
  1188.                 if ($av) {
  1189.                     $av->setAttributeOption($attributeOption);
  1190.                     $av->setPosition($attributeOption->getPosition());
  1191.                 }
  1192.             }
  1193.         } elseif ($this->getType() === static::TYPE_TEXT) {
  1194.             $av = $this->createAttributeValue($product);
  1195.             if ($av) {
  1196.                 $av->setEditable(false);
  1197.                 $av->setValue('');
  1198.             }
  1199.         } elseif ($this->getType() === static::TYPE_HIDDEN) {
  1200.             $attributeOption = Database::getRepo(AttributeOption::class)->findOneBy(
  1201.                 [
  1202.                     'attribute' => $this,
  1203.                     'addToNew'  => true,
  1204.                 ]
  1205.             );
  1207.             if ($attributeOption) {
  1208.                 $av = $this->createAttributeValue($product);
  1209.                 if ($av) {
  1210.                     $av->setAttributeOption($attributeOption);
  1211.                 }
  1212.             }
  1213.         }
  1215.         $this->setDisplayAbove(
  1216.             [
  1217.                 'product' => $product,
  1218.                 'displayAbove' => $displayAbove,
  1219.             ]
  1220.         );
  1221.     }
  1223.     /**
  1224.      * Apply changes
  1225.      *
  1226.      * @param \XLite\Model\Product $product Product
  1227.      * @param mixed                $changes Changes
  1228.      *
  1229.      * @return void
  1230.      */
  1231.     public function applyChanges(\XLite\Model\Product $product, $changes)
  1232.     {
  1233.         if (
  1234.             (
  1235.                 !$this->getProductClass()
  1236.                 && !$this->getProduct()
  1237.             )
  1238.             || (
  1239.                 $this->getProductClass()
  1240.                 && $product->getProductClass()
  1241.                 && $this->getProductClass()->getId() == $product->getProductClass()->getId()
  1242.             )
  1243.             || ($this->getProduct()
  1244.                 && $this->getProduct()->getId() == $product->getId()
  1245.             )
  1246.         ) {
  1247.             $class = static::getAttributeValueClass($this->getType());
  1248.             $repo = Database::getRepo($class);
  1250.             switch ($this->getType()) {
  1251.                 case static::TYPE_TEXT:
  1252.                     $this->setAttributeValue($product, $changes);
  1253.                     break;
  1255.                 case static::TYPE_CHECKBOX:
  1256.                 case static::TYPE_SELECT:
  1257.                     foreach ($repo->findBy(['product' => $product, 'attribute' => $this]) as $av) {
  1258.                         $uniq = $this->getType() === static::TYPE_CHECKBOX
  1259.                             ? $av->getValue()
  1260.                             : $av->getAttributeOption()->getId();
  1262.                         if (in_array($uniq, $changes['deleted'])) {
  1263.                             $repo->delete($av, false);
  1264.                         } elseif (
  1265.                             isset($changes['changed'][$uniq])
  1266.                             || isset($changes['added'][$uniq])
  1267.                         ) {
  1268.                             $data = $changes['changed'][$uniq] ?? $changes['added'][$uniq];
  1270.                             if (
  1271.                                 isset($data['defaultValue'])
  1272.                                 && $data['defaultValue']
  1273.                                 && !$av->getDefaultValue()
  1274.                             ) {
  1275.                                 $pr = $repo->findOneBy(
  1276.                                     [
  1277.                                         'product'      => $product,
  1278.                                         'attribute'    => $this,
  1279.                                         'defaultValue' => true,
  1280.                                     ]
  1281.                                 );
  1282.                                 if ($pr) {
  1283.                                     $pr->setDefaultValue(false);
  1284.                                 }
  1285.                             }
  1287.                             $repo->update($av, $data);
  1289.                             if (isset($changes['added'][$uniq])) {
  1290.                                 unset($changes['added'][$uniq]);
  1291.                             }
  1292.                         }
  1293.                     }
  1295.                     if ($changes['added']) {
  1296.                         foreach ($changes['added'] as $uniq => $data) {
  1297.                             if (
  1298.                                 isset($data['defaultValue'])
  1299.                                 && $data['defaultValue']
  1300.                             ) {
  1301.                                 $pr = $repo->findOneBy(
  1302.                                     [
  1303.                                         'product'      => $product,
  1304.                                         'attribute'    => $this,
  1305.                                         'defaultValue' => true,
  1306.                                     ]
  1307.                                 );
  1308.                                 if ($pr) {
  1309.                                     $pr->setDefaultValue(false);
  1310.                                 }
  1311.                             }
  1312.                             $av = $this->createAttributeValue($product);
  1314.                             if ($av) {
  1315.                                 if ($this->getType() === static::TYPE_CHECKBOX) {
  1316.                                     $av->setValue($uniq);
  1317.                                 } else {
  1318.                                     $av->setAttributeOption(
  1319.                                         Database::getRepo(AttributeOption::class)->find($uniq)
  1320.                                     );
  1321.                                 }
  1322.                                 $repo->update($av, $data);
  1323.                             }
  1324.                         }
  1325.                     }
  1326.                     break;
  1328.                 default:
  1329.             }
  1330.             Database::getEM()->flush();
  1331.         }
  1332.     }
  1334.     /**
  1335.      * Set attribute value
  1336.      *
  1337.      * @param \XLite\Model\Product $product Product
  1338.      * @param mixed                $data    Value
  1339.      *
  1340.      * @return void
  1341.      */
  1342.     public function setAttributeValue(\XLite\Model\Product $product, $data, bool $flush = true)
  1343.     {
  1344.         $repo = Database::getRepo(
  1345.             static::getAttributeValueClass($this->getType())
  1346.         );
  1348.         $method = $this->defineSetAttributeValueMethodName($data);
  1349.         $this->$method($repo, $product, $data, $flush);
  1350.     }
  1352.     /**
  1353.      * Get attribute value
  1354.      *
  1355.      * @param \XLite\Model\Product $product  Product
  1356.      * @param boolean              $asString As string flag OPTIONAL
  1357.      *
  1358.      * @return mixed
  1359.      */
  1360.     public function getAttributeValue(\XLite\Model\Product $product, $asString = false)
  1361.     {
  1362.         return Database::getRepo(static::class)?->getAttributeValue($product, $this->getType(), $this->getId(), $asString);
  1363.     }
  1365.     /**
  1366.      * Get attribute value
  1367.      *
  1368.      * @param \XLite\Model\Product $product Product
  1369.      *
  1370.      * @return \XLite\Model\AttributeValue\AAttributeValue
  1371.      */
  1372.     public function getDefaultAttributeValue(\XLite\Model\Product $product)
  1373.     {
  1374.         $repo = Database::getRepo(static::getAttributeValueClass($this->getType()));
  1376.         $attributeValue = $repo->findOneBy(['product' => $product, 'attribute' => $this, 'defaultValue' => true]);
  1377.         if (!$attributeValue) {
  1378.             $attributeValue = $repo->findDefaultAttributeValue(['product' => $product, 'attribute' => $this]);
  1379.         }
  1381.         return $attributeValue;
  1382.     }
  1384.     /**
  1385.      * This attribute is multiple or not flag
  1386.      *
  1387.      * @param \XLite\Model\Product $product Product
  1388.      *
  1389.      * @return boolean
  1390.      */
  1391.     public function isMultiple(\XLite\Model\Product $product)
  1392.     {
  1393.         $repo = Database::getRepo(static::getAttributeValueClass($this->getType()));
  1395.         return (!$this->getProduct() || $this->getProduct()->getId() == $product->getId())
  1396.             && (!$this->getProductClass()
  1397.                 || ($product->getProductClass()
  1398.                     && $this->getProductClass()->getId() == $product->getProductClass()->getId()
  1399.                 )
  1400.             )
  1401.             && 1 < count($repo->findBy(['product' => $product, 'attribute' => $this]));
  1402.     }
  1404.     /**
  1405.      * This attribute is hidden or not flag
  1406.      *
  1407.      * @return bool
  1408.      */
  1409.     public function isHidden()
  1410.     {
  1411.         return $this->getType() === static::TYPE_HIDDEN;
  1412.     }
  1414.     /**
  1415.      * Create attribute value
  1416.      *
  1417.      * @param \XLite\Model\Product $product Product
  1418.      *
  1419.      * @return mixed
  1420.      */
  1421.     protected function createAttributeValue(\XLite\Model\Product $product)
  1422.     {
  1423.         $class = static::getAttributeValueClass($this->getType());
  1425.         $attributeValue = new $class();
  1426.         $attributeValue->setProduct($product);
  1427.         $attributeValue->setAttribute($this);
  1428.         Database::getEM()->persist($attributeValue);
  1430.         return $attributeValue;
  1431.     }
  1433.     /**
  1434.      * Create attribute option
  1435.      *
  1436.      * @param string $value Option name
  1437.      *
  1438.      * @return AttributeOption
  1439.      */
  1440.     protected function createAttributeOption($value)
  1441.     {
  1442.         $attributeOption = new AttributeOption();
  1443.         $attributeOption->setAttribute($this);
  1444.         $attributeOption->setName($value);
  1446.         Database::getEM()->persist($attributeOption);
  1448.         return $attributeOption;
  1449.     }
  1451.     // {{{ Set attribute value
  1453.     /**
  1454.      * Define method name for 'setAttributeValue' operation
  1455.      *
  1456.      * @param mixed $data Data
  1457.      *
  1458.      * @return string
  1459.      */
  1460.     protected function defineSetAttributeValueMethodName($data)
  1461.     {
  1462.         if ($this->getType() === static::TYPE_SELECT) {
  1463.             $result = 'setAttributeValueSelect';
  1464.         } elseif ($this->getType() === static::TYPE_CHECKBOX && isset($data['multiple']) && $data['multiple']) {
  1465.             $result = 'setAttributeValueCheckbox';
  1466.         } elseif ($this->getType() === static::TYPE_HIDDEN) {
  1467.             $result = 'setAttributeValueHidden';
  1468.         } else {
  1469.             $result = 'setAttributeValueDefault';
  1470.         }
  1472.         return $result;
  1473.     }
  1475.     /**
  1476.      * Set attribute value (select)
  1477.      *
  1478.      * @param \XLite\Model\Repo\ARepo $repo    Repository
  1479.      * @param \XLite\Model\Product    $product Product
  1480.      * @param array                   $data    Data
  1481.      *
  1482.      * @return void
  1483.      */
  1484.     protected function setAttributeValueSelect(
  1485.         \XLite\Model\Repo\ARepo $repo,
  1486.         \XLite\Model\Product $product,
  1487.         array $data,
  1488.         bool $flush = true
  1489.     ) {
  1490.         $ids = [];
  1491.         $values = $data['value'] ?? [];
  1492.         krsort($values);
  1493.         foreach ($values as $id => $value) {
  1494.             $value = trim($value);
  1495.             if (strlen($value) > 0 && is_int($id)) {
  1496.                 if (!isset($data['deleteValue'][$id])) {
  1497.                     [$avId] = $this->setAttributeValueSelectItem($repo, $product, $data, $id, $value, $flush);
  1498.                     $ids[$avId] = $avId;
  1499.                 }
  1501.                 if (!isset($data['multiple'])) {
  1502.                     break;
  1503.                 }
  1504.             }
  1505.         }
  1507.         // Make a performance curtsy, especially to import.
  1508.         // We don't need to do anything with EM if the collection hasn't been initialized (fetched from DB).
  1509.         $isCollectionInitialized = $product
  1510.             && $product->getAttributeValueS() instanceof PersistentCollection
  1511.             && $product->getAttributeValueS()->isInitialized();
  1513.         foreach ($repo->findBy(['product' => $product, 'attribute' => $this]) as $data) {
  1514.             if ($data->getId() && !isset($ids[$data->getId()])) {
  1515.                 $repo->delete($data, false);
  1517.                 if ($isCollectionInitialized) {
  1518.                     // We have to delete child entities in EM otherwise it will be cascadePersisted again (unmark2delete)
  1519.                     // for ex. here \XLite\Logic\Import\Processor\AProcessor::importData()->\XLite\Core\Database::getEM()->persist($model); XCB-2770
  1520.                     // according to doctrine doc https://www.doctrine-project.org/projects/doctrine-orm/en/2.17/reference/working-with-objects.html#persisting-entities
  1521.                     $product->getAttributeValueS()->removeElement($data);
  1522.                 }
  1523.             }
  1524.         }
  1525.     }
  1527.     protected function setAttributeValueSelectItem(
  1528.         \XLite\Model\Repo\ARepo $repo,
  1529.         \XLite\Model\Product $product,
  1530.         array $data,
  1531.         $id,
  1532.         $value,
  1533.         bool $flush = true
  1534.     ) {
  1535.         static $runtimeCacheAttributeValues = [];
  1537.         static $runtimeCacheAttributeOptions = [];
  1539.         $result = [null, null, null];
  1540.         $attributeValue = $this->getAttributeOptionByValue($repo, $data, $id, $value);
  1541.         $attributeOption = $this->getAttributeOption($value, $attributeValue, $runtimeCacheAttributeOptions);
  1543.         if (!$attributeValue) {
  1544.             $attributeValue = $this->findOrCreateAttributeValue($repo, $attributeOption, $product, $id, $data, $runtimeCacheAttributeValues);
  1545.         }
  1547.         if ($attributeValue) {
  1548.             $this->processAttributeValue($attributeValue, $attributeOption, $data, $id);
  1550.             if ($flush) {
  1551.                 Database::getEM()->flush();
  1552.             }
  1554.             $result = [
  1555.                 $attributeValue->getId(),
  1556.                 $attributeValue,
  1557.                 $attributeOption,
  1558.             ];
  1559.         }
  1561.         return $result;
  1562.     }
  1565.     protected function getAttributeOptionByValue(Arepo $repo, array $data, ?int $id, ?string $value): ?AAttributeValue
  1566.     {
  1567.         if ($id > 0 &&  !isset($data['ignoreIds']) && $this->getProduct()) {
  1568.             $attributeValue = $repo->find($id);
  1569.             if ($attributeValue) {
  1570.                 $attributeOption = $attributeValue->getAttributeOption();
  1571.                 $attributeOption->setName($value);
  1572.                 return $attributeValue;
  1573.             }
  1574.         }
  1575.         return null;
  1576.     }
  1578.     protected function getAttributeOption(
  1579.         ?string $value,
  1580.         ?AAttributeValue $attributeValue,
  1581.         array &$attributeOptionsRuntimeCache
  1582.     ): AttributeOption {
  1583.         $attributeOptionKey = spl_object_id($this) . $value;
  1585.         if ($attributeOption = $attributeOptionsRuntimeCache[$attributeOptionKey] ?? null) {
  1586.             return $attributeOption;
  1587.         }
  1589.         if ($attributeValue) {
  1590.             return $attributeValue->getAttributeOption();
  1591.         }
  1593.         $attributeOption = Database::getRepo(AttributeOption::class)
  1594.             ->findOneByNameAndAttribute($value, $this);
  1596.         if ($attributeOption) {
  1597.             return $attributeOption;
  1598.         }
  1600.         $attributeOption = $this->createAttributeOption($value);
  1602.         $attributeOptionsRuntimeCache[$attributeOptionKey] = $attributeOption;
  1604.         return $attributeOption;
  1605.     }
  1607.     protected function findOrCreateAttributeValue(
  1608.         ARepo $repo,
  1609.         AttributeOption $attributeOption,
  1610.         Product $product,
  1611.         ?int $id,
  1612.         array $data,
  1613.         array &$runtimeCacheAttributeValues = []
  1614.     ): AAttributeValue {
  1615.         $attributeValueCacheKey = spl_object_id($product) . $attributeOption?->getId();
  1617.         $attributeValue = $repo->findOneBy([
  1618.             'attribute_option' => $attributeOption,
  1619.             'product' => $product,
  1620.         ]);
  1622.         if (!$attributeValue && $id > 0 && !isset($data['ignoreIds'])) {
  1623.             $attributeValue = $repo->find($id);
  1624.         } elseif (isset($runtimeCacheAttributeValues[$attributeValueCacheKey]) && $attributeOption?->getId()) {
  1625.             $attributeValue = $runtimeCacheAttributeValues[$attributeValueCacheKey];
  1626.         }
  1628.         if (!$attributeValue) {
  1629.             $attributeValue = $this->createAttributeValue($product);
  1630.             $this->setAttributeValuePosition($attributeValue, $product);
  1631.             $product->addAttributeValueS($attributeValue);
  1633.             $runtimeCacheAttributeValues[$attributeValueCacheKey] = $attributeValue;
  1634.         }
  1636.         return $attributeValue;
  1637.     }
  1639.     protected function setAttributeValuePosition(AAttributeValue $attributeValue, Product $product): void
  1640.     {
  1641.         $attributeValue->setPosition(
  1642.             array_reduce(
  1643.                 $product->getAttributeValueS()->toArray(),
  1644.                 function ($carry, AttributeValueSelect $item) {
  1645.                     return $item->getAttribute() === $this ? max($carry, $item->getPosition()) : $carry;
  1646.                 },
  1647.                 0
  1648.             ) + 10
  1649.         );
  1650.     }
  1652.     protected function processAttributeValue($attributeValue, $attributeOption, $data, $id)
  1653.     {
  1654.         $attributeValue->setAttributeOption($attributeOption);
  1655.         $attributeValue->setDefaultValue(isset($data['default'][$id]));
  1657.         foreach ($attributeValue::getModifiers() as $modifier => $options) {
  1658.             if (isset($data[$modifier][$id])) {
  1659.                 $attributeValue->setModifier($data[$modifier][$id], $modifier);
  1660.             }
  1661.         }
  1662.     }
  1664.     /**
  1665.      * Set attribute value (checkbox)
  1666.      *
  1667.      * @param \XLite\Model\Repo\ARepo $repo    Repository
  1668.      * @param \XLite\Model\Product    $product Product
  1669.      * @param array                   $data    Data
  1670.      *
  1671.      * @return void
  1672.      */
  1673.     protected function setAttributeValueCheckbox(
  1674.         \XLite\Model\Repo\ARepo $repo,
  1675.         \XLite\Model\Product $product,
  1676.         array $data,
  1677.         bool $flush = true
  1678.     ) {
  1679.         foreach ([true, false] as $value) {
  1680.             $this->setAttributeValueCheckboxItem($repo, $product, $data, $value);
  1681.         }
  1682.     }
  1684.     /**
  1685.      * Set attribute value (checkbox item)
  1686.      *
  1687.      * @param \XLite\Model\Repo\ARepo $repo    Repository
  1688.      * @param \XLite\Model\Product    $product Product
  1689.      * @param array                   $data    Data
  1690.      * @param boolean|int             $value   Item value
  1691.      *
  1692.      * @return \XLite\Model\AttributeValue\AttributeValueCheckbox
  1693.      */
  1694.     protected function setAttributeValueCheckboxItem(
  1695.         \XLite\Model\Repo\ARepo $repo,
  1696.         \XLite\Model\Product $product,
  1697.         array $data,
  1698.         $value
  1699.     ) {
  1700.         $attributeValue = $repo->findOneBy(
  1701.             [
  1702.                 'product'   => $product,
  1703.                 'attribute' => $this,
  1704.                 'value'     => $value,
  1705.             ]
  1706.         );
  1708.         if (!$attributeValue) {
  1709.             $attributeValue = $this->createAttributeValue($product);
  1710.             $attributeValue->setValue($value);
  1711.         }
  1713.         $value = (int) $value;
  1714.         $attributeValue->setDefaultValue(isset($data['default'][$value]));
  1715.         foreach ($attributeValue::getModifiers() as $modifier => $options) {
  1716.             if (isset($data[$modifier]) && isset($data[$modifier][$value])) {
  1717.                 $attributeValue->setModifier($data[$modifier][$value], $modifier);
  1718.             }
  1719.         }
  1721.         return $attributeValue;
  1722.     }
  1724.     /**
  1725.      * Set attribute value (hidden)
  1726.      *
  1727.      * @param \XLite\Model\Repo\ARepo $repo    Repository
  1728.      * @param \XLite\Model\Product    $product Product
  1729.      * @param array                   $data    Data
  1730.      *
  1731.      * @return void
  1732.      */
  1733.     protected function setAttributeValueHidden(
  1734.         \XLite\Model\Repo\ARepo $repo,
  1735.         \XLite\Model\Product $product,
  1736.         array $data,
  1737.         bool $flush = true
  1738.     ) {
  1739.         $value = $data['value'] ?? [];
  1741.         if (is_array($value)) {
  1742.             $value = end($value);
  1743.         }
  1744.         $value = trim($value);
  1746.         if (strlen($value) != 0) {
  1747.             $this->setAttributeValueHiddenItem($repo, $product, $data, $value, $flush);
  1748.         } else {
  1749.             $attributeValue = $repo->findOneBy(
  1750.                 [
  1751.                     'attribute' => $this,
  1752.                     'product' => $product,
  1753.                 ]
  1754.             );
  1756.             if ($attributeValue) {
  1757.                 $repo->delete($attributeValue);
  1758.             }
  1759.         }
  1760.     }
  1762.     /**
  1763.      * Set hidden attribute item
  1764.      *
  1765.      * @param \XLite\Model\Repo\ARepo $repo    Repository
  1766.      * @param \XLite\Model\Product    $product Product
  1767.      * @param array                   $data    Data
  1768.      * @param mixed                   $value   Attribute value
  1769.      *
  1770.      * @return \XLite\Model\AttributeValue\AttributeValueHidden
  1771.      */
  1772.     protected function setAttributeValueHiddenItem(
  1773.         \XLite\Model\Repo\ARepo $repo,
  1774.         \XLite\Model\Product $product,
  1775.         array $data,
  1776.         $value,
  1777.         bool $flush = true
  1778.     ) {
  1779.         $attributeValue = $repo->findOneBy(
  1780.             [
  1781.                 'attribute' => $this,
  1782.                 'product' => $product,
  1783.             ]
  1784.         );
  1786.         $attributeOption = Database::getRepo(AttributeOption::class)
  1787.             ->findOneByNameAndAttribute($value, $this);
  1789.         if (!$attributeOption) {
  1790.             $attributeOption = $this->createAttributeOption($value);
  1791.         }
  1793.         if (!$attributeValue) {
  1794.             $attributeValue = $this->createAttributeValue($product);
  1795.             $product->addAttributeValueH($attributeValue);
  1796.         }
  1798.         if ($attributeValue) {
  1799.             $attributeValue->setAttributeOption($attributeOption);
  1801.             if ($flush) {
  1802.                 Database::getEM()->flush();
  1803.             }
  1804.         }
  1806.         return $attributeValue;
  1807.     }
  1809.     /**
  1810.      * Set attribute value (default)
  1811.      *
  1812.      * @param \XLite\Model\Repo\ARepo $repo    Repository
  1813.      * @param \XLite\Model\Product    $product Product
  1814.      * @param mixed                   $data    Data
  1815.      *
  1816.      * @return \XLite\Model\AttributeValue\AttributeValueText
  1817.      */
  1818.     protected function setAttributeValueDefault(
  1819.         \XLite\Model\Repo\ARepo $repo,
  1820.         \XLite\Model\Product $product,
  1821.         $data,
  1822.         bool $flush = true
  1823.     ) {
  1824.         $editable = is_array($data) && $this->getType() === static::TYPE_TEXT && isset($data['editable'])
  1825.             ? (bool) preg_match('/^1|yes|y|on$/iS', $data['editable'])
  1826.             : null;
  1827.         $value = is_array($data) ? $data['value'] : $data;
  1828.         $value = is_null($value) ? '' : $value;
  1829.         if (is_array($value)) {
  1830.             $value = array_shift($value);
  1831.         }
  1832.         $delete = true;
  1833.         $attributeValue = null;
  1835.         if ($value !== '' || $editable !== null || $this->getType() === static::TYPE_TEXT) {
  1836.             $attributeValue = $repo->findOneBy(['product' => $product, 'attribute' => $this]);
  1838.             if (!$attributeValue) {
  1839.                 $attributeValue = $this->createAttributeValue($product);
  1840.                 $delete = false;
  1841.             }
  1843.             $attributeValue->setValue($value);
  1844.             if ($editable !== null) {
  1845.                 $attributeValue->setEditable($editable);
  1846.             }
  1847.         }
  1849.         if ($delete) {
  1850.             foreach ($repo->findBy(['product' => $product, 'attribute' => $this]) as $data) {
  1851.                 if (!$attributeValue || $attributeValue->getId() !== $data->getId()) {
  1852.                     $repo->delete($data, false);
  1853.                 }
  1854.             }
  1855.         }
  1857.         return $attributeValue;
  1858.     }
  1860.     // }}}
  1862.     /**
  1863.      * Get id
  1864.      *
  1865.      * @return integer
  1866.      */
  1867.     public function getId()
  1868.     {
  1869.         return $this->id;
  1870.     }
  1872.     /**
  1873.      * Set decimals
  1874.      *
  1875.      * @param integer $decimals
  1876.      * @return Attribute
  1877.      */
  1878.     public function setDecimals($decimals)
  1879.     {
  1880.         $this->decimals = $decimals;
  1881.         return $this;
  1882.     }
  1884.     /**
  1885.      * Get decimals
  1886.      *
  1887.      * @return integer
  1888.      */
  1889.     public function getDecimals()
  1890.     {
  1891.         return $this->decimals;
  1892.     }
  1894.     /**
  1895.      * Get type
  1896.      *
  1897.      * @return string
  1898.      */
  1899.     public function getType()
  1900.     {
  1901.         return $this->type;
  1902.     }
  1904.     /**
  1905.      * Get display mode
  1906.      *
  1907.      * @param \XLite\Model\Product $product Product OPTIONAL
  1908.      * @return string
  1909.      */
  1910.     public function getDisplayMode($product = null)
  1911.     {
  1912.         $productId = $product
  1913.             ? $product->getId()
  1914.             : \XLite\Core\Request::getInstance()->product_id;
  1916.         $prop = $this->getProductAttributeProperty($productId);
  1918.         if ($prop && $prop->getDisplayMode()) {
  1919.             return $prop->getDisplayMode();
  1920.         }
  1922.         return $this->displayMode;
  1923.     }
  1925.     /**
  1926.      * @param $productId
  1927.      *
  1928.      * @return null|\XLite\Model\AttributeProperty
  1929.      */
  1930.     protected function getProductAttributeProperty($productId)
  1931.     {
  1932.         return $this->executeCachedRuntime(function () use ($productId) {
  1933.             $property = null;
  1935.             if (
  1936.                 $productId
  1937.                 && ($product = Database::getRepo(\XLite\Model\Product::class)->find($productId))
  1938.             ) {
  1939.                 $property = Database::getRepo(\XLite\Model\AttributeProperty::class)->findOneBy([
  1940.                     'product' => $product,
  1941.                     'attribute'  => $this,
  1942.                 ]);
  1943.             }
  1945.             return $property;
  1946.         }, ['getProductAttributeProperty', $this->getId(), $productId]);
  1947.     }
  1949.     /**
  1950.      * Set display mode
  1951.      *
  1952.      * @param string $value
  1953.      * @param boolean $isNew New attribute flag OPTIONAL
  1954.      *
  1955.      * @return Attribute
  1956.      */
  1957.     public function setDisplayMode($value, $isNew = false)
  1958.     {
  1959.         if (
  1960.             $this->displayMode !== $value
  1961.             && $this->getAttributeProperties()
  1962.             && (!\XLite\Core\Request::getInstance()->product_id
  1963.                 || $isNew)
  1964.         ) {
  1965.             foreach ($this->getAttributeProperties() as $prop) {
  1966.                 $prop->setDisplayMode($value);
  1967.             }
  1968.         }
  1970.         $this->displayMode = $value;
  1972.         return $this;
  1973.     }
  1975.     /**
  1976.      * Return display modes
  1977.      *
  1978.      * @return array
  1979.      */
  1980.     public static function getDisplayModes()
  1981.     {
  1982.         return [
  1983.             static::SELECT_BOX_MODE    => static::t('Selectbox'),
  1984.             static::BLOCKS_MODE        => static::t('Blocks'),
  1985.             static::SPECIFICATION_MODE => static::t('Specification'),
  1986.         ];
  1987.     }
  1989.     /**
  1990.      * Return display mode name
  1991.      *
  1992.      * @return string
  1993.      */
  1994.     public function getDisplayModeName()
  1995.     {
  1996.         $displayModes = self::getDisplayModes();
  1998.         return $displayModes[$this->displayMode] ?? '';
  1999.     }
  2001.     /**
  2002.      * Set productClass
  2003.      *
  2004.      * @param \XLite\Model\ProductClass $productClass
  2005.      * @return Attribute
  2006.      */
  2007.     public function setProductClass(\XLite\Model\ProductClass $productClass = null)
  2008.     {
  2009.         $this->productClass = $productClass;
  2010.         return $this;
  2011.     }
  2013.     /**
  2014.      * Get productClass
  2015.      *
  2016.      * @return \XLite\Model\ProductClass
  2017.      */
  2018.     public function getProductClass()
  2019.     {
  2020.         return $this->productClass;
  2021.     }
  2023.     /**
  2024.      * Set attributeGroup
  2025.      *
  2026.      * @param \XLite\Model\AttributeGroup $attributeGroup
  2027.      * @return Attribute
  2028.      */
  2029.     public function setAttributeGroup(\XLite\Model\AttributeGroup $attributeGroup = null)
  2030.     {
  2031.         $this->attributeGroup = $attributeGroup;
  2032.         return $this;
  2033.     }
  2035.     /**
  2036.      * Get attributeGroup
  2037.      *
  2038.      * @return \XLite\Model\AttributeGroup
  2039.      */
  2040.     public function getAttributeGroup()
  2041.     {
  2042.         return $this->attributeGroup;
  2043.     }
  2045.     /**
  2046.      * Add attribute_options
  2047.      *
  2048.      * @param AttributeOption $attributeOptions
  2049.      *
  2050.      * @return Attribute
  2051.      */
  2052.     public function addAttributeOptions(AttributeOption $attributeOptions)
  2053.     {
  2054.         $this->attribute_options[] = $attributeOptions;
  2055.         return $this;
  2056.     }
  2058.     /**
  2059.      * Get attribute_options
  2060.      *
  2061.      * @return \Doctrine\Common\Collections\Collection
  2062.      */
  2063.     public function getAttributeOptions()
  2064.     {
  2065.         return $this->attribute_options;
  2066.     }
  2068.     /**
  2069.      * Set product
  2070.      *
  2071.      * @param \XLite\Model\Product $product
  2072.      * @return Attribute
  2073.      */
  2074.     public function setProduct(\XLite\Model\Product $product = null)
  2075.     {
  2076.         $this->product = $product;
  2077.         return $this;
  2078.     }
  2080.     /**
  2081.      * Get product
  2082.      *
  2083.      * @return \XLite\Model\Product
  2084.      */
  2085.     public function getProduct()
  2086.     {
  2087.         return $this->product;
  2088.     }
  2090.     /**
  2091.      * Add attribute property
  2092.      *
  2093.      * @param \XLite\Model\AttributeProperty $attributeProperty
  2094.      * @return Attribute
  2095.      */
  2096.     public function addAttributeProperty(\XLite\Model\AttributeProperty $attributeProperty)
  2097.     {
  2098.         $this->attribute_properties[] = $attributeProperty;
  2099.         return $this;
  2100.     }
  2102.     /**
  2103.      * Get attribute_properties
  2104.      *
  2105.      * @return \Doctrine\Common\Collections\Collection
  2106.      */
  2107.     public function getAttributeProperties()
  2108.     {
  2109.         return $this->attribute_properties;
  2110.     }
  2112.     // {{{ Translation Getters / setters
  2114.     /**
  2115.      * @return string
  2116.      */
  2117.     public function getUnit()
  2118.     {
  2119.         return $this->getTranslationField(__FUNCTION__);
  2120.     }
  2122.     /**
  2123.      * @param string $unit
  2124.      *
  2125.      * @return \XLite\Model\Base\Translation
  2126.      */
  2127.     public function setUnit($unit)
  2128.     {
  2129.         return $this->setTranslationField(__FUNCTION__, $unit);
  2130.     }
  2132.     // }}}
  2134.     public function setName($name)
  2135.     {
  2136.         // Optimized check with precalculated name
  2137.         if ($this->getName() === $name) {
  2138.             return $this;
  2139.         }
  2141.         return parent::setName($name);
  2142.     }
  2144.     public function getName()
  2145.     {
  2146.         return $this->precalculatedName ?? parent::getName();
  2147.     }
  2149.     public function setPrecalculatedName(?string $precalculatedName): void
  2150.     {
  2151.         $this->precalculatedName = $precalculatedName;
  2152.     }
  2154.     public function hasAddToNew(): bool
  2155.     {
  2156.         if ($this->getAddToNew() && count($this->getAddToNew()) > 1) {
  2157.             return true;
  2158.         }
  2160.         if ($this->getType() === static::TYPE_SELECT) {
  2161.             $optionsCount = $this->getAddToNewOptionsCount();
  2163.             if ($optionsCount > 1) {
  2164.                 return true;
  2165.             }
  2166.         }
  2168.         return false;
  2169.     }
  2171.     public function setPrecalculatedAddToNewOptionsCount(?int $precalculatedAddToNewOptionsCount): void
  2172.     {
  2173.         $this->precalculatedAddToNewOptionsCount = $precalculatedAddToNewOptionsCount;
  2174.     }
  2176.     protected function getAddToNewOptionsCount(): int
  2177.     {
  2178.         return $this->precalculatedAddToNewOptionsCount ?? $this->calculateAddToNewOptionsCount();
  2179.     }
  2181.     protected function calculateAddToNewOptionsCount(): int
  2182.     {
  2183.         if ($this->getType() !== static::TYPE_SELECT) {
  2184.             return 0;
  2185.         }
  2187.         return Database::getRepo(AttributeOption::class)?->countBy(
  2188.             [
  2189.                 'attribute' => $this,
  2190.                 'addToNew'  => true,
  2191.             ]
  2192.         );
  2193.     }
  2194. }