123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 |
- <?php
- /**
- * @package Grav\Common\User
- *
- * @copyright Copyright (c) 2015 - 2022 Trilby Media, LLC. All rights reserved.
- * @license MIT License; see LICENSE file for details.
- */
- namespace Grav\Common\User;
- use Grav\Common\Config\Config;
- use Grav\Common\Data\Blueprints;
- use Grav\Common\Data\Data;
- use Grav\Common\File\CompiledYamlFile;
- use Grav\Common\Grav;
- use Grav\Common\Utils;
- /**
- * @deprecated 1.7 Use $grav['user_groups'] instead of this class. In type hints, please use UserGroupInterface.
- */
- class Group extends Data
- {
- /**
- * Get the groups list
- *
- * @return array
- * @deprecated 1.7, use $grav['user_groups'] Flex UserGroupCollection instead
- */
- protected static function groups()
- {
- user_error(__METHOD__ . '() is deprecated since Grav 1.7, use $grav[\'user_groups\'] Flex UserGroupCollection instead', E_USER_DEPRECATED);
- return Grav::instance()['config']->get('groups', []);
- }
- /**
- * Get the groups list
- *
- * @return array
- * @deprecated 1.7, use $grav['user_groups'] Flex UserGroupCollection instead
- */
- public static function groupNames()
- {
- user_error(__METHOD__ . '() is deprecated since Grav 1.7, use $grav[\'user_groups\'] Flex UserGroupCollection instead', E_USER_DEPRECATED);
- $groups = [];
- foreach (static::groups() as $groupname => $group) {
- $groups[$groupname] = $group['readableName'] ?? $groupname;
- }
- return $groups;
- }
- /**
- * Checks if a group exists
- *
- * @param string $groupname
- * @return bool
- * @deprecated 1.7, use $grav['user_groups'] Flex UserGroupCollection instead
- */
- public static function groupExists($groupname)
- {
- user_error(__METHOD__ . '() is deprecated since Grav 1.7, use $grav[\'user_groups\'] Flex UserGroupCollection instead', E_USER_DEPRECATED);
- return isset(self::groups()[$groupname]);
- }
- /**
- * Get a group by name
- *
- * @param string $groupname
- * @return object
- * @deprecated 1.7, use $grav['user_groups'] Flex UserGroupCollection instead
- */
- public static function load($groupname)
- {
- user_error(__METHOD__ . '() is deprecated since Grav 1.7, use $grav[\'user_groups\'] Flex UserGroupCollection instead', E_USER_DEPRECATED);
- $groups = self::groups();
- $content = $groups[$groupname] ?? [];
- $content += ['groupname' => $groupname];
- $blueprints = new Blueprints();
- $blueprint = $blueprints->get('user/group');
- return new Group($content, $blueprint);
- }
- /**
- * Save a group
- *
- * @return void
- */
- public function save()
- {
- $grav = Grav::instance();
- /** @var Config $config */
- $config = $grav['config'];
- $blueprints = new Blueprints();
- $blueprint = $blueprints->get('user/group');
- $config->set("groups.{$this->get('groupname')}", []);
- $fields = $blueprint->fields();
- foreach ($fields as $field) {
- if ($field['type'] === 'text') {
- $value = $field['name'];
- if (isset($this->items['data'][$value])) {
- $config->set("groups.{$this->get('groupname')}.{$value}", $this->items['data'][$value]);
- }
- }
- if ($field['type'] === 'array' || $field['type'] === 'permissions') {
- $value = $field['name'];
- $arrayValues = Utils::getDotNotation($this->items['data'], $field['name']);
- if ($arrayValues) {
- foreach ($arrayValues as $arrayIndex => $arrayValue) {
- $config->set("groups.{$this->get('groupname')}.{$value}.{$arrayIndex}", $arrayValue);
- }
- }
- }
- }
- $type = 'groups';
- $blueprints = $this->blueprints();
- $filename = CompiledYamlFile::instance($grav['locator']->findResource("config://{$type}.yaml"));
- $obj = new Data($config->get($type), $blueprints);
- $obj->file($filename);
- $obj->save();
- }
- /**
- * Remove a group
- *
- * @param string $groupname
- * @return bool True if the action was performed
- * @deprecated 1.7, use $grav['user_groups'] Flex UserGroupCollection instead
- */
- public static function remove($groupname)
- {
- user_error(__METHOD__ . '() is deprecated since Grav 1.7, use $grav[\'user_groups\'] Flex UserGroupCollection instead', E_USER_DEPRECATED);
- $grav = Grav::instance();
- /** @var Config $config */
- $config = $grav['config'];
- $blueprints = new Blueprints();
- $blueprint = $blueprints->get('user/group');
- $type = 'groups';
- $groups = $config->get($type);
- unset($groups[$groupname]);
- $config->set($type, $groups);
- $filename = CompiledYamlFile::instance($grav['locator']->findResource("config://{$type}.yaml"));
- $obj = new Data($groups, $blueprint);
- $obj->file($filename);
- $obj->save();
- return true;
- }
- }
|