dukt / facebook

src/base/PluginTrait.php

<?php
/**
 * @link      https://dukt.net/facebook/
 * @copyright Copyright (c) Dukt
 * @license   https://github.com/dukt/facebook/blob/master/LICENSE.md
 */

namespace dukt\facebook\base;

use Craft;
use dukt\facebook\Plugin as Facebook;

/**
 * PluginTrait implements the common methods and properties for plugin classes.
 *
 * @property \dukt\facebook\services\Api            $api            The api service
 * @property \dukt\facebook\services\Cache          $cache          The cache service
 * @property \dukt\facebook\services\Oauth          $oauth          The oauth service
 * @property \dukt\facebook\services\Reports        $reports        The reports service
 *
 * @author Dukt <support@dukt.net>
 * @since  2.0
 */
trait PluginTrait
{
    /**
     * Returns the accounts service.
     *
     * @return \dukt\facebook\services\Accounts The accounts service
     */
    public function getAccounts()
    {
        /** @var Facebook $this */
        return $this->get('accounts');

The expression return $this->get('accounts') also could return the type mixed which is incompatible with the documented return type dukt\facebook\services\Accounts.

    }

    /**
     * Returns the api service.
     *
     * @return \dukt\facebook\services\Api The api service
     */
    public function getApi()
    {
        /** @var Facebook $this */
        return $this->get('api');

The expression return $this->get('api') also could return the type mixed which is incompatible with the documented return type dukt\facebook\services\Api.

    }

    /**
     * Returns the cache service.
     *
     * @return \dukt\facebook\services\Cache The cache service
     */
    public function getCache()
    {
        /** @var Facebook $this */
        return $this->get('cache');

The expression return $this->get('cache') also could return the type mixed which is incompatible with the documented return type dukt\facebook\services\Cache.

    }

    /**
     * Returns the oauth service.
     *
     * @return \dukt\facebook\services\Oauth The oauth service
     */
    public function getOauth()
    {
        /** @var Facebook $this */
        return $this->get('oauth');

The expression return $this->get('oauth') also could return the type mixed which is incompatible with the documented return type dukt\facebook\services\Oauth.

    }

    /**
     * Returns the reports service.
     *
     * @return \dukt\facebook\services\Reports The reports service
     */
    public function getReports()
    {
        /** @var Facebook $this */
        return $this->get('reports');

The expression return $this->get('reports') also could return the type mixed which is incompatible with the documented return type dukt\facebook\services\Reports.

    }

    /**
     * Returns `true` if client ID, client secret and token are defined.
     *
     * @return bool
     */
    public function isConfigured()
    {
        $oauthClientId = $this->getClientId();
        $oauthClientSecret = $this->getClientSecret();

        if(!empty($oauthClientId) && !empty($oauthClientSecret))
        {
            $token = Facebook::$plugin->getOauth()->getToken();

            if($token !== null)
            {
                return true;
            }
        }

        return false;
    }

    /**
     * Gets the OAuth client ID
     *
     * @param bool $parse
     * @return bool|mixed|string|null
     */
    public function getClientId(bool $parse = true)
    {
        $clientId = Facebook::$plugin->getSettings()->oauthClientId;

        if (!$clientId) {
            return null;
        }

        return $parse ? Craft::parseEnv($clientId) : $clientId;

The function Craft::parseEnv() has been deprecated: in 3.7.29. [[App::parseEnv()]] should be used instead.

    }

    /**
     * Gets the OAuth client secret
     *
     * @param bool $parse
     * @return bool|mixed|string|null
     */
    public function getClientSecret(bool $parse = true)
    {
        $clientSecret = Facebook::$plugin->getSettings()->oauthClientSecret;

        if (!$clientSecret) {
            return null;
        }

        return $parse ? Craft::parseEnv($clientSecret) : $clientSecret;

The function Craft::parseEnv() has been deprecated: in 3.7.29. [[App::parseEnv()]] should be used instead.

    }
}