Documentation

Checklist
in package
Uses UtilsProvider

Checklist handler.

Table of Contents

Constants

ITEMS_ORDERED  = [\DevOwl\RealCookieBanner\view\checklist\Install::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\Install::class, \DevOwl\RealCookieBanner\view\checklist\License::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\License::class, \DevOwl\RealCookieBanner\view\checklist\GetPro::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\GetPro::class, \DevOwl\RealCookieBanner\view\checklist\SaveSettings::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\SaveSettings::class, \DevOwl\RealCookieBanner\view\checklist\PrivacyPolicy::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\PrivacyPolicy::class, \DevOwl\RealCookieBanner\view\checklist\OperatorContact::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\OperatorContact::class, \DevOwl\RealCookieBanner\view\checklist\PrivacyPolicyMentionUsage::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\PrivacyPolicyMentionUsage::class, \DevOwl\RealCookieBanner\view\checklist\Scanner::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\Scanner::class, \DevOwl\RealCookieBanner\view\checklist\AddCookie::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\AddCookie::class, \DevOwl\RealCookieBanner\view\checklist\CustomizeBanner::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\CustomizeBanner::class, \DevOwl\RealCookieBanner\view\checklist\AddBlocker::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\AddBlocker::class, \DevOwl\RealCookieBanner\view\checklist\ActivateBanner::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\ActivateBanner::class, \DevOwl\RealCookieBanner\view\checklist\Shortcode::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\Shortcode::class, \DevOwl\RealCookieBanner\view\checklist\ViewStats::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\ViewStats::class]

Properties

$me  : Checklist
Singleton instance.

Methods

getInstance()  : mixed
Get singleton instance.
getPluginConstantPrefix()  : string
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
isAllChecked()  : bool
Check if all items are checked through "I have already done all the steps".
isChecked()  : bool
Check if any of items is checked
isCompleted()  : mixed
Check if the checklist is completed.
isOverdue()  : mixed
Check if the checklist is not completed yet and is overdue e.g. 2 weeks.
result()  : mixed
Get current checklist result.
toggle()  : bool
Toggle a checklist item checked state. If you pass 'all' as ID, all checkbox items will be marked as checked.
__construct()  : mixed
C'tor.

Constants

ITEMS_ORDERED

public mixed ITEMS_ORDERED = [\DevOwl\RealCookieBanner\view\checklist\Install::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\Install::class, \DevOwl\RealCookieBanner\view\checklist\License::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\License::class, \DevOwl\RealCookieBanner\view\checklist\GetPro::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\GetPro::class, \DevOwl\RealCookieBanner\view\checklist\SaveSettings::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\SaveSettings::class, \DevOwl\RealCookieBanner\view\checklist\PrivacyPolicy::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\PrivacyPolicy::class, \DevOwl\RealCookieBanner\view\checklist\OperatorContact::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\OperatorContact::class, \DevOwl\RealCookieBanner\view\checklist\PrivacyPolicyMentionUsage::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\PrivacyPolicyMentionUsage::class, \DevOwl\RealCookieBanner\view\checklist\Scanner::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\Scanner::class, \DevOwl\RealCookieBanner\view\checklist\AddCookie::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\AddCookie::class, \DevOwl\RealCookieBanner\view\checklist\CustomizeBanner::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\CustomizeBanner::class, \DevOwl\RealCookieBanner\view\checklist\AddBlocker::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\AddBlocker::class, \DevOwl\RealCookieBanner\view\checklist\ActivateBanner::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\ActivateBanner::class, \DevOwl\RealCookieBanner\view\checklist\Shortcode::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\Shortcode::class, \DevOwl\RealCookieBanner\view\checklist\ViewStats::IDENTIFIER => \DevOwl\RealCookieBanner\view\checklist\ViewStats::class]

Properties

Methods

getInstance()

Get singleton instance.

public static getInstance() : mixed
Tags
codeCoverageIgnore

getPluginConstantPrefix()

Get the prefix of this plugin so composer packages can dynamically build other constant values on it.

public getPluginConstantPrefix() : string
Tags
codeCoverageIgnore

It only returns a string with the constant prefix

Return values
string

isAllChecked()

Check if all items are checked through "I have already done all the steps".

public isAllChecked() : bool
Return values
bool

isChecked()

Check if any of items is checked

public isChecked(string $identifier) : bool
Parameters
$identifier : string

One of the ITEMS_ORDERED

Return values
bool

isCompleted()

Check if the checklist is completed.

public isCompleted() : mixed

isOverdue()

Check if the checklist is not completed yet and is overdue e.g. 2 weeks.

public isOverdue(string $time) : mixed
Parameters
$time : string

E.g. +2 weeks

result()

Get current checklist result.

public result() : mixed

toggle()

Toggle a checklist item checked state. If you pass 'all' as ID, all checkbox items will be marked as checked.

public toggle(string $id, bool $state) : bool
Parameters
$id : string
$state : bool
Return values
bool

__construct()

C'tor.

private __construct() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results