helper.php

<?php

use Contentstack\Support\Utility;
use Contentstack\Error\ErrorMessages;

if(!function_exists('contentstackGetFunctionName')) {
    /*
     * To get the Query method name
     * @return string|function-name
     * */
    function contentstackGetFunctionName() {
        $stack = debug_backtrace();
        if(count($stack) > 2) {
            return $stack[3]['function'];
        }
        return $stack[0]['function'];
    }
}

if(!function_exists('contentstackCreateError')) {
    /*
     * Create exception object based on messages
     * @param
     *      string|msg - Exception message to be delivered
     * @return Exception
     * */
    function contentstackCreateError($msg = '') {
        if(!Utility::isEmpty($msg)) return new Exception($msg);
    }
}

if (!function_exists('contentstackSearch')) {
    /*
     * search
     * search
     * @param
     *      $operator - query operator
     *      $query - Query object
     *      $value - value to be search
     * @return $query
     * */
    function contentstackSearch($operator = '', $query = array(), $value = '') {
        if(!(!Utility::isEmpty($value) && is_string($value)))
            throw contentstackCreateError(ErrorMessages::formatMessage(ErrorMessages::INVALID_STRING_INPUT, contentstackGetFunctionName()));
        $query[$operator] = $value;
        return $query;
    }
}

if (!function_exists('contentstackReferences')) {
    /*
     * contentstackReferences
     * contentstackReferences
     * @param
     *      $query - Query object
     *      $values - array of fields to be included in the result set
     * @return $query
     * */
    function contentstackReferences($operator = '', $query = array(), $value = array()) {
        if(!is_array($value))
            throw contentstackCreateError(ErrorMessages::INVALID_INCLUDE_REFERENCES);
        $query[$operator] = $value;
        return $query;
    }
}

if (!function_exists('contentstackProjection')) {
    /*
     * projection
     * projection
     * @param
     *      $query - Query object
     *      $values - array of fields to be included in the result set
     * @return $query
     * */
    function contentstackProjection($operator = '', $query = array(), $level = 'BASE', $value = array()) {
        if(is_array($level)) {
            $value = $level;
            $level = 'BASE';
        }
        if(!(!Utility::isEmpty($level) && is_string($level) && is_array($value))) throw contentstackCreateError(ErrorMessages::INVALID_INPUT_TYPE);
        if(!Utility::isKeySet($query, $operator)) $query[$operator] = array();
        if(!Utility::isKeySet($query[$operator], $level)) $query[$operator][$level] = array();
        $query[$operator][$level] = array_merge($query[$operator][$level], $value);
        return $query;
    }
}

if (!function_exists('contentstackRegexp')) {
    /*
     * contentstackRegexp
     * contentstackRegexp
     * @param
     *      $operator - query operator
     *      $query - Query object
     *      $key - key of the query
     *      $value - value to be set against key
     *      $options - options for the regular expression
     * @return $query
     * */
    function contentstackRegexp($operator = '', $query = array(), $values = array()) {
        if(count($values) === 2 || count($values) === 3) {
            if(Utility::isEmpty($values[0]) && Utility::isEmpty($values[1]) && is_string($values[0]) && is_string($values[1]))
                throw contentstackCreateError(ErrorMessages::INVALID_REGEX_KEY_VALUE);
            if(isset($values[2]) && !(is_string($values[2]) && strlen($values[2]) > 0)) {
                throw contentstackCreateError(ErrorMessages::INVALID_REGEX_OPTIONS);
            }
            $query[$values[0]] = array($operator => $values[1]);
            if(isset($values[2]))
                $query[$values[0]]['$options'] = $values[2];
            return $query;
        } else {
            throw contentstackCreateError(ErrorMessages::INVALID_REGEX_ARGS);
        }
    }
}

if (!function_exists('contentstackTags')) {
    /*
     * contentstackTags
     * contentstackTags
     * @param
     *      $operator - query operator
     *      $query - Query object
     *      $value - array of tags
     * @return $query
     * */
    function contentstackTags($operator = '', $query = array(), $value = '') {
        if(!(is_array($value) && count($value) > 0))
            throw contentstackCreateError(ErrorMessages::INVALID_TAGS_INPUT);
        $query[$operator] = $value;
        return $query;
    }
}


if (!function_exists('contentstackComparision')) {
    /*
     * comparision
     * comparision
     * @param
     *      $operator - query operator
     *      $query - Query object
     *      $key - key of the query
     *      $value - value to be set against key
     * @return $query
     * */
    function contentstackComparision($operator = '', $query = array(), $key = '', $value = '') {
        if(!(!Utility::isEmpty($key) && is_string($key) && !Utility::isEmpty($value)))
            throw contentstackCreateError(ErrorMessages::formatMessage(ErrorMessages::INVALID_KEY_VALUE, contentstackGetFunctionName()));
        $query[$key] = array($operator => $value);
        return $query;
    }
}

if (!function_exists('contentstackLogical')) {
    /*
     * logical
     * logical operations
     * @param
     *      $operator - query operator
     *      $query - Query object
     *      $value - array of Query object or json query
     * @return $query
     * @ignore
     * */
    function contentstackLogical($operator = '', $query = array(), $value = array()) {
        if(!(is_array($value) && count($value) > 0))
            throw contentstackCreateError(ErrorMessages::formatMessage(ErrorMessages::INVALID_QUERY_INPUT, contentstackGetFunctionName()));
        foreach($value as $key => $_qry) {
            if(!Utility::isKeySet($query, $operator)) $query[$operator] = array();
            if($_qry instanceof \Contentstack\Stack\BaseQuery)
                array_push($query[$operator], $_qry->subQuery);
            else if(is_array($_qry))
                array_push($query[$operator], $_qry);
            else {
                unset($query[$operator]);
                throw contentstackCreateError(ErrorMessages::INVALID_QUERY_OBJECTS);
            }
        }
        return $query;
    }
}

if (!function_exists('contentstackContains')) {
    /*
     * contains
     * contains
     * @param
     *      $operator - query operator
     *      $query - Query object
     *      $key - key of the query
     *      $value - array of value to be set against key
     * @return $query
     * */
    function contentstackContains($operator = '', $query = array(), $key = '', $value = array()) {
        if (!(!Utility::isEmpty($key) && is_string($key) && is_array($value)))
            throw contentstackCreateError(ErrorMessages::formatMessage(ErrorMessages::INVALID_KEY_ARRAY_VALUE, contentstackGetFunctionName()));
        $query[$key] = array($operator => $value);
        return $query;
    }
}

if (!function_exists('contentstackPagination')) {
    /*
     * pagination
     * Creates the skip and limit parameters
     * @param
     *      $operator - key of the query
     *      $query - Query object
     *      $value - value to be set against key
     * @return $query
     * */
    function contentstackPagination($operator = '', $query = array(), $value = '') {
        if (!(!Utility::isEmpty($value) && is_numeric($value)))
            throw contentstackCreateError(ErrorMessages::formatMessage(ErrorMessages::INVALID_NUMERIC_INPUT, contentstackGetFunctionName()));
        $query[$operator] = $value;
        return $query;
    }
}

if (!function_exists('contentstackLanguage')) {
    /*
     * language
     * Set the locale on the Query
     * @param
     *      $operator - key of the query
     *      $query - Query object
     *      $value - value to be set against key
     * @return $query
     * */
    function contentstackLanguage($operator = '', $query = array(), $value = '') {
       
        if (!(!Utility::isEmpty($value) && is_string($value)))
            throw contentstackCreateError(ErrorMessages::formatMessage(ErrorMessages::INVALID_STRING_INPUT, contentstackGetFunctionName()));
            $query[$operator] = $value; 
        return $query;
    }
}

if (!function_exists('contentstackSorting')) {
    /*
     * sort
     * sort the field based on the query
     * @param
     *      $operator - key of the query
     *      $query - Query object
     *      $field_uid - field_uid which is to be use for sorting
     * @return $query
     * */
    function contentstackSorting($operator = '', $query = array(), $key = '') {
        if (!(!Utility::isEmpty($key) && is_string($key)))
            throw contentstackCreateError(ErrorMessages::formatMessage(ErrorMessages::INVALID_FIELD_INPUT, contentstackGetFunctionName()));
        $query[$operator] = $key;
        return $query;
    }
}

if (!function_exists('contentstackAddBoolean')) {
    /*
     * addBoolean
     * Set the boolean parameter on the Query
     * @param
     *      $operator - key of the query
     *      $query - Query object
     *      $value - value to be set against key
     * @return $query
     * */
    function contentstackAddBoolean($operator = '', $query = array()) {
        $query[$operator] = 'true';
        return $query;
    }
}

if (!function_exists('contentstackAddParam')) {
    /*
     * AddParam
     * Set the locale on the Query
     * @param
     *      $operator - key of the query
     *      $query - Query object
     *      $value - value to be set against key
     * @return $query
     * */
    function contentstackAddParam($key = '', $query = array(), $value = '') {
        $query[$key] =  $value;
        return $query;
    }
}

if (!function_exists('contentstackExistence')) {
    /*
     * existence
     * Set the boolean parameter on the Query
     * @param
     *      $operator - $operator of the query
     *      $query - Query object
     *      $key - field_uid against which query to be checked
     *      $value - value to be set against key
     * @return $query
     * */
    function contentstackExistence($operator = '', $query = array(), $key = '', $value = false) {
        if (!(!Utility::isEmpty($key) && is_string($key)))
            throw contentstackCreateError(ErrorMessages::formatMessage(ErrorMessages::INVALID_FIELD_UID, contentstackGetFunctionName()));
        $query[$key] = array($operator => $value);
        return $query;
    }
}