CorpUniver
in package
Класс для работы с объектами модуля "Корпоративный университет"
Class CorpUniver
Tags
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
Иконки материалов
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
Сайты с видео
public
mixed
VIDEOSITE
= ['youtube', 'youtu.be', 'vimeo.com', 'rutube.ru', 'myvi.tv', 'vimple.ru', 'wistia.com', 'brightcove.com', 'sproutvideo.com', 'oculu.com']
Properties
$response
public
array<string|int, mixed>
$response
= []
Methods
addAnswer()
Добавление ответа на вопрос
public
static addAnswer([array<string|int, mixed> $params = [] ]) : int
Parameters
- $params : array<string|int, mixed> = []
Return values
int —courseConstructor()
Список материалов и заданий по курсу. Основной список
public
static courseConstructor( $id[, null $iduser = null ]) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —courseList()
Вывод материалов курса при прохождении
public
static courseList( $id, int $iduser) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —delete()
Удаление курса
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()
Добавление/изменение категории(раздела) курсов
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()
Удаление лекции
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()
Удаление материала
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()
Удаление вопроса
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()
Удаление задания
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()
Добавление/изменение курса
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()
Добавление/изменение категории(раздела) курсов
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()
Добавление/изменение лекции
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()
Добавление/изменение материала
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()
Добавление/изменение вопроса
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()
Добавление/изменение задания
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()
Получение информации о курсе
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()
Получение информации о лекции
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()
Получение информации о материале
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()
Получение информации о вопросе и ответов на него
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()
Получение информации о задании
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()
Информация по прохождению Курса/Лекции/Материала
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()
Получение списка вариантов ответа к вопросу
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()
Получение списка лекций курса
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()
Получение списка материалов лекции
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()
Получение списка вопросов
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()
Получение списка заданий лекции
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()
Отмечаем предыдущий материал выполненным
public
static progressCheckWayCource( $id, int $iduser) : bool
Parameters
Return values
bool —progressCource()
Прогресс курса
public
static progressCource( $id, int $iduser) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —progressLecture()
Прогресс выполнения лекции пользователем
public
static progressLecture( $id, int $iduser) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —startWayCource()
Отметка начала прохождения Курса/Лекции/Материала/Задачи и его окончания
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()
Возвращает иконку видео, если ссылка с видеохостинга
private
static iconBySource( $url) : bool|mixed