EDUSOHO踩坑笔记之十一：主题开发之数据标签
EDUSOHO踩坑笔记之十一：主题开发之数据标签
数据标签是可直接在twig页面获取数据的一种方式，无需通过Controller获取，方便了主题的开发。
使用方式
例：目前有数据标签CourseSetDataTag，则调用以下代码：
{% set courseSet = data('CourseSet',{id: 1}) %}
调用data方法，第一个参数是不含DataTag的数据标签名，{}里面是数据标签所需要的参数，多个参数用 ‘,’ 连接，获取之后可直接在页面下文调用。
数据标签列表
数据标签目录：src/AppBundle/Extensions/DataTag/
课程相关
- CourseSetDataTag
- FreeCourseSetsDataTag
- RecommendCourseSetsDataTag
- LatestCourseSetsDataTag
- PopularCourseSetsDataTag
- RelatedCourseSetsDataTag
- CourseDataTag
- CoursesByCourseSetIdDataTag
- CourseSetByCourseDataTag
- FirstCourseDataTag
- DefaultCourseByCourseSetDataTag
- PublishedCourseByCourseSetDataTag
- PublishedTasksDataTag
- RecentLiveCourseSetsDataTag
- PublishedLivingTasksDataTag
- RecentLiveTasksDataTag
- UserLatestLearnCoursesDataTag
班级相关
- ClassroomDataTag
- ClassroomsDataTag
- LatestClassroomsDataTag
- RecommendClassroomsDataTag
公开课相关
- OpenCourseDataTag
- OpenCoursesDataTag
- RecommendOpenCoursesDataTag
- OpenCourseLessonDataTag
小组相关
- GroupDataTag
- HotGroupDataTag
- HotThreadsDataTag
- LatestGroupThreadsDataTag
资讯相关
- ArticleDataTag
- ArticleCategoryDataTag
- LatestArticlesDataTag
- PopularArticlePostsDataTag
- PublishedArticlesDataTag
用户相关
- LatestTeachersDataTag
- LatestUsersDataTag
- PromotedTeacherDataTag
- RecommendTeachersDataTag
- StudyCenterMissionsDataTag
- UserDataTag
- UserProfileDataTag
- UserandProfilesDataTag
- UserFriendCountDataTag
其他
- NavigationDataTag
- NavigationsTreeDataTag
- AnnouncementDataTag
- AnnouncementsDataTag
- CategoriesDataTag
- CategoryDataTag
- TagDataTag
- TagsDataTag
- TagMarksDataTag
- VipLevelsDataTag
CourseSetDataTag
描述
- 获取单个课程信息
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
id int string |
是 | 课程ID |
FreeCourseSetsDataTag
描述
- 获取免费课程列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 课程数量，取值不能超过100 |
orderby string |
否 | 排序字段 'hitNum','recommended','rating','studentNum',recommendedSeq'，默认latest |
categoryId/categoryCode int string/string |
否 | 分类ID/分类编码 |
RecommendCourseSetsDataTag
描述
- 获取推荐课程列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 课程数量，取值不能超过100 |
orderby string |
否 | 排序字段 'hitNum','recommended','rating','studentNum',recommendedSeq'，默认recommendedSeq |
categoryId/categoryCode int string/string |
否 | 分类ID/分类编码 |
notFill bool |
否 | 推荐课程不足时不填充课程数，默认:false |
LatestCourseSetsDataTag
描述
- 获取课程列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 课程数量，取值不能超过100 |
type string |
否 | 排序字段 'hitNum','recommended','rating','studentNum',recommendedSeq'，默认latest |
categoryId int string |
否 | 分类ID |
notFree int string |
否 | 1：代表不包括免费课程 0：代表包括 默认0 |
PopularCourseSetsDataTag
描述
- 获取热门课程列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 课程数量，取值不能超过100 |
orderby string |
否 | 排序字段 'hitNum','recommended','rating','studentNum',recommendedSeq'，默认hitNum |
categoryId/categoryCode int string/string |
否 | 分类ID/分类编码 |
notFree int string |
否 | 1：代表不包括免费课程 0：代表包括 默认0 |
RelatedCourseSetsDataTag
描述
- 获取单个课程的相关课程列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 课程数量，取值不能超过100 |
courseSetId int string |
是 | 课程ID |
CourseDataTag
描述
- 获取单个计划信息
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 课程数量，取值不能超过100 |
fetchCourseSet bool |
否 | 是否获取课程信息 'true','false' ，默认false |
CoursesByCourseSetIdDataTag
描述
- 获取单个课程下的教学计划列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseSetId int string |
是 | 课程ID |
status string |
否 | 是否获取课程信息 'draft','published','closed' |
CourseSetByCourseDataTag
描述
- 根据教学计划ID获取一个课程
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseSetId int string |
是 | 课程ID |
FirstCourseDataTag
描述
- 获取单个课程下第一个创建的教学计划
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseSetId int string |
是 | 课程ID |
DefaultCourseByCourseSetDataTag
描述
- 获取单个课程下的默认教学计划
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseSetId int string |
是 | 课程ID |
PublishedCourseByCourseSetDataTag
描述
- 获取单个课程下第一个发布的教学计划
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseSetId int string |
是 | 课程ID |
PublishedTasksDataTag
描述
- 获取单个课程的任务列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseSetId int string |
是 | 课程ID |
RecentLiveCourseSetsDataTag
描述
- 获取最新直播任务的课程列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
PublishedLivingTasksDataTag
描述
- 获取正在直播的已发布的任务列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseSetId int string |
是 | 课程ID |
RecentLiveTasksDataTag
描述
- 获取近期直播未结束的（用户）任务列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
userId int string |
否 | 用户ID |
UserLatestLearnCoursesDataTag
描述
- 获取用户当前学习的课程列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
userId int string |
否 | 用户ID |
ClassroomDataTag
描述
- 获取一个班级信息
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
classroomId int string |
是 | 班级ID |
ClassroomsDataTag
描述
- 获取班级列表，时间倒序排列
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
LatestClassroomsDataTag
描述
- 获取公开展示的班级列表，时间倒序排列
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
RecommendClassroomsDataTag
描述
- 获取推荐班级列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
OpenCourseDataTag
描述
- 获取单个公开课信息
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseId int string |
是 | 公开课ID |
OpenCoursesDataTag
描述
- 获取公开课列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
orderType string |
否 | 排序规则 'recommendedSeq','hitNum'，默认时间倒序 |
categoryId int string |
否 | 分类ID |
RecommendOpenCoursesDataTag
描述
- 获取公开课列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
courseId int string |
是 | 公开课ID |
OpenCourseLessonDataTag
描述
- 获取一个公开课的课时
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
lessonId int string |
是 | 公开课课时ID |
GroupDataTag
描述
- 获取单个小组信息
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
groupId int string |
是 | 小组ID |
HotGroupDataTag
描述
- 获取最热小组列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
HotThreadsDataTag
描述
- 获取小组最热话题列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
LatestGroupThreadsDataTag
描述
- 获取小组最新话题列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
ArticleDataTag
描述
- 获取单个资讯内容
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
courseId int string |
是 | 资讯ID |
ArticleCategoryDataTag
描述
- 获取资讯栏目及其子栏目
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
code string |
否 | 栏目code |
- LatestArticlesDataTag
描述
- 获取最新资讯列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
type string |
否 | 资讯类型 'featured'(头条),'promoted'(推荐),'sticky'(置顶) |
categoryId int string |
否 | 栏目ID |
PopularArticlePostsDataTag
描述
- 获取文章热门评论列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
PublishedArticlesDataTag
描述
- 获取已发布资讯列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
sort string |
否 | 排序规则 'created'(创建时间),'published'(发布时间,带置顶),'normal'(发布时间),'popular'(热门) |
LatestTeachersDataTag
描述
- 获取最新老师列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
LatestUsersDataTag
描述
- 获取最新用户列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
onlyMember bool |
否 | true时，只返回普通用户，默认false |
PromotedTeacherDataTag
描述
- 获取最新的一个推荐教师
参数
- 无
RecommendTeachersDataTag
描述
- 获取推荐老师列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
StudyCenterMissionsDataTag
描述
- 获取用户所有课程中未学的任务
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
userId int string |
是 | 用户ID |
count int string |
是 | 展示数量，取值不能超过100 |
missionCount int string |
是 | 每个课程的任务数量 |
UserDataTag
描述
- 获取单个用户信息（不包含profile信息）
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
userId int string |
是 | 用户ID |
UserProfileDataTag
描述
- 获取单个用户个人信息
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
userId int string |
是 | 用户ID |
UserandProfilesDataTag
描述
- 获取单个用户全部信息（包含profile信息）
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
userId int string |
是 | 用户ID |
UserFriendCountDataTag
描述
- 获取一个用户的关注/粉丝的数量
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
userId int string |
是 | 用户ID |
NavigationDataTag
描述
- 获取导航列表及其子导航
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
type string |
是 | 导航类型 'top'(顶部导航),'foot'(底部导航) |
NavigationsTreeDataTag
描述
- 获取已开启的顶部导航及其子导航列表
参数
- 无
AnnouncementDataTag
描述
- 获取正在进行中的站内公告列表
参数
- 无
AnnouncementsDataTag
描述
- 获取正在进行中的站内公告列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
count int string |
是 | 展示数量，取值不能超过100 |
targetId int string |
是 | 课程ID／班级ID |
targetType string |
是 | 目标类型 'course','classroom','global' |
CategoriesDataTag
描述
- 获取分类列表
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
group int string |
是 | 分类组ID |
parentId int string |
否 | 分类ID |
CategoryDataTag
描述
- 获取单个分类信息
参数
- categoryId 必需 分类ID
| 字段 | 是否必填 | 描述 |
|---|---|---|
categoryId int string |
是 | 分类ID |
TagDataTag
描述
- 获取单个标签信息
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
tagId int string |
是 | 标签ID |
TagsDataTag
描述
- 获取所有标签
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
tagIds array |
是 | 标签IDs |
count int string |
是 | 展示数量 |
- 这里2个参数2选一
TagMarksDataTag
描述
- 获取标签信息(tagName,tagId,groupId)
参数
| 字段 | 是否必填 | 描述 |
|---|---|---|
tags array |
是 | 标签IDs |
VipLevelsDataTag
描述
- 获取会员等级列表
参数
- 无