README

Gatekeeper提供了一组规则，用于控制对定义功能的访问。为了便于设置和使用，已将依赖项保持到最低，无需数据库存储，同时仍然可以从数据库、json文件等轻松配置。

目前它包含以下规则（尽管也很容易添加您自己的规则）

$rule_config = [
    'website_overhaul' => [
        // turn the site overhaul on for a few specific users
        [
            'type'   => \Behance\NBD\Gatekeeper\Rules\IdentifierRule::RULE_NAME,
            'params' => [
                'valid_identifiers' => [
                    123, // admin 1 user id
                    456, // admin 2 user id
                ]
            ]
        ],
        // roll out the new site to 10% of users (users who see it will remain consistent)
        [
            'type'   => \Behance\NBD\Gatekeeper\Rules\AuthenticatedPercentageRule::RULE_NAME,
            'params' => [
                'percentage' => 10
            ]
        ],
    ],
    'welcome_text' => [
        // allow everyone to see this feature
        [
            'type'   => \Behance\NBD\Gatekeeper\Rules\BinaryRule::RULE_NAME,
            'params' => [
                'on' => true
            ]
        ],
    ]
];

$ruleset_provider = new \Behance\NBD\Gatekeeper\RulesetProviders\ConfigRulesetProvider( $rule_config );

$gatekeeper       = new \Behance\NBD\Gatekeeper\Gatekeeper( $ruleset_provider );

// This can be any kind of identifier. the percentage rule hashes it consistently
// so the same user identifiers are always allowed/disallowed into the test.
// Here we use an "authenticated" identifier because we're dealing with a user id.
$identifier = [
    'authenticated' => 456
];

if ( $gatekeeper->canAccess( 'welcome_text', $identifier ) ) {

   echo "<p>Welcome to the website.</p>";

}

if ( $gatekeeper->canAccess( 'website_overhaul', $identifier ) ) {

   echo "<p>Congrats! You get to see the awesome new site!</p>";

}
else {

   echo "<p>Looks like you're stuck with the old stuff...</p>";

}

更高级用法

StartTimeRule与IpRangeRule的组合

$rule_config = [
    'special_secret_stuff' => [
        // turn the stuff for the admin users
        [
            'type'   => \Behance\NBD\Gatekeeper\Rules\IdentifierRule::RULE_NAME,
            'params' => [
                'valid_identifiers' => [
                    123, // admin 1 user id
                    456, // admin 2 user id
                ]
            ]
        ],
        // turn on the stuff right away for a range of IPs (ex. your office)
        [
            'type'   => \Behance\NBD\Gatekeeper\Rules\IpRangeRule::RULE_NAME,
            'params' => [
                'start_ip' => '192.168.56.101',
                'end_ip'   => '192.168.56.105',
            ]
        ],
        // let everyone see the stuff starting in 2017
        [
            'type'   => \Behance\NBD\Gatekeeper\Rules\StartTimeRule::RULE_NAME,
            'params' => [
                'start' => new DateTimeImmutable('2017-01-01')
            ]
        ],
    ]
];

$ruleset_provider = new \Behance\NBD\Gatekeeper\RulesetProviders\ConfigRulesetProvider( $rule_config );

$gatekeeper       = new \Behance\NBD\Gatekeeper\Gatekeeper( $ruleset_provider );

$identifier = [
    'ip'            => $_SERVER['REMOTE_ADDR'],
    'authenticated' => 678, // not an admin, so has to be in IP range or it must be 2017 for access to be granted
];

if ( $gatekeeper->canAccess( 'special_secret_stuff', $identifier ) ) {

   echo "<p>You get to see the secret stuff!</p>";

}
else {

   echo "<p>There's nothing here to see...</p>";

}

许可证

nbd.php-gatekeeper采用MIT许可证。有关更多信息，请参阅许可证文件。

贡献

有关信息，请参阅CONTRIBUTING.md。