Gianism API | takahashifumiki.com
\
Gianism
Service
Common
Cron
Helper
Pattern

\Gianism\ServiceFacebook

Description of facebook_controller

Summary

Methods
Properties
Constants
disconnect()
handle_publish()
handle_admin()
get_publish_permission_link()
get_admin_connect_link()
update_facebook_admin()
is_user_like_me_on_fangate()
is_registered_user_on_fangate()
is_guest_on_fangate()
is_fangate()
mail_owner()
id_owner()
fan_gate_helper()
print_script()
is_connected()
get_facebook_id()
get_user_mail()
set_user_mail()
set_user_id()
__get()
set_option()
is_pseudo_mail()
parse_request()
handle_login()
profile_connect()
connection_message()
login_form()
filter_link()
button()
login_button()
connect_button()
disconnect_button()
user_can_register()
get_instance()
_()
e()
get()
post()
request()
nonce_action()
nonce_create()
nonce_field()
verify_nonce()
is_ssl_required()
is_enabled()
get_meta_owner()
get_service_instance()
$verbose_service_name
$umeta_id
$umeta_mail
$umeta_token
$url_prefix
$message_key_name
$cert_path
$api
$admin
$admin_id
$admin_account
$admin_pages
$service_name
$enabled
$dir
$url
$all_services
$nonce_key_name
No constants found
init_action()
get_api_url()
handle_default()
__construct()
handle_connect()
handle_disconnect()
get_redirect_to()
get_action()
filter_redirect()
get_redirect_endpoint()
is_smartphone()
hook_connect()
hook_disconnect()
user_password_unknown()
valid_username_from_mail()
api_error_string()
duplicate_account_string()
welcome()
auth_fail()
mail_fail_string()
registration_error_string()
kill_wrong_access()
test_user_can_register()
get_response()
add_message()
wp_die()
session_write()
session_get()
session_delete()
$fb_app_id
$fb_app_secret
$fb_fan_gate
$fb_use_api
$option_keys
$name
$version
$domain
N/A
signed_request()
$_signed_request
$instances
$_all_services
N/A

Properties

$verbose_service_name

$verbose_service_name : string

Verbose service name

If not set, $this->service_name will be used;

Type

string

$umeta_id

$umeta_id : string

Meta key of usermeta for facebook id

Type

string

$umeta_mail

$umeta_mail : string

Meta key of usermeta for facebook mail

Type

string

$umeta_token

$umeta_token : string

Meta key of usermeta for Facebook access token

Type

string

$url_prefix

$url_prefix : string

URL prefix

If this property is empty, service name will be used. e.g. http://example.jp/facebook/

Type

string

$message_key_name

$message_key_name : string

Message post type

Type

string

$cert_path

$cert_path : string

Path to cert file.

Type

string

$api

$api : \Facebook

Facebook object

Type

\Facebook

$admin

$admin : \Facebook|\WP_Error

Facebook object for Admin Use

Type

\Facebook|\WP_Error

$admin_id

$admin_id : int

Type

int

$admin_account

$admin_account : array|false

Type

array|false

$admin_pages

$admin_pages : array

Type

array

$service_name

$service_name : string

Type

string

$enabled

$enabled : bool

Type

bool

$dir

$dir : string

Type

string

$url

$url : string

Type

string

$all_services

$all_services : array

Type

array

$nonce_key_name

$nonce_key_name : string

Type

string

$fb_app_id

$fb_app_id : string

Facebook application ID

Type

string

$fb_app_secret

$fb_app_secret : string

Facebook application secret

Type

string

$fb_fan_gate

$fb_fan_gate : int

Page ID of Fan gate.

Type

int

$fb_use_api

$fb_use_api : bool

Whether if use global setting

Type

bool

$option_keys

$option_keys : array

Option key to retrieve

Type

array

$name

$name : string

Name

Used for option key, nonce, etc.

Type

string

$version

$version : string

Version number

Type

string

$domain

$domain : string

i18n Domain

Type

string

$_signed_request

$_signed_request : array

Type

array

$instances

$instances : \Gianism\Singleton

Instance holder

Type

\Gianism\Singleton

$_all_services

$_all_services : array

All services

Type

array

Methods

disconnect()

disconnect(int $user_id) : mixed

Disconnect user from this service

Parameters

int $user_id

Returns

mixed

handle_publish()

handle_publish(\WP_Query $wp_query)

Handle publish action

Parameters

\WP_Query $wp_query

handle_admin()

handle_admin(\WP_Query $wp_query)

Parameters

\WP_Query $wp_query

get_publish_permission_link()

get_publish_permission_link(string $redirect_url, string $action, array $args) : string

Returns login url which get additional permission

Parameters

string $redirect_url
string $action

This action hook will booted.
array $args

Additional key-value

Returns

string

get_admin_connect_link()

get_admin_connect_link(bool $require_publish) : string

Get admin connect link

Parameters

bool $require_publish

Returns

string

update_facebook_admin()

update_facebook_admin()

Update admin account id.

is_user_like_me_on_fangate()

is_user_like_me_on_fangate() : bool

Returns if user like my page. Only available on Facebook Tab page or application.

Returns

bool

is_registered_user_on_fangate()

is_registered_user_on_fangate() : int

Returns if current facebook user is wordpress registered user.

If current Facebook user is registerd on your WordPress, returns user ID on WordPress.

Returns

int

is_guest_on_fangate()

is_guest_on_fangate() : boolean

Return true if current user is not logged in Facebook

Returns

boolean

is_fangate()

is_fangate() : bool

Returns if current page is fan gate.

Returns

bool

mail_owner()

mail_owner(string $email) : int

Return user id of email if exists

Parameters

string $email

Returns

int

id_owner()

id_owner(string $fb_id) : int

Returns user id with facebook id

Parameters

string $fb_id

Returns

int

fan_gate_helper()

fan_gate_helper()

Initialize Facebook Fangate Scripts

print_script()

print_script() : void

Print JS on footer of both admin panel and public page.

Paramater 'js' should be true and if 'js' is 'no-fb-root', div#fb-root won't be displayed.

is_connected()

is_connected(int $user_id) : bool

Detect if user is connected to this service

Parameters

int $user_id

Returns

bool

get_facebook_id()

get_facebook_id(int $wp_user_id) : int

Returns User's Facebook ID

Parameters

int $wp_user_id

Returns

int

get_user_mail()

get_user_mail(int $wp_user_id) : string

Returns Facebook mail

Parameters

int $wp_user_id

Returns

string

set_user_mail()

set_user_mail(string $mail, int $user_id) : void

Save Facebook Mail

Parameters

string $mail
int $user_id

set_user_id()

set_user_id(string $fb_user_id, int $wp_user_id) : void

Save Facebook ID

Parameters

string $fb_user_id
int $wp_user_id

__get()

__get(string $name) : mixed

Getter

Parameters

string $name

Returns

mixed

set_option()

set_option() : void

Setup default option

is_pseudo_mail()

is_pseudo_mail(string $mail) : bool

This controller reutrn always false

Parameters

string $mail

Returns

bool

parse_request()

parse_request(string $action, \WP_Query $wp_query) : void

Called on redirect endpoint

Parameters

string $action
\WP_Query $wp_query

handle_login()

handle_login(\WP_Query $wp_query)

Make user login

Parameters

\WP_Query $wp_query

profile_connect()

profile_connect(\WP_User $user) : void

Show connect button on profile page

Parameters

\WP_User $user

connection_message()

connection_message(string $context) : string

Connection message

Overriding this function, you can customize connection message

Parameters

string $context

Returns

string

login_form()

login_form(boolean $is_register) : void

Display login buttons

Parameters

boolean $is_register

filter_link()

filter_link(string $markup, string $href, string $text, bool $is_register) : string

Resturns link to filter

Parameters

string $markup
string $href
string $text
bool $is_register

Returns

string

button()

button(string $text, string $href, bool $icon_name, array $class_names, array $attributes) : string

Create common button

Parameters

string $text
string $href
bool $icon_name
array $class_names
array $attributes

Returns

string

login_button()

login_button(string $redirect, bool $register) : string

Show login button

Parameters

string $redirect
bool $register

Returns

string

connect_button()

connect_button(string $redirect_to) : string

Get connect button

Parameters

string $redirect_to

If not set, profile page's URL

Returns

string

disconnect_button()

disconnect_button(string $redirect_to) : string

Get disconnect button

Parameters

string $redirect_to

If not set, profile page's URL

Returns

string

user_can_register()

user_can_register() : bool

Detect if user can register

Returns

bool

get_instance()

get_instance(array $argument) : self

Get instance

Parameters

array $argument

Returns

self

_()

_(string $string) : string

Alias of __

Parameters

string $string

Returns

string

e()

e(string $string)

Alias of _e

Parameters

string $string

get()

get(string $key) : mixed

Return $_GET

Parameters

string $key

Returns

mixed

post()

post(string $key) : mixed

Return $_POST

Parameters

string $key

Returns

mixed

request()

request(string $key) : mixed

return $_REQUEST

Parameters

string $key

Returns

mixed

nonce_action()

nonce_action(string $action) : string

Return nonce name with prefix

Parameters

string $action

Returns

string

nonce_create()

nonce_create(string $action) : string

Parameters

string $action

Returns

string

nonce_field()

nonce_field(string $action, bool $referrer)

Alias of wp_nonce_field

Parameters

string $action
bool $referrer

Default false.

verify_nonce()

verify_nonce(string $action, string $referrer) : boolean

Check nonce

Parameters

string $action
string $referrer

Returns

boolean

is_ssl_required()

is_ssl_required() : boolean

Returns if login is forced to use SSL.

To override it, use filter gianism_force_ssl_login

Returns

boolean

is_enabled()

is_enabled(string $service) : bool

Determine if service is enabled.

Parameters

string $service

If not specified, one of the services are enabled, return true.

Returns

bool

get_meta_owner()

get_meta_owner(string $key, string $value) : int

Retrieve user meta's owner ID

Parameters

string $key
string $value

Returns

int —

User ID. If not exists, return 0

get_service_instance()

get_service_instance(string $service) : null|\Gianism\Service\Common\Mail

Get service instance

Parameters

string $service

Returns

null|\Gianism\Service\Common\Mail

init_action()

init_action() : void

Initialize

If some stuff is required, override this.

get_api_url()

get_api_url(string $action) : string|false

Return api URL to authenticate

If you need additional information (ex. token), use $this->session_write inside.

$this->session_write('token', $token); return $url;

Parameters

string $action

'connect', 'login'

Throws

\Exception

Returns

string|false —

URL to redirect

handle_default()

handle_default(string $action) : void

Handle callback request

This function must exit at last.

Parameters

string $action

__construct()

__construct(array $argument)

Constructor

Parameters

array $argument

handle_connect()

handle_connect(\WP_Query $wp_query)

Handle connect

Parameters

\WP_Query $wp_query

handle_disconnect()

handle_disconnect(\WP_Query $wp_query)

Handle disconnect

Parameters

\WP_Query $wp_query

get_redirect_to()

get_redirect_to(string $default, array $args) : string

Returns redirect to url if set.

Parameters

string $default
array $args

Returns

string

get_action()

get_action() : string

Returns current action name.

Returns

string

filter_redirect()

filter_redirect(string $url, string $context) : string

Filter redirect URL

Parameters

string $url
string $context

login, connect, disconnect

Returns

string

get_redirect_endpoint()

get_redirect_endpoint(string $action, string $nonce_key, array $args) : string

Get URL for immediate endpoint.

Parameters

string $action

'connect', 'disconnect', 'login' or else.
string $nonce_key

If empty, nonce won't be set.
array $args

Returns

string

is_smartphone()

is_smartphone() : boolean

Detect if current client is smartphone.

Returns

boolean

hook_connect()

hook_connect(int $user_id, mixed $data, bool $on_creation)

Fires connect hook

Parameters

int $user_id
mixed $data
bool $on_creation

hook_disconnect()

hook_disconnect(mixed $user_id)

Fires disconnect hook

Parameters

mixed $user_id

user_password_unknown()

user_password_unknown(int $user_id)

Use's password is automatically generated

Parameters

int $user_id

valid_username_from_mail()

valid_username_from_mail(string $email) : string

Create valid username from email address

Parameters

string $email

Throws

\Exception

Returns

string

api_error_string()

api_error_string() : string

Returns API error string

Returns

string

duplicate_account_string()

duplicate_account_string() : string

Message account duplication

Returns

string

welcome()

welcome(string $who)

Add welcome message

Parameters

string $who

auth_fail()

auth_fail(string $message)

Add error message

Parameters

string $message

mail_fail_string()

mail_fail_string() : string

Add error message

Returns

string

registration_error_string()

registration_error_string() : string

Registration error string

Returns

string

kill_wrong_access()

kill_wrong_access()

Kill wrong access

test_user_can_register()

test_user_can_register() : bool

Test if can register.

Throws

\Exception

Returns

bool

get_response()

get_response(string $endpoint, string|array $request, string $method, bool $json, array $additional_headers) : array|\stdClass|bool|null

Get Request

Parameters

string $endpoint
string|array $request
string $method

If x-www-form-urlencoded required, pass array or else, pass query string.
bool $json

if this request is JSON
array $additional_headers

Additional headers.

Returns

array|\stdClass|bool|null

add_message()

add_message(string $string, bool $error)

Add message to show

Parameters

string $string
bool $error

wp_die()

wp_die(string $message, int $status_code, bool $return)

Short hand for wp_die

Parameters

string $message
int $status_code
bool $return

session_write()

session_write(string $key, mixed $value)

Write session

Parameters

string $key
mixed $value

session_get()

session_get(string $key) : bool

Get session

After get, session key will be deleted.

Parameters

string $key

Returns

bool

session_delete()

session_delete(string $key)

Delete session

Parameters

string $key

signed_request()

signed_request(string $key) : string

Get signed request

Parameters

string $key

Returns

string