unarealidad / canarium-kernal-core
canarium的基础,包括框架和抽象层,这对于构建基于canarium的应用至关重要。
Requires
- php: >=5.3.23
- beberlei/doctrineextensions: dev-master
- bjyoungblood/bjy-authorize: dev-master
- doctrine/doctrine-orm-module: 0.8.*
- gedmo/doctrine-extensions: 2.3.*
- goalio/goalio-rememberme: 1.*
- goalio/goalio-rememberme-doctrine-orm: 1.*
- google/apiclient: ^2.0
- unarealidad/canarium-libraries-error-handler: dev-master
- unarealidad/canarium-libraries-goalio-mail-service: dev-master
- unarealidad/canarium-libraries-google-sso: dev-master
- unarealidad/canarium-modules-contact-us: dev-master
- unarealidad/canarium-modules-form: dev-master
- unarealidad/canarium-modules-page: dev-master
- unarealidad/canarium-modules-settings: dev-master
- webino/webino-image-thumb: dev-master
- zendframework/zendframework: 2.4.*
- zendframework/zendservice-recaptcha: *
- zf-commons/zfc-admin: dev-master
- zf-commons/zfc-user: 1.1.0
- zf-commons/zfc-user-doctrine-orm: 1.0.0
- zfcampus/zf-apigility: dev-master
- zfcampus/zf-apigility-doctrine: dev-master
- zfcampus/zf-apigility-documentation: >=1.0.5,<2.0.0
- zfcampus/zf-deploy: ~1.0
- zfcampus/zf-development-mode: ~2.0
- zfcampus/zf-doctrine-querybuilder: ~1.0
This package is not auto-updated.
Last update: 2020-01-10 16:04:08 UTC
README
canarium的基础,包括框架和抽象层,这对于构建基于canarium的应用至关重要。这是canarium的核心,用于安装和初始化Canarium模块的依赖项。这是任何canarium应用实例或应用主的基本要求。
安装
通过composer安装
composer require unarealidad/canarium-kernal-core dev-master
将CanariumCore
添加到Appmaster的config/application.config.php
或Appinstance的config/instance.config.php
中的modules
键下
将示例配置config/canariumcontactus.local.php.dist
复制到Appinstance的config/autoload/
目录,并删除.dist
扩展名。
转到Appinstance目录,并运行以下命令以更新您的数据库
./doctrine-module orm:schema-tool:update --force
将数据/initial_rows.sql导入到您的数据库中。这将向数据库添加2个新用户
用户:root@root.com 密码:123456 用户级别:超级用户
用户:admin@admin.com 密码:123456 用户级别:管理员
请记住更改每个账户的密码。
配置
主要配置键:canariumcore
示例配置文件:config/canariumcore.local.php.dist
配置项 | 示例值 | 必需 | 描述 |
---|---|---|---|
site_name | 'Sample Site' | true | 您的网站名称,将显示在页面标题中 |
verbose_title | true | false | 是否显示控制器和动作以供调试目的在页面标题中 |
is_authentication_required | true | false | 是否所有页面都需要登录用户才能访问。默认为false。如果设置为true,则所有请求页面的访客用户将被重定向到登录页面(除注册和忘记密码页面外)。 |
is_authentication_whitelist | array('login') | false | 要排除由is_authentication_required 引起的重定向的路由数组。 |
login_on_denied_access | true | false | 当出现403禁止访问时,是否将用户重定向到登录页面。默认为true。如果设置为false,则403消息和跟踪信息将可见,这对于调试目的很有用。 |
denied_access_redirect_route | 'home' | 当出现403时,将重定向到的路由。如果设置login_on_denied_access为true,则将覆盖此设置。 | |
logout_third_party_login_too | false | false | 是否在用户登出后也注销第三方登录会话,如Google。 |
application_hash | '#1HKS)>>#EAZJR' | false | 创建身份验证令牌时使用的哈希值 |
default_app_id | 11 | false | 在API调用上使用的默认应用ID |
default_app_secret | '50b9d04e28e1380bf522a7430b7a9b5c08a8cc16' | false | 在API调用上使用的默认应用密钥 |
公开页面
URL | 模板 | 访问 | 描述 |
---|---|---|---|
/user/login | user/login.phtml | 访客 | 显示登录页面 |
/user/logout | none | 用户 | 登出用户 |
/user/register | user/register.phtml | 访客 | 显示注册页面 |
/user/changepassword | user/changepassword.phtml | 用户 | 显示更改密码页面 |
/user/changeemail | user/changeemail.phtml | 用户 | 显示更改电子邮件页面 |
user/update-profile | user/update-profile.phtml | 用户 | 显示个人资料更新页面 |
/admin | admin/index.phtml | 管理员 | 显示管理员面板的着陆页面 |
所有模板位置相对于Appinstance根目录的/public/templates/canarium-core/。在模块的view/目录中提供了示例模板。
公开服务
canariumcore_user_service
- 处理用户相关操作(如登录、注册等)的用户服务。canariumcore_app_service
- canarium的API服务
Canarium公开端点
所有canarium端点都在'/canarium-api'中公开。返回的数据格式如下json
{ code: 200, message: 'Some message', data: {} }
其中data
包含端点的输出。
端点 | 方法 | 参数 | 描述 |
---|---|---|---|
/canarium-api/get-current-user | GET | none | 返回当前登录用户信息。 |
/canarium-api/login | POST | id, secret, email | 返回用户访问令牌 |
/canarium-api/delete-account | POST | access_token | 删除当前登录用户。这需要一个有效的访问令牌 |