Documentation

common.php

common.php -- Common Matrix constants and procedures.

This file contains common Matrix constants and procedures that are used in other files.

Tags
author

Artyom V. Poptsov poptsov.artyom@gmail.com

Table of Contents

Constants

MATRIX_CLIENT_URL  = "/_matrix/client/r0"
MATRIX_MEDIA_DOWNLOAD_URL  = '/_matrix/media/r0/download'
MATRIX_MEDIA_UPLOAD_URL  = '/_matrix/media/r0/upload'
MATRIX_REGISTER_URL  = "/_matrix/client/r0/admin/register"
SYNAPSE_API_VERSION  = "v2"
SYNAPSE_URL  = "/_synapse/"

Functions

is_fqn()  : bool
Predicate. Check if a $name is a fully qualified name (FQN.) E.g.
make_fqn()  : string
Make Matrix fully qualified name (FQN.)

Constants

MATRIX_CLIENT_URL

public mixed MATRIX_CLIENT_URL = "/_matrix/client/r0"

MATRIX_MEDIA_DOWNLOAD_URL

public mixed MATRIX_MEDIA_DOWNLOAD_URL = '/_matrix/media/r0/download'

MATRIX_MEDIA_UPLOAD_URL

public mixed MATRIX_MEDIA_UPLOAD_URL = '/_matrix/media/r0/upload'

MATRIX_REGISTER_URL

public mixed MATRIX_REGISTER_URL = "/_matrix/client/r0/admin/register"

SYNAPSE_API_VERSION

public mixed SYNAPSE_API_VERSION = "v2"

SYNAPSE_URL

public mixed SYNAPSE_URL = "/_synapse/"

Functions

is_fqn()

Predicate. Check if a $name is a fully qualified name (FQN.) E.g.

is_fqn(string $name) : bool

'@avp:example.ru'

Parameters
$name : string

Name to check.

Return values
bool

true if $name is a fully qualified user name, false otherwise.

make_fqn()

Make Matrix fully qualified name (FQN.)

make_fqn(string $name, string $server) : string
Parameters
$name : string

Name to use.

$server : string

Server name.

Return values
string

A fully qualified name.


        
On this page

Search results