Piwik \

Piwik

主piwik助手类。

包含各种常见任务的帮助器方法。我们鼓励插件开发人员尽可能地重用这些方法。

方法

该类定义了以下方法:

• getCurrentUserEmail ()—返回当前用户的电子邮件地址。
• getCurrentUserLastSeen ()-返回当前用户的最后一次显示。
• getCurrentUserLogin ()—返回当前用户的用户名。
• getCurrentUserTokenAuth ()-返回当前用户的token认证。
• hasUserSuperUserAccessOrIsTheUser ()——返回真正的如果当前用户是超级用户或指定的用户使用美元．
• checkUserHasSuperUserAccessOrIsTheUser ()—确认当前用户为指定用户或超级用户。
• hasTheUserSuperUserAccess ()—检查指定用户是否具有超级用户权限。
• hasUserSuperUserAccess ()-如果当前用户具有超级用户访问权限，则返回true。
• isUserIsAnonymous ()-如果当前用户为特殊用户，则返回true匿名用户与否。
• checkUserIsNotAnonymous ()—检查用户是否为匿名用户。
• checkUserHasSuperUserAccess ()—检查当前用户是否具有超级用户权限。
• isUserHasAdminAccess ()——返回真正的如果用户具有访问请求站点的管理员权限，假否则如果。
• checkUserHasAdminAccess ()-检查当前用户是否对所请求的站点列表具有管理员访问权限。
• isUserHasSomeAdminAccess ()——返回真正的当前用户对至少一个站点具有管理员访问权限。
• checkUserHasSomeWriteAccess ()—检查当前用户是否有至少一个站点的写权限。
• isUserHasSomeWriteAccess ()——返回真正的当前用户对至少一个站点具有写访问权限。
• isUserHasCapability ()——返回真正的当前用户是否具有给定站点的给定功能。
• checkUserHasSomeAdminAccess ()—检查当前用户是否对至少一个站点具有管理员权限。
• isUserHasViewAccess ()——返回真正的如果用户对所请求的站点列表具有查看访问权限。
• isUserHasWriteAccess ()——返回真正的如果用户对所请求的站点列表具有写访问权限。
• checkUserHasViewAccess ()-检查当前用户是否对所请求的站点列表具有查看访问权限
• checkUserHasWriteAccess ()-检查当前用户是否对所请求的站点列表具有写访问权限
• isUserHasSomeViewAccess ()——返回真正的当前用户对至少一个站点具有查看权限。
• checkUserHasSomeViewAccess ()—检查当前用户是否对至少一个站点具有查看权限。
• getLoginPluginName ()-返回当前正在使用的登录插件名称。
• redirectToModule ()-将当前请求重定向到一个新的模块和动作。
• isValidEmailString ()——返回真正的如果提供的电子邮件地址是有效的。
• postEvent ()-发布一个事件到Matomo(以前是Piwik)的事件分派器，它将执行事件的观察者。
• addAction ()—为事件注册观察者。
• 翻译()-返回使用翻译令牌的国际化字符串。
• getPeriod ()-返回当前请求中提供的句点。
• 获取当前日期()-返回当前请求中提供的日期。

getCurrentUserEmail ()

返回当前用户的电子邮件地址。

签名

• 它返回一个字符串价值。

getCurrentUserLastSeen ()

返回当前用户的Last Seen。

签名

• 它返回一个字符串价值。

getCurrentUserLogin ()

返回当前用户的用户名。

签名

• 它返回一个字符串价值。

getCurrentUserTokenAuth ()

返回当前用户的令牌认证。

签名

• 它返回一个字符串价值。

hasUserSuperUserAccessOrIsTheUser ()

返回真正的如果当前用户是超级用户或指定的用户使用美元．

签名

• 它接受以下参数:
  • 使用美元（字符串) -用户名。
• 它返回一个保龄球价值。

checkUserHasSuperUserAccessOrIsTheUser ()

检查当前用户是否为指定用户或超级用户。

签名

• 它接受以下参数:
  • 使用美元（字符串) -用户名。
• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • Piwik \ NoAccessException—用户既不是超级用户，也不是普通用户使用美元．

hasTheUserSuperUserAccess ()

检查给定用户是否具有超级用户访问权限。

签名

• 它接受以下参数:
  • 使用美元（字符串) -用户名。
• 它返回一个保龄球价值。

hasUserSuperUserAccess ()

如果当前用户具有超级用户访问权限，则返回true。

签名

• 它返回一个保龄球价值。

isUserIsAnonymous ()

如果当前用户是特殊用户，则返回true匿名用户与否。

签名

• 它返回一个保龄球价值。

checkUserIsNotAnonymous ()

检查用户是否为匿名用户。

签名

• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • Piwik \ NoAccessException—如果当前用户为匿名用户。

checkUserHasSuperUserAccess ()

检查当前用户是否具有超级用户访问权限。

签名

• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • 异常—如果当前用户不是超级用户。

isUserHasAdminAccess ()

返回真正的如果用户具有访问请求站点的管理员权限，假否则如果。

签名

• 它接受以下参数:
  • idSites美元（int|数组) -用于检查访问权限的站点id列表。
• 它返回一个保龄球价值。

checkUserHasAdminAccess ()

检查当前用户是否对所请求的站点列表具有管理员访问权限。

签名

• 它接受以下参数:
  • idSites美元（int|数组) -一个或多个站点id，以检查访问。
• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • 异常-如果用户没有管理员权限。

isUserHasSomeAdminAccess ()

返回真正的当前用户对至少一个站点具有管理员访问权限。

签名

• 它返回一个保龄球价值。

checkUserHasSomeWriteAccess ()

检查当前用户是否对至少一个站点具有写访问权限。

签名

• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • 异常-如果用户没有写访问任何网站。

isUserHasSomeWriteAccess ()

返回真正的当前用户对至少一个站点具有写访问权限。

签名

• 它返回一个保龄球价值。

isUserHasCapability ()

返回真正的当前用户是否具有给定站点的给定功能。

签名

• 它接受以下参数:

  • idSites美元

  • 美元的能力

• 它返回一个保龄球价值。

checkUserHasSomeAdminAccess ()

检查当前用户是否对至少一个站点具有管理员访问权限。

签名

• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • 异常-如果用户没有任何网站的管理员访问权限。

isUserHasViewAccess ()

返回真正的如果用户对所请求的站点列表具有查看访问权限。

签名

• 它接受以下参数:
  • idSites美元（int|数组) -一个或多个站点id，以检查访问。
• 它返回一个保龄球价值。

isUserHasWriteAccess ()

返回真正的如果用户对所请求的站点列表具有写访问权限。

签名

• 它接受以下参数:
  • idSites美元（int|数组) -一个或多个站点id，以检查访问。
• 它返回一个保龄球价值。

checkUserHasViewAccess ()

检查当前用户是否具有对所请求的站点列表的查看访问权

签名

• 它接受以下参数:
  • idSites美元（int|数组) -用于检查访问权限的站点id列表。
• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • 异常-如果当前用户没有查看访问列表中的每个站点。

checkUserHasWriteAccess ()

检查当前用户是否对所请求的站点列表具有写访问权

签名

• 它接受以下参数:
  • idSites美元（int|数组) -用于检查访问权限的站点id列表。
• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • 异常-如果当前用户对列表中的每个站点都没有写访问权。

isUserHasSomeViewAccess ()

返回真正的当前用户对至少一个站点具有查看权限。

签名

• 它返回一个保龄球价值。

checkUserHasSomeViewAccess ()

检查当前用户是否对至少一个站点具有查看权限。

签名

• 它不返回任何东西，也不返回混合结果。
• 它会抛出以下异常之一:
  • 异常-如果用户没有查看任何网站的访问权限。

getLoginPluginName ()

返回当前正在使用的登录插件的名称。

必须使用，因为它是不允许硬编码'登录'在url以防另一个登录插件正在使用。

签名

• 它返回一个字符串价值。

redirectToModule ()

将当前请求重定向到新的模块和操作。

签名

• 它接受以下参数:
  • newModule美元（字符串) -目标模块，例如，“UserCountry”．
  • newAction美元（字符串) -目标控制器动作，例如，“指数”．
  • 美元的参数（数组-重定向前要修改的查询参数值。
• 它不返回任何东西，也不返回混合结果。

isValidEmailString ()

返回真正的如果提供的电子邮件地址是有效的。

签名

• 它接受以下参数:

  • emailAddress美元（字符串) - - -

• 它返回一个保龄球价值。

postEvent ()

向Matomo的事件调度程序发布一个事件，该事件调度程序将执行事件的观察者。

签名

• 它接受以下参数:
  • eventName美元（字符串-事件名称。
  • 美元的参数（数组-转发给观察者回调的参数数组。
  • 等待美元（保龄球-如果为真，在此事件触发后加载的插件将执行该事件的观察器。
  • 美元的插件（数组|零-执行观察者的插件列表。如果为空，将执行所有的插件观察者。
• 它不返回任何东西，也不返回混合结果。

addAction ()

向事件注册一个观察者。

注意:观察者通常应该在插件对象中定义。您不太可能需要使用这个函数。

签名

• 它接受以下参数:
  • eventName美元（字符串-事件名称。
  • $函数（可调用的|数组-观察者。
• 它不返回任何东西，也不返回混合结果。

翻译()

返回使用转换令牌的国际化字符串。如果找不到令牌的翻译，则返回令牌。

签名

• 它接受以下参数:

  • translationId美元（字符串) -翻译ID，例如，“General_Date”．
  • args美元（数组|字符串|int) - - -sprintf要应用于国际化字符串的参数。
  • 美元的语言（字符串|零) -可选强制语言。

• 返回:字符串—翻译后的字符串或translationId美元．

getPeriod ()

返回当前请求中提供的句点。

如果没有提供$default，此方法将抛出一个异常期在请求中找不到

签名

• 它接受以下参数:
  • 美元的违约（字符串|零) -使用的默认值
• 它返回一个字符串价值。
• 它会抛出以下异常之一:
  • 异常

获取当前日期()

返回当前请求中提供的日期。

如果没有提供$default，此方法将抛出一个异常日期在请求中找不到

签名

• 它接受以下参数:
  • 美元的违约（字符串|零) -使用的默认值
• 它返回一个字符串价值。
• 它会抛出以下异常之一:
  • 异常