code
stringlengths 31
1.39M
| docstring
stringlengths 23
16.8k
| func_name
stringlengths 1
126
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
166
| url
stringlengths 50
220
| license
stringclasses 7
values |
|---|---|---|---|---|---|---|---|
public function resolve(array $arguments, $resolved = null)
{
if (count($arguments) < 3) {
$route_handle = array_shift($arguments);
$route_parameters = count($arguments) ? array_shift($arguments) : [];
if (is_string($route_handle) &&
strtolower(substr($route_handle, 0, 6)) == 'route/' &&
is_array($route_parameters)) {
$route_handle = substr($route_handle, 6);
if ($this->getRouteList()->get($route_handle)) {
if ($path = $this->getGenerator()->generate($route_handle, $route_parameters, UrlGeneratorInterface::ABSOLUTE_PATH)) {
return $this->pathUrlResolver->resolve([$path]);
}
}
}
}
return $resolved;
}
|
Resolve urls from the list of registered routes takes a string.
[code]
$url = \URL::to('route/user_route', array('id' => 1));
[/code]
OR
[code]
// Register a route
$route_list->register('/users/{id}', '\My\Application\User\Controller::view', 'user_route');
// Create a resolver
$route_url_resolver = new \Concrete\Core\Url\Resolver\RouteUrlResolver($generator, $route_list);
// Retrieve the URL
$url = $route_url_resolver->resolve(array('route/user_route', array('id' => 1)));
[/code]
@param array $arguments [ string $handle, array $parameters = array() ]
The first parameter MUST be prepended with
"route/" for it to be tested
@param \League\URL\URLInterface|null $resolved
@return \League\URL\URLInterface|null
|
resolve
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/RouteUrlResolver.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/RouteUrlResolver.php
|
MIT
|
public function __construct(Application $app, PathUrlResolver $path_url_resolver)
{
$this->app = $app;
$this->pathUrlResolver = $path_url_resolver;
}
|
@param \Concrete\Core\Application\Application $app
@param \Concrete\Core\Url\Resolver\PathUrlResolver $path_url_resolver
|
__construct
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/UserInfoUrlResolver.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/UserInfoUrlResolver.php
|
MIT
|
public function resolve(array $arguments, $resolved = null)
{
if ($resolved) {
return $resolved;
}
$user = $arguments ? head($arguments) : null;
if ($user instanceof UserInfo) {
$site = $this->app->make('site')->getSite();
if ($site) {
$config = $site->getConfigRepository();
if ($config->get('user.profiles_enabled')) {
return $user->getUserPublicProfileUrl();
}
}
return $this->pathUrlResolver->resolve(['/dashboard/users/search', 'view', $user->getUserID()]);
}
return null;
}
|
{@inheritdoc}
@see \Concrete\Core\Url\Resolver\UrlResolverInterface::resolve()
|
resolve
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/UserInfoUrlResolver.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/UserInfoUrlResolver.php
|
MIT
|
public function __construct($default_handle = '', ?UrlResolverInterface $default_resolver = null)
{
if ($default_resolver) {
$this->addResolver($default_handle, $default_resolver);
}
$this->default = $default_handle;
}
|
@param string $default_handle
@param \Concrete\Core\Url\Resolver\UrlResolverInterface|null $default_resolver
|
__construct
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/Manager/ResolverManager.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/Manager/ResolverManager.php
|
MIT
|
public function addResolver($handle, UrlResolverInterface $resolver, $priority = 512)
{
$priority = min(1024, max(1, (int) $priority));
$this->resolvers[$handle] = $resolver;
if (!isset($this->priorityTree[$priority])) {
$this->priorityTree[$priority] = [];
ksort($this->priorityTree);
}
$this->priorityTree[$priority][] = $handle;
}
|
{@inheritdoc}
@see \Concrete\Core\Url\Resolver\Manager\ResolverManagerInterface::addResolver()
|
addResolver
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/Manager/ResolverManager.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/Manager/ResolverManager.php
|
MIT
|
public function getDefaultResolver()
{
return $this->getResolver($this->default);
}
|
{@inheritdoc}
@see \Concrete\Core\Url\Resolver\Manager\ResolverManagerInterface::getDefaultResolver()
|
getDefaultResolver
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/Manager/ResolverManager.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/Manager/ResolverManager.php
|
MIT
|
public function getResolver($handle)
{
return array_get($this->resolvers, $handle, null);
}
|
{@inheritdoc}
@see \Concrete\Core\Url\Resolver\Manager\ResolverManagerInterface::getResolver()
|
getResolver
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/Manager/ResolverManager.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/Manager/ResolverManager.php
|
MIT
|
public function getResolvers()
{
return $this->resolvers;
}
|
@return \Concrete\Core\Url\Resolver\UrlResolverInterface[]
|
getResolvers
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/Manager/ResolverManager.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/Manager/ResolverManager.php
|
MIT
|
public function resolve(array $args)
{
$resolved = null;
foreach ($this->priorityTree as $list) {
foreach ($list as $handle) {
if ($handle == $this->default) {
continue;
}
$resolver = $this->getResolver($handle);
$resolved = $resolver->resolve($args, $resolved);
}
}
if ($default = $this->getResolver($this->default)) {
$resolved = $default->resolve($args, $resolved);
}
return $resolved;
}
|
{@inheritdoc}
@see \Concrete\Core\Url\Resolver\Manager\ResolverManagerInterface::resolve()
|
resolve
|
php
|
concretecms/concretecms
|
concrete/src/Url/Resolver/Manager/ResolverManager.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Url/Resolver/Manager/ResolverManager.php
|
MIT
|
public function insertHeaders()
{
$this->writer->insertOne(iterator_to_array($this->getHeaders()));
}
|
Insert a header row for this result set
|
insertHeaders
|
php
|
concretecms/concretecms
|
concrete/src/User/CsvWriter.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/CsvWriter.php
|
MIT
|
public function insertUserList(UserList $list)
{
$this->writer->insertAll($this->projectList($list));
}
|
Insert all data from the passed userlist
@param \Concrete\Core\User\UserList $list
|
insertUserList
|
php
|
concretecms/concretecms
|
concrete/src/User/CsvWriter.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/CsvWriter.php
|
MIT
|
private function projectList(UserList $list)
{
$statement = $list->deliverQueryObject()->execute();
foreach ($statement as $result) {
$user = $list->getResult($result);
yield iterator_to_array($this->projectUser($user));
}
}
|
A generator that takes a UserList and converts it to CSV rows
@param \Concrete\Core\User\UserList $list
@return \Generator
|
projectList
|
php
|
concretecms/concretecms
|
concrete/src/User/CsvWriter.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/CsvWriter.php
|
MIT
|
private function projectUser(UserInfo $user)
{
yield $user->getUserName();
yield $user->getUserEmail();
$userRegistrationDate = $user->getUserDateAdded();
yield $this->date->formatCustom(\DateTime::ATOM, $userRegistrationDate);
list($active, $inactive) = $this->getTranslatedStatus();
yield $user->isActive() ? $active : $inactive;
yield $user->getNumLogins();
$attributes = $this->getAttributeKeys();
foreach ($attributes as $attribute) {
$value = $user->getAttributeValueObject($attribute);
yield $value ? $value->getPlainTextValue() : '';
}
}
|
Turn a user into an array
@param \Concrete\Core\User\UserInfo $user
@return array
|
projectUser
|
php
|
concretecms/concretecms
|
concrete/src/User/CsvWriter.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/CsvWriter.php
|
MIT
|
private function getHeaders()
{
// Static headers
$headers = [t('Username'), t('Email'), t('Signup Date'), t('Status'), t('# Logins')];
foreach ($headers as $header) {
yield $header;
}
// Get headers for User attributes
$attributes = $this->category->getList();
foreach ($attributes as $attribute) {
yield $attribute->getAttributeKeyDisplayName();
}
}
|
A generator that returns all headers
@return \Generator
|
getHeaders
|
php
|
concretecms/concretecms
|
concrete/src/User/CsvWriter.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/CsvWriter.php
|
MIT
|
private function getAttributeKeys()
{
if (!isset($this->attributeKeys)) {
$this->attributeKeys = $this->category->getList();
}
return $this->attributeKeys;
}
|
Memoize the attribute keys so that we aren't looking them up over and over
@return array
|
getAttributeKeys
|
php
|
concretecms/concretecms
|
concrete/src/User/CsvWriter.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/CsvWriter.php
|
MIT
|
private function getTranslatedStatus()
{
if ($this->status === null) {
$this->status = [t('Active'), t('Inactive')];
}
return $this->status;
}
|
Get the translated status texts
@return string[]
|
getTranslatedStatus
|
php
|
concretecms/concretecms
|
concrete/src/User/CsvWriter.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/CsvWriter.php
|
MIT
|
public function __construct(
Repository $config,
Session $session,
ResolverManagerInterface $resolverManager,
ResponseFactoryInterface $responseFactory,
Numbers $valn,
Service $siteService
) {
$this->config = $config;
$this->session = $session;
$this->resolverManager = $resolverManager;
$this->responseFactory = $responseFactory;
$this->valn = $valn;
$this->siteService = $siteService;
}
|
Initialize the instance.
@param \Concrete\Core\Config\Repository\Repository $config
@param \Symfony\Component\HttpFoundation\Session\Session $session
@param \Concrete\Core\Url\Resolver\Manager\ResolverManagerInterface $resolverManager
@param \Concrete\Core\Http\ResponseFactoryInterface $responseFactory
@param \Concrete\Core\Utility\Service\Validation\Numbers $valn
@param \Concrete\Core\Site\Service $siteService
|
__construct
|
php
|
concretecms/concretecms
|
concrete/src/User/PostLoginLocation.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/PostLoginLocation.php
|
MIT
|
public function resetSessionPostLoginUrl()
{
$this->session->remove(static::POSTLOGIN_SESSION_KEY);
}
|
Clear the post-login data saved in session.
|
resetSessionPostLoginUrl
|
php
|
concretecms/concretecms
|
concrete/src/User/PostLoginLocation.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/PostLoginLocation.php
|
MIT
|
public function setSessionPostLoginUrl($url)
{
$normalized = null;
if ($url instanceof Page) {
if (!$url->isError()) {
$cID = (int) $url->getCollectionID();
if ($cID > 0) {
$normalized = $cID;
}
}
} elseif ($this->valn->integer($url, 1)) {
$normalized = (int) $url;
} else {
$url = (string) $url;
if (strpos($url, '/') !== false) {
$normalized = $url;
}
}
$this->resetSessionPostLoginUrl();
if ($normalized !== null) {
$this->session->set(static::POSTLOGIN_SESSION_KEY, $normalized);
}
}
|
Store in the session the post-login URL or page.
@param string|\League\Url\UrlInterface|\Concrete\Core\Page\Page|int $url the URL to redirect users to after login
|
setSessionPostLoginUrl
|
php
|
concretecms/concretecms
|
concrete/src/User/PostLoginLocation.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/PostLoginLocation.php
|
MIT
|
public function getSessionPostLoginUrl($resetSessionPostLoginUrl = false)
{
$result = '';
$normalized = $this->session->get(static::POSTLOGIN_SESSION_KEY);
if ($this->valn->integer($normalized, 1)) {
$page = Page::getByID($normalized);
if ($page && !$page->isError()) {
$result = (string) $this->resolverManager->resolve([$page]);
}
} elseif (strpos((string) $normalized, '/') !== false) {
$result = $normalized;
}
if ($resetSessionPostLoginUrl) {
$this->resetSessionPostLoginUrl();
}
return $result;
}
|
Get the post-login URL as stored in the session.
@param bool $resetSessionPostLoginUrl Should the post-login-related data stored in session be cleared?
@return string Empty string if unavailable
|
getSessionPostLoginUrl
|
php
|
concretecms/concretecms
|
concrete/src/User/PostLoginLocation.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/PostLoginLocation.php
|
MIT
|
public function getDefaultPostLoginUrl()
{
$result = '';
$loginRedirectMode = (string) $this->config->get('concrete.misc.login_redirect');
switch ($loginRedirectMode) {
case 'CUSTOM':
$loginRedirectCollectionID = $this->config->get('concrete.misc.login_redirect_cid');
if ($this->valn->integer($loginRedirectCollectionID, 1)) {
$page = Page::getByID($loginRedirectCollectionID);
if ($page && !$page->isError()) {
$result = (string) $this->resolverManager->resolve([$page]);
}
}
break;
case 'DESKTOP':
$desktop = DesktopList::getMyDesktop();
if ($desktop && !$desktop->isError()) {
$result = (string) $this->resolverManager->resolve([$desktop]);
}
break;
}
return $result;
}
|
Get the default post-login URL.
@return string Empty string if unavailable
|
getDefaultPostLoginUrl
|
php
|
concretecms/concretecms
|
concrete/src/User/PostLoginLocation.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/PostLoginLocation.php
|
MIT
|
public function getFallbackPostLoginUrl()
{
/** @var \Concrete\Core\Entity\Site\Site $site */
$site = $this->siteService->getSite();
$home = $site->getSiteHomePageObject();
if ($home && !$home->isError()) {
$result = (string) $this->resolverManager->resolve([$home]);
} else {
$result = (string) $this->resolverManager->resolve(['/']);
}
return $result;
}
|
Get the fallback post-login URL (called when all other methods fail).
@return string
|
getFallbackPostLoginUrl
|
php
|
concretecms/concretecms
|
concrete/src/User/PostLoginLocation.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/PostLoginLocation.php
|
MIT
|
public function getPostLoginUrl($resetSessionPostLoginUrl = false)
{
$result = $this->getSessionPostLoginUrl($resetSessionPostLoginUrl);
if ($result === '') {
$result = $this->getDefaultPostLoginUrl();
if ($result === '') {
$result = $this->getFallbackPostLoginUrl();
}
}
return $result;
}
|
Get the post-login URL.
@param bool $resetSessionPostLoginUrl Should the post-login-related data stored in session be cleared?
@return string
|
getPostLoginUrl
|
php
|
concretecms/concretecms
|
concrete/src/User/PostLoginLocation.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/PostLoginLocation.php
|
MIT
|
public function getPostLoginRedirectResponse($resetSessionPostLoginUrl = false)
{
$result = $this->responseFactory->redirect(
$this->getPostLoginUrl($resetSessionPostLoginUrl),
Response::HTTP_FOUND
);
// Disable caching for response
$result = $result->setMaxAge(0)->setSharedMaxAge(0)->setPrivate();
$result->headers->addCacheControlDirective('must-revalidate', true);
$result->headers->addCacheControlDirective('no-store', true);
return $result;
}
|
Create a Response that redirects the user to the configured URL.
@param bool $resetSessionPostLoginUrl Should the post-login-related data stored in session be cleared?
@return \Symfony\Component\HttpFoundation\Response
|
getPostLoginRedirectResponse
|
php
|
concretecms/concretecms
|
concrete/src/User/PostLoginLocation.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/PostLoginLocation.php
|
MIT
|
public function createSuperUser($uPasswordEncrypted, $uEmail)
{
$dh = $this->application->make('date');
$entity = new UserEntity();
$entity->setUserID(USER_SUPER_ID);
$entity->setUserName(USER_SUPER);
$entity->setUserEmail($uEmail);
$entity->setUserPassword($uPasswordEncrypted);
$entity->setUserIsActive(true);
$this->entityManager->persist($entity);
$this->entityManager->flush();
return $this->userInfoRepository->getByID($entity->getUserID());
}
|
@param string $uPasswordEncrypted
@param string $uEmail
@return UserInfo|null
|
createSuperUser
|
php
|
concretecms/concretecms
|
concrete/src/User/RegistrationService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/RegistrationService.php
|
MIT
|
public function create($data)
{
$uae = new AddUser($data);
$uae = \Events::dispatch('on_before_user_add', $uae);
if (!$uae->proceed()) {
return false;
}
$hasher = $this->application->make(PasswordHasher::class);
if (isset($data['uIsValidated']) && $data['uIsValidated'] == 1) {
$uIsValidated = 1;
} elseif (isset($data['uIsValidated']) && $data['uIsValidated'] == 0) {
$uIsValidated = 0;
} else {
$uIsValidated = -1;
}
if (isset($data['uIsFullRecord']) && $data['uIsFullRecord'] == 0) {
$uIsFullRecord = 0;
} else {
$uIsFullRecord = 1;
}
$password_to_insert = $data['uPassword'] ?? '';
$hash = $hasher->hashPassword($password_to_insert);
$uDefaultLanguage = null;
if (isset($data['uDefaultLanguage']) && $data['uDefaultLanguage'] != '') {
$uDefaultLanguage = $data['uDefaultLanguage'];
}
$uHomeFileManagerFolderID = null;
if (isset($data['uHomeFileManagerFolderID']) && $data['uHomeFileManagerFolderID'] != '') {
$uHomeFileManagerFolderID = $data['uHomeFileManagerFolderID'];
}
$entity = new UserEntity();
$entity->setUserName($data['uName']);
$entity->setUserEmail($data['uEmail']);
$entity->setUserPassword($hash);
$entity->setUserIsValidated($uIsValidated);
$entity->setUserIsFullRecord($uIsFullRecord);
$entity->setUserDefaultLanguage($uDefaultLanguage);
$entity->setHomeFileManagerFolderID($uHomeFileManagerFolderID);
$entity->setUserIsActive(true);
$this->entityManager->persist($entity);
$this->entityManager->flush();
$newUID = $entity->getUserID();
$ui = $this->userInfoRepository->getByID($newUID);
if (is_object($ui)) {
$uo = $ui->getUserObject();
$groupControllers = \Group::getAutomatedOnRegisterGroupControllers($uo);
foreach ($groupControllers as $ga) {
if ($ga->check($uo)) {
$uo->enterGroup($ga->getGroupObject());
}
}
// run any internal event we have for user add
$ue = new UserInfoWithPassword($ui);
$ue->setUserPassword($password_to_insert);
\Events::dispatch('on_user_add', $ue);
// Now we notify any relevant users.
$type = $this->application->make('manager/notification/types')->driver('user_signup');
/* @var UserSignupType $type */
$u = $this->application->make(User::class);
$createdBy = null;
if ($u->isRegistered()) {
$creator = $u->getUserInfoObject();
if (is_object($creator)) {
$createdBy = $creator->getEntityObject();
}
}
$signup = new UserSignup($ui->getEntityObject(), $createdBy);
$notifier = $type->getNotifier();
$subscription = $type->getSubscription($signup);
$notified = $notifier->getUsersToNotify($subscription, $signup);
$notification = $type->createNotification($signup);
$signup->getNotifications()->add($notification);
$notifier->notify($notified, $notification);
}
return $ui;
}
|
@param array $data
@return UserInfo|false|null
|
create
|
php
|
concretecms/concretecms
|
concrete/src/User/RegistrationService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/RegistrationService.php
|
MIT
|
public function getNewUsernameFromUserDetails($email, $suggestedUsername = '', $firstName = '', $lastName = '')
{
$baseUsername = $this->stringToUsernameChunk($suggestedUsername);
if ($baseUsername === '') {
$firstName = $this->stringToUsernameChunk($firstName);
$lastName = $this->stringToUsernameChunk($lastName);
if ($firstName !== '' || $lastName !== '') {
$baseUsername = trim($firstName . '_' . $lastName, '_');
} else {
$mailbox = strstr((string) $email, '@', true);
$baseUsername = $this->stringToUsernameChunk($mailbox);
}
if ($baseUsername === '') {
$baseUsername = 'user';
}
}
$username = $baseUsername;
$suffix = 1;
while ($this->userInfoRepository->getByName($username) !== null) {
$username = $baseUsername . '_' . $suffix;
++$suffix;
}
return $username;
}
|
Create an unused username starting from user details.
@param string $email The user's email address
@param string $suggestedUsername A suggestion about the username
@param string $firstName The user's first name
@param string $lastName The user's last name
@return string
|
getNewUsernameFromUserDetails
|
php
|
concretecms/concretecms
|
concrete/src/User/RegistrationService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/RegistrationService.php
|
MIT
|
public function __construct(Application $application, MailService $mh, Repository $config)
{
$this->application = $application;
$this->mh = $mh;
$this->config = $config;
}
|
StatusService constructor.
@param \Concrete\Core\Application\Application $application
@param \Concrete\Core\Mail\Service $mh
@param \Concrete\Core\Config\Repository\Repository $config
|
__construct
|
php
|
concretecms/concretecms
|
concrete/src/User/StatusService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/StatusService.php
|
MIT
|
public static function getByUserID($uID, $login = false, $cacheItemsOnLogin = true)
{
$app = Application::getFacadeApplication();
$db = $app['database']->connection();
$v = [$uID];
$q = 'SELECT uID, uName, uIsActive, uLastOnline, uTimezone, uDefaultLanguage, uLastPasswordChange FROM Users WHERE uID = ? LIMIT 1';
$r = $db->query($q, $v);
$row = $r ? $r->fetch() : null;
$nu = null;
if ($row) {
$nu = new static();
$nu->setPropertiesFromArray($row);
$nu->uGroups = $nu->_getUserGroups(true);
$nu->superUser = ($nu->getUserID() == USER_SUPER_ID);
if ($login) {
$nu->persist($cacheItemsOnLogin);
$nu->recordLogin();
$app = Application::getFacadeApplication();
/** @var NavigationCache $navigationCache */
$navigationCache = $app->make(NavigationCache::class);
$navigationCache->clear();
}
}
return $nu;
}
|
Return an User instance given its id (or null if it's not found)
@param int $uID The id of the user
@param bool $login = false Set to true to make the user the current one
@param bool $cacheItemsOnLogin = false Set to true to cache some items when $login is true
@return User|null
|
getByUserID
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function updateOnlineCheck(): void
{
$now = time();
$session = app('session');
$session->set('uOnlineCheck', $now);
$activityThreshold = app(SessionValidator::class)->getUserActivityThreshold();
$saveThreshold = $activityThreshold / 2;
$elapsedTime = $now - $session->get('uLastOnline');
if ($elapsedTime > $saveThreshold) {
$db = app(Connection::class);
$db->update('Users', ['uLastOnline' => $now], ['uID' => $this->getUserID()]);
$session->set('uLastOnline', $now);
}
}
|
This code throttles the writing of uLastOnline to the database, so that we're not constantly
updating the Users table. If you need to have the exact up to date metric on when a session
last looked at a page, use the uOnlineCheck session key.
|
updateOnlineCheck
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function recordLogin()
{
$app = Application::getFacadeApplication();
$db = $app['database']->connection();
$uLastLogin = $db->getOne('select uLastLogin from Users where uID = ?', [$this->uID]);
// Add a log entry
$logger = $app->make(LoggerFactory::class)->createLogger(Channels::CHANNEL_AUTHENTICATION);
$logger->info(t('Login from user {user} (ID {id}) succeeded'), [
'user' => $this->getUserName(),
'id' => $this->getUserID(),
]);
/** @var \Concrete\Core\Permission\IPService $iph */
$iph = $app->make('helper/validation/ip');
$ip = $iph->getRequestIP();
$db->query('update Users set uLastIP = ?, uLastLogin = ?, uPreviousLogin = ?, uNumLogins = uNumLogins + 1 where uID = ?', [($ip === false) ? ('') : ($ip->getIp()), time(), $uLastLogin, $this->uID]);
}
|
Increment number of logins and update login timestamps.
@throws \Exception
|
recordLogin
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function encryptPassword($uPassword, $salt = null)
{
return app(PasswordHasher::class)->hashPassword($uPassword);
}
|
$salt is retained for compatibilty with older versions of concerete5, but not used.
@param string $uPassword
@param null $salt
@return string
|
encryptPassword
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function legacyEncryptPassword($uPassword)
{
$app = Application::getFacadeApplication();
return md5($uPassword . ':' . $app['config']->get('concrete.user.password.legacy_salt'));
}
|
This is for compatibility with passwords generated in older versions of concrete5.
Use only for checking password hashes, not generating new ones to store.
@param string $uPassword
@return string
|
legacyEncryptPassword
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function getUserSessionValidSince()
{
return $this->uLastPasswordChange;
}
|
Return date in yyyy-mm-dd H:i:s format.
@return string
|
getUserSessionValidSince
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function logout($hard = true)
{
$app = Application::getFacadeApplication();
$events = $app->make('director');
$logger = $app->make(LoggerFactory::class)->createLogger(Channels::CHANNEL_AUTHENTICATION);
$currentUser = $app->make(User::class);
$event = new Event\Logout((int) $currentUser->getUserID());
$events->dispatch('on_before_user_logout', $event);
$logger->info(t('Logout from user {user} (ID {id}) requested'), [
'user' => $this->getUserName(),
'id' => $this->getUserID(),
]);
// First, we check to see if we have any collection in edit mode
$this->unloadCollectionEdit();
$this->unloadAuthenticationTypes();
$this->invalidateSession($hard);
$app->singleton(User::class, static function () {
return new User();
});
$navigationCache = $app->make(NavigationCache::class);
$navigationCache->clear();
$events->dispatch('on_user_logout', $event);
return $event->getResponse();
}
|
@param bool $hard
@return \Symfony\Component\HttpFoundation\Response|null
|
logout
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function getUserGroupObjects()
{
$gs = new GroupList();
$gs->filterByUserID($this->uID);
return $gs->getResults();
}
|
Returns an array of Group objects the user belongs to.
@return array
|
getUserGroupObjects
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function getUserGroups()
{
return $this->uGroups;
}
|
Returns an array of group ids the user belongs to.
@return array
|
getUserGroups
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function setUserDefaultLanguage($lang)
{
$app = Application::getFacadeApplication();
$db = $app['database']->connection();
$session = $app['session'];
$this->uDefaultLanguage = $lang;
$session->set('uDefaultLanguage', $lang);
$db->Execute('update Users set uDefaultLanguage = ? where uID = ?', [$lang, $this->getUserID()]);
}
|
Sets a default language for a user record.
@param string $lang
|
setUserDefaultLanguage
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function getUserDefaultLanguage()
{
return $this->uDefaultLanguage;
}
|
Gets the default language for the logged-in user.
@return string
|
getUserDefaultLanguage
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function getLastPasswordChange()
{
return $this->uLastPasswordChange;
}
|
Returns date in yyyy-mm-dd H:i:s format.
@return string
|
getLastPasswordChange
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function getUserLanguageToDisplay()
{
if ($this->getUserDefaultLanguage() != '') {
return $this->getUserDefaultLanguage();
} else {
$app = Application::getFacadeApplication();
$config = $app['config'];
return $config->get('concrete.locale');
}
}
|
Checks to see if the current user object is registered. If so, it queries that records
default language. Otherwise, it falls back to sitewide settings.
@return string
|
getUserLanguageToDisplay
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function getUserAccessEntityObjects()
{
$app = Application::getFacadeApplication();
$req = $app->make(Request::class);
if ($req->hasCustomRequestUser()) {
// we bypass session-saving performance
// and we don't save them in session.
return PermissionAccessEntity::getForUser($this);
}
if ($this->accessEntities === null) {
$session = $app['session'];
$validator = $app->make(SessionValidator::class);
// Check if the user is loggged in
if ($validator->hasActiveSession() && $session->has('uID')) {
// If a user is logged in and running a script to get the user access entities
// return the correct access entities
if ($session->has('accessEntities') && $this->getUserID() == $session->get('uID')) {
$entities = $session->get('accessEntities');
} elseif ($this->getUserID() == $session->get('uID')) {
$entities = PermissionAccessEntity::getForUser($this);
$session->set('accessEntities', $entities);
$session->set('accessEntitiesUpdated', time());
} else {
$entities = PermissionAccessEntity::getForUser($this);
}
} else {
if ((int)$this->getUserID() > 0) {
$entities = PermissionAccessEntity::getForUser($this);
} else {
$repository = $app->make(GroupRepository::class);
$group = $repository->getGroupByID(GUEST_GROUP_ID);
if ($group) {
$entities = [GroupEntity::getOrCreate($group)];
} else {
$entities = [];
}
}
}
$this->accessEntities = $entities;
}
return $this->accessEntities;
}
|
Function to return Permission Access Entities belonging to this user object
@return PermissionAccessEntity[] | array
|
getUserAccessEntityObjects
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function inGroup($g)
{
$app = Application::getFacadeApplication();
/** @var \Concrete\Core\Database\Connection\Connection $db */
$db = $app['database']->connection();
/** @var $likeBuilder LikeBuilder */
$likeBuilder = $app->make(LikeBuilder::class);
$query = $db->createQueryBuilder();
$query->select('ug.gID')->from('UserGroups', 'ug')
->innerJoin('ug', $query->getConnection()->getDatabasePlatform()->quoteSingleIdentifier('Groups'), 'g', 'ug.gID=g.gID')
->where($query->expr()->eq('ug.uID', ':userID'))
->andWhere($query->expr()->orX(
$query->expr()->eq('ug.gID', ':gID'),
$query->expr()->like('g.gPath', ':groupPath')
))
->setParameter('userID', $this->uID)
->setParameter('gID', $g->getGroupID())
->setParameter('groupPath', $likeBuilder->escapeForLike($g->getGroupPath()) . '/%')
->setMaxResults(1);
$results = $query->execute()->fetchColumn();
return (bool)$results;
}
|
Return true if user is in Group or any of this groups children.
@param Group $g
@return bool
|
inGroup
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function inExactGroup($g)
{
$app = Application::getFacadeApplication();
/** @var \Concrete\Core\Database\Connection\Connection $db */
$db = $app['database']->connection();
$query = $db->createQueryBuilder();
$query->select('ug.gID')->from('UserGroups', 'ug')
->where($query->expr()->eq('ug.uID', ':userID'))
->andWhere(
$query->expr()->eq('ug.gID', ':gID'))->setParameter('userID', $this->uID)
->setParameter('gID', $g->getGroupID())
->setMaxResults(1);
$results = $query->execute()->fetchColumn();
return (bool)$results;
}
|
Return true if user is in this Group.
Does not check if user is a member of children.
@param Group $g
@return bool
|
inExactGroup
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function loadMasterCollectionEdit($mcID, $ocID)
{
$app = Application::getFacadeApplication();
$session = $app['session'];
// basically, this function loads the master collection ID you're working on into session
// so you can work on it without the system failing because you're editing a template
$session->set('mcEditID', $mcID);
$session->set('ocID', $ocID);
}
|
@param int $mcID
@param int $ocID
|
loadMasterCollectionEdit
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function loadCollectionEdit(&$c)
{
$c->refreshCache();
// clear the cached available areas before entering edit mode
$app = Application::getFacadeApplication();
/** @var \Symfony\Component\HttpFoundation\Session\Session $session */
$session = $app->make("session");
$session->remove("used_areas");
// can only load one page into edit mode at a time.
if ($c->isCheckedOut()) {
return false;
}
$app = Application::getFacadeApplication();
$db = $app['database']->connection();
$cID = $c->getCollectionID();
// first, we check to see if we have a collection in edit mode. If we do, we relinquish it
$this->unloadCollectionEdit(false);
$q = 'select cIsCheckedOut, cCheckedOutDatetime from Pages where cID = ?';
$r = $db->executeQuery($q, [$cID]);
if ($r) {
$row = $r->fetch();
if (!$row['cIsCheckedOut']) {
$app['session']->set('editCID', $cID);
$uID = $this->getUserID();
$dh = $app->make('helper/date');
$datetime = $dh->getOverridableNow();
$q2 = 'update Pages set cIsCheckedOut = ?, cCheckedOutUID = ?, cCheckedOutDatetime = ?, cCheckedOutDatetimeLastEdit = ? where cID = ?';
$r2 = $db->executeQuery($q2, [1, $uID, $datetime, $datetime, $cID]);
$c->cIsCheckedOut = 1;
$c->cCheckedOutUID = $uID;
$c->cCheckedOutDatetime = $datetime;
$c->cCheckedOutDatetimeLastEdit = $datetime;
}
}
return true;
}
|
Loads a page in edit mode.
@param Page $c
@return bool
|
loadCollectionEdit
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function config($cfKey)
{
if ($this->isRegistered()) {
$app = Application::getFacadeApplication();
$db = $app['database']->connection();
$val = $db->GetOne('select cfValue from ConfigStore where uID = ? and cfKey = ?', [$this->getUserID(), $cfKey]);
return $val;
}
return null;
}
|
@param string $cfKey
@return string|null
|
config
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function saveConfig($cfKey, $cfValue)
{
$app = Application::getFacadeApplication();
$app['database']->connection()->Replace('ConfigStore', ['cfKey' => $cfKey, 'cfValue' => $cfValue, 'uID' => $this->getUserID()], ['cfKey', 'uID'], true);
}
|
@param string $cfKey
@param string $cfValue
|
saveConfig
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function persist($cache_interface = true)
{
$this->refreshUserGroups();
$app = Application::getFacadeApplication();
/** @var Repository $config */
$config = $app->make(Repository::class);
/** @var \Symfony\Component\HttpFoundation\Session\Session $session */
$session = $app['session'];
$session->set('uID', $this->getUserID());
$session->set('uName', $this->getUserName());
$session->set('uBlockTypesSet', false);
$session->set('uGroups', $this->getUserGroups());
$session->set('uLastOnline', $this->getLastOnline());
$session->set('uTimezone', $this->getUserTimezone());
$session->set('uDefaultLanguage', $this->getUserDefaultLanguage());
$session->set('uLastPasswordChange', $this->getLastPasswordChange());
/** @var \Concrete\Core\Cookie\CookieJar $cookie */
$cookie = $app['cookie'];
$cookie->set(
sprintf('%s_LOGIN', $app['config']->get('concrete.session.name')),
1,
// $expire
time() + (int)$config->get('concrete.session.remember_me.lifetime'),
// $path
DIR_REL . '/',
// $domain
$config->get('concrete.session.cookie.cookie_domain'),
// $secure
$config->get('concrete.session.cookie.cookie_secure'),
// $httpOnly
$config->get('concrete.session.cookie.cookie_httponly'),
// $sameSite
$config->get('concrete.session.cookie.samesite')
);
if ($cache_interface) {
$app->make('helper/concrete/ui')->cacheInterfaceItems();
}
$app->instance(User::class, $this);
}
|
Manage user session writing.
@param bool $cache_interface
|
persist
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
private function isPasswordExpired(Connection $cn, Repository $config, $uLastPasswordChange)
{
if (!$uLastPasswordChange) {
return false;
}
$maxAge = (int) ($config->get('concrete.user.password.max_age') ?? 0);
if ($maxAge <= 0) {
return false;
}
$lastChangeDateTime = DateTimeImmutable::createFromFormat($cn->getDatabasePlatform()->getDateTimeFormatString(), $uLastPasswordChange);
if (!$lastChangeDateTime) {
return false;
}
$ageInSeconds = time() - $lastChangeDateTime->getTimestamp();
$ageInDays = floor($ageInSeconds / 86400);
return $ageInDays >= $maxAge;
}
|
@param string|null $uLastPasswordChange
@return bool
|
isPasswordExpired
|
php
|
concretecms/concretecms
|
concrete/src/User/User.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/User.php
|
MIT
|
public function __construct(EntityManagerInterface $entityManager, UserCategory $attributeCategory, Application $application, AvatarServiceInterface $avatarService)
{
$this->avatarService = $avatarService;
$this->application = $application;
$this->entityManager = $entityManager;
$this->attributeCategory = $attributeCategory;
$this->connection = $entityManager->getConnection();
}
|
@param EntityManagerInterface $entityManager
@param UserCategory $attributeCategory
@param Application $application
@param AvatarServiceInterface $avatarService
|
__construct
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getPermissionObjectIdentifier()
{
return $this->entity->getUserID();
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\ObjectInterface::getPermissionObjectIdentifier()
|
getPermissionObjectIdentifier
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getPermissionResponseClassName()
{
return '\\Concrete\\Core\\Permission\\Response\\UserInfoResponse';
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\ObjectInterface::getPermissionResponseClassName()
|
getPermissionResponseClassName
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getPermissionAssignmentClassName()
{
return '\\Concrete\\Core\\Permission\\Assignment\\UserAssignment';
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\ObjectInterface::getPermissionAssignmentClassName()
|
getPermissionAssignmentClassName
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getPermissionObjectKeyCategoryHandle()
{
return 'user';
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\ObjectInterface::getPermissionObjectKeyCategoryHandle()
|
getPermissionObjectKeyCategoryHandle
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function markAsPasswordReset()
{
$this->connection->executeQuery('UPDATE Users SET uIsPasswordReset = 1 WHERE uID = ? limit 1', [$this->getUserID()]);
}
|
Marks the current user as having had a password reset from the system.
|
markAsPasswordReset
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserObject()
{
// returns a full user object - groups and everything - for this userinfo object
$nu = User::getByUserID($this->getUserID());
return $nu;
}
|
Gets the User object of the current UserInfo object ($this).
@return \Concrete\Core\User\User
|
getUserObject
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function update($data)
{
$uID = (int)$this->getUserID();
if ($uID === 0) {
$result = false;
} else {
$result = true;
$emailChanged = false;
$passwordChangedOn = null;
$fields = [];
$values = [];
$nullFields = [];
if (isset($data['uName'])) {
$fields[] = 'uName = ?';
$values[] = $data['uName'];
}
if (isset($data['uEmail']) && $data['uEmail'] !== $this->getUserEmail()) {
$emailChanged = true;
$fields[] = 'uEmail = ?';
$values[] = $data['uEmail'];
}
if (isset($data['uHasAvatar'])) {
$fields[] = 'uHasAvatar = ?';
$values[] = $data['uHasAvatar'] ? 1 : 0;
}
if (isset($data['uTimezone'])) {
$fields[] = 'uTimezone = ?';
$values[] = $data['uTimezone'];
}
if (isset($data['uDefaultLanguage'])) {
$fields[] = 'uDefaultLanguage = ?';
$values[] = $data['uDefaultLanguage'];
}
if (isset($data['uHomeFileManagerFolderID'])) {
if ($data['uHomeFileManagerFolderID'] == '') {
$nullFields[] = 'uHomeFileManagerFolderID';
} else {
$fields[] = 'uHomeFileManagerFolderID = ?';
$values[] = $data['uHomeFileManagerFolderID'];
}
}
if (isset($data['uPassword']) && (string)$data['uPassword'] !== '') {
if (isset($data['uPasswordConfirm']) && $data['uPassword'] === $data['uPasswordConfirm']) {
$passwordChangedOn = $this->application->make('date')->getOverridableNow();
$fields[] = 'uPassword = ?';
$values[] = $this->application->make(PasswordHasher::class)->hashPassword($data['uPassword']);
$fields[] = 'uLastPasswordChange = ?';
$values[] = $passwordChangedOn;
if (isset($data['uIsPasswordReset'])) {
$fields[] = 'uIsPasswordReset = ?';
$values[] = $data['uIsPasswordReset'] ? 1 : 0;
}
} else {
$result = null;
}
}
if (is_array($data['ignoredIPMismatches'] ?? null)) {
$fields[] = 'ignoredIPMismatches = ?';
$values[] = (new SimpleArrayType())->convertToDatabaseValue($data['ignoredIPMismatches'], $this->connection->getDatabasePlatform());
}
if ($result === true && !empty($fields)) {
$this->connection->executeQuery(
'update Users set ' . implode(', ', $fields) . ' where uID = ? limit 1',
array_merge($values, [$uID])
);
if (!empty($nullFields)) {
$nullFieldsStr = '';
foreach ($nullFields as $nullField) {
$nullFieldsStr .= (strlen($nullFieldsStr) > 0 ? ", " : "") . $nullField . " = NULL";
}
$nullQuery = sprintf('update Users set %s where uID = ? limit 1', $nullFieldsStr);
$this->connection->executeQuery($nullQuery, [$uID]);
}
if ($emailChanged) {
$this->connection->executeQuery('DELETE FROM UserValidationHashes WHERE uID = ?', [$uID]);
$h = $this->application->make('helper/validation/identifier');
$h->deleteKey('UserValidationHashes', 'uID', $uID);
}
// now we check to see if the user is updated his or her own logged in record
$session = $this->application->make('session');
if ($session->has('uID') && $uID === (int)$session->get('uID')) {
if (isset($data['uName'])) {
$session->set('uName', $data['uName']);
}
if (isset($data['uTimezone'])) {
$session->set('uTimezone', $data['uTimezone']);
}
if (isset($data['uDefaultLanguage'])) {
$session->set('uDefaultLanguage', $data['uDefaultLanguage']);
}
if (isset($data['uHomeFileManagerFolderID'])) {
$session->set('uHomeFileManagerFolderID', $data['uHomeFileManagerFolderID']);
}
if ($passwordChangedOn !== null) {
$session->set('uLastPasswordChange', $passwordChangedOn);
}
}
// run any internal event we have for user update
$ue = new UserInfoEvent($this);
$this->getDirector()->dispatch('on_user_update', $ue);
if ($passwordChangedOn !== null) {
$ue = new UserInfoWithPasswordEvent($this);
$ue->setUserPassword($data['uPassword']);
$this->getDirector()->dispatch('on_user_change_password', $ue);
}
}
}
return $result;
}
|
@param array $data
@return bool|null returns false if the record has not been saved, null if the password confirmation failed, true otherwise
|
update
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function passwordMatches(string $uPassword): bool
{
$hasher = $this->application->make(PasswordHasher::class);
return $hasher->CheckPassword($uPassword, $this->getUserPassword());
}
|
Checks the uPassword record for the current user and returns true if the hashed version of the
passed password matches.
@param $uPassword
@return bool
|
passwordMatches
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function triggerActivate($action = null, $requesterUID = null)
{
if ($requesterUID === null) {
$u = $this->application->make(User::class);
$requesterUID = $u->getUserID();
}
$pkr = new ActivateUserWorkflowRequest();
// default activate action of workflow is set after workflow request is created
if ($action !== null) {
$pkr->setRequestAction($action);
}
$pkr->setRequestedUserID($this->getUserID());
$pkr->setRequesterUserID($requesterUID);
$pkr->trigger();
// Figure out whether the user was marked active during the workflow.
// Usually happens if no workflows are attached (empty workflow).
if ($this->connection->fetchColumn('SELECT uIsActive FROM Users WHERE uID = ? limit 1', [$this->getUserID()])) {
$isActive = true;
} else {
$isActive = false;
}
$this->entity->setUserIsActive($isActive);
return $isActive;
}
|
@param string|null $action
@param int|null $requesterUID Use null for the current user
@return bool
|
triggerActivate
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function triggerDeactivate($requesterUID = null)
{
if ($requesterUID === null) {
$u = $this->application->make(User::class);
$requesterUID = $u->getUserID();
}
$pkr = new ActivateUserWorkflowRequest();
$pkr->setRequestAction('deactivate');
$pkr->setRequestedUserID($this->getUserID());
$pkr->setRequesterUserID($requesterUID);
$pkr->trigger();
if ($this->connection->fetchColumn('select uIsActive from Users where uID = ? limit 1', [$this->getUserID()])) {
$isActive = true;
} else {
$isActive = false;
}
$this->entity->setUserIsActive($isActive);
return $isActive === false;
}
|
@param int|null $requesterUID Use null for the current user
@return bool
|
triggerDeactivate
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function resetUserPassword($length = 256)
{
// resets user's password, and returns the value of the reset password
if ($this->getUserID() > 0) {
$id = $this->application->make(Identifier::class);
$newPassword = $id->getString($length);
$this->changePassword($newPassword);
$ue = new UserInfoEvent($this);
$this->getDirector()->dispatch('on_user_reset_password', $ue);
return $newPassword;
}
}
|
@param int $length
@return string|null
|
resetUserPassword
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getLastLogin()
{
return $this->entity->getUserLastLogin();
}
|
@see \Concrete\Core\Entity\User\User::getUserLastLogin()
|
getLastLogin
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getPreviousLogin()
{
return $this->entity->getUserPreviousLogin();
}
|
@see \Concrete\Core\Entity\User\User::getUserPreviousLogin()
|
getPreviousLogin
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserLastPasswordChange(): ?\DateTimeInterface
{
return $this->entity->getUserLastPasswordChange();
}
|
@see \Concrete\Core\Entity\User\User::getUserLastPasswordChange()
|
getUserLastPasswordChange
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function isActive()
{
return $this->entity->isUserActive();
}
|
@see \Concrete\Core\Entity\User\User::isUserActive()
|
isActive
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function isValidated()
{
return $this->entity->isUserValidated();
}
|
@see \Concrete\Core\Entity\User\User::isUserValidated()
|
isValidated
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function isFullRecord()
{
return $this->entity->isUserFullRecord();
}
|
@see \Concrete\Core\Entity\User\User::isUserFullRecord()
|
isFullRecord
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getNumLogins()
{
return $this->entity->getUserTotalLogins();
}
|
@see \Concrete\Core\Entity\User\User::getUserTotalLogins()
|
getNumLogins
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserID()
{
return $this->entity->getUserID();
}
|
@see \Concrete\Core\Entity\User\User::getUserID()
|
getUserID
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserDateLastUpdated()
{
return $this->entity->getUserDateLastUpdated();
}
|
@see \Concrete\Core\Entity\User\User::getUserID()
|
getUserDateLastUpdated
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserName()
{
return $this->entity->getUserName();
}
|
@see \Concrete\Core\Entity\User\User::getUserName()
|
getUserName
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserDisplayName()
{
return $this->entity->getUserName();
}
|
@see \Concrete\Core\Entity\User\User::getUserName()
|
getUserDisplayName
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserPassword()
{
return $this->entity->getUserPassword();
}
|
@see \Concrete\Core\Entity\User\User::getUserPassword()
|
getUserPassword
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserEmail()
{
return $this->entity->getUserEmail();
}
|
@see \Concrete\Core\Entity\User\User::getUserEmail()
|
getUserEmail
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserHomeFolderId()
{
return $this->entity->getHomeFileManagerFolderID();
}
|
@see \Concrete\Core\Entity\User\User::getHomeFileManagerFolderID()
|
getUserHomeFolderId
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserTimezone()
{
return $this->entity->getUserTimezone();
}
|
@see \Concrete\Core\Entity\User\User::getUserTimezone()
|
getUserTimezone
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserDefaultLanguage()
{
return $this->entity->getUserDefaultLanguage();
}
|
@see \Concrete\Core\Entity\User\User::getUserDefaultLanguage()
|
getUserDefaultLanguage
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getUserDateAdded()
{
return $this->entity->getUserDateAdded();
}
|
@see \Concrete\Core\Entity\User\User::getUserDateAdded()
|
getUserDateAdded
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getLastOnline()
{
return $this->entity->getUserLastOnline();
}
|
@see \Concrete\Core\Entity\User\User::getUserLastOnline()
|
getLastOnline
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function saveUserAttributesDefault(array $attributes)
{
foreach ($attributes as $uak) {
$controller = $uak->getController();
if (method_exists($controller, 'createDefaultAttributeValue')) {
$value = $controller->createDefaultAttributeValue();
if ($value !== null) {
$this->setAttribute($uak, $value);
}
}
}
$ue = new UserInfoWithAttributesEvent($this);
$ue->setAttributes($attributes);
$this->getDirector()->dispatch('on_user_attributes_saved', $ue);
}
|
@param \Concrete\Core\Entity\Attribute\Key\UserKey[] $attributes
|
saveUserAttributesDefault
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getObjectAttributeCategory()
{
return $this->application->make(UserCategory::class);
}
|
{@inheritdoc}
@return UserCategory
@see \Concrete\Core\Attribute\ObjectInterface::getObjectAttributeCategory()
|
getObjectAttributeCategory
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getAttributeValueObject($ak, $createIfNotExists = false)
{
if (!is_object($ak)) {
$ak = UserKey::getByHandle($ak);
}
if (is_object($ak)) {
$value = $this->getObjectAttributeCategory()->getAttributeValue($ak, $this->entity);
} else {
$value = null;
}
if ($value === null && $createIfNotExists) {
$value = new UserValue();
$value->setUser($this->entity);
$value->setAttributeKey($ak);
}
return $value;
}
|
@param string|\Concrete\Core\Entity\Attribute\Key\UserKey $ak
@param bool $createIfNotExists
@return UserValue|null
|
getAttributeValueObject
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function __call($nm, $a)
{
if (substr($nm, 0, 7) == 'getUser') {
$nm = preg_replace('/(?!^)[[:upper:]]/', '_\0', $nm);
$nm = strtolower($nm);
$nm = str_replace('get_user_', '', $nm);
return $this->getAttribute($nm);
}
}
|
Magic method for user attributes. This is db expensive but pretty damn cool
so if the attrib handle is "my_attribute", then get the attribute with $ui->getUserMyAttribute(), or "uFirstName" become $ui->getUserUfirstname();.
@return mixed|null
|
__call
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public static function add($data)
{
return app('user/registration')->create($data);
}
|
@deprecated Use app('user/registration')->create()
|
add
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public static function addSuperUser($uPasswordEncrypted, $uEmail)
{
return app('user/registration')->createSuperUser($uPasswordEncrypted, $uEmail);
}
|
@deprecated Use app('user/registration')->createSuperUser()
|
addSuperUser
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public static function register($data)
{
return app('user/registration')->createFromPublicRegistration($data);
}
|
@deprecated Use app('user/registration')->createFromPublicRegistration()
|
register
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public static function getByID($uID)
{
return app(UserInfoRepository::class)->getByID($uID);
}
|
@deprecated use app(\Concrete\Core\User\UserInfoRepository::class)->getByID()
|
getByID
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public static function getByUserName($uName)
{
return app(UserInfoRepository::class)->getByName($uName);
}
|
@deprecated use app(\Concrete\Core\User\UserInfoRepository::class)->getByName()
|
getByUserName
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public static function getByEmail($uEmail)
{
return app(UserInfoRepository::class)->getByEmail($uEmail);
}
|
@deprecated use app(\Concrete\Core\User\UserInfoRepository::class)->getByEmail()
|
getByEmail
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public static function getByValidationHash($uHash, $unredeemedHashesOnly = true)
{
return app(UserInfoRepository::class)->getByValidationHash($uHash, $unredeemedHashesOnly);
}
|
@deprecated use app(\Concrete\Core\User\UserInfoRepository::class)->getByValidationHash()
|
getByValidationHash
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfo.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfo.php
|
MIT
|
public function getByID($uID)
{
return $this->get('uID', $uID);
}
|
Returns the UserInfo object for a give user's uID.
@param int $uID
@return UserInfo|null
|
getByID
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfoRepository.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfoRepository.php
|
MIT
|
public function getByName($uName)
{
return $this->get('uName', $uName);
}
|
Returns the UserInfo object for a give user's username.
@param string $uName
@return UserInfo|null
|
getByName
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfoRepository.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfoRepository.php
|
MIT
|
public function getByEmail($uEmail)
{
return $this->get('uEmail', $uEmail);
}
|
Returns the UserInfo object for a give user's email address.
@param string $uEmail
@return UserInfo|null
|
getByEmail
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfoRepository.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfoRepository.php
|
MIT
|
public function getByUserEntity(UserEntity $entity)
{
$ui = $this->application->make(UserInfo::class);
$ui->setEntityObject($entity);
return $ui;
}
|
Get a UserInfo object from a user entity
@param \Concrete\Core\Entity\User\User $entity
@return \Concrete\Core\User\UserInfo
|
getByUserEntity
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfoRepository.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfoRepository.php
|
MIT
|
public function all($activeOnly = false)
{
$repository = $this->getRepository();
// If we only want active users
if ($activeOnly) {
$filter['uIsActive'] = true;
return array_map([$this, 'getByUserEntity'], $repository->findBy(['uIsActive' => true]));
}
return array_map([$this, 'getByUserEntity'], $repository->findAll());
}
|
Get all users
@param bool $activeOnly Only return active users
@return \Concrete\Core\User\UserInfo[]
|
all
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfoRepository.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfoRepository.php
|
MIT
|
public function getByValidationHash($uHash, $unredeemedHashesOnly = true)
{
$db = $this->entityManager->getConnection();
if ($unredeemedHashesOnly) {
$uID = $db->fetchColumn("select uID from UserValidationHashes where uHash = ? and uDateRedeemed = 0", array($uHash));
} else {
$uID = $db->fetchColumn("select uID from UserValidationHashes where uHash = ?", array($uHash));
}
if ($uID) {
$ui = $this->getByID($uID);
return $ui;
}
}
|
@param string $uHash
@param bool $unredeemedHashesOnly
@return \Concrete\Core\User\UserInfo|null
|
getByValidationHash
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfoRepository.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfoRepository.php
|
MIT
|
private function get($where, $var)
{
$entity = $this->getRepository()->findOneBy(array($where => $var));
if (!is_object($entity)) {
return null;
}
return $this->getByUserEntity($entity);
}
|
Resolve an single entity by
@param $where
@param $var
@return \Concrete\Core\User\UserInfo|null
|
get
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfoRepository.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfoRepository.php
|
MIT
|
protected function getRepository()
{
if (!$this->repository) {
$this->repository = $this->entityManager->getRepository(UserEntity::class);
}
return $this->repository;
}
|
Resolve the repository instance
@return \Doctrine\Common\Persistence\ObjectRepository
|
getRepository
|
php
|
concretecms/concretecms
|
concrete/src/User/UserInfoRepository.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserInfoRepository.php
|
MIT
|
public function getResult($queryRow)
{
return $this->getUserInfoRepository()->getByID($queryRow['uID']);
}
|
@param $queryRow
@return \Concrete\Core\User\UserInfo
|
getResult
|
php
|
concretecms/concretecms
|
concrete/src/User/UserList.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/User/UserList.php
|
MIT
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.