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

\Gianism\CronWeekly

Abstract class for google

Summary

Methods
Properties
Constants
build_timestamp()
fetch()
get_results()
do_cron()
__get()
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()
user_can_register()
$message_key_name
$google
$ga
$profile
$view_id
$table
$action
$dir
$url
$all_services
$nonce_key_name
INTERVAL
CATEGORY
SKIP_CRON
__construct()
today()
parse_row()
save()
add_message()
wp_die()
session_write()
session_get()
session_delete()
$time
$name
$version
$domain
N/A
No private methods found
$instances
$_all_services
N/A

Constants

INTERVAL

INTERVAL

Interval for cron

CATEGORY

CATEGORY

Category name for table

SKIP_CRON

SKIP_CRON

If true, cron doesn't work

Properties

$message_key_name

$message_key_name : string

Message post type

Type

string

$google

$google : \Gianism\Service\Google

Type

\Gianism\Service\Google

$ga

$ga : \Google_Service_Analytics

Type

\Google_Service_Analytics

$profile

$profile : array

Type

array

$view_id

$view_id : string

Type

string

$table

$table : string

Type

string

$action

$action : string

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

$time

$time : string

Cron start time

Default is midnite. If you want to change to typical time, override this. This will be converted to GMT.

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

$instances

$instances : \Gianism\Singleton

Instance holder

Type

\Gianism\Singleton

$_all_services

$_all_services : array

All services

Type

array

Methods

build_timestamp()

build_timestamp() : int

Create cron timestamp

Returns

int

fetch()

fetch(string $start_date, string $end_date, string $metrics, array $params) : array

Fetch data from Google Analytics API

Parameters

string $start_date

Date string
string $end_date

Date string
string $metrics

CSV of metrics E.g., 'ga:visits,ga:pageviews'
array $params

Option params below

Returns

array

get_results()

get_results() : array

Get result

Returns

array

do_cron()

do_cron()

Do cron and save data.

__get()

__get(string $name) : mixed

Getter

Parameters

string $name

Returns

mixed

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

user_can_register()

user_can_register() : bool

Detect if user can register

Returns

bool

__construct()

__construct(array $argument)

Constructor

Parameters

array $argument

today()

today() : string

Return today string in Y-m-d

Returns

string

parse_row()

parse_row(mixed $result) : void

Applied for each result

Parameters

mixed $result

save()

save(string $date, int $id, int $value)

Save to mysql

Parameters

string $date
int $id
int $value

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