Skip to content

Commit

Permalink
[TASK] Update to php 8.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Woeler committed Jun 10, 2022
1 parent 7e1610a commit ae60360
Show file tree
Hide file tree
Showing 10 changed files with 310 additions and 177 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
/vendor
/test.php
/bin/php-cs-fixer
/.php-cs-fixer.cache
133 changes: 133 additions & 0 deletions .php-cs-fixer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
<?php

use PhpCsFixer\Config;
use PhpCsFixer\Finder;

$rules = [
'array_syntax' => ['syntax' => 'short'],
'binary_operator_spaces' => [
'default' => 'single_space',
'operators' => ['=>' => null]
],
'blank_line_after_namespace' => true,
'blank_line_after_opening_tag' => true,
'blank_line_before_statement' => [
'statements' => ['return']
],
'braces' => true,
'cast_spaces' => true,
'class_definition' => true,
'concat_space' => [
'spacing' => 'none'
],
'declare_equal_normalize' => true,
'declare_strict_types' => true,
'elseif' => true,
'encoding' => true,
'full_opening_tag' => true,
'fully_qualified_strict_types' => true, // added by Shift
'function_declaration' => true,
'function_typehint_space' => true,
'heredoc_to_nowdoc' => true,
'include' => true,
'increment_style' => ['style' => 'post'],
'indentation_type' => true,
'linebreak_after_opening_tag' => true,
'line_ending' => true,
'lowercase_cast' => true,
'lowercase_keywords' => true,
'lowercase_static_reference' => true, // added from Symfony
'magic_method_casing' => true, // added from Symfony
'magic_constant_casing' => true,
'method_argument_space' => true,
'native_function_casing' => true,
'no_alias_functions' => true,
'no_extra_blank_lines' => [
'tokens' => [
'extra',
'throw',
'use',
'use_trait',
]
],
'no_blank_lines_after_class_opening' => true,
'no_blank_lines_after_phpdoc' => true,
'no_closing_tag' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => [
'use' => 'echo'
],
'no_multiline_whitespace_around_double_arrow' => true,
'multiline_whitespace_before_semicolons' => [
'strategy' => 'no_multi_line'
],
'no_short_bool_cast' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_spaces_after_function_name' => true,
'no_spaces_around_offset' => true,
'no_spaces_inside_parenthesis' => true,
'no_trailing_comma_in_list_call' => true,
'no_trailing_comma_in_singleline_array' => true,
'no_trailing_whitespace' => true,
'no_trailing_whitespace_in_comment' => true,
'no_unneeded_control_parentheses' => true,
'no_unreachable_default_argument_value' => true,
'no_unused_imports' => true,
'no_useless_return' => true,
'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true,
'normalize_index_brace' => true,
'not_operator_with_successor_space' => true,
'object_operator_without_whitespace' => true,
'ordered_imports' => ['sort_algorithm' => 'alpha'],
'phpdoc_indent' => true,
'phpdoc_no_access' => true,
'phpdoc_no_package' => true,
'phpdoc_no_useless_inheritdoc' => true,
'phpdoc_scalar' => true,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => true,
'phpdoc_to_comment' => true,
'phpdoc_trim' => true,
'phpdoc_types' => true,
'phpdoc_var_without_name' => true,
'self_accessor' => true,
'short_scalar_cast' => true,
'simplified_null_return' => true,
'single_blank_line_at_eof' => true,
'single_blank_line_before_namespace' => true,
'single_class_element_per_statement' => true,
'single_import_per_statement' => true,
'single_line_after_imports' => true,
'single_line_comment_style' => [
'comment_types' => ['hash']
],
'single_quote' => true,
'space_after_semicolon' => true,
'standardize_not_equals' => true,
'switch_case_semicolon_to_colon' => true,
'switch_case_space' => true,
'ternary_operator_spaces' => true,
'trailing_comma_in_multiline' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'visibility_required' => [
'elements' => ['method', 'property']
],
'whitespace_after_comma_in_array' => true,
];

$finder = Finder::create()
->in('src')
->name('*.php')
->ignoreDotFiles(true)
->ignoreVCS(true);

return (new Config())
->setFinder($finder)
->setRules($rules)
->setRiskyAllowed(true)
->setUsingCache(true);
13 changes: 0 additions & 13 deletions .php_cs

This file was deleted.

34 changes: 31 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ $message = (new DiscordTextMessage())
->setUsername('Webhook Test');

$webhook = new DiscordWebhook('https://discordapp.com/api/webhooks/SomeWebHook');
$webhook->send($message);
$messageData = $webhook->send($message);
```

Sending an embed message
Expand All @@ -30,7 +30,35 @@ $message = (new DiscordEmbedMessage())
->setImage('https://example.com/someimage.png');

$webhook = new DiscordWebhook('https://discordapp.com/api/webhooks/SomeWebHook');
$webhook->send($message);
$messageData = $webhook->send($message);
```

Sending messages via the webhook class will automatically handle rate limits.
Updating a message
```php
$messageId = '12345';
$message = (new DiscordTextMessage())
->setContent('Hello World')
->setAvatar('https://example.com/avatar.png')
->setUsername('Webhook Test');

$webhook = new DiscordWebhook('https://discordapp.com/api/webhooks/SomeWebHook');
$messageData = $webhook->update($messageId, $message);
```

Deleting a message
```php
$messageId = '12345';

$webhook = new DiscordWebhook('https://discordapp.com/api/webhooks/SomeWebHook');
$webhook->delete($messageId);
```

Getting a message
```php
$messageId = '12345';

$webhook = new DiscordWebhook('https://discordapp.com/api/webhooks/SomeWebHook');
$messageData = $webhook->get($messageId);
```

Ratelimits are automatically handled for all calls.
10 changes: 5 additions & 5 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
}
],
"require": {
"php": "^7.4|^8.0",
"php": "^8.1",
"ext-curl": "*",
"ext-json": "*"
},
Expand All @@ -21,13 +21,13 @@
},
"scripts": {
"cgl": [
"bin/php-cs-fixer fix --config .php_cs"
"bin/php-cs-fixer fix --config .php-cs-fixer.php"
]
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^2.19"
},
"config": {
"bin-dir": "bin/"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^3.8"
}
}
17 changes: 17 additions & 0 deletions src/Exception/DiscordInvalidResponseException.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,21 @@

class DiscordInvalidResponseException extends \Exception
{
private array $errorData;

public function __construct(string $message = '', int $code = 0, ?\Throwable $previous = null, array $errorData = [])
{
parent::__construct($message, $code, $previous);
$this->errorData = $errorData;
}

public function getErrorData(): array
{
return $this->errorData;
}

public function getStatusCode(): int
{
return $this->code;
}
}
57 changes: 55 additions & 2 deletions src/Message/AbstractDiscordMessage.php
Original file line number Diff line number Diff line change
@@ -1,12 +1,65 @@
<?php

declare(strict_types=1);

namespace Woeler\DiscordPhp\Message;

use JsonSerializable;

abstract class AbstractDiscordMessage implements JsonSerializable
{
abstract public function toArray(): array;
protected ?string $content = null;
protected ?string $avatar = null;
protected ?string $username = null;
protected bool $tts = false;

public function setContent(string $content): static
{
$this->content = $content;

return $this;
}

public function setAvatar(string $avatar): static
{
$this->avatar = $avatar;

return $this;
}

public function setUsername(string $username): static
{
$this->username = $username;

return $this;
}

public function getContent(): ?string
{
return $this->content;
}

public function getAvatar(): ?string
{
return $this->avatar;
}

public function getUsername(): ?string
{
return $this->username;
}

public function isTts(): bool
{
return $this->tts;
}

public function setTts(bool $tts): static
{
$this->tts = $tts;

return $this;
}

abstract public function jsonSerialize();
abstract public function jsonSerialize(): array;
}
Loading

0 comments on commit ae60360

Please sign in to comment.