oafasys / dblookup
提供了一种在 dblookup 表中查找常用值的服务的功能
Requires
- ext-json: *
README
此包提供了一种直接与查找数据库接口的简便方法。它包括检索各种数据组的方法,包括在返回之前以多种方式处理数据的方法。
安装
composer require oafasys/dblookup
配置
您的 .env 文件应包含
DBLOOKUP_HOST=
DBLOOKUP_PORT=
DBLOOKUP_DATABASE=
DBLOOKUP_USERNAME=
DBLOOKUP_PASSWORD=
请注意,在 'DB' 和 'LOOKUP' 之间没有下划线。
用法
扩展 DbLookup 模型
您可能需要自定义函数 -- 要执行此操作,您可以扩展 DbLookup 模型并在其中创建自己的方法。如果您发现多个项目需要相同的自定义方法,您可以考虑将它们添加到此包中以便通用访问。
可用方法
除了这里列出的方法外,还有其他方法可用。这些未列出的方法是内部方法,用于获取下方方法提供的结果列表。
以下所有方法都有一个 `$for`
变量。此变量可以取三个值之一,以确定如何返回结果
- null: 返回结果不变
- 'dropdown': 返回
`$value => $label`
对的形式 - 'api': 返回具有
`code`
和`label`
属性的对象
getCountries($for = null, $america_first = false, $three_character_code = false)
根据 `country`
表返回世界各国的国家。
`$america_first`
确定是否将美国列在列表顶部(true)或按字母顺序与其他国家一起出现(false)。
`$three_character_code`
:如果为 true,则返回三位国家代码;如果为 false,则返回两位国家代码。
getStates($for = null, $include_territories)
根据 `state`
表返回美国的州。
`$include_territories`
:如果为 true,则将扩展领土(例如,波多黎各、关岛)包含在结果中。
getProvinces($for = null)
根据 `state`
表返回加拿大的省份。
getZips($for = null)
根据 `zip_county`
表返回美国的 ZIP 代码。
getCounties($for = null)
根据 `zip_county`
表返回美国的县。
此方法返回州和县名的独特配对,以确定独特的县而不会重复行。
getCountiesByState($state_abbreviation, $for = null)
根据 `zip_county`
表返回给定州的县。
getCountiesByZip($zip, $for = null)
根据 `zip_county`
表返回给定 ZIP 代码的县。
getRecruitingTerms($for = null)
根据 `term`
表返回所有招聘术语。
这里的招聘术语由过去的一个 _inquiry_displaydate 和一个未来的 _application_display_enddate 定义。
getCurrentTerms($for = null)
根据 `term`
表返回所有当前术语。
这里的当前术语由过去的一个 _application_display_startdate 和一个未来的 _application_display_enddate 定义。
getUpcomingTerms($for = null)
根据 `term`
表返回所有即将到来的术语。
即将到来的术语由未来的一个 _application_display_enddate 定义。
getMajorsForSalesforce($for = null)
返回所有专业,基于 `intended_major`
表。
要包含在结果中,一行必须在 _intendedmajor 列中有所内容,且 _isenabled 列必须为 true。
getMajorsForPeoplesoft($for = null)
基于 `program_of_study`
表返回所有专业。
getSchools($for = null, $level = null)
根据学生录取的级别(例如,本科生)返回匹兹堡大学内的所有学校。
`$level`
: null 返回每所学校;其他选项是 UGRD 和 UPPER
getAdmitTypes($for = null, $app_center)
返回给定申请中心可用的所有录取类型。
`$app_center`
: 选项有 UPB、UPG、UPIT、UPJ
可用路由
dblookup 包提供了几个您可以使用来访问数据的路由。这对于处理表单的 Vue 组件特别有用,例如 PRIYA 上的招聘表单。
dblookup/provinces OR dblookup/states
这些路由以 API 准备的格式提供所有省份或所有州。
dblookup/state/{abbreviation}/counties
此路由将提供一个 API 准备好的列表,列出给定州内的县。
dblookup/zip/{zip}
此路由将提供一个 API 准备好的列表,列出给定 ZIP 内的县。