Elep

<?php
/*
 * Your installation or use of this SugarCRM file is subject to the applicable
 * terms available at
 * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.
 * If you do not agree to all of the applicable terms or do not have the
 * authority to bind the entity as an authorized representative, then do not
 * install or use this SugarCRM file.
 *
 * Copyright (C) SugarCRM Inc. All rights reserved.
 */

abstract class SugarListApi extends SugarApi
{
    protected $defaultLimit = 20;
    protected $allowOffsetEnd = true;
    protected $defaultOrderBy = ['date_modified' => 'DESC'];
    protected $addDefaultFields = ['id', 'date_modified'];
    protected $checkAcls = true;

/**
     * This function will parse arguments and hand them back in an array
     * The defaults are set as part of the class ($defaultLimit, $allowOffsetEnd, $defaultOrderBy, $addDefaultFields, $checkAcls)
     *
     * @param ServiceBase $api The API class (typically RestService)
     * @param array $args The argument array as passed in to the API call, currently checked variables are
     *        max_num, offset, fields, order_by
     * @param SugarBean|null $seed This is the seed bean that feeds the list, if you pass in a null seed then the fields are not validated
     * @return array An array with the options limit, offset, fields and order_by set
     */
    public function parseArguments(ServiceBase $api, array $args, SugarBean $seed = null)
    {
        $limit = $this->defaultLimit;
        if (isset($args['max_num'])) {
            $limit = (int)$args['max_num'];
        }

$limit = $this->checkMaxListLimit($limit);

$offset = 0;
        if (isset($args['offset'])) {
            if ($args['offset'] === 'end') {
                if ($this->allowOffsetEnd) {
                    $offset = 'end';
                } else {
                    $offset = 0;
                }
            } else {
                //Do not allow negative offsets
                $offset = max(0, (int)$args['offset']);
            }
        }

$userFields = [];
        if (!empty($args['fields'])) {
            $userFields = explode(',', $args['fields']);
        }
        foreach ($this->addDefaultFields as $defaultField) {
            if (!in_array($defaultField, $userFields)) {
                $userFields[] = $defaultField;
            }
        }

$orderBy = '';
        if (isset($args['order_by'])) {
            if (strpos($args['order_by'], ',') !== 0) {
                // There is a comma, we are ordering by more than one thing
                $orderBys = explode(',', $args['order_by']);
            } else {
                $orderBys = [$args['order_by']];
            }
            $orderByArray = [];
            foreach ($orderBys as $order) {
                if (strpos($order, ':')) {
                    // It has a :, it's specifying ASC / DESC
                    [$column, $direction] = explode(':', $order);
                    if (strtolower($direction) == 'desc') {
                        $direction = 'DESC';
                    } else {
                        $direction = 'ASC';
                    }
                } else {
                    // No direction specified, let's let it fly free
                    $column = $order;
                    $direction = 'ASC';
                }
                if ($seed != null) {
                    if ($this->checkAcls && !$seed->ACLFieldAccess($column, 'list')) {
                        throw new SugarApiExceptionNotAuthorized('No access to view field: ' . $column . ' in module: ' . $seed->module_dir);
                    }
                    if (!isset($seed->field_defs[$column])) {
                        throw new SugarApiExceptionNotAuthorized('No access to view field: ' . $column . ' in module: ' . $seed->module_dir);
                    }
                }

$orderByArray[$column] = $direction;
            }
        } else {
            $orderByArray = $this->defaultOrderBy;
        }

return ['limit' => $limit,
            'offset' => $offset,
            'fields' => $userFields,
            'orderBy' => $orderByArray,
        ];
    }

/**
     * This function will convert an order by array returned by parseArguments into a SQL string
     * @param array $orderByArray an array of $column => $direction
     * @return string A SQL string of the order by.
     */
    public function convertOrderByToSql(array $orderByArray)
    {
        $sqlArray = [];
        foreach ($orderByArray as $column => $direction) {
            $sqlArray[] = $column . ' ' . $direction;
        }

return implode(',', $sqlArray);
    }
}