vendor/pimcore/pimcore/lib/Google/Cse/Item.php line 21

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Google\Cse;
  18. use Google\Service\CustomSearchAPI\Result;
  19. use Pimcore\Model;
  21. trigger_deprecation('pimcore/pimcore', '10.6', 'The "%s" class is deprecated and will be removed in Pimcore 11.', Item::class);
  23. /**
  24.  * @deprecated since Pimcore 10.6 and will be removed in Pimcore 11
  25.  */
  26. class Item
  27. {
  28.     /**
  29.      * @var Result
  30.      */
  31.     public $raw;
  33.     /**
  34.      * @var string
  35.      */
  36.     public $title;
  38.     /**
  39.      * @var string
  40.      */
  41.     public $htmlTitle;
  43.     /**
  44.      * @var string
  45.      */
  46.     public $link;
  48.     /**
  49.      * @var string
  50.      */
  51.     public $displayLink;
  53.     /**
  54.      * @var string
  55.      */
  56.     public $snippet;
  58.     /**
  59.      * @var string
  60.      */
  61.     public $htmlSnippet;
  63.     /**
  64.      * @var string
  65.      */
  66.     public $formattedUrl;
  68.     /**
  69.      * @var string
  70.      */
  71.     public $htmlFormattedUrl;
  73.     /**
  74.      * @var Model\Asset\Image|string|null
  75.      */
  76.     public $image;
  78.     /**
  79.      * @var Model\Document|null
  80.      */
  81.     public $document;
  83.     /**
  84.      * @var string
  85.      */
  86.     public $type;
  88.     /**
  89.      * @param Result $data
  90.      */
  91.     public function __construct(Result $data)
  92.     {
  93.         $this->setRaw($data);
  94.         $this->setValues($data);
  95.     }
  97.     /**
  98.      * @param Result $data
  99.      *
  100.      * @return $this
  101.      */
  102.     public function setValues(Result $data)
  103.     {
  104.         $properties = get_object_vars($data);
  105.         foreach ($properties as $key => $value) {
  106.             $this->setValue($key, $value);
  107.         }
  109.         return $this;
  110.     }
  112.     /**
  113.      * @param string $key
  114.      * @param mixed $value
  115.      *
  116.      * @return $this
  117.      */
  118.     public function setValue($key, $value)
  119.     {
  120.         $method = 'set' . $key;
  121.         if (method_exists($this, $method)) {
  122.             $this->$method($value);
  123.         }
  125.         return $this;
  126.     }
  128.     /**
  129.      * @param string $displayLink
  130.      *
  131.      * @return $this
  132.      */
  133.     public function setDisplayLink($displayLink)
  134.     {
  135.         $this->displayLink = $displayLink;
  137.         return $this;
  138.     }
  140.     /**
  141.      * @return string
  142.      */
  143.     public function getDisplayLink()
  144.     {
  145.         return $this->displayLink;
  146.     }
  148.     /**
  149.      * @param Model\Document $document
  150.      *
  151.      * @return $this
  152.      */
  153.     public function setDocument($document)
  154.     {
  155.         $this->document = $document;
  157.         return $this;
  158.     }
  160.     /**
  161.      * @return Model\Document|null
  162.      */
  163.     public function getDocument()
  164.     {
  165.         return $this->document;
  166.     }
  168.     /**
  169.      * @param string $formattedUrl
  170.      *
  171.      * @return $this
  172.      */
  173.     public function setFormattedUrl($formattedUrl)
  174.     {
  175.         $this->formattedUrl = $formattedUrl;
  177.         return $this;
  178.     }
  180.     /**
  181.      * @return string
  182.      */
  183.     public function getFormattedUrl()
  184.     {
  185.         return $this->formattedUrl;
  186.     }
  188.     /**
  189.      * @param string $htmlFormattedUrl
  190.      *
  191.      * @return $this
  192.      */
  193.     public function setHtmlFormattedUrl($htmlFormattedUrl)
  194.     {
  195.         $this->htmlFormattedUrl = $htmlFormattedUrl;
  197.         return $this;
  198.     }
  200.     /**
  201.      * @return string
  202.      */
  203.     public function getHtmlFormattedUrl()
  204.     {
  205.         return $this->htmlFormattedUrl;
  206.     }
  208.     /**
  209.      * @param string $htmlSnippet
  210.      *
  211.      * @return $this
  212.      */
  213.     public function setHtmlSnippet($htmlSnippet)
  214.     {
  215.         $this->htmlSnippet = $htmlSnippet;
  217.         return $this;
  218.     }
  220.     /**
  221.      * @return string
  222.      */
  223.     public function getHtmlSnippet()
  224.     {
  225.         return $this->htmlSnippet;
  226.     }
  228.     /**
  229.      * @param string $htmlTitle
  230.      *
  231.      * @return $this
  232.      */
  233.     public function setHtmlTitle($htmlTitle)
  234.     {
  235.         $this->htmlTitle = $htmlTitle;
  237.         return $this;
  238.     }
  240.     /**
  241.      * @return string
  242.      */
  243.     public function getHtmlTitle()
  244.     {
  245.         return $this->htmlTitle;
  246.     }
  248.     /**
  249.      * @param Model\Asset\Image|string $image
  250.      *
  251.      * @return $this
  252.      */
  253.     public function setImage($image)
  254.     {
  255.         $this->image = $image;
  257.         return $this;
  258.     }
  260.     /**
  261.      * @return Model\Asset\Image|string|null
  262.      */
  263.     public function getImage()
  264.     {
  265.         return $this->image;
  266.     }
  268.     /**
  269.      * @param string $link
  270.      *
  271.      * @return $this
  272.      */
  273.     public function setLink($link)
  274.     {
  275.         $this->link = $link;
  277.         return $this;
  278.     }
  280.     /**
  281.      * @return string
  282.      */
  283.     public function getLink()
  284.     {
  285.         return $this->link;
  286.     }
  288.     /**+
  289.      * @param Result $raw
  290.      * @return $this
  291.      */
  292.     public function setRaw(Result $raw)
  293.     {
  294.         $this->raw = $raw;
  296.         return $this;
  297.     }
  299.     /**
  300.      * @return Result
  301.      */
  302.     public function getRaw()
  303.     {
  304.         return $this->raw;
  305.     }
  307.     /**
  308.      * @param string $snippet
  309.      *
  310.      * @return $this
  311.      */
  312.     public function setSnippet($snippet)
  313.     {
  314.         $this->snippet = $snippet;
  316.         return $this;
  317.     }
  319.     /**
  320.      * @return string
  321.      */
  322.     public function getSnippet()
  323.     {
  324.         return $this->snippet;
  325.     }
  327.     /**
  328.      * @param string $title
  329.      *
  330.      * @return $this
  331.      */
  332.     public function setTitle($title)
  333.     {
  334.         $this->title = $title;
  336.         return $this;
  337.     }
  339.     /**
  340.      * @return string
  341.      */
  342.     public function getTitle()
  343.     {
  344.         return $this->title;
  345.     }
  347.     /**
  348.      * @param string $type
  349.      *
  350.      * @return $this
  351.      */
  352.     public function setType($type)
  353.     {
  354.         $this->type = $type;
  356.         return $this;
  357.     }
  359.     /**
  360.      * @return string
  361.      */
  362.     public function getType()
  363.     {
  364.         return $this->type;
  365.     }
  366. }