Requested changes for readability and style

This commit is contained in:
Matt Bonneau 2020-01-22 01:00:24 -05:00
parent 1af7e998b3
commit 2159ed40f9
4 changed files with 19 additions and 23 deletions

View File

@ -34,7 +34,7 @@ class ClientNegotiator {
// https://bugs.php.net/bug.php?id=74240 - need >=7.1.4 or >=7.0.18 // https://bugs.php.net/bug.php?id=74240 - need >=7.1.4 or >=7.0.18
$supported = PermessageDeflateOptions::permessageDeflateSupported(); $supported = PermessageDeflateOptions::permessageDeflateSupported();
if (!$supported) { if (!$supported) {
if ($perMessageDeflateOptions->getDeflate()) { if ($perMessageDeflateOptions->isEnabled()) {
trigger_error('permessage-deflate is being disabled because it is not support by your PHP version.', E_USER_NOTICE); trigger_error('permessage-deflate is being disabled because it is not support by your PHP version.', E_USER_NOTICE);
} }
$perMessageDeflateOptions = PermessageDeflateOptions::createDisabled(); $perMessageDeflateOptions = PermessageDeflateOptions::createDisabled();

View File

@ -12,7 +12,7 @@ final class PermessageDeflateOptions
/* this is a private instead of const for 5.4 compatibility */ /* this is a private instead of const for 5.4 compatibility */
private static $VALID_BITS = ['8', '9', '10', '11', '12', '13', '14', '15']; private static $VALID_BITS = ['8', '9', '10', '11', '12', '13', '14', '15'];
private $deflate = false; private $deflateEnabled = false;
private $server_no_context_takeover; private $server_no_context_takeover;
private $client_no_context_takeover; private $client_no_context_takeover;
@ -22,12 +22,13 @@ final class PermessageDeflateOptions
private function __construct() { } private function __construct() { }
public static function createDefault() { public static function createDefault() {
$new = new static(); $new = new static();
$new->deflate = true; $new->deflateEnabled = true;
$new->client_max_window_bits = self::MAX_WINDOW_BITS; $new->client_max_window_bits = self::MAX_WINDOW_BITS;
$new->client_no_context_takeover = false; $new->client_no_context_takeover = false;
$new->server_max_window_bits = self::MAX_WINDOW_BITS; $new->server_max_window_bits = self::MAX_WINDOW_BITS;
$new->server_no_context_takeover = false; $new->server_no_context_takeover = false;
return $new; return $new;
} }
@ -96,8 +97,8 @@ final class PermessageDeflateOptions
} }
array_shift($parts); array_shift($parts);
$options = new static(); $options = new static();
$options->deflate = true; $options->deflateEnabled = true;
foreach ($parts as $part) { foreach ($parts as $part) {
$kv = explode('=', $part); $kv = explode('=', $part);
$key = $kv[0]; $key = $kv[0];
@ -152,11 +153,6 @@ final class PermessageDeflateOptions
return $optionSets; return $optionSets;
} }
// public static function validateResponseToRequest(ResponseInterface $response, RequestInterface $request) {
// $requestOptions = static::fromRequestOrResponse($request);
// $responseOptions = static::fromRequestOrResponse($response);
// }
/** /**
* @return mixed * @return mixed
*/ */
@ -192,9 +188,9 @@ final class PermessageDeflateOptions
/** /**
* @return bool * @return bool
*/ */
public function getDeflate() public function isEnabled()
{ {
return $this->deflate; return $this->deflateEnabled;
} }
/** /**
@ -203,7 +199,7 @@ final class PermessageDeflateOptions
*/ */
public function addHeaderToResponse(ResponseInterface $response) public function addHeaderToResponse(ResponseInterface $response)
{ {
if (!$this->deflate) { if (!$this->deflateEnabled) {
return $response; return $response;
} }
@ -225,7 +221,7 @@ final class PermessageDeflateOptions
} }
public function addHeaderToRequest(RequestInterface $request) { public function addHeaderToRequest(RequestInterface $request) {
if (!$this->deflate) { if (!$this->deflateEnabled) {
return $request; return $request;
} }

View File

@ -126,7 +126,7 @@ class ServerNegotiator implements NegotiatorInterface {
return new Response(400, [], null, '1.1', $e->getMessage()); return new Response(400, [], null, '1.1', $e->getMessage());
} }
if ($this->enablePerMessageDeflate && $perMessageDeflateRequest->getDeflate()) { if ($this->enablePerMessageDeflate && $perMessageDeflateRequest->isEnabled()) {
$response = $perMessageDeflateRequest->addHeaderToResponse($response); $response = $perMessageDeflateRequest->addHeaderToResponse($response);
} }

View File

@ -62,7 +62,7 @@ class MessageBuffer {
/** /**
* @var bool * @var bool
*/ */
private $deflate = false; private $deflateEnabled = false;
/** /**
* @var int * @var int
@ -104,9 +104,9 @@ class MessageBuffer {
$this->permessageDeflateOptions = $permessageDeflateOptions ?: PermessageDeflateOptions::createDisabled(); $this->permessageDeflateOptions = $permessageDeflateOptions ?: PermessageDeflateOptions::createDisabled();
$this->deflate = $this->permessageDeflateOptions->getDeflate(); $this->deflateEnabled = $this->permessageDeflateOptions->isEnabled();
if ($this->deflate && !is_callable($this->sender)) { if ($this->deflateEnabled && !is_callable($this->sender)) {
throw new \InvalidArgumentException('sender must be set when deflate is enabled'); throw new \InvalidArgumentException('sender must be set when deflate is enabled');
} }
@ -263,7 +263,7 @@ class MessageBuffer {
* @return \Ratchet\RFC6455\Messaging\FrameInterface|FrameInterface * @return \Ratchet\RFC6455\Messaging\FrameInterface|FrameInterface
*/ */
public function frameCheck(FrameInterface $frame) { public function frameCheck(FrameInterface $frame) {
if ((false !== $frame->getRsv1() && !$this->deflate) || if ((false !== $frame->getRsv1() && !$this->deflateEnabled) ||
false !== $frame->getRsv2() || false !== $frame->getRsv2() ||
false !== $frame->getRsv3() false !== $frame->getRsv3()
) { ) {
@ -381,7 +381,7 @@ class MessageBuffer {
throw new \Exception('To send frames using the MessageBuffer, sender must be set.'); throw new \Exception('To send frames using the MessageBuffer, sender must be set.');
} }
if ($this->deflate && if ($this->deflateEnabled &&
($frame->getOpcode() === Frame::OP_TEXT || $frame->getOpcode() === Frame::OP_BINARY)) { ($frame->getOpcode() === Frame::OP_TEXT || $frame->getOpcode() === Frame::OP_BINARY)) {
$frame = $this->deflateFrame($frame); $frame = $this->deflateFrame($frame);
} }