classes/XLite/Model/Attribute.php line 687

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