Menu

## CorpUniver
in package

CorpUniver.php : 30

Класс для работы с объектами модуля "Корпоративный университет"

Class CorpUniver

##### Tags

author

  Ivan Drachev

co-author

  Vladislav Andreev v@salesman.pro

version
  1.0

  (06/09/2019)

  Example

      $CorpUniver = \Salesman\CorpUniver::info($id);

### Table of Contents

ICONMATERIAL = ["video" => "icon-youtube red", "audio" => "icon-volume-up broun", "image" => "icon-picture orange", "resource" => "icon-link-1 green", "text" => "icon-list-nested blue", "file" => "icon-attach-1 fiolet", "mpeg" => "icon-file-video blue"]
  Иконки материалов
VIDEOSITE = ['youtube', 'youtu.be', 'vimeo.com', 'rutube.ru', 'myvi.tv', 'vimple.ru', 'wistia.com', 'brightcove.com', 'sproutvideo.com', 'oculu.com']
  Сайты с видео
$response : array<string|int, mixed>
addAnswer() : int
  Добавление ответа на вопрос
courseConstructor() : array<string|int, mixed>
  Список материалов и заданий по курсу. Основной список
courseList() : array<string|int, mixed>
  Вывод материалов курса при прохождении
delete() : array<string|int, mixed>
  Удаление курса
deleteCategory() : array<string|int, mixed>
  Добавление/изменение категории(раздела) курсов
deleteLecture() : array<string|int, mixed>
  Удаление лекции
deleteMaterial() : array<string|int, mixed>
  Удаление материала
deleteQuestion() : array<string|int, mixed>
  Удаление вопроса
deleteTask() : array<string|int, mixed>
  Удаление задания
edit() : array<string|int, mixed>
  Добавление/изменение курса
editCategory() : array<string|int, mixed>
  Добавление/изменение категории(раздела) курсов
editLecture() : array<string|int, mixed>
  Добавление/изменение лекции
editMaterial() : array<string|int, mixed>
  Добавление/изменение материала
editQuestion() : array<string|int, mixed>
  Добавление/изменение вопроса
editTask() : array<string|int, mixed>
  Добавление/изменение задания
info() : array<string|int, mixed>
  Получение информации о курсе
infoLecture() : array<string|int, mixed>
  Получение информации о лекции
infoMaterial() : array<string|int, mixed>
  Получение информации о материале
infoQuestion() : array<string|int, mixed>
  Получение информации о вопросе и ответов на него
infoTask() : array<string|int, mixed>
  Получение информации о задании
infoWayCource() : array<string|int, mixed>|bool
  Информация по прохождению Курса/Лекции/Материала
listAnswers() : array<string|int, mixed>
  Получение списка вариантов ответа к вопросу
listLections() : array<string|int, mixed>
  Получение списка лекций курса
listMaterials() : array<string|int, mixed>
  Получение списка материалов лекции
listQuestions() : array<string|int, mixed>
  Получение списка вопросов
listTasks() : array<string|int, mixed>
  Получение списка заданий лекции
progressCheckWayCource() : bool
  Отмечаем предыдущий материал выполненным
progressCource() : array<string|int, mixed>
  Прогресс курса
progressLecture() : array<string|int, mixed>
  Прогресс выполнения лекции пользователем
startWayCource() : bool
  Отметка начала прохождения Курса/Лекции/Материала/Задачи и его окончания
iconBySource() : bool|mixed
  Возвращает иконку видео, если ссылка с видеохостинга

### Constants

#### ICONMATERIAL

CorpUniver.php : 35

Иконки материалов

`public mixed ICONMATERIAL = ["video" => "icon-youtube red", "audio" => "icon-volume-up broun", "image" => "icon-picture orange", "resource" => "icon-link-1 green", "text" => "icon-list-nested blue", "file" => "icon-attach-1 fiolet", "mpeg" => "icon-file-video blue"]`

#### VIDEOSITE

CorpUniver.php : 48

Сайты с видео

`public mixed VIDEOSITE = ['youtube', 'youtu.be', 'vimeo.com', 'rutube.ru', 'myvi.tv', 'vimple.ru', 'wistia.com', 'brightcove.com', 'sproutvideo.com', 'oculu.com']`

### Properties

#### $response

CorpUniver.php : 64
`public array<string|int, mixed> $response = []`

### Methods

#### addAnswer()

CorpUniver.php : 2384

Добавление ответа на вопрос

`public static addAnswer([array<string|int, mixed> $params = [] ]) : int`

##### Parameters

$params : array<string|int, mixed> = []

##### Return values

int —

#### courseConstructor()

CorpUniver.php : 75

Список материалов и заданий по курсу. Основной список

`public static courseConstructor( $id[, null $iduser = null ]) : array<string|int, mixed>`

##### Parameters

$id :
$iduser : null = null

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

#### courseList()

CorpUniver.php : 664

Вывод материалов курса при прохождении

`public static courseList( $id, int $iduser) : array<string|int, mixed>`

##### Parameters

$id :
$iduser : int

##### Return values

array<string|int, mixed> —

#### delete()

CorpUniver.php : 936

Удаление курса

`public static delete(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор курса

##### Return values

array<string|int, mixed> —

"Course"

error result - result = result - error - code - text

code: 403 - Курс с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id курса

Example

    $Course = \Salesman\CorpUniver::delete($id);

#### deleteCategory()

CorpUniver.php : 1097

Добавление/изменение категории(раздела) курсов

`public static deleteCategory(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор категории

##### Return values

array<string|int, mixed> —

"Category"

error result - result = result - error - code - text

code: 403 - Категория с указанным id не найдена в пределах аккаунта 405 - Отсутствуют параметры - id категории 407 - Отсутствуют параметры - Название категории

Example

    $Category = \Salesman\CorpUniver::editCategory($id, $params);

#### deleteLecture()

CorpUniver.php : 1320

Удаление лекции

`public static deleteLecture(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор лекции

##### Return values

array<string|int, mixed> —

"Lecture"

error result - result = result - error - code - text

code: 403 - Лекция с указанным id не найдена в пределах аккаунта 405 - Отсутствуют параметры - id лекции

Example

    $Lecture = \Salesman\CorpUniver::deleteLecture($id);

#### deleteMaterial()

CorpUniver.php : 1561

Удаление материала

`public static deleteMaterial(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор материала

##### Return values

array<string|int, mixed> —

"Material"

error result - result = result - error - code - text

code: 403 - Материал с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id материала

Example

    $Material = \Salesman\CorpUniver::deleteMaterial($id);

#### deleteQuestion()

CorpUniver.php : 2122

Удаление вопроса

`public static deleteQuestion(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор вопроса

##### Return values

array<string|int, mixed> —

"Question"

error result - result = result - error - code - text

code: 403 - Задание с указанным id не найдено в пределах аккаунта 405 - Отсутствуют параметры - id задания

Example

    $Task = \Salesman\CorpUniver::deleteTask($id);

#### deleteTask()

CorpUniver.php : 1805

Удаление задания

`public static deleteTask(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор задания

##### Return values

array<string|int, mixed> —

"Task"

error result - result = result - error - code - text

code: 403 - Задание с указанным id не найдено в пределах аккаунта 405 - Отсутствуют параметры - id задания

Example

    $Task = \Salesman\CorpUniver::deleteTask($id);

#### edit()

CorpUniver.php : 849

Добавление/изменение курса

`public static edit(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор курса
$params : array<string|int, mixed> = []
  - данные курса

##### Return values

array<string|int, mixed> —

"Course"

error result - result = result - error - code - text

code: 403 - Курс с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id курса 407 - Отсутствуют параметры - Название клиента

Example

    $Course = \Salesman\CorpUniver::edit($id, $params);

#### editCategory()

CorpUniver.php : 1010

Добавление/изменение категории(раздела) курсов

`public static editCategory(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор категории
$params : array<string|int, mixed> = []
  - данные категории

##### Return values

array<string|int, mixed> —

"Category"

error result - result = result - error - code - text

code: 403 - Категория с указанным id не найдена в пределах аккаунта 405 - Отсутствуют параметры - id категории 407 - Отсутствуют параметры - Название категории

Example

    $Category = \Salesman\CorpUniver::editCategory($id, $params);

#### editLecture()

CorpUniver.php : 1242

Добавление/изменение лекции

`public static editLecture(int $id[, string|null $name = NULL ], int $course) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор лекции
$name : string|null = NULL
  - название лекции
$course : int
  - id курса

##### Return values

array<string|int, mixed> —

"Lecture"

error result - result = result - error - code - text

code: 403 - Лекция с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id лекции

Example

    $Lecture = \Salesman\CorpUniver::editLecture($id, $name, $course);

#### editMaterial()

CorpUniver.php : 1488

Добавление/изменение материала

`public static editMaterial(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор материала
$params : array<string|int, mixed> = []
  - данные материала

##### Return values

array<string|int, mixed> —

"Material"

error result - result = result - error - code - text

code: 403 - Материал с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id материала 407 - Отсутствуют параметры - Название материала

Example

    $Material = \Salesman\CorpUniver::editMaterial($id, $params);

#### editQuestion()

CorpUniver.php : 2002

Добавление/изменение вопроса

`public static editQuestion(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор вопроса
$params : array<string|int, mixed> = []
  - данные вопроса

##### Return values

array<string|int, mixed> —

"Question"

error result - result = result - error - code - text

code: 403 - Вопрос с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id вопроса

Example

    $Question = \Salesman\CorpUniver::editQuestion($id, $params);

#### editTask()

CorpUniver.php : 1727

Добавление/изменение задания

`public static editTask(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор задания
$params : array<string|int, mixed> = []
  - данные задания

##### Return values

array<string|int, mixed> —

"Material"

error result - result = result - error - code - text

code: 403 - Задание с указанным id не найдено в пределах аккаунта 405 - Отсутствуют параметры - id задания 407 - Отсутствуют параметры - Название задания

Example

    $Task = \Salesman\CorpUniver::editTask($id, $params);

#### info()

CorpUniver.php : 310

Получение информации о курсе

`public static info(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор курса

##### Return values

array<string|int, mixed> —

"Course"

error result - result = result - error - code - text

code: 403 - Курс с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id курса

Example

    $Course = \Salesman\CorpUniver::info($id);

#### infoLecture()

CorpUniver.php : 1167

Получение информации о лекции

`public static infoLecture(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор лекции

##### Return values

array<string|int, mixed> —

"Lecture"

error result - result = result - error - code - text

code: 403 - Лекция с указанным id не найдена в пределах аккаунта 405 - Отсутствуют параметры - id лекции

Example

    $Lecture = \Salesman\CorpUniver::infoLecture($id);

#### infoMaterial()

CorpUniver.php : 1389

Получение информации о материале

`public static infoMaterial(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор материала

##### Return values

array<string|int, mixed> —

"Material"

error result - result = result - error - code - text

code: 403 - Материал с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id материала

Example

    $Material = \Salesman\CorpUniver::infoMaterial($id);

#### infoQuestion()

CorpUniver.php : 1940

Получение информации о вопросе и ответов на него

`public static infoQuestion(int $id, int $tid) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор задания
$tid : int
  - идентификатор задания

##### Return values

array<string|int, mixed> —

"Question"

error result - result = result - error - code - text

Example

    $Question = \Salesman\CorpUniver::infoQuestion($id);

#### infoTask()

CorpUniver.php : 1630

Получение информации о задании

`public static infoTask(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор задания

##### Return values

array<string|int, mixed> —

"Task"

error result - result = result - error - code - text

code: 403 - Задание с указанным id не найдено в пределах аккаунта 405 - Отсутствуют параметры - id задания

Example

    $Task = \Salesman\CorpUniver::infoTask($id);

#### infoWayCource()

CorpUniver.php : 426

Информация по прохождению Курса/Лекции/Материала

`public static infoWayCource([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|bool`

##### Parameters

$params : array<string|int, mixed> = []
  - int idcourse - id курса
  - int idlecture - id лекции
  - int idmaterial - id матриала
  - int idtask - id теста

##### Return values

array<string|int, mixed>|bool —

#### listAnswers()

CorpUniver.php : 2191

Получение списка вариантов ответа к вопросу

`public static listAnswers(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор вопроса

##### Return values

array<string|int, mixed> —

"listAnswers"

error result - result = result - error - code - text

Example

    $Answers = \Salesman\CorpUniver::listAnswers($id);

#### listLections()

CorpUniver.php : 394

Получение списка лекций курса

`public static listLections(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор курса

##### Return values

array<string|int, mixed> —

"Lections"

error result - result = result - error - code - text

Example

    $Lections = \Salesman\CorpUniver::listLections($id);

#### listMaterials()

CorpUniver.php : 500

Получение списка материалов лекции

`public static listMaterials(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор лекции

##### Return values

array<string|int, mixed> —

"Materials"

error result - result = result - error - code - text

Example

    $Materials = \Salesman\CorpUniver::listMaterials($id);

#### listQuestions()

CorpUniver.php : 1886

Получение списка вопросов

`public static listQuestions(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор задания

##### Return values

array<string|int, mixed> —

"Questions"

error result - result = result - error - code - text

Example

    $Questions = \Salesman\CorpUniver::listQuestions($id);

#### listTasks()

CorpUniver.php : 540

Получение списка заданий лекции

`public static listTasks(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор лекции

##### Return values

array<string|int, mixed> —

"Tasks"

error result - result = result - error - code - text

Example

    $Tasks = \Salesman\CorpUniver::listTasks($id);

#### progressCheckWayCource()

CorpUniver.php : 2230

Отмечаем предыдущий материал выполненным

`public static progressCheckWayCource( $id, int $iduser) : bool`

##### Parameters

$id :
$iduser : int

##### Return values

bool —

#### progressCource()

CorpUniver.php : 612

Прогресс курса

`public static progressCource( $id, int $iduser) : array<string|int, mixed>`

##### Parameters

$id :
$iduser : int

##### Return values

array<string|int, mixed> —

#### progressLecture()

CorpUniver.php : 569

Прогресс выполнения лекции пользователем

`public static progressLecture( $id, int $iduser) : array<string|int, mixed>`

##### Parameters

$id :
$iduser : int

##### Return values

array<string|int, mixed> —

#### startWayCource()

CorpUniver.php : 2289

Отметка начала прохождения Курса/Лекции/Материала/Задачи и его окончания

`public static startWayCource([array<string|int, mixed> $params = [] ], int $iduser) : bool`

##### Parameters

$params : array<string|int, mixed> = []
  - параметры
  - int idcourse - id курса
  - int idlecture - id лекции
  - int idmaterial - id матриала
  - int idtask - id теста
  - bool start = true, если это начало прохождения
  - bool end = true, если это окончание прохождения
$iduser : int

##### Return values

bool —

#### iconBySource()

CorpUniver.php : 2431

Возвращает иконку видео, если ссылка с видеохостинга

`private static iconBySource( $url) : bool|mixed`

##### Parameters

$url :

##### Return values

bool|mixed —

## Search results