Forem: Alex

How to find the exact version of a composer package?

Alex — Sun, 03 Sep 2023 14:36:43 +0000

Composer is a tool for dependency management in PHP. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you. Sometimes you may need to know the versions of installed libraries, this article will show you how to do that.

Check if composer installed

The first thing you'll need to do is to check if composer is installed. You can do this by running any composer command., for example --version.

composer --version

# output
Composer version 2.2.4 2022-01-08 12:30:42

If composer commands do not work, you will need install it first: Download composer.

Check the versions of all installed packages

You can check which packages are installed in the working directory by running one of the following commands - show or info:

composer show

# or

composer info

It will show you package names, versions and descriptions

curl/curl                         2.5.0    cURL class for PHP
symfony/http-client               v6.3.2   Provides powerful methods to fetch HTTP resources synchronously or asynchronously
symfony/http-foundation           v6.3.4   Defines an object-oriented layer for the HTTP specification
symfony/yaml                      v6.3.3   Loads and dumps YAML files

Check versions of globally installed packages

Sometimes you may need to check which packages are installed globally in the system. The show command should be run with the global keyword:

composer global show

And you will see a list similar to the previous one, but containing only globally installed packages

curl/curl 2.5.0 cURL class for PHP

Check the version of a specific package

For example, if you need to check what version of symfony/http-foundation is installed, you can do this as follows:

composer show symfony/http-foundation

It will give you a lot of information about the package: name, description, version, requirements, conflicting packages and much more:

name     : symfony/http-foundation
descrip. : Defines an object-oriented layer for the HTTP specification
keywords : 
versions : * v6.3.4
type     : library
...
requires
php >=8.1
symfony/deprecation-contracts ^2.5|^3
symfony/polyfill-mbstring ~1.1
symfony/polyfill-php83 ^1.27
...
conflicts
symfony/cache <6.2

If this amount of information is redundant, you can grep the versions only:

composer show symfony/http-foundation | grep versions

# output
versions : * v6.3.4

The same results can be achieved using info command

composer info symfony/http-foundation | grep versions

# output
versions : * v6.3.4

Check the package versions from a specific author/vendor

If you want to check the package version from a specific author/vendor, for example check the versions of installed Symfony components, you can pass a package mask using wildcards:

composer show "symfony/*"

It will only show packages that start with symfony/

symfony/http-client               v6.3.2   Provides powerful methods to fetch HTTP resources synchronously or asynchronously
symfony/http-foundation           v6.3.4   Defines an object-oriented layer for the HTTP specification
symfony/yaml                      v6.3.3   Loads and dumps YAML files

Bonus: composer why/depends

The composer show command shows the list of all installed packages, and you may find some unknown names in this list, e.g. libraries you didn't install, but which are present in your application. If you are curious how this happened, you can run the why or depends command:

composer why symfony/service-contracts

# or 

composer depends symfony/service-contract

It tells you which other packages depend on a particular one and why it was installed even though it was not required directly:

symfony/http-client  v6.3.2  requires   symfony/service-contracts (^2.5|^3)  
symfony/translation  v6.3.3  conflicts  symfony/service-contracts (<2.5)

Summary

Composer helps you manage your dependencies, as well as keep track of what version of certain packages are installed. The composer show or composer info commands can be used to find out the exact version of a composer package.

The composer why or composer depends commands are also useful to check why a particular package is installed or what other packages need it and in what version.

PHP+Slack: 5 easy ways to send a message

Alex — Sun, 27 Aug 2023 13:08:35 +0000

Slack has become a popular tool for workplace communication, allowing teams to collaborate easily. If you're a PHP developer, it can be useful to learn how to send messages to Slack. This article will show you 5 easy ways to do so.

Preconditions

PHP installed and curl extension enabled
Slack App with bot token created and added to the channel
chat:write scope is added to the App

Slack API

Slack provides a variety of API endpoints and methods, which can be found in the documentation.

Today we're gonna focus on the chat.postMessage endpoint. It sends some text TEXT to the particular channel CHANNEL_NAME by the bot BOT_API_TOKEN

curl --location 'https://slack.com/api/chat.postMessage' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'Authorization: Bearer BOT_API_TOKEN' \
--data '{
    "channel": "CHANNEL_NAME",
    "text": "TEXT"
}'

There are a lot of ways to call this endpoint and send a message to the channel inside a PHP project. We will cover 4 of them.

HTTP request with cURL

<?php

$botApiToken = 'xoxb-your-bot-api-token';
$channelName = 'your channel name';
$text = 'Hello, I am from PHP!';

$url = "https://slack.com/api/chat.postMessage";

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        "channel" => $channelName,
        "text" => $text,
    ]),
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer {$botApiToken}",
        'Content-Type: application/json; charset=utf-8',
    ],
]);
curl_exec($curl);
curl_close($curl);

Symfony HTTP client

Symfony is one of the most popular PHP frameworks. It provides a lot of different components out of the box and one of them is HTTP Client. It allows you to make HTTP requests easily.

Installation

composer require symfony/http-client

Standalone

<?php

require 'vendor/autoload.php';

use Symfony\Component\HttpClient\HttpClient;

$botApiToken = 'xoxb-your-bot-api-token';
$channelName = 'your channel name';
$text = 'Hello, I am from Symfony HTTP Client!';

$client = HttpClient::create([
    'base_uri' => 'https://slack.com',
]);

$client->request('POST', "/api/chat.postMessage", [
    'headers' => [
        'Accept' => 'application/json; charset=utf-8',
    ],
    'auth_bearer' => $botApiToken,
    'json' => [
        'channel' => $channelName,
        'text' => $text,
    ],
]);

Inside Symfony app

Prepare scoped client inside config/packages/framework.yaml

parameters:
    env(SLACK_BOT_API_TOKEN): 'xoxb-your-bot-api-token'

framework:
    http_client:
        scoped_clients:
            slack.client:
                base_uri: 'https://slack.com'
                auth_bearer: '%env(SLACK_BOT_API_TOKEN)%'
                headers:
                    Accept: 'application/json; charset=utf-8'

And use it inside your service

<?php

namespace App;

use Symfony\Contracts\HttpClient\HttpClientInterface;

class YourService
{
    public function __construct(
        private readonly HttpClientInterface $slackClient,
    )
    {
    }

    public function sendMessage(string $text): void
    {
        $channelName = 'your channel name';

        $this->slackClient->request('POST', '/api/chat.postMessage', [
            'json' => [
                'channel' => $channelName,
                'text' => $text,
            ],
        ]);
    }
}

Symfony Slack Notifier

Another Symfony component that can send a message to the Slack channel is Slack Notifier.

Installation

composer require symfony/slack-notifier

Standalone

<?php

require 'vendor/autoload.php';

use Symfony\Component\Notifier\Bridge\Slack\SlackTransport;
use Symfony\Component\Notifier\Chatter;
use Symfony\Component\Notifier\Message\ChatMessage;


$botApiToken = 'xoxb-your-bot-api-token';
$channelName = 'your channel name';
$text = 'Hello, I am from Symfony Slack Notifier!';

$slackTransport = new SlackTransport($botApiToken, $channelName);
$chatter = new Chatter($slackTransport);
$chatMessage = new ChatMessage($text);
$chatter->send($chatMessage);

Inside Symfony app

Configure notifier chatter transport inside
config/packages/framework.yaml

parameters:
    env(SLACK_DSN): 'slack://BOT_API_TOKEN@default?channel=CHANNEL_NAME'

framework:
    notifier:
        chatter_transports:
            slack: '%env(SLACK_DSN)%'

And use it inside your service

<?php

namespace App;

use Symfony\Component\Notifier\ChatterInterface;
use Symfony\Component\Notifier\Message\ChatMessage;

class YourService
{
    public function __construct(
        private readonly ChatterInterface $slackChatter
    )
    {
    }

    public function sendMessage(string $text): void
    {
        $this->slackChatter->send(new ChatMessage($text));
    }
}

jolicode PHP client for Slack's API

There are other framework agnostic libraries that can help you send a message to the Slack channel. Slack calls them Community Tools.

One of them is jolicode's PHP client for Slack's API

Installation

composer require jolicode/slack-php-api

Standalone

<?php

require 'vendor/autoload.php';

use JoliCode\Slack\Api\Client;
use JoliCode\Slack\ClientFactory;

$botApiToken = 'xoxb-your-bot-api-token';
$channelName = 'your channel name';
$text = 'Hello, I am from Jolicode Client!';

/** @var Client $client */
$client = ClientFactory::create($botApiToken);

$client->chatPostMessage([
    'channel' => $channelName,
    'text' => $text,
]);

Slack Webhook

Another way to send a message to a channel is Slack Webhook.

You can create your webhook here

After webhook is created, copy YOUR_WEBHOOK_URL and make a simple cURL request. It will send TEXT to your CHANNEL_NAME.

curl --location 'YOUR_WEBHOOK_URL' \
--header 'Content-Type: application/json' \
--data '{
    "channel": "CHANNEL_NAME",
    "text": "TEXT"
}'

In PHP it will look like this

<?php

$text = 'Hello, I am from PHP Slack Webhook!';
$channelName = 'your channel name';
$url = "your webhook url";

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        "channel" => $channelName,
        "text" => $text,
    ]),
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json; charset=utf-8',
    ],
]);
curl_exec($curl);
curl_close($curl);

Summary

There are many ways to send a message to a Slack channel. It can be done using a Slack App or a Slack Webhook The choice you make depends on your needs and the technologies you're working with. This article shows 5 simple ways to send messages to Slack using PHP, in fact there are many more than five and it's up to you which one to use.

PHP+Telegram: 5 easy ways how to send a message

Alex — Tue, 22 Aug 2023 08:47:53 +0000

In the world of online communication, Telegram stands out as a popular messaging platform. If you're a developer, it might be useful to know how to easily send a message to Telegram from the code. This article will show you 5 easy ways to do it using PHP.

Preconditions:

PHP installed and curl extension enabled
Public Telegram channel created
Telegram bot created using BotFather
Bot added to channel administrators

Telegram API

Telegram provides a variety of API endpoints and methods, which can be found in the documentation.

Today we're gonna focus on the sendMessage endpoint. It sends some text {TEXT} to the particular channel {CHANNEL_ID} by the bot {BOT_API_TOKEN}

https://api.telegram.org/bot{BOT_API_TOKEN}/sendMessage?chat_id={CHANNEL_ID}&text={TEXT}

There are a lot of ways to call this endpoint and send a message to the channel inside a PHP project. We will cover 5 of them.

HTTP request with cURL

Functional style

<?php

$botApiToken = 'your bot api token';
$channelId ='your channel id';
$text = 'Hello, I am from PHP!';

$query = http_build_query([
    'chat_id' => $channelId,
    'text' => $text,
]);
$url = "https://api.telegram.org/bot{$botApiToken}/sendMessage?{$query}";

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
));
curl_exec($curl);
curl_close($curl);

OOP style

Installation

composer require curl/curl

Usage

<?php

require 'vendor/autoload.php';

$botApiToken = 'your bot api token';
$channelId ='your channel id';
$text = 'Hello, I am from PHP!';

$query = http_build_query([
    'chat_id' => $channelId,
    'text' => $text,
]);
$url = "https://api.telegram.org/bot{$botApiToken}/sendMessage?{$query}";

$curl = new \Curl\Curl();
$curl->get($url);

One line magic using file_get_contents

<?php

$botApiToken = 'your bot api token';
$channelId = 'your channel id';
$text = 'Hello, I am from PHP file_get_contents!';
$query = http_build_query([
    'chat_id' => $channelId,
    'text' => $text,
]);
$url = "https://api.telegram.org/bot{$botApiToken}/sendMessage?{$query}";
file_get_contents($url);

Symfony HTTP client

Symfony is one of the most popular PHP frameworks. It provides a lot of different components out of the box and one of them is HTTP Client. It allows you to make HTTP requests easily.

Installation

composer require symfony/http-client

Standalone

<?php

require 'vendor/autoload.php';

use Symfony\Component\HttpClient\HttpClient;

$botApiToken = 'your bot api token';
$channelId ='your channel id';
$text = 'Hello, I am from Symfony HTTP Client!';

$client = HttpClient::create([
    'base_uri' => 'https://api.telegram.org',
]);

$client->request('GET', "/bot{$botApiToken}/sendMessage", [
    'query' => [
        'chat_id' => $channelId,
        'text' => $text,
    ],
]);

Inside Symfony app

Prepare scoped client inside config/packages/framework.yaml

framework:
    http_client:
        scoped_clients:
            telegram.client:
                base_uri: 'https://api.telegram.org'

And use it inside your service

<?php

namespace App;

use Symfony\Contracts\HttpClient\HttpClientInterface;

class YourService
{
    public function __construct(
        private readonly HttpClientInterface $telegramClient,
    )
    {
    }

    public function sendMessage(string $text): void
    {
        $botApiToken = 'your bot api token';
        $channelId ='your channel id';

        $this->telegramClient->request('GET', "/bot{$botApiToken}/sendMessage", [
            'query' => [
                'chat_id' => $channelId,
                'text' => $text,
            ],
        ]);
    }
}

Symfony Telegram Notifier

Another Symfony component that can send a message to the Telegram channel is Telegram Notifier.

Installation

composer require symfony/telegram-notifier

Standalone

<?php

require 'vendor/autoload.php';

use Symfony\Component\Notifier\Bridge\Telegram\TelegramTransport;
use Symfony\Component\Notifier\Chatter;
use Symfony\Component\Notifier\Message\ChatMessage;

$botApiToken = 'your bot api token';
$channelId ='your channel id';

$text = 'Hello, I am from Symfony Telegram Notifier!';

$telegramTransport = new TelegramTransport($botApiToken, $channelId);
$chatter = new Chatter($telegramTransport);
$chatMessage = new ChatMessage($text);
$chatter->send($chatMessage);

Inside Symfony app

Configure notifier chatter transport inside
config/packages/framework.yaml

parameters:
  env(TELEGRAM_DSN): 'telegram://BOT_API_TOKEN@default?channel=CHANNEL_ID'

framework:
    notifier:
        chatter_transports:
            telegram: '%env(TELEGRAM_DSN)%'

And use it inside your service

<?php

namespace App;

use Symfony\Component\Notifier\ChatterInterface;
use Symfony\Component\Notifier\Message\ChatMessage;

class YourService
{
    public function __construct(
        private readonly ChatterInterface $telegramChatter
    )
    {
    }

    public function sendMessage(string $text): void
    {
        $this->telegramChatter->send(new ChatMessage($text));
    }
}

Telegram Bot SDK

Telegram Bot SDK lets you develop Telegram Bots in PHP easily! Supports Laravel framework and comes with addons to enhance your bot development experience.

Installation

composer require irazasyed/telegram-bot-sdk

Standalone

<?php

require 'vendor/autoload.php';

use Telegram\Bot\Api;

$botApiToken = 'your bot api token';
$channelId ='your channel id';

$telegram = new Api($botApiToken);
$telegram->sendMessage([
    'chat_id' => $channelId,
    'text' => $text,
]);

Inside Laravel app

php artisan vendor:publish --tag="telegram-config"

<?php

namespace App;

use Telegram\Bot\Api;

class YourService
{
    public function __construct(private readonly Api $telegram)
    {
    }

    public function sendMessage(string $channelId, string $text): void
    {
        $this->telegram->sendMessage([
            'chat_id' => $channelId,
            'text' => $text,
        ]);
    }
}

Summary

There are many ways to achieve the same goal. With so many options available, there's no definitive "right" way to send a Telegram message using PHP. The choice you make depends on your needs and the technologies you're working with. This article shows five simple ways to send messages to Telegram using PHP, in fact there are many more than five and it's up to you which one to use.