bitrix24-php-sdk documentation

Basic necessary knowledge

Full list of buzzwords, patterns and dependencies used in SDK.

Bitrix24

• Bitrix24 REST API and Marketing Applications

PHP

• namespaces: Organize code into logical groups
• env variables: Access environment-specific configuration
• generators: Create iterators for large data sets efficiently
• interfaces: Define contracts for classes
• inheritance: Extend class functionality

PHP standards for interoperability

• PSR-3: Logger Interface: Common interface for logging libraries.
• PSR-7: HTTP message interfaces: Common interfaces for representing HTTP messages as described in RFC 7230 and RFC 7231, and URIs for use with HTTP messages as described in RFC 3986.

Design patterns

• Fabric: Create objects without specifying exact class
• Observer: Implement publish-subscribe architecture
• Builder: Design pattern that lets you construct complex objects step by step
• Strategy: Behavioral design pattern that lets you define a family of algorithms, put each of them into a separate class, and make their objects interchangeable.

Software architecture

• The Twelve-Factor App: The twelve-factor app is a methodology for building software-as-a-service apps.

Infrastructure

• composer: PHP dependency management tool
• make: Automate build processes
• env-files: Store configuration in the environment
• yaml: YAML is a data serialisation language designed to be directly writable and readable by humans.
• GitHub Actions: automate tasks throughout the software development lifecycle.
• ngrok: Share your local app without deploying
• PHP built-in web-server: This web server is designed to aid application development. It may also be useful for testing purposes or for application demonstrations that are run in controlled environments.
• cURL: Command line tool and library for transferring data with URLs

Code quality and refactoring

• phpunit: PHP testing framework
• phpstan: PHP static analysis tool
• rector: PHP automated refactoring tool

Additional PHP dependencies

• monolog: Logging for PHP, supports severity levels from rfc5424
• libphonenumber for PHP: Library for parsing, formatting, storing and validating international phone numbers. This library is based on Google's libphonenumber.
• darsyn\IP: IP is an immutable value object for (both version 4 and 6) IP addresses.
• carbon: Simple PHP API extension for DateTime.
• moneyphp: PHP implementation of the Money pattern, as described in Patterns of Enterprise Application Architecture.
• moneyphp-percentage: Percentage (VAT) value object for moneyphp/money package.

Symfony components

• symfony/http-client: low-level HTTP client with support for both PHP stream wrappers and cURL. It provides utilities to consume APIs and supports synchronous and asynchronous operations.
• symfony/console: eases the creation of beautiful and testable command line interfaces.
• symfony/dotenv: parses .env files to make environment variables stored in them accessible via $_SERVER or $_ENV.
• symfony/filesystem: provides platform-independent utilities for filesystem operations and for file/directory paths manipulation.
• symfony/mime: allows manipulating the MIME messages used to send emails and provides utilities related to MIME types.
• symfony/finder: finds files and directories based on different criteria (name, file size, modification time, etc.) via an intuitive fluent interface.
• symfony/http-client-contracts: a set of abstractions extracted out of the Symfony components.
• symfony/http-foundation: defines an object-oriented layer for the HTTP specification.
• symfony/event-dispatcher: provides tools that allow your application components to communicate with each other by dispatching events and listening to them.
• symfony/uid: provides utilities to work with unique identifiers (UIDs) such as UUIDs and ULIDs.