Skip to content

Commit

Permalink
some Doc Blocks added
Browse files Browse the repository at this point in the history
  • Loading branch information
ajangi committed Feb 18, 2021
1 parent 94080c8 commit 6283d47
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 10 deletions.
28 changes: 18 additions & 10 deletions src/IceResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ public function getStatusCode()
/**
* Set the value of status_code
*
* @param $status_code
* @return self
*/
public function setStatusCode($status_code)
*/
public function setStatusCode($status_code): IceResponse
{
$this->status_code = $status_code;

Expand All @@ -61,9 +62,10 @@ public function getResult()
/**
* Set the value of result
*
* @param $result
* @return self
*/
public function setResult($result)
*/
public function setResult($result): IceResponse
{
$this->result = $result;

Expand All @@ -81,9 +83,10 @@ public function getData()
/**
* Set the value of data
*
* @param $data
* @return self
*/
public function setData($data)
*/
public function setData($data): IceResponse
{
$this->data = $data;

Expand All @@ -101,9 +104,10 @@ public function getMessages()
/**
* Set the value of messages
*
* @param $messages
* @return self
*/
public function setMessages($messages)
*/
public function setMessages($messages): IceResponse
{
$this->messages = $messages;

Expand All @@ -121,15 +125,19 @@ public function getDeveloperMessage()
/**
* Set the value of developer_message
*
* @param $developer_message
* @return self
*/
public function setDeveloperMessage($developer_message)
*/
public function setDeveloperMessage($developer_message): IceResponse
{
$this->developer_message = $developer_message;

return $this;
}

/**
* @return Response
*/
public function send(): Response
{
return new Response(json_encode([
Expand Down
4 changes: 4 additions & 0 deletions src/NotFoundErrorResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

namespace IceResponse;

/**
* Class NotFoundErrorResponse
* @package IceResponse
*/
class NotFoundErrorResponse extends IceResponse
{
public function __construct(array $messages = [], string $developer_message = '')
Expand Down
9 changes: 9 additions & 0 deletions src/ResponseInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@
namespace IceResponse;
use Symfony\Component\HttpFoundation\Response;

/**
* Interface ResponseInterface
* @package IceResponse
*/
interface ResponseInterface {

/**
* @return Response
*/
public function send(): Response;

}
8 changes: 8 additions & 0 deletions src/SuccessResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@

namespace IceResponse;

/**
* Class SuccessResponse
* @package IceResponse
*/
class SuccessResponse extends IceResponse
{
/**
* SuccessResponse constructor.
* @param array $data
*/
public function __construct(array $data = [])
{
parent::__construct(200, self::SUCCESS_RESPONSE, $data, [], '');
Expand Down

0 comments on commit 6283d47

Please sign in to comment.