Для установки домена, api ключа, директории для загрузки файлов в common/config/params необходимо положить следующие настройки:
'worksection-api'=> ['domain'=>'https://api домен', // api домен worksection вашей компании (Пример - https://doris.worksection.com) 'apiKey'=>'api ключ', // api hash key - (генерировать может только админ приложения)'uploadPath'=>'/uploads/tests'// временный путь для сохранения файлов относительно webroot (после передачи файла api он будет автоматически удален)]
Использование
Работа с комментариями
Поиск комментариев
usesergios\worksectionApi\src\mappers\CommentMapper;$commentMapper=newCommentMapper('ссылка на задачу');// Пример /project/51000/7784366/ //В findByAttributes передача параметров происходит по атрибутах 2 моделей (Comments,User). //Имя полей моделей которое можно передавать в метод findByAttribures:// - модель User ['user'=> ['id'=>Integer|String,'lastName'=>String,'email'=>String,'name'=>String,'post'=>String,'avatar'=>String,'company'=>String,'department'=>String ] ];// - модель Comment ['dateAdded'=>String,'text'=>String ];$commentCollection=$commentMapper->findByAttributes(['dateAdded'=>'2019-07-24 11:01', // Формат YYYY-MM-DD hh:mm'text'=>'Test', //Текст комментария'user'=> ['id'=>userID, // integer or string'lastName'=>'Фамилия','firstName'=>'Василий','email'=>'test@gmail.com','name'=>'Василий Петрович','post'=>'Backend developer', // должность'avatar'=>'https://ссылки-на-аватар','company'=>'Название компании','department'=>'Отдел', ]]);//возвращает коллекцию комментариев по критериях поиска$commentCollection=$commentMapper->findAll();//возвращает коллекцию всех комментариев
Создание кометария
usesergios\worksectionApi\src\models\Comment;usesergios\worksectionApi\src\mappers\CommentMapper;usesergios\worksectionApi\src\models\User;$commentMapper=newCommentMapper('ссылка на задачу');// Пример /project/51000/7784366/ //создание кометария$comment=newComment();$comment->setAttributes(['text'=>'Test']);// Текст комментария$comment->setTodo(1,'check box text 1'); // Создание checkbox с текстом - check box text 1 $comment->setTodo(2,'check box text 2'); // Создание checkbox с текстом - check box text 2...$comment->saveImage($image); //отправка файла к комментарию ($image - объект UploadedFile)//создание пользователя$user=newUser();$user->setAttributes(['email'=>'sergeydovzhanutsia@gmail.com']);//заполнения атрибутов пользователя$comment->setUser($user);//привязка пользователя к комментарию$commentMapper=$commentMapper->create($comment);//Создание кометария (возвращает объект созданного комментария)
Работа с пользователями
usesergios\worksectionApi\src\mappers\UserMapper;$userMapper=newUserMapper();$userCollection=$userMapper->findAll(); //возвращает коллекцию всех пользователей//поиск пользователей по критериям//В findByAttribures нужно передавать имя полей которое есть в модели User.$userCollection=$userMapper->findByAttributes(['id'=>51659, // id пользователя'email'=>'email','lastName'=>'фамилия','firstName'=>'имя','name'=>'имя фамилия','post'=>'должность','avatar'=>'https://ссылка-на-аватар','company'=>'Название компании','department'=>'Отдел',]); //возвращает коллекцию всех найденных пользователей
The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.