Skip to content

SystemHelper.md

Latest commit

 

History

History
269 lines (212 loc) · 7.72 KB

SystemHelper.md

File metadata and controls

269 lines (212 loc) · 7.72 KB

System Helper

Helper for system operation.

PHP7

1. Outline

2. Description

3. Installation

3.1. composer install

$ composer require nueip/helpers

4. Dependency

  • PHP7

5. Usage

5.1. System

  • library for Cookie operating
  • Wrap the PHP native function/variable setcookie()/$_COOKIE to enrich the function and simplify the usage method.
  • Extra features:
    • Support Cookie prefix packaging
    • Support default values: expires, path, domain, secure, httponly
    • Dedicated function: Root domain access

5.1.1. Setting

  • 使用前設定
// 引入Composer autoload
include('../vendor/autoload.php');

// 宣告使用 SystemHelper
use nueip\SystemHelper;

5.1.2. 最小記憶體設定

最小記憶體設定

  • 以M為單位，不做單位轉換
  • 如果現有可用記憶體大於本次設定值，不會縮減
  • 建議：一般程式不超過512M，匯出程式不超過1024M
  • 最大 2048M

5.1.2.1. Description

memoryMoreThan( [string `$memorySize`] ) : bool

5.1.2.2. Parameters

$memorySize (*string*) – 記憶體大小，單位 M，預設 256M

5.1.2.3. Return Values

bool

5.1.2.4. Example

use nueip\helpers\SystemHelper;

SystemHelper::memoryMoreThan('256M');

echo ini_get('memory_limit');
// Result: 256M

5.2. Cookie

  • library for Cookie operating
  • Wrap the PHP native function/variable setcookie()/$_COOKIE to enrich the function and simplify the usage method.
  • Extra features:
    • Support Cookie prefix packaging
    • Support default values: expires, path, domain, secure, httponly
    • Dedicated function: Root domain access

5.2.1. Setting

  • 使用前設定
// 引入Composer autoload
include('../vendor/autoload.php');

// 宣告使用 SystemHelper
use marsapp\helper\system\SystemHelper;

// 常數設定 - 需設 Cookie前綴、過期時間、預設路徑、根網域
define('COOKIE_DEFAULT_PREFIX', 'dev_');
define('COOKIE_DEFAULT_EXPIRES', 0);
define('COOKIE_DEFAULT_PATH', '/');
define('COOKIE_ROOT_DOMAIN', 'dev.local');

5.2.2. Cookie Default Option - Single

5.2.2.1. Description

cookieOption(string $param, string $value = null) : string|null

5.2.2.2. Parameters

  • $param : string
    • The target parameter of the cookie default options.
  • $value : string
    • New data.
  • When $param does not exist, return null
  • When there is $param but no $value(null), get the current value of $param
  • When there is $param and $value, after updating the data, the updated value will be returned

5.2.2.3. Return Values

string|null

5.2.2.4. Example

// 取得Cookie預設參數值
$httponly = SystemHelper::cookieOption('httponly');

// 設定Cookie預設參數-單筆
$httponly = SystemHelper::cookieOption('httponly', false);

5.2.3. Set Cookie Default Option - Multiple

5.2.3.1. Description

cookieOptions(array $options = []) : array

5.2.3.2. Parameters

  • $options : array
    • batch update cookie default options.

5.2.3.3. Return Values

array, return complete cookie default options.

5.2.3.4. Example

// 變數設定
$options = [
    // 存放路徑
    'path' => '/tmp/',
    // 是否只能通過HTTP協議訪問
    'httponly' => false,
];

// 回傳完整Cookie預設參數
$cookieOptions = SystemHelper::cookieOptions();

// 設定Cookie預設參數-多筆
$cookieOptions = SystemHelper::cookieOptions($options);

5.2.4. Set Cookie

5.2.4.1. Description

cookieSet(string $name, string $value = "", array $options = []) : bool

Set Cookie, Wrap the PHP native function setcookie() to simplify usage.

5.2.4.2. Parameters

  • $name : string
    • The name of the cookie.
  • $value : string
    • The value of the cookie.
  • $options : array
    • 'prefix' => '', // Cookie前綴，預設無前綴
    • 'expires' => time()+3600, // 過期時間，預設無期限
    • 'path' => '/', // 存放路徑
    • 'domain' => "", // 所屬網域
    • 'secure' => true, // 是否只在https生效
    • 'httponly' => false, // 是否只能通過HTTP協議訪問

5.2.4.3. Return Values

bool, like PHP function setcookie()

5.2.4.4. Example

// 變數設定
$name = 'testCookie';
$value = "test-" . mt_rand(1111, 9999);
$options = [
    // 存放路徑
    'path' => '/',
    // 是否只能通過HTTP協議訪問
    'httponly' => true,
];

// 設定Cookie
SystemHelper::cookieSet($name, $value, $options);
  • $options可用參數
    • 'prefix' => '', // Cookie前綴，預設無前綴
    • 'expires' => time()+3600, // 過期時間，預設無期限
    • 'path' => '/', // 存放路徑
    • 'domain' => "", // 所屬網域
    • 'secure' => true, // 是否只在https生效
    • 'httponly' => false, // 是否只能通過HTTP協議訪問

5.2.5. Set Cookie on root domain

5.2.5.1. Description

cookieSetRoot(string $name, string $value = "", array $options = []) : bool

Like cookieSet(), but domain fixed on root domain.

5.2.6. Get Cookie

5.2.6.1. Description

cookieGet(string $name) : mixed

取得目標Cookie值

5.2.7. Delete Cookie

5.2.7.1. Description

cookieExpired(string $name, array $options = []) : bool

Delete target cookie.

5.2.8. Delete Cookie on root domain

5.2.8.1. Description

cookieExpiredRoot(string $name, array $options = []) : bool

Like cookieExpired(), but domain fixed on root domain.

6. Example

see: example/example-cookie.php

7. Contributing