Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Admin\Roles

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Abstract Role Manager template.

[8] Fix | Delete

[9] Fix | Delete

abstract class WPSEO_Abstract_Role_Manager implements WPSEO_Role_Manager {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Registered roles.

[13] Fix | Delete

[14] Fix | Delete

* @var array

[15] Fix | Delete

[16] Fix | Delete

protected $roles = [];

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Registers a role.

[20] Fix | Delete

[21] Fix | Delete

* @param string $role Role to register.

[22] Fix | Delete

* @param string $display_name Display name to use.

[23] Fix | Delete

* @param string|null $template Optional. Role to base the new role on.

[24] Fix | Delete

[25] Fix | Delete

* @return void

[26] Fix | Delete

[27] Fix | Delete

public function register( $role, $display_name, $template = null ) {

[28] Fix | Delete

$this->roles[ $role ] = (object) [

[29] Fix | Delete

'display_name' => $display_name,

[30] Fix | Delete

'template' => $template,

[31] Fix | Delete

];

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Returns the list of registered roles.

[36] Fix | Delete

[37] Fix | Delete

* @return string[] List or registered roles.

[38] Fix | Delete

[39] Fix | Delete

public function get_roles() {

[40] Fix | Delete

return array_keys( $this->roles );

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Adds the registered roles.

[45] Fix | Delete

[46] Fix | Delete

* @return void

[47] Fix | Delete

[48] Fix | Delete

public function add() {

[49] Fix | Delete

foreach ( $this->roles as $role => $data ) {

[50] Fix | Delete

$capabilities = $this->get_capabilities( $data->template );

[51] Fix | Delete

$capabilities = $this->filter_existing_capabilties( $role, $capabilities );

[52] Fix | Delete

[53] Fix | Delete

$this->add_role( $role, $data->display_name, $capabilities );

[54] Fix | Delete

}

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Removes the registered roles.

[59] Fix | Delete

[60] Fix | Delete

* @return void

[61] Fix | Delete

[62] Fix | Delete

public function remove() {

[63] Fix | Delete

$roles = array_keys( $this->roles );

[64] Fix | Delete

array_map( [ $this, 'remove_role' ], $roles );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Returns the capabilities for the specified role.

[69] Fix | Delete

[70] Fix | Delete

* @param string $role Role to fetch capabilities from.

[71] Fix | Delete

[72] Fix | Delete

* @return array List of capabilities.

[73] Fix | Delete

[74] Fix | Delete

protected function get_capabilities( $role ) {

[75] Fix | Delete

if ( ! is_string( $role ) || empty( $role ) ) {

[76] Fix | Delete

return [];

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

$wp_role = get_role( $role );

[80] Fix | Delete

if ( ! $wp_role ) {

[81] Fix | Delete

return [];

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

return $wp_role->capabilities;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Returns true if the capability exists on the role.

[89] Fix | Delete

[90] Fix | Delete

* @param WP_Role $role Role to check capability against.

[91] Fix | Delete

* @param string $capability Capability to check.

[92] Fix | Delete

[93] Fix | Delete

* @return bool True if the capability is defined for the role.

[94] Fix | Delete

[95] Fix | Delete

protected function capability_exists( WP_Role $role, $capability ) {

[96] Fix | Delete

return ! array_key_exists( $capability, $role->capabilities );

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Filters out capabilities that are already set for the role.

[101] Fix | Delete

[102] Fix | Delete

* This makes sure we don't override configurations that have been previously set.

[103] Fix | Delete

[104] Fix | Delete

* @param string $role The role to check against.

[105] Fix | Delete

* @param array $capabilities The capabilities that should be set.

[106] Fix | Delete

[107] Fix | Delete

* @return array Capabilties that can be safely set.

[108] Fix | Delete

[109] Fix | Delete

protected function filter_existing_capabilties( $role, array $capabilities ) {

[110] Fix | Delete

if ( $capabilities === [] ) {

[111] Fix | Delete

return $capabilities;

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

$wp_role = get_role( $role );

[115] Fix | Delete

if ( ! $wp_role ) {

[116] Fix | Delete

return $capabilities;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

foreach ( $capabilities as $capability => $grant ) {

[120] Fix | Delete

if ( $this->capability_exists( $wp_role, $capability ) ) {

[121] Fix | Delete

unset( $capabilities[ $capability ] );

[122] Fix | Delete

}

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

return $capabilities;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

/**

[129] Fix | Delete

* Adds a role to the system.

[130] Fix | Delete

[131] Fix | Delete

* @param string $role Role to add.

[132] Fix | Delete

* @param string $display_name Name to display for the role.

[133] Fix | Delete

* @param array $capabilities Capabilities to add to the role.

[134] Fix | Delete

[135] Fix | Delete

* @return void

[136] Fix | Delete

[137] Fix | Delete

abstract protected function add_role( $role, $display_name, array $capabilities = [] );

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Removes a role from the system.

[141] Fix | Delete

[142] Fix | Delete

* @param string $role Role to remove.

[143] Fix | Delete

[144] Fix | Delete

* @return void

[145] Fix | Delete

[146] Fix | Delete

abstract protected function remove_role( $role );

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete