Completed
Push — master ( 3a9edb...9a7c98 )
by André
13:29
created

UserService::moveUserGroup()   B

Complexity

Conditions 4
Paths 5

Size

Total Lines 31
Code Lines 19

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
eloc 19
nc 5
nop 2
dl 0
loc 31
rs 8.5806
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * File containing the eZ\Publish\Core\Repository\UserService class.
5
 *
6
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
7
 * @license For full copyright and license information view LICENSE file distributed with this source code.
8
 */
9
namespace eZ\Publish\Core\Repository;
10
11
use eZ\Publish\API\Repository\Values\Content\LocationQuery;
12
use eZ\Publish\Core\Repository\Values\User\UserCreateStruct;
13
use eZ\Publish\API\Repository\Values\User\UserCreateStruct as APIUserCreateStruct;
14
use eZ\Publish\API\Repository\Values\User\UserUpdateStruct;
15
use eZ\Publish\Core\Repository\Values\User\User;
16
use eZ\Publish\API\Repository\Values\User\User as APIUser;
17
use eZ\Publish\Core\Repository\Values\User\UserGroup;
18
use eZ\Publish\API\Repository\Values\User\UserGroup as APIUserGroup;
19
use eZ\Publish\Core\Repository\Values\User\UserGroupCreateStruct;
20
use eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct as APIUserGroupCreateStruct;
21
use eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct;
22
use eZ\Publish\API\Repository\Values\Content\Location;
23
use eZ\Publish\API\Repository\Values\Content\Content as APIContent;
24
use eZ\Publish\SPI\Persistence\User\Handler;
25
use eZ\Publish\API\Repository\Repository as RepositoryInterface;
26
use eZ\Publish\API\Repository\UserService as UserServiceInterface;
27
use eZ\Publish\SPI\Persistence\User as SPIUser;
28
use eZ\Publish\Core\FieldType\User\Value as UserValue;
29
use eZ\Publish\API\Repository\Values\Content\Query\Criterion\LogicalAnd as CriterionLogicalAnd;
30
use eZ\Publish\API\Repository\Values\Content\Query\Criterion\ContentTypeId as CriterionContentTypeId;
31
use eZ\Publish\API\Repository\Values\Content\Query\Criterion\LocationId as CriterionLocationId;
32
use eZ\Publish\API\Repository\Values\Content\Query\Criterion\ParentLocationId as CriterionParentLocationId;
33
use eZ\Publish\Core\Base\Exceptions\ContentValidationException;
34
use eZ\Publish\Core\Base\Exceptions\InvalidArgumentValue;
35
use eZ\Publish\Core\Base\Exceptions\BadStateException;
36
use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
37
use eZ\Publish\Core\Base\Exceptions\NotFoundException;
38
use eZ\Publish\Core\Base\Exceptions\UnauthorizedException;
39
use ezcMailTools;
40
use Exception;
41
42
/**
43
 * This service provides methods for managing users and user groups.
44
 *
45
 * @example Examples/user.php
46
 */
47
class UserService implements UserServiceInterface
48
{
49
    /**
50
     * @var \eZ\Publish\API\Repository\Repository
51
     */
52
    protected $repository;
53
54
    /**
55
     * @var \eZ\Publish\SPI\Persistence\User\Handler
56
     */
57
    protected $userHandler;
58
59
    /**
60
     * @var array
61
     */
62
    protected $settings;
63
64
    /**
65
     * Setups service with reference to repository object that created it & corresponding handler.
66
     *
67
     * @param \eZ\Publish\API\Repository\Repository $repository
68
     * @param \eZ\Publish\SPI\Persistence\User\Handler $userHandler
69
     * @param array $settings
70
     */
71
    public function __construct(RepositoryInterface $repository, Handler $userHandler, array $settings = array())
72
    {
73
        $this->repository = $repository;
74
        $this->userHandler = $userHandler;
75
        // Union makes sure default settings are ignored if provided in argument
76
        $this->settings = $settings + array(
77
            'defaultUserPlacement' => 12,
78
            'userClassID' => 4, // @todo Rename this settings to swap out "Class" for "Type"
79
            'userGroupClassID' => 3,
80
            'hashType' => User::PASSWORD_HASH_PHP_DEFAULT,
81
            'siteName' => 'ez.no',
82
        );
83
    }
84
85
    /**
86
     * Creates a new user group using the data provided in the ContentCreateStruct parameter.
87
     *
88
     * In 4.x in the content type parameter in the profile is ignored
89
     * - the content type is determined via configuration and can be set to null.
90
     * The returned version is published.
91
     *
92
     * @param \eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct $userGroupCreateStruct a structure for setting all necessary data to create this user group
93
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $parentGroup
94
     *
95
     * @return \eZ\Publish\API\Repository\Values\User\UserGroup
96
     *
97
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to create a user group
98
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the input structure has invalid data
99
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $userGroupCreateStruct is not valid
100
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is missing or set to an empty value
101
     */
102
    public function createUserGroup(APIUserGroupCreateStruct $userGroupCreateStruct, APIUserGroup $parentGroup)
103
    {
104
        $contentService = $this->repository->getContentService();
105
        $locationService = $this->repository->getLocationService();
106
        $contentTypeService = $this->repository->getContentTypeService();
107
108
        if ($userGroupCreateStruct->contentType === null) {
109
            $userGroupContentType = $contentTypeService->loadContentType($this->settings['userGroupClassID']);
110
            $userGroupCreateStruct->contentType = $userGroupContentType;
111
        }
112
113
        $loadedParentGroup = $this->loadUserGroup($parentGroup->id);
114
115
        if ($loadedParentGroup->getVersionInfo()->getContentInfo()->mainLocationId === null) {
116
            throw new InvalidArgumentException('parentGroup', 'parent user group has no main location');
117
        }
118
119
        $locationCreateStruct = $locationService->newLocationCreateStruct(
120
            $loadedParentGroup->getVersionInfo()->getContentInfo()->mainLocationId
121
        );
122
123
        $this->repository->beginTransaction();
124
        try {
125
            $contentDraft = $contentService->createContent($userGroupCreateStruct, array($locationCreateStruct));
126
            $publishedContent = $contentService->publishVersion($contentDraft->getVersionInfo());
127
            $this->repository->commit();
128
        } catch (Exception $e) {
129
            $this->repository->rollback();
130
            throw $e;
131
        }
132
133
        return $this->buildDomainUserGroupObject($publishedContent);
134
    }
135
136
    /**
137
     * Loads a user group for the given id.
138
     *
139
     * @param mixed $id
140
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
141
     *
142
     * @return \eZ\Publish\API\Repository\Values\User\UserGroup
143
     *
144
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to create a user group
145
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the user group with the given id was not found
146
     */
147
    public function loadUserGroup($id, array $prioritizedLanguages = [])
148
    {
149
        $content = $this->repository->getContentService()->loadContent($id, $prioritizedLanguages);
150
151
        return $this->buildDomainUserGroupObject($content);
152
    }
153
154
    /**
155
     * Loads the sub groups of a user group.
156
     *
157
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $userGroup
158
     * @param int $offset the start offset for paging
159
     * @param int $limit the number of user groups returned
160
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
161
     *
162
     * @return \eZ\Publish\API\Repository\Values\User\UserGroup[]
163
     *
164
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to read the user group
165
     */
166
    public function loadSubUserGroups(APIUserGroup $userGroup, $offset = 0, $limit = 25, array $prioritizedLanguages = [])
167
    {
168
        $locationService = $this->repository->getLocationService();
169
170
        $loadedUserGroup = $this->loadUserGroup($userGroup->id);
171
        if (!$this->repository->canUser('content', 'read', $loadedUserGroup)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\API\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Indicates if the current user is allowed to perform an action given by the function on the given
objects. Example: canUser( 'content', 'edit', $content, $location ); This will check edit permission on content given the specific location, if skipped if will check on all locations. Example2: canUser( 'section', 'assign', $content, $section ); Check if user has access to assign $content to $section.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
172
            throw new UnauthorizedException('content', 'read');
173
        }
174
175
        if ($loadedUserGroup->getVersionInfo()->getContentInfo()->mainLocationId === null) {
176
            return array();
177
        }
178
179
        $mainGroupLocation = $locationService->loadLocation(
180
            $loadedUserGroup->getVersionInfo()->getContentInfo()->mainLocationId
181
        );
182
183
        $searchResult = $this->searchSubGroups($mainGroupLocation, $offset, $limit);
184
        if ($searchResult->totalCount == 0) {
185
            return array();
186
        }
187
188
        $subUserGroups = array();
189 View Code Duplication
        foreach ($searchResult->searchHits as $searchHit) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
190
            $subUserGroups[] = $this->buildDomainUserGroupObject(
191
                $this->repository->getContentService()->internalLoadContent(
0 ignored issues
show
Bug introduced by
The method internalLoadContent() does not exist on eZ\Publish\API\Repository\ContentService. Did you maybe mean loadContent()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
192
                    $searchHit->valueObject->contentInfo->id,
0 ignored issues
show
Documentation introduced by
The property contentInfo does not exist on object<eZ\Publish\API\Re...ory\Values\ValueObject>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
193
                    $prioritizedLanguages
194
                )
195
            );
196
        }
197
198
        return $subUserGroups;
199
    }
200
201
    /**
202
     * Returns (searches) subgroups of a user group described by its main location.
203
     *
204
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
205
     * @param int $offset
206
     * @param int $limit
207
     *
208
     * @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult
209
     */
210
    protected function searchSubGroups(Location $location, $offset = 0, $limit = 25)
211
    {
212
        $searchQuery = new LocationQuery();
213
214
        $searchQuery->offset = $offset;
215
        $searchQuery->limit = $limit;
216
217
        $searchQuery->filter = new CriterionLogicalAnd([
218
            new CriterionContentTypeId($this->settings['userGroupClassID']),
219
            new CriterionParentLocationId($location->id),
220
        ]);
221
222
        $searchQuery->sortClauses = $location->getSortClauses();
0 ignored issues
show
Documentation Bug introduced by
It seems like $location->getSortClauses() of type array<integer,object,{"0":"object"}> is incompatible with the declared type array<integer,object<eZ\...tent\Query\SortClause>> of property $sortClauses.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
223
224
        return $this->repository->getSearchService()->findLocations($searchQuery, array(), false);
225
    }
226
227
    /**
228
     * Removes a user group.
229
     *
230
     * the users which are not assigned to other groups will be deleted.
231
     *
232
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $userGroup
233
     *
234
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to create a user group
235
     */
236 View Code Duplication
    public function deleteUserGroup(APIUserGroup $userGroup)
237
    {
238
        $loadedUserGroup = $this->loadUserGroup($userGroup->id);
239
240
        $this->repository->beginTransaction();
241
        try {
242
            //@todo: what happens to sub user groups and users below sub user groups
243
            $affectedLocationIds = $this->repository->getContentService()->deleteContent($loadedUserGroup->getVersionInfo()->getContentInfo());
244
            $this->repository->commit();
245
        } catch (Exception $e) {
246
            $this->repository->rollback();
247
            throw $e;
248
        }
249
250
        return $affectedLocationIds;
251
    }
252
253
    /**
254
     * Moves the user group to another parent.
255
     *
256
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $userGroup
257
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $newParent
258
     *
259
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to move the user group
260
     */
261
    public function moveUserGroup(APIUserGroup $userGroup, APIUserGroup $newParent)
262
    {
263
        $loadedUserGroup = $this->loadUserGroup($userGroup->id);
264
        $loadedNewParent = $this->loadUserGroup($newParent->id);
265
266
        $locationService = $this->repository->getLocationService();
267
268
        if ($loadedUserGroup->getVersionInfo()->getContentInfo()->mainLocationId === null) {
269
            throw new BadStateException('userGroup', 'existing user group is not stored and/or does not have any location yet');
270
        }
271
272
        if ($loadedNewParent->getVersionInfo()->getContentInfo()->mainLocationId === null) {
273
            throw new BadStateException('newParent', 'new user group is not stored and/or does not have any location yet');
274
        }
275
276
        $userGroupMainLocation = $locationService->loadLocation(
277
            $loadedUserGroup->getVersionInfo()->getContentInfo()->mainLocationId
278
        );
279
        $newParentMainLocation = $locationService->loadLocation(
280
            $loadedNewParent->getVersionInfo()->getContentInfo()->mainLocationId
281
        );
282
283
        $this->repository->beginTransaction();
284
        try {
285
            $locationService->moveSubtree($userGroupMainLocation, $newParentMainLocation);
286
            $this->repository->commit();
287
        } catch (Exception $e) {
288
            $this->repository->rollback();
289
            throw $e;
290
        }
291
    }
292
293
    /**
294
     * Updates the group profile with fields and meta data.
295
     *
296
     * 4.x: If the versionUpdateStruct is set in $userGroupUpdateStruct, this method internally creates a content draft, updates ts with the provided data
297
     * and publishes the draft. If a draft is explicitly required, the user group can be updated via the content service methods.
298
     *
299
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $userGroup
300
     * @param \eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct $userGroupUpdateStruct
301
     *
302
     * @return \eZ\Publish\API\Repository\Values\User\UserGroup
303
     *
304
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to update the user group
305
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $userGroupUpdateStruct is not valid
306
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set empty
307
     */
308
    public function updateUserGroup(APIUserGroup $userGroup, UserGroupUpdateStruct $userGroupUpdateStruct)
309
    {
310
        if ($userGroupUpdateStruct->contentUpdateStruct === null &&
311
            $userGroupUpdateStruct->contentMetadataUpdateStruct === null) {
312
            // both update structs are empty, nothing to do
313
            return $userGroup;
314
        }
315
316
        $contentService = $this->repository->getContentService();
317
318
        $loadedUserGroup = $this->loadUserGroup($userGroup->id);
319
320
        $this->repository->beginTransaction();
321
        try {
322
            $publishedContent = $loadedUserGroup;
323 View Code Duplication
            if ($userGroupUpdateStruct->contentUpdateStruct !== null) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
324
                $contentDraft = $contentService->createContentDraft($loadedUserGroup->getVersionInfo()->getContentInfo());
325
326
                $contentDraft = $contentService->updateContent(
327
                    $contentDraft->getVersionInfo(),
328
                    $userGroupUpdateStruct->contentUpdateStruct
329
                );
330
331
                $publishedContent = $contentService->publishVersion($contentDraft->getVersionInfo());
332
            }
333
334
            if ($userGroupUpdateStruct->contentMetadataUpdateStruct !== null) {
335
                $publishedContent = $contentService->updateContentMetadata(
336
                    $publishedContent->getVersionInfo()->getContentInfo(),
337
                    $userGroupUpdateStruct->contentMetadataUpdateStruct
338
                );
339
            }
340
341
            $this->repository->commit();
342
        } catch (Exception $e) {
343
            $this->repository->rollback();
344
            throw $e;
345
        }
346
347
        return $this->buildDomainUserGroupObject($publishedContent);
348
    }
349
350
    /**
351
     * Create a new user. The created user is published by this method.
352
     *
353
     * @param \eZ\Publish\API\Repository\Values\User\UserCreateStruct $userCreateStruct the data used for creating the user
354
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup[] $parentGroups the groups which are assigned to the user after creation
355
     *
356
     * @return \eZ\Publish\API\Repository\Values\User\User
357
     *
358
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to move the user group
359
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $userCreateStruct is not valid
360
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is missing or set to an empty value
361
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if a user with provided login already exists
362
     */
363
    public function createUser(APIUserCreateStruct $userCreateStruct, array $parentGroups)
364
    {
365
        if (empty($parentGroups)) {
366
            throw new InvalidArgumentValue('parentGroups', $parentGroups);
367
        }
368
369
        if (!is_string($userCreateStruct->login) || empty($userCreateStruct->login)) {
370
            throw new InvalidArgumentValue('login', $userCreateStruct->login, 'UserCreateStruct');
371
        }
372
373 View Code Duplication
        if (!is_string($userCreateStruct->email) || empty($userCreateStruct->email)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
374
            throw new InvalidArgumentValue('email', $userCreateStruct->email, 'UserCreateStruct');
375
        }
376
377
        if (!ezcMailTools::validateEmailAddress($userCreateStruct->email)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \ezcMailTools::validateE...serCreateStruct->email) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
378
            throw new InvalidArgumentValue('email', $userCreateStruct->email, 'UserCreateStruct');
379
        }
380
381
        if (!is_string($userCreateStruct->password) || empty($userCreateStruct->password)) {
382
            throw new InvalidArgumentValue('password', $userCreateStruct->password, 'UserCreateStruct');
383
        }
384
385
        if (!is_bool($userCreateStruct->enabled)) {
386
            throw new InvalidArgumentValue('enabled', $userCreateStruct->enabled, 'UserCreateStruct');
387
        }
388
389
        try {
390
            $this->userHandler->loadByLogin($userCreateStruct->login);
391
            throw new InvalidArgumentException('userCreateStruct', 'User with provided login already exists');
392
        } catch (NotFoundException $e) {
393
            // Do nothing
394
        }
395
396
        $contentService = $this->repository->getContentService();
397
        $locationService = $this->repository->getLocationService();
398
        $contentTypeService = $this->repository->getContentTypeService();
399
400
        if ($userCreateStruct->contentType === null) {
401
            $userContentType = $contentTypeService->loadContentType($this->settings['userClassID']);
402
            $userCreateStruct->contentType = $userContentType;
403
        }
404
405
        $locationCreateStructs = array();
406
        foreach ($parentGroups as $parentGroup) {
407
            $parentGroup = $this->loadUserGroup($parentGroup->id);
408
            if ($parentGroup->getVersionInfo()->getContentInfo()->mainLocationId !== null) {
409
                $locationCreateStructs[] = $locationService->newLocationCreateStruct(
410
                    $parentGroup->getVersionInfo()->getContentInfo()->mainLocationId
411
                );
412
            }
413
        }
414
415
        // Search for the first ezuser field type in content type
416
        $userFieldDefinition = null;
417
        foreach ($userCreateStruct->contentType->getFieldDefinitions() as $fieldDefinition) {
418
            if ($fieldDefinition->fieldTypeIdentifier == 'ezuser') {
419
                $userFieldDefinition = $fieldDefinition;
420
                break;
421
            }
422
        }
423
424
        if ($userFieldDefinition === null) {
425
            throw new ContentValidationException('Provided content type does not contain ezuser field type');
426
        }
427
428
        $fixUserFieldType = true;
429
        foreach ($userCreateStruct->fields as $index => $field) {
430
            if ($field->fieldDefIdentifier == $userFieldDefinition->identifier) {
431
                if ($field->value instanceof UserValue) {
0 ignored issues
show
Documentation introduced by
The property $value is declared protected in eZ\Publish\API\Repository\Values\Content\Field. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
432
                    $userCreateStruct->fields[$index]->value->login = $userCreateStruct->login;
0 ignored issues
show
Documentation introduced by
The property $value is declared protected in eZ\Publish\API\Repository\Values\Content\Field. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
433
                } else {
434
                    $userCreateStruct->fields[$index]->value = new UserValue(
0 ignored issues
show
Documentation introduced by
The property $value is declared protected in eZ\Publish\API\Repository\Values\Content\Field. Since you implemented __set(), maybe consider adding a @property or @property-write annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
435
                        array(
436
                            'login' => $userCreateStruct->login,
437
                        )
438
                    );
439
                }
440
441
                $fixUserFieldType = false;
442
            }
443
        }
444
445
        if ($fixUserFieldType) {
446
            $userCreateStruct->setField(
447
                $userFieldDefinition->identifier,
448
                new UserValue(
449
                    array(
450
                        'login' => $userCreateStruct->login,
451
                    )
452
                )
453
            );
454
        }
455
456
        $this->repository->beginTransaction();
457
        try {
458
            $contentDraft = $contentService->createContent($userCreateStruct, $locationCreateStructs);
459
            // Create user before publishing, so that external data can be returned
460
            $spiUser = $this->userHandler->create(
461
                new SPIUser(
462
                    array(
463
                        'id' => $contentDraft->id,
464
                        'login' => $userCreateStruct->login,
465
                        'email' => $userCreateStruct->email,
466
                        'passwordHash' => $this->createPasswordHash(
467
                            $userCreateStruct->login,
468
                            $userCreateStruct->password,
469
                            $this->settings['siteName'],
470
                            $this->settings['hashType']
471
                        ),
472
                        'hashAlgorithm' => $this->settings['hashType'],
473
                        'isEnabled' => $userCreateStruct->enabled,
474
                        'maxLogin' => 0,
475
                    )
476
                )
477
            );
478
            $publishedContent = $contentService->publishVersion($contentDraft->getVersionInfo());
479
480
            $this->repository->commit();
481
        } catch (Exception $e) {
482
            $this->repository->rollback();
483
            throw $e;
484
        }
485
486
        return $this->buildDomainUserObject($spiUser, $publishedContent);
487
    }
488
489
    /**
490
     * Loads a user.
491
     *
492
     * @param mixed $userId
493
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
494
     *
495
     * @return \eZ\Publish\API\Repository\Values\User\User
496
     *
497
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if a user with the given id was not found
498
     */
499
    public function loadUser($userId, array $prioritizedLanguages = [])
500
    {
501
        /** @var \eZ\Publish\API\Repository\Values\Content\Content $content */
502
        $content = $this->repository->getContentService()->internalLoadContent($userId, $prioritizedLanguages);
0 ignored issues
show
Bug introduced by
The method internalLoadContent() does not exist on eZ\Publish\API\Repository\ContentService. Did you maybe mean loadContent()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
503
        // Get spiUser value from Field Value
504
        foreach ($content->getFields() as $field) {
505
            if (!$field->value instanceof UserValue) {
0 ignored issues
show
Documentation introduced by
The property $value is declared protected in eZ\Publish\API\Repository\Values\Content\Field. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
506
                continue;
507
            }
508
509
            /** @var \eZ\Publish\Core\FieldType\User\Value $value */
510
            $value = $field->value;
0 ignored issues
show
Documentation introduced by
The property $value is declared protected in eZ\Publish\API\Repository\Values\Content\Field. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
511
            $spiUser = new SPIUser();
512
            $spiUser->id = $value->contentId;
513
            $spiUser->login = $value->login;
514
            $spiUser->email = $value->email;
515
            $spiUser->hashAlgorithm = $value->passwordHashType;
516
            $spiUser->passwordHash = $value->passwordHash;
517
            $spiUser->isEnabled = $value->enabled;
518
            $spiUser->maxLogin = $value->maxLogin;
519
            break;
520
        }
521
522
        // If for some reason not found, load it
523
        if (!isset($spiUser)) {
524
            $spiUser = $this->userHandler->load($userId);
525
        }
526
527
        return $this->buildDomainUserObject($spiUser, $content);
528
    }
529
530
    /**
531
     * Loads anonymous user.
532
     *
533
     * @deprecated since 5.3, use loadUser( $anonymousUserId ) instead
534
     *
535
     * @uses ::loadUser()
536
     *
537
     * @return \eZ\Publish\API\Repository\Values\User\User
538
     */
539
    public function loadAnonymousUser()
540
    {
541
        return $this->loadUser($this->settings['anonymousUserID']);
542
    }
543
544
    /**
545
     * Loads a user for the given login and password.
546
     *
547
     * {@inheritdoc}
548
     *
549
     * @param string $login
550
     * @param string $password the plain password
551
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
552
     *
553
     * @return \eZ\Publish\API\Repository\Values\User\User
554
     *
555
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if credentials are invalid
556
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if a user with the given credentials was not found
557
     */
558
    public function loadUserByCredentials($login, $password, array $prioritizedLanguages = [])
559
    {
560
        if (!is_string($login) || empty($login)) {
561
            throw new InvalidArgumentValue('login', $login);
562
        }
563
564
        if (!is_string($password)) {
565
            throw new InvalidArgumentValue('password', $password);
566
        }
567
568
        $spiUser = $this->userHandler->loadByLogin($login);
569
        if (!$this->verifyPassword($login, $password, $spiUser)) {
570
            throw new NotFoundException('user', $login);
571
        }
572
573
        return $this->buildDomainUserObject($spiUser, null, $prioritizedLanguages);
574
    }
575
576
    /**
577
     * Loads a user for the given login.
578
     *
579
     * {@inheritdoc}
580
     *
581
     * @param string $login
582
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
583
     *
584
     * @return \eZ\Publish\API\Repository\Values\User\User
585
     *
586
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if a user with the given credentials was not found
587
     */
588
    public function loadUserByLogin($login, array $prioritizedLanguages = [])
589
    {
590
        if (!is_string($login) || empty($login)) {
591
            throw new InvalidArgumentValue('login', $login);
592
        }
593
594
        $spiUser = $this->userHandler->loadByLogin($login);
595
596
        return $this->buildDomainUserObject($spiUser, null, $prioritizedLanguages);
597
    }
598
599
    /**
600
     * Loads a user for the given email.
601
     *
602
     * {@inheritdoc}
603
     *
604
     * @param string $email
605
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
606
     *
607
     * @return \eZ\Publish\API\Repository\Values\User\User[]
608
     */
609
    public function loadUsersByEmail($email, array $prioritizedLanguages = [])
610
    {
611
        if (!is_string($email) || empty($email)) {
612
            throw new InvalidArgumentValue('email', $email);
613
        }
614
615
        $users = array();
616
        foreach ($this->userHandler->loadByEmail($email) as $spiUser) {
617
            $users[] = $this->buildDomainUserObject($spiUser, null, $prioritizedLanguages);
618
        }
619
620
        return $users;
621
    }
622
623
    /**
624
     * This method deletes a user.
625
     *
626
     * @param \eZ\Publish\API\Repository\Values\User\User $user
627
     *
628
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to delete the user
629
     */
630 View Code Duplication
    public function deleteUser(APIUser $user)
631
    {
632
        $loadedUser = $this->loadUser($user->id);
633
634
        $this->repository->beginTransaction();
635
        try {
636
            $affectedLocationIds = $this->repository->getContentService()->deleteContent($loadedUser->getVersionInfo()->getContentInfo());
637
            $this->userHandler->delete($loadedUser->id);
638
            $this->repository->commit();
639
        } catch (Exception $e) {
640
            $this->repository->rollback();
641
            throw $e;
642
        }
643
644
        return $affectedLocationIds;
645
    }
646
647
    /**
648
     * Updates a user.
649
     *
650
     * 4.x: If the versionUpdateStruct is set in the user update structure, this method internally creates a content draft, updates ts with the provided data
651
     * and publishes the draft. If a draft is explicitly required, the user group can be updated via the content service methods.
652
     *
653
     * @param \eZ\Publish\API\Repository\Values\User\User $user
654
     * @param \eZ\Publish\API\Repository\Values\User\UserUpdateStruct $userUpdateStruct
655
     *
656
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to update the user
657
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $userUpdateStruct is not valid
658
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set empty
659
     *
660
     * @return \eZ\Publish\API\Repository\Values\User\User
661
     */
662
    public function updateUser(APIUser $user, UserUpdateStruct $userUpdateStruct)
663
    {
664
        $loadedUser = $this->loadUser($user->id);
665
666
        // We need to determine if we have anything to update.
667
        // UserUpdateStruct is specific as some of the new content is in
668
        // content update struct and some of it is in additional fields like
669
        // email, password and so on
670
        $doUpdate = false;
671
        foreach ($userUpdateStruct as $propertyValue) {
0 ignored issues
show
Bug introduced by
The expression $userUpdateStruct of type object<eZ\Publish\API\Re...\User\UserUpdateStruct> is not traversable.
Loading history...
672
            if ($propertyValue !== null) {
673
                $doUpdate = true;
674
                break;
675
            }
676
        }
677
678
        if (!$doUpdate) {
679
            // Nothing to update, so we just quit
680
            return $user;
681
        }
682
683
        if ($userUpdateStruct->email !== null) {
684 View Code Duplication
            if (!is_string($userUpdateStruct->email) || empty($userUpdateStruct->email)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
685
                throw new InvalidArgumentValue('email', $userUpdateStruct->email, 'UserUpdateStruct');
686
            }
687
688
            if (!ezcMailTools::validateEmailAddress($userUpdateStruct->email)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \ezcMailTools::validateE...serUpdateStruct->email) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
689
                throw new InvalidArgumentValue('email', $userUpdateStruct->email, 'UserUpdateStruct');
690
            }
691
        }
692
693 View Code Duplication
        if ($userUpdateStruct->password !== null && (!is_string($userUpdateStruct->password) || empty($userUpdateStruct->password))) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
694
            throw new InvalidArgumentValue('password', $userUpdateStruct->password, 'UserUpdateStruct');
695
        }
696
697
        if ($userUpdateStruct->enabled !== null && !is_bool($userUpdateStruct->enabled)) {
698
            throw new InvalidArgumentValue('enabled', $userUpdateStruct->enabled, 'UserUpdateStruct');
699
        }
700
701
        if ($userUpdateStruct->maxLogin !== null && !is_int($userUpdateStruct->maxLogin)) {
702
            throw new InvalidArgumentValue('maxLogin', $userUpdateStruct->maxLogin, 'UserUpdateStruct');
703
        }
704
705
        $contentService = $this->repository->getContentService();
706
707
        if (!$this->repository->canUser('content', 'edit', $loadedUser)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\API\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Indicates if the current user is allowed to perform an action given by the function on the given
objects. Example: canUser( 'content', 'edit', $content, $location ); This will check edit permission on content given the specific location, if skipped if will check on all locations. Example2: canUser( 'section', 'assign', $content, $section ); Check if user has access to assign $content to $section.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
708
            throw new UnauthorizedException('content', 'edit');
709
        }
710
711
        $this->repository->beginTransaction();
712
        try {
713
            $publishedContent = $loadedUser;
714 View Code Duplication
            if ($userUpdateStruct->contentUpdateStruct !== null) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
715
                $contentDraft = $contentService->createContentDraft($loadedUser->getVersionInfo()->getContentInfo());
716
                $contentDraft = $contentService->updateContent(
717
                    $contentDraft->getVersionInfo(),
718
                    $userUpdateStruct->contentUpdateStruct
719
                );
720
                $publishedContent = $contentService->publishVersion($contentDraft->getVersionInfo());
721
            }
722
723
            if ($userUpdateStruct->contentMetadataUpdateStruct !== null) {
724
                $contentService->updateContentMetadata(
725
                    $publishedContent->getVersionInfo()->getContentInfo(),
726
                    $userUpdateStruct->contentMetadataUpdateStruct
727
                );
728
            }
729
730
            $this->userHandler->update(
731
                new SPIUser(
732
                    array(
733
                        'id' => $loadedUser->id,
734
                        'login' => $loadedUser->login,
0 ignored issues
show
Documentation introduced by
The property $login is declared protected in eZ\Publish\API\Repository\Values\User\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
735
                        'email' => $userUpdateStruct->email ?: $loadedUser->email,
0 ignored issues
show
Documentation introduced by
The property $email is declared protected in eZ\Publish\API\Repository\Values\User\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
736
                        'passwordHash' => $userUpdateStruct->password ?
737
                            $this->createPasswordHash(
738
                                $loadedUser->login,
0 ignored issues
show
Documentation introduced by
The property $login is declared protected in eZ\Publish\API\Repository\Values\User\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
739
                                $userUpdateStruct->password,
740
                                $this->settings['siteName'],
741
                                $this->settings['hashType']
742
                            ) :
743
                            $loadedUser->passwordHash,
0 ignored issues
show
Documentation introduced by
The property $passwordHash is declared protected in eZ\Publish\API\Repository\Values\User\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
744
                        'hashAlgorithm' => $this->settings['hashType'],
745
                        'isEnabled' => $userUpdateStruct->enabled !== null ? $userUpdateStruct->enabled : $loadedUser->enabled,
0 ignored issues
show
Documentation introduced by
The property $enabled is declared protected in eZ\Publish\API\Repository\Values\User\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
746
                        'maxLogin' => $userUpdateStruct->maxLogin !== null ? (int)$userUpdateStruct->maxLogin : $loadedUser->maxLogin,
0 ignored issues
show
Documentation introduced by
The property $maxLogin is declared protected in eZ\Publish\API\Repository\Values\User\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
747
                    )
748
                )
749
            );
750
751
            $this->repository->commit();
752
        } catch (Exception $e) {
753
            $this->repository->rollback();
754
            throw $e;
755
        }
756
757
        return $this->loadUser($loadedUser->id);
758
    }
759
760
    /**
761
     * Assigns a new user group to the user.
762
     *
763
     * @param \eZ\Publish\API\Repository\Values\User\User $user
764
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $userGroup
765
     *
766
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to assign the user group to the user
767
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the user is already in the given user group
768
     */
769
    public function assignUserToUserGroup(APIUser $user, APIUserGroup $userGroup)
770
    {
771
        $loadedUser = $this->loadUser($user->id);
772
        $loadedGroup = $this->loadUserGroup($userGroup->id);
773
        $locationService = $this->repository->getLocationService();
774
775
        $existingGroupIds = array();
776
        $userLocations = $locationService->loadLocations($loadedUser->getVersionInfo()->getContentInfo());
777
        foreach ($userLocations as $userLocation) {
778
            $existingGroupIds[] = $userLocation->parentLocationId;
779
        }
780
781
        if ($loadedGroup->getVersionInfo()->getContentInfo()->mainLocationId === null) {
782
            throw new BadStateException('userGroup', 'user group has no main location or no locations');
783
        }
784
785
        if (in_array($loadedGroup->getVersionInfo()->getContentInfo()->mainLocationId, $existingGroupIds)) {
786
            // user is already assigned to the user group
787
            throw new InvalidArgumentException('user', 'user is already in the given user group');
788
        }
789
790
        $locationCreateStruct = $locationService->newLocationCreateStruct(
791
            $loadedGroup->getVersionInfo()->getContentInfo()->mainLocationId
792
        );
793
794
        $this->repository->beginTransaction();
795
        try {
796
            $locationService->createLocation(
797
                $loadedUser->getVersionInfo()->getContentInfo(),
798
                $locationCreateStruct
799
            );
800
            $this->repository->commit();
801
        } catch (Exception $e) {
802
            $this->repository->rollback();
803
            throw $e;
804
        }
805
    }
806
807
    /**
808
     * Removes a user group from the user.
809
     *
810
     * @param \eZ\Publish\API\Repository\Values\User\User $user
811
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $userGroup
812
     *
813
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to remove the user group from the user
814
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the user is not in the given user group
815
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException If $userGroup is the last assigned user group
816
     */
817
    public function unAssignUserFromUserGroup(APIUser $user, APIUserGroup $userGroup)
818
    {
819
        $loadedUser = $this->loadUser($user->id);
820
        $loadedGroup = $this->loadUserGroup($userGroup->id);
821
        $locationService = $this->repository->getLocationService();
822
823
        $userLocations = $locationService->loadLocations($loadedUser->getVersionInfo()->getContentInfo());
824
        if (empty($userLocations)) {
825
            throw new BadStateException('user', 'user has no locations, cannot unassign from group');
826
        }
827
828
        if ($loadedGroup->getVersionInfo()->getContentInfo()->mainLocationId === null) {
829
            throw new BadStateException('userGroup', 'user group has no main location or no locations, cannot unassign');
830
        }
831
832
        foreach ($userLocations as $userLocation) {
833
            if ($userLocation->parentLocationId == $loadedGroup->getVersionInfo()->getContentInfo()->mainLocationId) {
834
                // Throw this specific BadState when we know argument is valid
835
                if (count($userLocations) === 1) {
836
                    throw new BadStateException('user', 'user only has one user group, cannot unassign from last group');
837
                }
838
839
                $this->repository->beginTransaction();
840
                try {
841
                    $locationService->deleteLocation($userLocation);
842
                    $this->repository->commit();
843
844
                    return;
845
                } catch (Exception $e) {
846
                    $this->repository->rollback();
847
                    throw $e;
848
                }
849
            }
850
        }
851
852
        throw new InvalidArgumentException('userGroup', 'user is not in the given user group');
853
    }
854
855
    /**
856
     * Loads the user groups the user belongs to.
857
     *
858
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed read the user or user group
859
     *
860
     * @param \eZ\Publish\API\Repository\Values\User\User $user
861
     * @param int $offset the start offset for paging
862
     * @param int $limit the number of user groups returned
863
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
864
     *
865
     * @return \eZ\Publish\API\Repository\Values\User\UserGroup[]
866
     */
867
    public function loadUserGroupsOfUser(APIUser $user, $offset = 0, $limit = 25, array $prioritizedLanguages = [])
868
    {
869
        $locationService = $this->repository->getLocationService();
870
871
        if (!$this->repository->getPermissionResolver()->canUser('content', 'read', $user)) {
872
            throw new UnauthorizedException('content', 'read');
873
        }
874
875
        $userLocations = $locationService->loadLocations(
876
            $user->getVersionInfo()->getContentInfo()
877
        );
878
879
        $parentLocationIds = array();
880
        foreach ($userLocations as $userLocation) {
881
            if ($userLocation->parentLocationId !== null) {
882
                $parentLocationIds[] = $userLocation->parentLocationId;
883
            }
884
        }
885
886
        $searchQuery = new LocationQuery();
887
888
        $searchQuery->offset = $offset;
889
        $searchQuery->limit = $limit;
890
        $searchQuery->performCount = false;
891
892
        $searchQuery->filter = new CriterionLogicalAnd(
893
            [
894
                new CriterionContentTypeId($this->settings['userGroupClassID']),
895
                new CriterionLocationId($parentLocationIds),
896
            ]
897
        );
898
899
        $searchResult = $this->repository->getSearchService()->findLocations($searchQuery);
900
901
        $userGroups = [];
902 View Code Duplication
        foreach ($searchResult->searchHits as $resultItem) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
903
            $userGroups[] = $this->buildDomainUserGroupObject(
904
                $this->repository->getContentService()->internalLoadContent(
0 ignored issues
show
Bug introduced by
The method internalLoadContent() does not exist on eZ\Publish\API\Repository\ContentService. Did you maybe mean loadContent()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
905
                    $resultItem->valueObject->contentInfo->id,
0 ignored issues
show
Documentation introduced by
The property contentInfo does not exist on object<eZ\Publish\API\Re...ory\Values\ValueObject>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
906
                    $prioritizedLanguages
907
                )
908
            );
909
        }
910
911
        return $userGroups;
912
    }
913
914
    /**
915
     * Loads the users of a user group.
916
     *
917
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to read the users or user group
918
     *
919
     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $userGroup
920
     * @param int $offset the start offset for paging
921
     * @param int $limit the number of users returned
922
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
923
     *
924
     * @return \eZ\Publish\API\Repository\Values\User\User[]
925
     */
926
    public function loadUsersOfUserGroup(
927
        APIUserGroup $userGroup,
928
        $offset = 0,
929
        $limit = 25,
930
        array $prioritizedLanguages = []
931
    ) {
932
        $loadedUserGroup = $this->loadUserGroup($userGroup->id);
933
934
        if ($loadedUserGroup->getVersionInfo()->getContentInfo()->mainLocationId === null) {
935
            return [];
936
        }
937
938
        $mainGroupLocation = $this->repository->getLocationService()->loadLocation(
939
            $loadedUserGroup->getVersionInfo()->getContentInfo()->mainLocationId
940
        );
941
942
        $searchQuery = new LocationQuery();
943
944
        $searchQuery->filter = new CriterionLogicalAnd(
945
            [
946
                new CriterionContentTypeId($this->settings['userClassID']),
947
                new CriterionParentLocationId($mainGroupLocation->id),
948
            ]
949
        );
950
951
        $searchQuery->offset = $offset;
952
        $searchQuery->limit = $limit;
953
        $searchQuery->performCount = false;
954
        $searchQuery->sortClauses = $mainGroupLocation->getSortClauses();
0 ignored issues
show
Documentation Bug introduced by
It seems like $mainGroupLocation->getSortClauses() of type array<integer,object,{"0":"object"}> is incompatible with the declared type array<integer,object<eZ\...tent\Query\SortClause>> of property $sortClauses.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
955
956
        $searchResult = $this->repository->getSearchService()->findLocations($searchQuery);
957
958
        $users = [];
959
        foreach ($searchResult->searchHits as $resultItem) {
960
            $users[] = $this->buildDomainUserObject(
961
                $this->userHandler->load($resultItem->valueObject->contentInfo->id),
0 ignored issues
show
Documentation introduced by
The property contentInfo does not exist on object<eZ\Publish\API\Re...ory\Values\ValueObject>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
962
                $this->repository->getContentService()->internalLoadContent(
0 ignored issues
show
Bug introduced by
The method internalLoadContent() does not exist on eZ\Publish\API\Repository\ContentService. Did you maybe mean loadContent()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
963
                    $resultItem->valueObject->contentInfo->id,
0 ignored issues
show
Documentation introduced by
The property contentInfo does not exist on object<eZ\Publish\API\Re...ory\Values\ValueObject>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
964
                    $prioritizedLanguages
965
                )
966
            );
967
        }
968
969
        return $users;
970
    }
971
972
    /**
973
     * Instantiate a user create class.
974
     *
975
     * @param string $login the login of the new user
976
     * @param string $email the email of the new user
977
     * @param string $password the plain password of the new user
978
     * @param string $mainLanguageCode the main language for the underlying content object
979
     * @param \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType 5.x the content type for the underlying content object. In 4.x it is ignored and taken from the configuration
980
     *
981
     * @return \eZ\Publish\API\Repository\Values\User\UserCreateStruct
982
     */
983
    public function newUserCreateStruct($login, $email, $password, $mainLanguageCode, $contentType = null)
984
    {
985
        if ($contentType === null) {
986
            $contentType = $this->repository->getContentTypeService()->loadContentType(
987
                $this->settings['userClassID']
988
            );
989
        }
990
991
        return new UserCreateStruct(
992
            array(
993
                'contentType' => $contentType,
994
                'mainLanguageCode' => $mainLanguageCode,
995
                'login' => $login,
996
                'email' => $email,
997
                'password' => $password,
998
                'enabled' => true,
999
                'fields' => array(),
1000
            )
1001
        );
1002
    }
1003
1004
    /**
1005
     * Instantiate a user group create class.
1006
     *
1007
     * @param string $mainLanguageCode The main language for the underlying content object
1008
     * @param null|\eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType 5.x the content type for the underlying content object. In 4.x it is ignored and taken from the configuration
1009
     *
1010
     * @return \eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct
1011
     */
1012
    public function newUserGroupCreateStruct($mainLanguageCode, $contentType = null)
1013
    {
1014
        if ($contentType === null) {
1015
            $contentType = $this->repository->getContentTypeService()->loadContentType(
1016
                $this->settings['userGroupClassID']
1017
            );
1018
        }
1019
1020
        return new UserGroupCreateStruct(
1021
            array(
1022
                'contentType' => $contentType,
1023
                'mainLanguageCode' => $mainLanguageCode,
1024
                'fields' => array(),
1025
            )
1026
        );
1027
    }
1028
1029
    /**
1030
     * Instantiate a new user update struct.
1031
     *
1032
     * @return \eZ\Publish\API\Repository\Values\User\UserUpdateStruct
1033
     */
1034
    public function newUserUpdateStruct()
1035
    {
1036
        return new UserUpdateStruct();
1037
    }
1038
1039
    /**
1040
     * Instantiate a new user group update struct.
1041
     *
1042
     * @return \eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct
1043
     */
1044
    public function newUserGroupUpdateStruct()
1045
    {
1046
        return new UserGroupUpdateStruct();
1047
    }
1048
1049
    /**
1050
     * Builds the domain UserGroup object from provided Content object.
1051
     *
1052
     * @param \eZ\Publish\API\Repository\Values\Content\Content $content
1053
     *
1054
     * @return \eZ\Publish\API\Repository\Values\User\UserGroup
1055
     */
1056
    protected function buildDomainUserGroupObject(APIContent $content)
1057
    {
1058
        $locationService = $this->repository->getLocationService();
1059
1060
        $subGroupCount = 0;
1061
        if ($content->getVersionInfo()->getContentInfo()->mainLocationId !== null) {
1062
            $mainLocation = $locationService->loadLocation(
1063
                $content->getVersionInfo()->getContentInfo()->mainLocationId
1064
            );
1065
            $parentLocation = $locationService->loadLocation($mainLocation->parentLocationId);
1066
            $subGroups = $this->searchSubGroups($mainLocation, 0, 0);
1067
            $subGroupCount = $subGroups->totalCount;
1068
        }
1069
1070
        return new UserGroup(
1071
            array(
1072
                'content' => $content,
1073
                'parentId' => isset($parentLocation) ? $parentLocation->contentId : null,
1074
                'subGroupCount' => $subGroupCount,
1075
            )
1076
        );
1077
    }
1078
1079
    /**
1080
     * Builds the domain user object from provided persistence user object.
1081
     *
1082
     * @param \eZ\Publish\SPI\Persistence\User $spiUser
1083
     * @param \eZ\Publish\API\Repository\Values\Content\Content|null $content
1084
     * @param string[] $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
1085
     *
1086
     * @return \eZ\Publish\API\Repository\Values\User\User
1087
     */
1088
    protected function buildDomainUserObject(
1089
        SPIUser $spiUser,
1090
        APIContent $content = null,
1091
        array $prioritizedLanguages = []
1092
    ) {
1093
        if ($content === null) {
1094
            $content = $this->repository->getContentService()->internalLoadContent(
0 ignored issues
show
Bug introduced by
The method internalLoadContent() does not exist on eZ\Publish\API\Repository\ContentService. Did you maybe mean loadContent()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
1095
                $spiUser->id,
1096
                $prioritizedLanguages
1097
            );
1098
        }
1099
1100
        return new User(
1101
            array(
1102
                'content' => $content,
1103
                'login' => $spiUser->login,
1104
                'email' => $spiUser->email,
1105
                'passwordHash' => $spiUser->passwordHash,
1106
                'hashAlgorithm' => (int)$spiUser->hashAlgorithm,
1107
                'enabled' => $spiUser->isEnabled,
1108
                'maxLogin' => (int)$spiUser->maxLogin,
1109
            )
1110
        );
1111
    }
1112
1113
    /**
1114
     * Verifies if the provided login and password are valid.
1115
     *
1116
     * @param string $login User login
1117
     * @param string $password User password
1118
     * @param \eZ\Publish\SPI\Persistence\User $spiUser Loaded user handler
1119
     *
1120
     * @return bool return true if the login and password are sucessfully
1121
     * validate and false, if not.
1122
     */
1123
    protected function verifyPassword($login, $password, $spiUser)
1124
    {
1125
        // In case of bcrypt let php's password functionality do it's magic
1126
        if ($spiUser->hashAlgorithm === User::PASSWORD_HASH_BCRYPT ||
1127
            $spiUser->hashAlgorithm === User::PASSWORD_HASH_PHP_DEFAULT) {
1128
            return password_verify($password, $spiUser->passwordHash);
1129
        }
1130
1131
        // Randomize login time to protect against timing attacks
1132
        usleep(mt_rand(0, 30000));
1133
1134
        $passwordHash = $this->createPasswordHash(
1135
            $login,
1136
            $password,
1137
            $this->settings['siteName'],
1138
            $spiUser->hashAlgorithm
1139
        );
1140
1141
        return $passwordHash === $spiUser->passwordHash;
1142
    }
1143
1144
    /**
1145
     * Returns password hash based on user data and site settings.
1146
     *
1147
     * @param string $login User login
1148
     * @param string $password User password
1149
     * @param string $site The name of the site
1150
     * @param int $type Type of password to generate
1151
     *
1152
     * @return string Generated password hash
1153
     */
1154
    protected function createPasswordHash($login, $password, $site, $type)
1155
    {
1156
        switch ($type) {
1157
            case User::PASSWORD_HASH_MD5_PASSWORD:
1158
                return md5($password);
1159
1160
            case User::PASSWORD_HASH_MD5_USER:
1161
                return md5("$login\n$password");
1162
1163
            case User::PASSWORD_HASH_MD5_SITE:
1164
                return md5("$login\n$password\n$site");
1165
1166
            case User::PASSWORD_HASH_PLAINTEXT:
1167
                return $password;
1168
1169
            case User::PASSWORD_HASH_BCRYPT:
1170
                return password_hash($password, PASSWORD_BCRYPT);
1171
1172
            case User::PASSWORD_HASH_PHP_DEFAULT:
1173
                return password_hash($password, PASSWORD_DEFAULT);
1174
1175
            default:
1176
                return md5($password);
1177
        }
1178
    }
1179
}
1180