Bitrix API

Channel extends BaseObject implements ArrayAccess

Table of Contents

Interfaces

ArrayAccess

Properties

$channels  : mixed

Methods

__construct()  : mixed
Channel constructor.
canEdit()  : bool
canEditVote()  : bool
canRead()  : bool
get()  : mixed|null
getApplication()  : CMain
getById()  : Result|CDBResult
getErrorByCode()  : Error|null
getErrors()  : array<string|int, Error>
getId()  : int
getList()  : Result|CDBResult
getUser()  : CUser
init()  : void
exists only for child class
loadFromId()  : BaseObject
loadUserGroups()  : array<string|int, mixed>
offsetExists()  : mixed|null
Whether a offset exists.
offsetGet()  : mixed|null
offsetSet()  : void
offsetUnset()  : void
shutdown()  : mixed
Debug function

Properties

$channels

public static mixed $channels = array()

Methods

__construct()

Channel constructor.

public __construct(mixed $id) : mixed
Parameters
$id : mixed
Tags
throws
ArgumentNullException

canEdit()

public canEdit(int $userId) : bool
Parameters
$userId : int

User ID.

Return values
bool

canEditVote()

public canEditVote(int $userId) : bool
Parameters
$userId : int

User ID.

Return values
bool

canRead()

public canRead(int $userId) : bool
Parameters
$userId : int

User ID.

Return values
bool

get()

public get(string $key) : mixed|null
Parameters
$key : string

Characteristic that you want to know.

Return values
mixed|null

getById()

public static getById(int $id) : Result|CDBResult
Parameters
$id : int

Channel ID.

Return values
Result|CDBResult

getErrorByCode()

public getErrorByCode(string|int $code) : Error|null
Parameters
$code : string|int

The code of the error.

Tags
inheritdoc

Returns an error with the necessary code.

Return values
Error|null

getList()

public static getList(array<string|int, mixed> $parameters) : Result|CDBResult
Parameters
$parameters : array<string|int, mixed>

Array of query parameters.

Tags
throws
ArgumentException
Return values
Result|CDBResult

init()

exists only for child class

public init() : void
Tags
throws
ObjectNotFoundException

loadFromId()

public static loadFromId(int $id[, bool $shouldBeNewIfIdIsNull = false ]) : BaseObject
Parameters
$id : int

Entity ID.

$shouldBeNewIfIdIsNull : bool = false
Return values
BaseObject

loadUserGroups()

public static loadUserGroups(int $userId) : array<string|int, mixed>
Parameters
$userId : int

User ID.

Return values
array<string|int, mixed>

offsetExists()

Whether a offset exists.

public offsetExists(string $offset) : mixed|null
Parameters
$offset : string

An offset to check for.

Return values
mixed|null

offsetGet()

public offsetGet(string $offset) : mixed|null
Parameters
$offset : string

The offset to retrieve.

Return values
mixed|null

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed

The offset to assign the value to.

$value : mixed

The value to set.

Tags
throws
NotSupportedException

offsetUnset()

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

The offset to unset.

shutdown()

Debug function

public static shutdown() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results