Zemit\Mvc\Controller\Traits\Actions\Rest\FindAction

Complexity

Total Complexity

4

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	findWithAction()	0	4	1
A	getAllAction()	0	3	1
A	findAction()	0	4	1
A	getAllWithAction()	0	3	1

<?php

/**
 * This file is part of the Zemit Framework.
 *
 * (c) Zemit Team <contact@zemit.com>
 *
 * For the full copyright and license information, please view the LICENSE.txt
 * file that was distributed with this source code.
 */

namespace Zemit\Mvc\Controller\Traits\Actions\Rest;

use Phalcon\Http\ResponseInterface;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractExpose;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractInjectable;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractParams;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractQuery;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractRestResponse;

trait FindAction
{
    use AbstractExpose;
    use AbstractParams;
    use AbstractQuery;
    use AbstractInjectable;
    use AbstractRestResponse;
    
    /**
     * Find and expose the resultset.
     * @link findAction()
     * 
     * @deprecated use {@link findAction()}
     * @return ResponseInterface The HTTP response that indicates the success of retrieving all records.
     * @throws \Exception
     */
    public function getAllAction(): ResponseInterface
    {
        return $this->findAction();
    }
    
    /**
     * Find with relationships and expose the resultset.
     * @link findWithAction()
     * 
     * @deprecated use {@link findWithAction()}
     * @return ResponseInterface The HTTP response that contains the resultset with the relationships.
     * @throws \Exception
     */
    public function getAllWithAction(): ResponseInterface
    {
        return $this->findWithAction();
    }
    
    /**
     * Find and expose the resultset.
     *
     * This method finds the resultset and exposes it for further processing.
     *
     * @return ResponseInterface The HTTP response that indicates the success of finding and exposing the resultset.
     * @throws \Exception
     */
    public function findAction(): ResponseInterface
    {
        $this->view->setVar('data', $this->listExpose($this->find()->toArray()));
        return $this->setRestResponse(true);
    }
    
    /**
     * Find with relationships and expose the resultset.
     *
     * This method finds the resultset with relationships and exposes it for further processing.
     *
     * @return ResponseInterface The HTTP response that indicates the success of finding and exposing the resultset.
     * @throws \Exception
     */
    public function findWithAction(): ResponseInterface
    {
        $this->view->setVar('data', $this->listExpose($this->findWith()));
        return $this->setRestResponse(true);
    }
}