Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory :  /home/corals/old/vendor/astock/stock-api-libphp/src/Request/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

<?php
/**
 * Copyright 2017 Adobe Systems Incorporated. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 */

namespace AdobeStock\Api\Request;

use \AdobeStock\Api\Exception\StockApi as StockApiException;
use \AdobeStock\Api\Core\Constants as Constants;
use \AdobeStock\Api\Models\SearchParameters as SearchParametersModel;

class SearchFiles
{
    /**
     * @var string Language location code
     */
    public $locale;
    
    /**
     * @var SearchParametersModel search params.
     */
    public $search_parameters;
    
    /**
     * @var array result column constants
     */
    public $result_columns;
    
    /**
     * @var string Similar Image Path
     */
    public $similar_image;
    
    /**
     * Getter for Locale.
     * @return string|null Language location code.
     */
    public function getLocale() : ?string
    {
        return $this->locale;
    }
    
    /**
     * Setter for Locale.
     * @param string $locale Language location code.
     * @return SearchFiles
     */
    public function setLocale(string $locale = null) : SearchFiles
    {
        if ($locale == null) {
            throw StockApiException::withMessage('Locale cannot be null');
        }
        
        $this->locale = $locale;
        return $this;
    }
    
    /**
     * Get SearchParameters array that consists of various search params
     * @return SearchParametersModel|null
     */
    public function getSearchParams() : ?SearchParametersModel
    {
        return $this->search_parameters;
    }
    
    /**
     * Sets SearchParameters object that consists of various search params
     * @param SearchParametersModel $search_parameters
     * @return SearchFiles
     */
    public function setSearchParams(SearchParametersModel $search_parameters = null) : SearchFiles
    {
        if ($search_parameters == null) {
            throw StockApiException::withMessage('SearchParams array cannot be null');
        }
        
        $this->search_parameters = $search_parameters;
        return $this;
    }
    
    /**
     * Get ResultColumns array that you have included for columns
     * @return array|null
     */
    public function getResultColumns() : ?array
    {
        return $this->result_columns;
    }
    
    /**
     * Set ResultColumns array consisting of result column constants
     * @param array $result_columns
     * @return SearchFiles
     */
    public function setResultColumns(array $result_columns = null) : SearchFiles
    {
        if (empty($result_columns)) {
            throw StockApiException::withMessage('ResultColumns array cannot be empty');
        }
        
        $this->result_columns = $result_columns;
        return $this;
    }
    
    /**
     * Getter for similar image path.
     * @return string|null Similar image path.
     */
    public function getSimilarImage() : ?string
    {
        return $this->similar_image;
    }
    
    /**
     * Setter for similar image path.
     * @param string $similar_image Similar Image Path.
     * @return SearchFiles
     */
    public function setSimilarImage(string $similar_image) : SearchFiles
    {
        if (!file_exists($similar_image)) {
            throw StockApiException::withMessage('Image File doesn\'t exist on this path');
        }
        
        $this->similar_image = $similar_image;
        return $this;
    }
}