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

\GianismBootstrap

Main controller of Gianism

This controller initialize Gianism.

Summary

Methods
Properties
Constants
rewrite_rules_array()
check_rewirte()
hijack_query()
notice_about_session()
register_assets()
enqueue_global_assets()
enqueue_admin_assets()
get_instance()
_()
e()
get()
post()
request()
nonce_action()
nonce_create()
nonce_field()
verify_nonce()
is_ssl_required()
is_enabled()
__get()
get_meta_owner()
get_service_instance()
user_can_register()
$message_key_name
$dir
$url
$all_services
$nonce_key_name
No constants found
__construct()
add_message()
wp_die()
session_write()
session_get()
session_delete()
$name
$version
$domain
N/A
No private methods found
$rewrites
$prefixes
$instances
$_all_services
N/A

Properties

$message_key_name

$message_key_name : string

Message post type

Type

string

$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

$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

$rewrites

$rewrites : array

Rewrite rules.

Initialized on constructor

Type

array

$prefixes

$prefixes : array

URL prefixes

Type

array

$instances

$instances : \Gianism\Singleton

Instance holder

Type

\Gianism\Singleton

$_all_services

$_all_services : array

All services

Type

array

Methods

rewrite_rules_array()

rewrite_rules_array(array $rules) : array

Customize rewrite rules

Parameters

array $rules

Returns

array

check_rewirte()

check_rewirte()

Check rewrite rules and flush if required

hijack_query()

hijack_query(\WP_Query $wp_query)

If endpoint matched, do parse request.

Parameters

\WP_Query $wp_query

notice_about_session()

notice_about_session()

Notice about session

register_assets()

register_assets()

Register assets

enqueue_global_assets()

enqueue_global_assets()

Enqueue assets for public screen

enqueue_admin_assets()

enqueue_admin_assets()

Enqueue admin scripts

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()

__get(string $name) : mixed

Getter

Parameters

string $name

Returns

mixed

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

user_can_register()

user_can_register() : bool

Detect if user can register

Returns

bool

__construct()

__construct(array $argument)

Constructor

Parameters

array $argument

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