Universal Framework Documentation

# Classes

Cookie helper.
Extends Nothing
Implements Nothing
Uses Nothing

This class has not constants.

__call ( )

This magic method is called everytime an inaccessible method is called (either by visibility contrains or it doesn't exist) Here we are simulating shared protected methods across "package" classes This method is inherited by all child classes of Package.

public function __call( mixed $method, mixed $args ) : void
Parameter Type(s) Description
$method mixed
$args mixed

all ( ) static

public static function all(  ) : void

day ( ) static

Set cookie by days.

public static function day( mixed $name, mixed $value = true, mixed $expire, mixed $path = '/', mixed $domain = '', mixed $secure = false, mixed $httponly = false ) : void
Parameter Type(s) Description
$name mixed
$value optional mixed
$expire mixed
$path optional mixed
$domain optional mixed
$secure optional mixed
$httponly optional mixed
See also \Cookie\helper::set()
automatically set expire time to day format

del ( ) static

Delete cookie.

public static function del( mixed $name ) : boolean
Parameter Type(s) Description
$name mixed

Returns:

true | false | null * return true if success and exists * return false if cookie not exists * return null if $_COOKIE constant not exists

destroy ( ) static

Destroy all cookies except php session and spesific cookies name.

public static function destroy( mixed $except = array() ) : void
Parameter Type(s) Description
$except optional mixed

domain ( ) static

public static function domain( mixed $domain ) : void
Parameter Type(s) Description
$domain mixed

get ( ) static

Get Cookie By Name.

public static function get( mixed $name, mixed $AllowEmpty = true ) : string|array|null
Parameter Type(s) Description
$name mixed
$AllowEmpty optional mixed

get_current_path ( ) static

public static function get_current_path(  ) : void

get_current_url ( ) static

public static function get_current_url(  ) : void

has ( ) static

Check cookie exist.

public static function has( mixed $name, boolean $AllowEmpty = true ) : boolean|null
Parameter Type(s) Description
$name mixed
$AllowEmpty optional boolean if true, will return false if cookie value empty

Returns:

true indicated exists, null indicated empty value, false indicated not set

hours ( ) static

Set cookie by hours.

public static function hours( mixed $name, mixed $value = true, mixed $expire = 1, mixed $path = '/', mixed $domain = '', mixed $secure = false, mixed $httponly = false ) : void
Parameter Type(s) Description
$name mixed
$value optional mixed
$expire optional mixed
$path optional mixed
$domain optional mixed
$secure optional mixed
$httponly optional mixed
See also \Cookie\helper::set()
automatically set expire time to hours format

mins ( ) static

Set cookie by minutes.

public static function mins( mixed $name, mixed $value = true, mixed $expire, mixed $path = '/', mixed $domain = '', mixed $secure = false, mixed $httponly = false ) : void
Parameter Type(s) Description
$name mixed
$value optional mixed
$expire mixed
$path optional mixed
$domain optional mixed
$secure optional mixed
$httponly optional mixed
See also \Cookie\helper::set()
automatically set expire time to minutes format

one ( ) static

one time function when cookie name empty.

public static function one( mixed $cookie_name, mixed $value, integer $minutes, callable $callback ) : void
Parameter Type(s) Description
$cookie_name mixed
$value mixed
$minutes integer minute to be expired
$callback callable

reconstruct_url ( ) static

public static function reconstruct_url( mixed $url ) : void
Parameter Type(s) Description
$url mixed

secure ( ) static

public static function secure( mixed $secure ) : void
Parameter Type(s) Description
$secure mixed

set ( ) static

Set cookie helper.

public static function set( mixed $name, mixed $value, float|integer|string $expire, mixed $path = '/', string $domain = '', boolean $secure = false, boolean $httponly = false ) : \Cookie\setcookie
Parameter Type(s) Description
$name mixed
$value mixed
$expire float
integer
string		 1m/1h/1d/1y default m(minute)
$path optional mixed
$domain optional string default $_SERVER['HTTP_HOST']
$secure optional boolean
$httponly optional boolean

This class has not inherited methods.

$domain static

public static $domain = '/';

Types:

  • mixed

$secure static

public static $secure = false;

Types:

  • mixed

$password static

public static $password = CONFIG['security']['salt'];

Types:

  • mixed

This class has not inherited properties.

# DB\Backup

The Backup_Database class.
Extends Nothing
Implements Nothing
Uses Nothing

# \DB\Backup Constants

This class has not constants.

# \DB\Backup Methods

__construct ( )

Constructor initializes database.

public function __construct( mixed $host, mixed $username, mixed $passwd, mixed $dbName, mixed $charset = 'utf8' ) : void
Parameter Type(s) Description
$host mixed
$username mixed
$passwd mixed
$dbName mixed
$charset optional mixed

backupTables ( )

Backup the whole database or just some tables Use '*' for whole database or 'table1 table2 table3.

public function backupTables( string $tables = '*' ) : void
Parameter Type(s) Description
$tables optional string

Description:

..'.

clean ( )

Clean All Backup Databases SQL.

public function clean(  ) : void

download ( )

Download SQL File To Client Browser.

public function download( mixed $sqlFile ) : void
Parameter Type(s) Description
$sqlFile mixed

initializeDatabase ( )

Initialize Configured Database.

public function initializeDatabase(  ) : void

saveFile ( )

Save SQL to file.

protected function saveFile( string &$sql, string $format = '' ) : void
Parameter Type(s) Description
$sql string
$format optional string date('Ymd-His', time()) or other

# \DB\Backup Inherited methods

This class has not inherited methods.

# \DB\Backup Properties

$host

Host where database is located.

public $host = '';

Types:

  • mixed

$username

Username used to connect to database.

public $username = '';

Types:

  • mixed

$passwd

Password used to connect to database.

public $passwd = '';

Types:

  • mixed

$dbName

Database to backup.

public $dbName = '';

Types:

  • mixed

$charset

Database charset.

public $charset = '';

Types:

  • mixed

$conn

public $conn;

Types:

  • \mysqli -null

$outputDir

Output Directory.

public $outputDir = __DIR__ . '/backup';

Types:

  • string

$result

Result.

public $result = array();

Types:

  • array

# \DB\Backup Inherited properties

This class has not inherited properties.

# DB\EPDOStatement
Extends \
Implements Psr\Log\LoggerAwareInterface
Uses Nothing

# \DB\EPDOStatement Constants

WARNING_USING_ADDSLASHES

WARNING_USING_ADDSLASHES = 'addslashes is not suitable for production logging, etc. Please consider updating your processes to provide a valid PDO object that can perform the necessary translations and can be updated with your e.g. package management, etc.';

Type: mixed

# \DB\EPDOStatement Methods

__construct ( )

The first argument passed in should be an instance of the PDO object. If so, we'll cache it's reference locally to allow for the best escaping possible later when interpolating our query. Other parameters can be added if needed.

protected function __construct( \PDO $pdo = null ) : void
Parameter Type(s) Description
$pdo optional \PDO

_debugQuery ( )

public function _debugQuery( mixed $replaced = true ) : void
Parameter Type(s) Description
$replaced optional mixed

_debugReplace ( )

protected function _debugReplace( mixed $m ) : void
Parameter Type(s) Description
$m mixed

bindParam ( )

Overrides the default \PDOStatement method to add the named parameter and it's reference to the array of bound parameters - then accesses and returns parent::bindParam method.

public function bindParam( string $param, mixed &$value, integer $datatype = \PDO::PARAM_STR, integer $length = 0, mixed $driverOptions = false ) : boolean
Parameter Type(s) Description
$param string
$value mixed
$datatype optional integer
$length optional integer
$driverOptions optional mixed

Returns:

  • default of \PDOStatement::bindParam()

bindValue ( )

Overrides the default \PDOStatement method to add the named parameter and it's value to the array of bound values

  • then accesses and returns parent::bindValue method.
public function bindValue( string $param, mixed $value, integer $datatype = \PDO::PARAM_STR ) : boolean
Parameter Type(s) Description
$param string
$value mixed
$datatype optional integer

Returns:

  • default of \PDOStatement::bindValue()

execute ( )

Overrides the default \PDOStatement method to generate the full query string - then accesses and returns parent::execute method.

public function execute( array $inputParams = array() ) : boolean
Parameter Type(s) Description
$inputParams optional array

Returns:

  • default of \PDOStatement::execute()

interpolateQuery ( )

Copies $this->queryString then replaces bound markers with associated values ($this->queryString is not modified but the resulting query string is assigned to $this->fullQuery).

public function interpolateQuery( array $inputParams = null ) : string
Parameter Type(s) Description
$inputParams optional array - array of values to replace ? marked parameters in the query string

Returns:

$testQuery - interpolated db query string

setLogger ( )

{@inheritdoc}

public function setLogger( \Psr\Log\LoggerInterface $logger ) : void
Parameter Type(s) Description
$logger \Psr\Log\LoggerInterface

# \DB\EPDOStatement Inherited methods

This class has not inherited methods.

# \DB\EPDOStatement Properties

$fullQuery

public $fullQuery;

Types:

  • string

$_pdo

protected $_pdo = '';

Types:

  • \PDO

$boundParams

protected $boundParams = array();

Types:

  • array

$_debugValues

Migrate from \DB\statement.

protected $_debugValues = null;

Types:

  • mixed

# \DB\EPDOStatement Inherited properties

This class has not inherited properties.

# DB\manager
Extends Nothing
Implements Nothing
Uses Nothing

# \DB\manager Constants

This class has not constants.

# \DB\manager Methods

backup_tables ( )

public function backup_tables( mixed $host, mixed $user, mixed $pass, mixed $name, mixed $nama_file, mixed $tables = '*' ) : void
Parameter Type(s) Description
$host mixed
$user mixed
$pass mixed
$name mixed
$nama_file mixed
$tables optional mixed

# \DB\manager Inherited methods

This class has not inherited methods.

# \DB\manager Properties

This class has not properties.

# \DB\manager Inherited properties

This class has not inherited properties.

# DB\schema
Extends Nothing
Implements Nothing
Uses Nothing

# \DB\schema Constants

This class has not constants.

# \DB\schema Methods

get_enumset_values ( ) static

Get ENUM or SET values.

public static function get_enumset_values( \DB\pdo $pdo, mixed $table, mixed $field ) : array
Parameter Type(s) Description
$pdo \DB\pdo
$table mixed
$field mixed

interpolateQuery ( ) static

Replaces any parameter placeholders in a query with the value of that parameter. Useful for debugging. Assumes anonymous parameters from $params are are in the same order as specified in $query.

public static function interpolateQuery( string $query, array $params ) : string
Parameter Type(s) Description
$query string The sql query with parameter placeholders
$params array The array of substitution parameters

Returns:

The interpolated query

modify_enumset_values ( ) static

Modify ENUM or SET values.

public static function modify_enumset_values( \DB\pdo $pdo, mixed $table, mixed $field, array $newData ) : array
Parameter Type(s) Description
$pdo \DB\pdo
$table mixed
$field mixed
$newData array
See also https://stackoverflow.com/questions/1501958/how-do-i-add-more-members-to-my-enum-type-column-in-mysql

# \DB\schema Inherited methods

This class has not inherited methods.

# \DB\schema Properties

This class has not properties.

# \DB\schema Inherited properties

This class has not inherited properties.

# Filemanager\file
Extends Nothing
Implements Nothing
Uses Nothing

# \Filemanager\file Constants

This class has not constants.

# \Filemanager\file Methods

__construct ( )

public function __construct(  ) : void

__istatic ( )

public function __istatic(  ) : void

cleanDump ( )

public function cleanDump( mixed $c, mixed $_ ) : void
Parameter Type(s) Description
$c mixed
$_ mixed

createFile ( )

Create file and directory recursively.

public function createFile( string $path, boolean $create = true, boolean $force = false, boolean $append = false, mixed $dump = false ) : string
Parameter Type(s) Description
$path string File Path
$create optional boolean * true to create * false to abort create
$force optional boolean * true force overwrite * false not create if exists
$append optional boolean append to file
$dump optional mixed

Returns:

filepath

createFolder ( )

Create folder recursively.

public function createFolder( string $d, mixed $root = null, boolean $noroot = null, mixed $dump = false ) : string
Parameter Type(s) Description
$d string pathname or dirname
$root optional mixed root directory * default $_SERVER['DOCUMENT_ROOT']
$noroot optional boolean false will return begins with $root
$dump optional mixed

delete ( ) static

Recursive delete.

public static function delete( string $path ) : void
Parameter Type(s) Description
$path string files or folder

deleteDirectory ( ) static

Delete Non-Empty Directory.

public static function deleteDirectory( mixed $dir ) : boolean
Parameter Type(s) Description
$dir mixed

deleteFile ( )

Delete file.

public function deleteFile( mixed $file ) : boolean
Parameter Type(s) Description
$file mixed

destroy_old_files ( )

public function destroy_old_files( mixed $dir, mixed $sec = 3600, mixed $prefix = null ) : void
Parameter Type(s) Description
$dir mixed
$sec optional mixed
$prefix optional mixed

determineContent ( )

public function determineContent( mixed $create ) : void
Parameter Type(s) Description
$create mixed

directoryIterator ( ) static

Iterate files in directory.

public static function directoryIterator( string $path ) : array
Parameter Type(s) Description
$path string

emptyDir ( ) static

Flush directory.

public static function emptyDir( mixed $dir ) : void
Parameter Type(s) Description
$dir mixed

file ( ) static

Create file nested.

public static function file( mixed $path, boolean $create = true, boolean $force = false, boolean $append = false, boolean $dump = false ) : string
Parameter Type(s) Description
$path mixed
$create optional boolean content
$force optional boolean
$append optional boolean
$dump optional boolean

folder ( ) static

public static function folder( mixed $path ) : mixed
Parameter Type(s) Description
$path mixed

get ( ) static

Read file with json decode support.

public static function get( string $file, boolean $parse_json = false ) : string|array
Parameter Type(s) Description
$file string
$parse_json optional boolean

Returns:

NULL = failed

isWin ( ) static

Is Device Windows?

public static function isWin(  ) : boolean

mkdir ( )

Create folder 777.

public function mkdir( mixed $x ) : void
Parameter Type(s) Description
$x mixed

remove ( ) static

public static function remove( mixed $str ) : void
Parameter Type(s) Description
$str mixed

smartFilePath ( )

Normalize Path To Linux Format.

public function smartFilePath( string $path ) : string
Parameter Type(s) Description
$path string

Returns:

$dir

tmp ( ) static

Get TMP Folder.

public static function tmp(  ) : mixed

toUnixPath ( ) static

public static function toUnixPath( mixed $path ) : void
Parameter Type(s) Description
$path mixed

withPath ( ) static

Initialize File (Alternative Multiple Constructor).

public static function withPath( mixed $filepath ) : void
Parameter Type(s) Description
$filepath mixed
See also https://stackoverflow.com/a/1701337

write ( ) static

Write file recursive.

public static function write( string $path, string $content = '', boolean $append = false ) : string
Parameter Type(s) Description
$path string
$content optional string
$append optional boolean

# \Filemanager\file Inherited methods

This class has not inherited methods.

# \Filemanager\file Properties

$content

public $content = '';

Types:

  • mixed

$modified

public $modified = array();

Types:

  • mixed

$created

public $created = array();

Types:

  • mixed

# \Filemanager\file Inherited properties

This class has not inherited properties.

# Filemanager\scan
Extends Nothing
Implements Nothing
Uses Nothing

# \Filemanager\scan Constants

This class has not constants.

# \Filemanager\scan Methods

__construct ( )

public function __construct( mixed $opt = array() ) : void
Parameter Type(s) Description
$opt optional mixed

getStatic ( ) static

public static function getStatic(  ) : void

scanAllFiles ( ) static

public static function scanAllFiles( mixed $dir, mixed $exclude = '/^(.{1,2}|\.htaccess)$/s' ) : void
Parameter Type(s) Description
$dir mixed
$exclude optional mixed

scandir ( ) static

public static function scandir( mixed $dir ) : void
Parameter Type(s) Description
$dir mixed

# \Filemanager\scan Inherited methods

This class has not inherited methods.

# \Filemanager\scan Properties

$static static

public static $static = null;

Types:

  • mixed

$opt static

public static $opt;

Types:

  • mixed

# \Filemanager\scan Inherited properties

This class has not inherited properties.

# GoogleExt\Attributes
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Attributes Constants

This class has not constants.

# \GoogleExt\Attributes Methods

This class has not methods.

# \GoogleExt\Attributes Inherited methods

This class has not inherited methods.

# \GoogleExt\Attributes Properties

$scheme

public $scheme;

Types:

  • mixed

$term

public $term;

Types:

  • mixed

$rel

public $rel;

Types:

  • mixed

$type

public $type;

Types:

  • mixed

$href

public $href;

Types:

  • mixed

# \GoogleExt\Attributes Inherited properties

This class has not inherited properties.

# GoogleExt\Author
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Author Constants

This class has not constants.

# \GoogleExt\Author Methods

This class has not methods.

# \GoogleExt\Author Inherited methods

This class has not inherited methods.

# \GoogleExt\Author Properties

$name

public $name;

Types:

  • mixed

$email

public $email;

Types:

  • mixed

$id

public $id;

Types:

  • mixed

$displayName

public $displayName;

Types:

  • mixed

$url

public $url;

Types:

  • mixed

$image

Image.

public $image;

Types:

  • \GoogleExt\Image

# \GoogleExt\Author Inherited properties

This class has not inherited properties.

# GoogleExt\Blog
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Blog Constants

This class has not constants.

# \GoogleExt\Blog Methods

This class has not methods.

# \GoogleExt\Blog Inherited methods

This class has not inherited methods.

# \GoogleExt\Blog Properties

$id

public $id;

Types:

  • mixed

# \GoogleExt\Blog Inherited properties

This class has not inherited properties.

# GoogleExt\blogger
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\blogger Constants

This class has not constants.

# \GoogleExt\blogger Methods

__construct ( )

public function __construct( \Google\Client|\GoogleExt\client $client ) : void
Parameter Type(s) Description
$client \Google\Client
\GoogleExt\client

byId ( )

Get blog information by id.

public function byId( integer|string $blogId ) : \GoogleExt\Google_Service_Blogger_Blog2|\Google_Service_Blogger_Blog
Parameter Type(s) Description
$blogId integer
string

byUrl ( )

Get blog information by url.

public function byUrl( mixed $url ) : \Google_Service_Blogger_Blog|\GoogleExt\Google_Service_Blogger_Blog2
Parameter Type(s) Description
$url mixed

getPost ( )

Get Post Information By Id.

public function getPost( string $id ) : \GoogleExt\Blogger_Post
Parameter Type(s) Description
$id string

getPosts ( )

Get All Blogger Posts.

public function getPosts( boolean $force = false ) : array<mixed,\GoogleExt\Blogger_Post>
Parameter Type(s) Description
$force optional boolean recrawl

listPosts ( )

public function listPosts( mixed $limit = 5 ) : void
Parameter Type(s) Description
$limit optional mixed

setBlogId ( )

public function setBlogId( mixed $id ) : void
Parameter Type(s) Description
$id mixed

# \GoogleExt\blogger Inherited methods

This class has not inherited methods.

# \GoogleExt\blogger Properties

$posts

public $posts;

Types:

  • mixed

$blogs

public $blogs;

Types:

  • mixed

$blogId

public $blogId;

Types:

  • mixed

$recrawl

public $recrawl = false;

Types:

  • boolean

# \GoogleExt\blogger Inherited properties

This class has not inherited properties.

# GoogleExt\Blogger_Post
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Blogger_Post Constants

This class has not constants.

# \GoogleExt\Blogger_Post Methods

__construct ( )

public function __construct( mixed $deserializedJson, mixed $fromCache = false ) : void
Parameter Type(s) Description
$deserializedJson mixed
$fromCache optional mixed

__toString ( )

public function __toString(  ) : void

set ( )

public function set( mixed $data ) : void
Parameter Type(s) Description
$data mixed

# \GoogleExt\Blogger_Post Inherited methods

This class has not inherited methods.

# \GoogleExt\Blogger_Post Properties

$kind

public $kind;

Types:

  • mixed

$id

public $id;

Types:

  • mixed

$blog

Blog.

public $blog;

Types:

  • \GoogleExt\Blog

$published

public $published;

Types:

  • mixed

$updated

public $updated;

Types:

  • mixed

$url

public $url;

Types:

  • mixed

$selfLink

public $selfLink;

Types:

  • mixed

$title

public $title;

Types:

  • mixed

$content

Post contents.

public $content;

Types:

  • string

$author

Author.

public $author;

Types:

  • \GoogleExt\Author

$replies

Replies.

public $replies;

Types:

  • \GoogleExt\Replies

$labels

Labels.

public $labels = array();

Types:

  • array<mixed,string>

$etag

Etag.

public $etag;

Types:

  • string

$draft

public $draft = false;

Types:

  • mixed

$deserializedBy

public $deserializedBy = 'curl';

Types:

  • mixed

$category

Categories.

public $category = array();

Types:

  • array<mixed,\GoogleExt\Category> -array<mixed,\GoogleExt\Attributes>

$link

Links Blogger.

public $link = array();

Types:

  • array<mixed,\GoogleExt\Link>

# \GoogleExt\Blogger_Post Inherited properties

This class has not inherited properties.

# GoogleExt\Category
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Category Constants

This class has not constants.

# \GoogleExt\Category Methods

This class has not methods.

# \GoogleExt\Category Inherited methods

This class has not inherited methods.

# \GoogleExt\Category Properties

$attributes

Attributes

public $attributes;

Types:

  • \GoogleExt\Attributes

# \GoogleExt\Category Inherited properties

This class has not inherited properties.

# GoogleExt\Google_Service_Blogger_Blog2
Extends GoogleExt\Serializer
Implements Nothing
Uses Nothing

# \GoogleExt\Google_Service_Blogger_Blog2 Constants

This class has not constants.

# \GoogleExt\Google_Service_Blogger_Blog2 Methods

__construct ( )

public function __construct( mixed $deserializedJson ) : void
Parameter Type(s) Description
$deserializedJson mixed

getId ( )

Get blog id.

public function getId(  ) : string

set ( )

public function set( mixed $data ) : void
Parameter Type(s) Description
$data mixed

# \GoogleExt\Google_Service_Blogger_Blog2 Inherited methods

This class has not inherited methods.

# \GoogleExt\Google_Service_Blogger_Blog2 Properties

This class has not properties.

# \GoogleExt\Google_Service_Blogger_Blog2 Inherited properties

# GoogleExt\Image
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Image Constants

This class has not constants.

# \GoogleExt\Image Methods

This class has not methods.

# \GoogleExt\Image Inherited methods

This class has not inherited methods.

# \GoogleExt\Image Properties

$src

public $src;

Types:

  • mixed

$rel

public $rel;

Types:

  • mixed

$width

public $width;

Types:

  • mixed

$height

public $height;

Types:

  • mixed

$url

public $url;

Types:

  • mixed

# \GoogleExt\Image Inherited properties

This class has not inherited properties.
Extends Nothing
Implements Nothing
Uses Nothing

This class has not constants.

This class has not methods.

This class has not inherited methods.

$attributes

Attributes

public $attributes;

Types:

  • \GoogleExt\Attributes

This class has not inherited properties.

# GoogleExt\Locale
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Locale Constants

This class has not constants.

# \GoogleExt\Locale Methods

This class has not methods.

# \GoogleExt\Locale Inherited methods

This class has not inherited methods.

# \GoogleExt\Locale Properties

$country

public $country;

Types:

  • mixed

$language

public $language;

Types:

  • mixed

$variant

public $variant;

Types:

  • mixed

# \GoogleExt\Locale Inherited properties

This class has not inherited properties.

# GoogleExt\Pages
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Pages Constants

This class has not constants.

# \GoogleExt\Pages Methods

This class has not methods.

# \GoogleExt\Pages Inherited methods

This class has not inherited methods.

# \GoogleExt\Pages Properties

$selfLink

public $selfLink;

Types:

  • mixed

$totalItems

public $totalItems;

Types:

  • mixed

# \GoogleExt\Pages Inherited properties

This class has not inherited properties.

# GoogleExt\Posts
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Posts Constants

This class has not constants.

# \GoogleExt\Posts Methods

This class has not methods.

# \GoogleExt\Posts Inherited methods

This class has not inherited methods.

# \GoogleExt\Posts Properties

$selfLink

public $selfLink;

Types:

  • mixed

$totalItems

public $totalItems;

Types:

  • mixed

# \GoogleExt\Posts Inherited properties

This class has not inherited properties.

# GoogleExt\recaptcha

Google Recaptcha.

$recap = new GoogleExt\recaptcha();

// using manual token
$recaptcha->verify("Generated Token Here", function ($success, $response, $token) { e(func_get_args()); });

// using g-recaptcha-response
$recaptcha->verify($_REQUEST['g-recaptcha-response'], function ($success, $response, $token) { e(func_get_args()); });
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\recaptcha Constants

This class has not constants.

# \GoogleExt\recaptcha Methods

verify ( )

Verify Recaptcha.

public function verify( string $token, callable $callback ) : void
Parameter Type(s) Description
$token string
$callback callable

# \GoogleExt\recaptcha Inherited methods

This class has not inherited methods.

# \GoogleExt\recaptcha Properties

$secretKey static

Secret Key (Default from config.json).

public static $secretKey = CONFIG['google']['recaptcha']['secret'];

Types:

  • string

# \GoogleExt\recaptcha Inherited properties

This class has not inherited properties.

# GoogleExt\Replies
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Replies Constants

This class has not constants.

# \GoogleExt\Replies Methods

This class has not methods.

# \GoogleExt\Replies Inherited methods

This class has not inherited methods.

# \GoogleExt\Replies Properties

$totalItems

public $totalItems;

Types:

  • mixed

$selfLink

public $selfLink;

Types:

  • mixed

# \GoogleExt\Replies Inherited properties

This class has not inherited properties.

# GoogleExt\Serializer
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Serializer Constants

This class has not constants.

# \GoogleExt\Serializer Methods

This class has not methods.

# \GoogleExt\Serializer Inherited methods

This class has not inherited methods.

# \GoogleExt\Serializer Properties

$deserializedBy

Status deserialized.

public $deserializedBy = 'curl';

Types:

  • string

$customMetaData

public $customMetaData;

Types:

  • mixed

$description

public $description;

Types:

  • mixed

$id

Blog ID.

public $id;

Types:

  • string

$kind

public $kind;

Types:

  • mixed

$name

public $name;

Types:

  • mixed

$published

public $published;

Types:

  • mixed

$selfLink

public $selfLink;

Types:

  • mixed

$status

public $status;

Types:

  • mixed

$updated

public $updated;

Types:

  • mixed

$url

public $url;

Types:

  • mixed

$posts

Blogger Posts.

public $posts;

Types:

  • \GoogleExt\Posts

$pages

Blogger Pages.

public $pages;

Types:

  • \GoogleExt\Pages

$locale

Blogger Locale.

public $locale;

Types:

  • \GoogleExt\Locale

# \GoogleExt\Serializer Inherited properties

This class has not inherited properties.

# GoogleExt\Translator
Extends Nothing
Implements Nothing
Uses Nothing

# \GoogleExt\Translator Constants

This class has not constants.

# \GoogleExt\Translator Methods

insert ( )

Insert Target String To Be Translated.

public function insert( string $content ) : void
Parameter Type(s) Description
$content string

# \GoogleExt\Translator Inherited methods

This class has not inherited methods.

# \GoogleExt\Translator Properties

This class has not properties.

# \GoogleExt\Translator Inherited properties

This class has not inherited properties.

# JSON\json
Extends Nothing
Implements Nothing
Uses Nothing

# \JSON\json Constants

This class has not constants.

# \JSON\json Methods

assoc ( ) static

Force Assoc.

public static function assoc( array|object $arr ) : \JSON\json_decode
Parameter Type(s) Description
$arr array
object

beautify ( ) static

beautify JSON.

public static function beautify( \stdClass|array|object|string $data ) : string
Parameter Type(s) Description
$data \stdClass
array
object
string

headerJSON ( ) static

public static function headerJSON(  ) : void

init ( ) static

chaining.

public static function init(  ) : \JSON\json

is_json ( ) static

Validate json string.

public static function is_json( string $string ) : boolean
Parameter Type(s) Description
$string string

isJson ( ) static

public static function isJson( mixed $string ) : void
Parameter Type(s) Description
$string mixed

json ( ) static

JSON formatter.

public static function json( mixed $data = array(), boolean $header = true, boolean $print = true ) : void
Parameter Type(s) Description
$data optional mixed
$header optional boolean
$print optional boolean

json_decode ( ) static

json_decode default assoc.

public static function json_decode( mixed $str, mixed $err_callback = null, boolean $assoc = true ) : \JSON\json_decode
Parameter Type(s) Description
$str mixed
$err_callback optional mixed
$assoc optional boolean

json_last_error_e ( ) static

JSON error explanatory.

public static function json_last_error_e(  ) : void

jsond ( ) static

JSON decode with verification.

public static function jsond( string $str, mixed $callback = null ) : void
Parameter Type(s) Description
$str string
$callback optional mixed

jsonDecode ( ) static

public static function jsonDecode( mixed $input ) : void
Parameter Type(s) Description
$input mixed

load ( )

Load JSON.

public function load( mixed $file, mixed $assoc = false ) : void
Parameter Type(s) Description
$file mixed
$assoc optional mixed

save ( )

Save JSON from load($file, $assoc = false).

public function save(  ) : \JSON\json

# \JSON\json Inherited methods

This class has not inherited methods.

# \JSON\json Properties

$static static

public static $static;

Types:

  • mixed

$result

public $result;

Types:

  • mixed

# \JSON\json Inherited properties

This class has not inherited properties.

# MVC\captcha
Extends MVC\router
Implements Nothing
Uses Nothing

# \MVC\captcha Constants

This class has not constants.

# \MVC\captcha Methods

__construct ( )

public function __construct(  ) : void

create ( )

Create captcha ids.

public function create(  ) : void

jpeg ( )

public function jpeg( mixed $captcha_code ) : void
Parameter Type(s) Description
$captcha_code mixed

receiver ( )

Receiver (Create captcha).

public function receiver( string $header_name = 'hname' ) : void
Parameter Type(s) Description
$header_name optional string javascript function name in header format

receiver2 ( )

public function receiver2( mixed $header_name = null ) : void
Parameter Type(s) Description
$header_name optional mixed

validate ( )

Validate coupon codes.

public function validate( mixed $captcha ) : void
Parameter Type(s) Description
$captcha mixed

# \MVC\captcha Inherited methods

# \MVC\captcha Properties

$key

public $key = null;

Types:

  • mixed

# \MVC\captcha Inherited properties

# MVC\Exception
Extends \
Implements Nothing
Uses Nothing

# \MVC\Exception Constants

This class has not constants.

# \MVC\Exception Methods

__construct ( )

public function __construct( mixed $message, mixed $code = 0, \MVC\Exception $previous = null ) : void
Parameter Type(s) Description
$message mixed
$code optional mixed
$previous optional \MVC\Exception

__toString ( )

public function __toString(  ) : void

debug_string_backtrace ( )

public function debug_string_backtrace(  ) : void

generateCallTrace ( )

public function generateCallTrace(  ) : void

is_admin ( )

public function is_admin(  ) : void

# \MVC\Exception Inherited methods

This class has not inherited methods.

# \MVC\Exception Properties

This class has not properties.

# \MVC\Exception Inherited properties

This class has not inherited properties.

# MVC\helper
Extends Nothing
Implements Nothing
Uses Nothing

# \MVC\helper Constants

This class has not constants.

# \MVC\helper Methods

__construct ( )

public function __construct(  ) : void

_cloudflare_CheckIP ( ) static

public static function _cloudflare_CheckIP( mixed $ip ) : void
Parameter Type(s) Description
$ip mixed

_cloudflare_Requests_Check ( ) static

public static function _cloudflare_Requests_Check(  ) : void

asset_find ( ) static

public static function asset_find( mixed $fn = array() ) : void
Parameter Type(s) Description
$fn optional mixed

babel ( ) static

public static function babel( mixed $path ) : void
Parameter Type(s) Description
$path mixed

base_url ( ) static

Get path base URL

  • example (/cookie/file.html) -> (https://httpbin.org/cookie/file.html).
public static function base_url( string $path, boolean $forceSSL = false ) : string
Parameter Type(s) Description
$path string pathname from base url
$forceSSL optional boolean force https protocol returned * true or false or null

Returns:

protocol://origin/pathname

clean_multiple_hypens ( ) static

public static function clean_multiple_hypens( mixed $string ) : void
Parameter Type(s) Description
$string mixed

clean_special_characters ( ) static

Clean special characters from string.

public static function clean_special_characters( mixed $string, string $replace = '' ) : string
Parameter Type(s) Description
$string mixed
$replace optional string

clean_whitespace ( ) static

public static function clean_whitespace( mixed $str ) : void
Parameter Type(s) Description
$str mixed

cleanBuffer ( ) static

Clean output buffers.

public static function cleanBuffer(  ) : void

config ( ) static

public static function config(  ) : void

cors ( ) static

Cors domain verify, detect AJAX, and validate AJAX CORS.

public static function cors( boolean $print_server = false ) : void
Parameter Type(s) Description
$print_server optional boolean Debug mode

ddos_key ( ) static

public static function ddos_key(  ) : void

delcookie ( ) static

public static function delcookie( mixed $name ) : void
Parameter Type(s) Description
$name mixed

env ( ) static

if (env('dev')) return boolean; //is development environtment or not

Get environtment framework.

public static function env( string $for ) : string|boolean
Parameter Type(s) Description
$for string dev or prod

fixSlash ( ) static

Fix path string default OS separate slash and replaced by /

  • WIN (\)
  • LINUX (/).
public static function fixSlash( mixed $path, mixed $maxlength = 10 ) : string
Parameter Type(s) Description
$path mixed
$maxlength optional mixed

get_canonical ( ) static

get canonical url.

public static function get_canonical( string $url = null, boolean $whos = true ) : void
Parameter Type(s) Description
$url optional string null for current page
$whos optional boolean include host or not (http://domain)

get_clean_uri ( ) static

Get request uri without parameter.

public static function get_clean_uri( string $url = null ) : string
Parameter Type(s) Description
$url optional string

get_client_ip ( ) static

public static function get_client_ip(  ) : void

get_url_path ( ) static

Get URL from local file.

public static function get_url_path( array|string $path, boolean $cache = null ) : string
Parameter Type(s) Description
$path array
string		 destinations * array will be looped, which found first, return them
$cache optional boolean

Returns:

if empty == not found

getcookie ( ) static

Get Cookie By Name.

public static function getcookie( mixed $name ) : void
Parameter Type(s) Description
$name mixed

getOrigin ( ) static

public static function getOrigin(  ) : void

getRequestIP ( ) static

public static function getRequestIP(  ) : void

geturl ( ) static

Get current URL.

public static function geturl( boolean $forceSSL = false ) : string
Parameter Type(s) Description
$forceSSL optional boolean force https protocol returned * true or false or null

Returns:

protocol://origin/pathname

HeaderAccept ( ) static

Get Header Request Accept.

public static function HeaderAccept(  ) : void

headerExt ( ) static

public static function headerExt( mixed $ext ) : void
Parameter Type(s) Description
$ext mixed

include_asset ( ) static

public static function include_asset( mixed $fn, mixed $fn2 = null, mixed $callback = null ) : void
Parameter Type(s) Description
$fn mixed
$fn2 optional mixed
$callback optional mixed

ip_in_multirange ( ) static

public static function ip_in_multirange( mixed $ip, array $ranges ) : void
Parameter Type(s) Description
$ip mixed
$ranges array

ip_in_range ( ) static

Check if a given ip is in a network.

public static function ip_in_range( string $ip, string $range ) : boolean
Parameter Type(s) Description
$ip string IP to check in IPV4 format eg. 127.0.0.1
$range string IP/CIDR netmask eg. 127.0.0.0/24, also 127.0.0.1 is accepted and /32 assumed
See also https://gist.github.com/ryanwinchester/578c5b50647df3541794

Returns:

true if the ip is in this range / false if not

is_google ( ) static

Check if request is google.

public static function is_google(  ) : boolean

is_header ( ) static

Check if header request has $any.

public static function is_header( mixed $any ) : string|null
Parameter Type(s) Description
$any mixed

is_url ( ) static

is url ?

public static function is_url( string $url ) : boolean
Parameter Type(s) Description
$url string

is_windows ( ) static

Detect current OS is Windows.

public static function is_windows(  ) : boolean

isCloudflare ( ) static

public static function isCloudflare(  ) : void

isLocal ( ) static

Check if current is localhost.

public static function isLocal( string $regex = null ) : boolean
Parameter Type(s) Description
$regex optional string new regex

load_asset ( ) static

public static function load_asset( mixed $path ) : void
Parameter Type(s) Description
$path mixed

parse_url2 ( ) static

Parse URL deeper.

public static function parse_url2( string $url, boolean $encoded = false ) : \MVC\parse_url
Parameter Type(s) Description
$url string
$encoded optional boolean

php_error_log ( ) static

GET PHP ERROR LOG.

public static function php_error_log( mixed $onlypath = false ) : string|null
Parameter Type(s) Description
$onlypath optional mixed

platformSlashes ( ) static

public static function platformSlashes( mixed $path ) : void
Parameter Type(s) Description
$path mixed

print_server ( ) static

public static function print_server(  ) : void

request_data ( ) static

Get request data

  • $_GET[$name]
  • $_REQUEST[$name]
  • $_POST[$name].
public static function request_data( string $type = 'get', mixed $name ) : string|null
Parameter Type(s) Description
$type optional string request method * get = only accept get * post = only accept post * any = accept all request
$name mixed What data requests will you take?

require_method ( ) static

public static function require_method( mixed $method ) : void
Parameter Type(s) Description
$method mixed

sanitize_output ( ) static

Minify HTML.

public static function sanitize_output( string $buffer ) : void
Parameter Type(s) Description
$buffer string

sass ( ) static

Sass Compiler.

public static function sass( mixed $path ) : void
Parameter Type(s) Description
$path mixed

setcookie ( ) static

Set cookie helper.

public static function setcookie( mixed $name, mixed $value = true, float|integer $day, string $path = '/', string $domain = '', boolean $secure = false, boolean $httponly = false ) : void
Parameter Type(s) Description
$name mixed
$value optional mixed
$day float
integer
$path optional string
$domain optional string
$secure optional boolean
$httponly optional boolean

trycatch ( ) static

public static function trycatch( mixed $try ) : void
Parameter Type(s) Description
$try mixed

url2host ( ) static

transfor url to host (domain only).

public static function url2host( mixed $url, mixed $fallback = null ) : string|null
Parameter Type(s) Description
$url mixed
$fallback optional mixed if url is not valid return $fallback value

useragent ( ) static

Get Useragent.

public static function useragent(  ) : string

webkit_asset ( ) static

public static function webkit_asset( mixed $path, mixed $alternative = null ) : void
Parameter Type(s) Description
$path mixed
$alternative optional mixed

# \MVC\helper Inherited methods

This class has not inherited methods.

# \MVC\helper Properties

$key static

public static $key = 'AUX';

Types:

  • mixed

$expire static

public static $expire = 10;

Types:

  • mixed

$router static

public static $router;

Types:

  • mixed

$arch static

Class architecture database.

public static $arch = array();

Types:

  • array

# \MVC\helper Inherited properties

This class has not inherited properties.

# MVC\router
Extends MVC\themes
Implements Nothing
Uses Nothing

# \MVC\router Constants

This class has not constants.

# \MVC\router Methods

__construct ( )

public function __construct(  ) : void

config ( )

public function config( mixed $router ) : void
Parameter Type(s) Description
$router mixed

environtment ( )

Define environtment

  • development / production.
public function environtment( mixed $env = 'production' ) : string
Parameter Type(s) Description
$env optional mixed

findRoute ( )

Find router from parameter URL.

public function findRoute(  ) : void

get_env ( ) static

Get framework environtment.

public static function get_env(  ) : string

GUID ( )

public function GUID(  ) : void

is_hard_reload ( )

Check browser no-cache request (hard reload).

public function is_hard_reload(  ) : boolean

is_header ( )

Check if header request has $any.

public function is_header( mixed $any ) : string|null
Parameter Type(s) Description
$any mixed

is_post ( )

public function is_post( mixed $any, mixed $alternative = null ) : void
Parameter Type(s) Description
$any mixed
$alternative optional mixed

is_production ( )

public function is_production(  ) : void

is_req ( )

public function is_req( mixed $any, mixed $alternative = null ) : void
Parameter Type(s) Description
$any mixed
$alternative optional mixed

is_reqs ( )

check if one of the headers exists.

public function is_reqs( mixed $anys ) : boolean|string
Parameter Type(s) Description
$anys mixed

Description:

if ($this->is_reqs(['DNT', 'Connection']))

no_direct ( )

public function no_direct(  ) : void

redirect ( )

public function redirect( mixed $path ) : void
Parameter Type(s) Description
$path mixed

safe_redirect ( ) static

Safe redirect, support any conditions.

public static function safe_redirect( mixed $path ) : void
Parameter Type(s) Description
$path mixed

# \MVC\router Inherited methods

# \MVC\router Properties

$root

public $root;

Types:

  • mixed

$PHP_ERROR_FILE

public $PHP_ERROR_FILE = PHP_ERROR_FILE;

Types:

  • mixed

$env

public $env;

Types:

  • mixed

# \MVC\router Inherited properties

# MVC\themes
Extends Nothing
Implements Nothing
Uses Nothing

# \MVC\themes Constants

This class has not constants.

# \MVC\themes Methods

__construct ( )

public function __construct(  ) : void

date ( )

public function date( mixed $time, mixed $format = 'm/j/y g:i A' ) : void
Parameter Type(s) Description
$time mixed
$format optional mixed

dump ( )

Dump this variable.

public function dump( \MVC\variadic $var ) : void
Parameter Type(s) Description
$var \MVC\variadic

fix_slash ( )

Transform to linux separated file.

public function fix_slash( mixed $path ) : void
Parameter Type(s) Description
$path mixed

is_admin ( )

public function is_admin(  ) : void

isJSONRequest ( )

public function isJSONRequest(  ) : void

label ( )

Set Label Router.

public function label( mixed $label = 'default' ) : \MVC\themes
Parameter Type(s) Description
$label optional mixed

load_render ( )

public function load_render( mixed $variables, mixed $print = true ) : void
Parameter Type(s) Description
$variables mixed
$print optional mixed

modified ( )

public function modified( mixed $time ) : void
Parameter Type(s) Description
$time mixed

NoThemeRequest ( )

public function NoThemeRequest(  ) : void

prepare_config ( )

public function prepare_config(  ) : void

published ( )

public function published( mixed $time ) : void
Parameter Type(s) Description
$time mixed

remove_root ( )

Remove root path.

public function remove_root( mixed $path ) : void
Parameter Type(s) Description
$path mixed

render ( )

Include passed variable.

public function render( mixed $variables = array(), mixed $print = true ) : void
Parameter Type(s) Description
$variables optional mixed
$print optional mixed

set ( )

Set theme default.

public function set( mixed $theme, mixed $useTheme = true ) : $this
Parameter Type(s) Description
$theme mixed
$useTheme optional mixed

setThemeByZones ( )

setThemeByZones([ 'theme-name'=>['zone1', 'zone2'], 'another-theme'=>['zone3','zone4'], 'default-template'])

Set theme by zone divider.

public function setThemeByZones( mixed $config, mixed $default ) : $this
Parameter Type(s) Description
$config mixed
$default mixed

Description:

if not exists in zone divider, will using default template.

shutdown ( )

Turn zone into maintenance mode (Maintenance page).

public function shutdown( array|string $zone ) : \MVC\themes
Parameter Type(s) Description
$zone array
string		 if empty, will turn into maintenance mode in all zone

thumbnail ( )

public function thumbnail( mixed $src ) : void
Parameter Type(s) Description
$src mixed

view ( )

public function view( mixed $file ) : void
Parameter Type(s) Description
$file mixed

# \MVC\themes Inherited methods

This class has not inherited methods.

# \MVC\themes Properties

$root_theme

public $root_theme;

Types:

  • mixed

$theme

public $theme;

Types:

  • mixed

$view

public $view;

Types:

  • mixed

$meta

public $meta = array();

Types:

  • mixed

$title

public $title = '';

Types:

  • mixed

$config

public $config;

Types:

  • mixed

$config_folder

public $config_folder;

Types:

  • mixed

$session

Session instances.

public $session = null;

Types:

  • \Session\session

# \MVC\themes Inherited properties

This class has not inherited properties.

# MVC\uid
Extends Nothing
Implements Nothing
Uses Nothing

# \MVC\uid Constants

This class has not constants.

# \MVC\uid Methods

checkRequestUID ( ) static

public static function checkRequestUID( mixed $header_name, mixed $regen_session_timeout = 60 ) : void
Parameter Type(s) Description
$header_name mixed
$regen_session_timeout optional mixed

include_uid_js ( ) static

public static function include_uid_js(  ) : void

receiveUID ( ) static

public static function receiveUID( mixed $header_name, mixed $regen_session_timeout = 60 ) : void
Parameter Type(s) Description
$header_name mixed
$regen_session_timeout optional mixed

removeLastCache ( ) static

public static function removeLastCache(  ) : void

verifyUID ( ) static

public static function verifyUID(  ) : void

# \MVC\uid Inherited methods

This class has not inherited methods.

# \MVC\uid Properties

This class has not properties.

# \MVC\uid Inherited properties

This class has not inherited properties.

# Session\FileSessionHandler
Extends Nothing
Implements \SessionHandlerInterface
Uses Nothing

# \Session\FileSessionHandler Constants

This class has not constants.

# \Session\FileSessionHandler Methods

__construct ( )

public function __construct( mixed $sess_path, mixed $prefix = 'sess_', mixed $postfix = '' ) : void
Parameter Type(s) Description
$sess_path mixed
$prefix optional mixed
$postfix optional mixed

close ( )

public function close(  ) : void

destroy ( )

public function destroy( mixed $sess_id ) : void
Parameter Type(s) Description
$sess_id mixed

gc ( )

public function gc( mixed $lifetime ) : void
Parameter Type(s) Description
$lifetime mixed

open ( )

public function open( mixed $save_path, mixed $sess_name ) : void
Parameter Type(s) Description
$save_path mixed
$sess_name mixed

read ( )

public function read( mixed $sess_id ) : void
Parameter Type(s) Description
$sess_id mixed

write ( )

public function write( mixed $sess_id, mixed $data ) : void
Parameter Type(s) Description
$sess_id mixed
$data mixed

# \Session\FileSessionHandler Inherited methods

This class has not inherited methods.

# \Session\FileSessionHandler Properties

$sess_path

protected $sess_path;

Types:

  • mixed

$prefix

protected $prefix;

Types:

  • mixed

$postfix

protected $postfix;

Types:

  • mixed

# \Session\FileSessionHandler Inherited properties

This class has not inherited properties.

# Session\session
Extends Nothing
Implements Nothing
Uses Nothing

# \Session\session Constants

This class has not constants.

# \Session\session Methods

__construct ( )

public function __construct( mixed $timeout = 3600, mixed $session_folder = null ) : void
Parameter Type(s) Description
$timeout optional mixed
$session_folder optional mixed

all ( ) static

public static function all(  ) : void

dump ( )

public function dump(  ) : void

get ( ) static

public static function get( mixed $key ) : void
Parameter Type(s) Description
$key mixed

getInstance ( ) static

public static function getInstance(  ) : void

gets ( ) static

public static function gets( mixed $keys ) : void
Parameter Type(s) Description
$keys mixed

handle ( )

public function handle( mixed $timeout, mixed $folder = null ) : void
Parameter Type(s) Description
$timeout mixed
$folder optional mixed

has ( ) static

Is session set ?

public static function has( mixed $key, mixed $empty = true ) : void
Parameter Type(s) Description
$key mixed
$empty optional mixed

is_sess ( )

public function is_sess( mixed $session_name, mixed $not_found = null ) : void
Parameter Type(s) Description
$session_name mixed
$not_found optional mixed

is_session_started ( )

public function is_session_started(  ) : void

now ( )

public function now(  ) : void

sess ( )

public function sess( mixed $key, mixed $val ) : void
Parameter Type(s) Description
$key mixed
$val mixed

set_session ( ) static

public static function set_session( mixed $data, mixed $value = null ) : void
Parameter Type(s) Description
$data mixed
$value optional mixed

start_timeout ( )

public function start_timeout( mixed $timeout = 5, mixed $probability = 100 ) : void
Parameter Type(s) Description
$timeout optional mixed
$probability optional mixed

unses ( ) static

Unset Session.

public static function unses( \Session\Number|array|string $name ) : void
Parameter Type(s) Description
$name \Session\Number
array
string

# \Session\session Inherited methods

This class has not inherited methods.

# \Session\session Properties

$sessionCookieName

public $sessionCookieName = 'uf';

Types:

  • mixed

$cookiePath

public $cookiePath = '/';

Types:

  • mixed

$cookieDomain

public $cookieDomain = '';

Types:

  • mixed

# \Session\session Inherited properties

This class has not inherited properties.

# simplehtmldom\Debug

Implements functions for debugging purposes. Debugging can be enabled and disabled on demand. Debug messages are send to error_log by default but it is also possible to register a custom debug handler.
Extends Nothing
Implements Nothing
Uses Nothing

# \simplehtmldom\Debug Constants

This class has not constants.

# \simplehtmldom\Debug Methods

disable ( ) static

Disables debug mode.

public static function disable(  ) : void

enable ( ) static

Enables debug mode.

public static function enable(  ) : void

isEnabled ( ) static

Checks whether debug mode is enabled.

public static function isEnabled(  ) : boolean

Returns:

true if debug mode is enabled, false otherwise

log ( ) static

Adds a debug message to error_log if debug mode is enabled. Does nothing if debug mode is disabled.

public static function log( mixed $message ) : void
Parameter Type(s) Description
$message mixed

log_once ( ) static

Adds a debug message to error_log if debug mode is enabled. Does nothing if debug mode is disabled. Each message is logged only once.

public static function log_once( mixed $message ) : void
Parameter Type(s) Description
$message mixed

setDebugHandler ( ) static

Sets the debug handler.

public static function setDebugHandler( mixed $function = null ) : void
Parameter Type(s) Description
$function optional mixed

Description:

null: error_log (default)

# \simplehtmldom\Debug Inherited methods

This class has not inherited methods.

# \simplehtmldom\Debug Properties

This class has not properties.

# \simplehtmldom\Debug Inherited properties

This class has not inherited properties.

# simplehtmldom\helper
Extends Nothing
Implements Nothing
Uses Nothing

# \simplehtmldom\helper Constants

This class has not constants.

# \simplehtmldom\helper Methods

str_get_html ( ) static

str_get_html.

public static function str_get_html( \simplehtmldom\[type] $str, boolean $lowercase = true, boolean $forceTagsClosed = true, \simplehtmldom\[type] $target_charset = DEFAULT_TARGET_CHARSET, boolean $stripRN = true, \simplehtmldom\[type] $defaultBRText = DEFAULT_BR_TEXT, \simplehtmldom\[type] $defaultSpanText = DEFAULT_SPAN_TEXT ) : \simplehtmldom\HtmlDocument
Parameter Type(s) Description
$str \simplehtmldom\[type]
$lowercase optional boolean
$forceTagsClosed optional boolean
$target_charset optional \simplehtmldom\[type]
$stripRN optional boolean
$defaultBRText optional \simplehtmldom\[type]
$defaultSpanText optional \simplehtmldom\[type]

# \simplehtmldom\helper Inherited methods

This class has not inherited methods.

# \simplehtmldom\helper Properties

This class has not properties.

# \simplehtmldom\helper Inherited properties

This class has not inherited properties.

# simplehtmldom\HtmlDocument

HTMLDocument class.
Extends Nothing
Implements Nothing
Uses Nothing

# \simplehtmldom\HtmlDocument Constants

This class has not constants.

# \simplehtmldom\HtmlDocument Methods

__call ( )

public function __call( mixed $func, mixed $args ) : void
Parameter Type(s) Description
$func mixed
$args mixed

__construct ( )

public function __construct( mixed $str = null, mixed $lowercase = true, mixed $forceTagsClosed = true, mixed $target_charset = DEFAULT_TARGET_CHARSET, mixed $stripRN = true, mixed $defaultBRText = DEFAULT_BR_TEXT, mixed $defaultSpanText = DEFAULT_SPAN_TEXT, mixed $options = 0 ) : void
Parameter Type(s) Description
$str optional mixed
$lowercase optional mixed
$forceTagsClosed optional mixed
$target_charset optional mixed
$stripRN optional mixed
$defaultBRText optional mixed
$defaultSpanText optional mixed
$options optional mixed

__debugInfo ( )

public function __debugInfo(  ) : void

__destruct ( )

public function __destruct(  ) : void

__get ( )

public function __get( mixed $name ) : void
Parameter Type(s) Description
$name mixed

__toString ( )

public function __toString(  ) : void

as_text_node ( )

protected function as_text_node( mixed $tag ) : void
Parameter Type(s) Description
$tag mixed

childNodes ( )

public function childNodes( mixed $idx = -1 ) : void
Parameter Type(s) Description
$idx optional mixed

copy_skip ( )

protected function copy_skip( mixed $chars ) : void
Parameter Type(s) Description
$chars mixed

copy_until ( )

protected function copy_until( mixed $chars ) : void
Parameter Type(s) Description
$chars mixed

copy_until_char ( )

protected function copy_until_char( mixed $char ) : void
Parameter Type(s) Description
$char mixed

createElement ( )

public function createElement( mixed $name, mixed $value = null ) : void
Parameter Type(s) Description
$name mixed
$value optional mixed

createTextNode ( )

public function createTextNode( mixed $value ) : void
Parameter Type(s) Description
$value mixed

decode ( )

protected function decode(  ) : void

dump ( )

public function dump( mixed $show_attr = true ) : void
Parameter Type(s) Description
$show_attr optional mixed

expect ( )

public function expect( mixed $selector, mixed $idx = null, mixed $lowercase = false ) : void
Parameter Type(s) Description
$selector mixed
$idx optional mixed
$lowercase optional mixed

find ( )

Find elements by CSS Selector.

public function find( string $selector, \simplehtmldom\number|null $idx = null, boolean $lowercase = false ) : array<mixed,\simplehtmldom\HtmlNode>|\simplehtmldom\HtmlNode
Parameter Type(s) Description
$selector string CSS Selector
$idx optional \simplehtmldom\number
null
$lowercase optional boolean

firstChild ( )

public function firstChild(  ) : void

getElementById ( )

public function getElementById( mixed $id ) : void
Parameter Type(s) Description
$id mixed

getElementByTagName ( )

public function getElementByTagName( mixed $name ) : void
Parameter Type(s) Description
$name mixed

getElementsById ( )

public function getElementsById( mixed $id, mixed $idx = null ) : void
Parameter Type(s) Description
$id mixed
$idx optional mixed

getElementsByTagName ( )

public function getElementsByTagName( mixed $name, mixed $idx = null ) : void
Parameter Type(s) Description
$name mixed
$idx optional mixed

lastChild ( )

public function lastChild(  ) : void

link_nodes ( )

protected function link_nodes( mixed &$node, mixed $is_child ) : void
Parameter Type(s) Description
$node mixed
$is_child mixed

load ( )

public function load( mixed $str, mixed $lowercase = true, mixed $stripRN = true, mixed $defaultBRText = DEFAULT_BR_TEXT, mixed $defaultSpanText = DEFAULT_SPAN_TEXT, mixed $options = 0 ) : void
Parameter Type(s) Description
$str mixed
$lowercase optional mixed
$stripRN optional mixed
$defaultBRText optional mixed
$defaultSpanText optional mixed
$options optional mixed

loadFile ( )

public function loadFile( mixed $file ) : void
Parameter Type(s) Description
$file mixed

parse ( )

protected function parse( mixed $trim = false ) : void
Parameter Type(s) Description
$trim optional mixed

parse_attr ( )

protected function parse_attr( mixed $node, mixed $name, mixed &$space, mixed $trim ) : void
Parameter Type(s) Description
$node mixed
$name mixed
$space mixed
$trim mixed

parse_charset ( )

protected function parse_charset(  ) : void

prepare ( )

protected function prepare( mixed $str, mixed $lowercase = true, mixed $defaultBRText = DEFAULT_BR_TEXT, mixed $defaultSpanText = DEFAULT_SPAN_TEXT ) : void
Parameter Type(s) Description
$str mixed
$lowercase optional mixed
$defaultBRText optional mixed
$defaultSpanText optional mixed

read_tag ( )

protected function read_tag( mixed $trim ) : void
Parameter Type(s) Description
$trim mixed

remove_callback ( )

public function remove_callback(  ) : void

remove_noise ( )

protected function remove_noise( mixed $pattern, mixed $remove_tag = false ) : void
Parameter Type(s) Description
$pattern mixed
$remove_tag optional mixed

restore_noise ( )

public function restore_noise( mixed $text ) : void
Parameter Type(s) Description
$text mixed

save ( )

Save modified html.

public function save( string $filepath = '' ) : void
Parameter Type(s) Description
$filepath optional string

search_noise ( )

public function search_noise( mixed $text ) : void
Parameter Type(s) Description
$text mixed

set_callback ( )

public function set_callback( mixed $function_name ) : void
Parameter Type(s) Description
$function_name mixed

skip ( )

protected function skip( mixed $chars ) : void
Parameter Type(s) Description
$chars mixed

title ( )

public function title(  ) : void

# \simplehtmldom\HtmlDocument Inherited methods

This class has not inherited methods.

# \simplehtmldom\HtmlDocument Properties

$root

HtmlNode instance.

public $root = null;

Types:

  • \simplehtmldom\HtmlNode

$nodes

public $nodes = array();

Types:

  • mixed

$callback

public $callback = null;

Types:

  • mixed

$lowercase

public $lowercase = false;

Types:

  • mixed

$original_size

public $original_size;

Types:

  • mixed

$size

public $size;

Types:

  • mixed

$_charset

public $_charset = '';

Types:

  • mixed

$_target_charset

public $_target_charset = '';

Types:

  • mixed

$default_br_text

public $default_br_text = '';

Types:

  • mixed

$default_span_text

public $default_span_text = '';

Types:

  • mixed

$pos

protected $pos;

Types:

  • mixed

$doc

protected $doc;

Types:

  • mixed

$char

protected $char;

Types:

  • mixed

$cursor

protected $cursor;

Types:

  • mixed

$parent

protected $parent;

Types:

  • mixed

$noise

protected $noise = array();

Types:

  • mixed

$token_blank

protected $token_blank = " \t\r\n";

Types:

  • mixed

$token_equal

protected $token_equal = ' =/>';

Types:

  • mixed

$token_slash

protected $token_slash = " />\r\n\t";

Types:

  • mixed

$token_attr

protected $token_attr = ' >';

Types:

  • mixed

$self_closing_tags

protected $self_closing_tags = array('area' => 1, 'base' => 1, 'br' => 1, 'col' => 1, 'embed' => 1, 'hr' => 1, 'img' => 1, 'input' => 1, 'link' => 1, 'meta' => 1, 'param' => 1, 'source' => 1, 'track' => 1, 'wbr' => 1);

Types:

  • mixed

$block_tags

protected $block_tags = array('body' => 1, 'div' => 1, 'form' => 1, 'root' => 1, 'span' => 1, 'table' => 1);

Types:

  • mixed

$optional_closing_tags

protected $optional_closing_tags = array('b' => array('b' => 1), 'dd' => array('dd' => 1, 'dt' => 1), 'dl' => array('dd' => 1, 'dt' => 1), 'dt' => array('dd' => 1, 'dt' => 1), 'li' => array('li' => 1), 'optgroup' => array('optgroup' => 1, 'option' => 1), 'option' => array('optgroup' => 1, 'option' => 1), 'p' => array('p' => 1), 'rp' => array('rp' => 1, 'rt' => 1), 'rt' => array('rp' => 1, 'rt' => 1), 'td' => array('td' => 1, 'th' => 1), 'th' => array('td' => 1, 'th' => 1), 'tr' => array('td' => 1, 'th' => 1, 'tr' => 1));

Types:

  • mixed

# \simplehtmldom\HtmlDocument Inherited properties

This class has not inherited properties.

# simplehtmldom\HtmlNode

HTMLNode class.
Extends Nothing
Implements Nothing
Uses Nothing

# \simplehtmldom\HtmlNode Constants

HDOM_INFO_BEGIN

HDOM_INFO_BEGIN = 0;

Type: mixed

HDOM_INFO_END

HDOM_INFO_END = 1;

Type: mixed

HDOM_INFO_ENDSPACE

HDOM_INFO_ENDSPACE = 7;

Type: mixed

HDOM_INFO_INNER

HDOM_INFO_INNER = 5;

Type: mixed

HDOM_INFO_OUTER

HDOM_INFO_OUTER = 6;

Type: mixed

HDOM_INFO_QUOTE

HDOM_INFO_QUOTE = 2;

Type: mixed

HDOM_INFO_SPACE

HDOM_INFO_SPACE = 3;

Type: mixed

HDOM_INFO_TEXT

HDOM_INFO_TEXT = 4;

Type: mixed

HDOM_QUOTE_DOUBLE

HDOM_QUOTE_DOUBLE = 0;

Type: mixed

HDOM_QUOTE_NO

HDOM_QUOTE_NO = 3;

Type: mixed

HDOM_QUOTE_SINGLE

HDOM_QUOTE_SINGLE = 1;

Type: mixed

HDOM_TYPE_CDATA

HDOM_TYPE_CDATA = 7;

Type: mixed

HDOM_TYPE_COMMENT

HDOM_TYPE_COMMENT = 2;

Type: mixed

HDOM_TYPE_ELEMENT

HDOM_TYPE_ELEMENT = 1;

Type: mixed

HDOM_TYPE_ROOT

HDOM_TYPE_ROOT = 5;

Type: mixed

HDOM_TYPE_TEXT

HDOM_TYPE_TEXT = 3;

Type: mixed

HDOM_TYPE_UNKNOWN

HDOM_TYPE_UNKNOWN = 6;

Type: mixed

# \simplehtmldom\HtmlNode Methods

__call ( )

public function __call( mixed $func, mixed $args ) : void
Parameter Type(s) Description
$func mixed
$args mixed

__construct ( )

public function __construct( mixed $dom ) : void
Parameter Type(s) Description
$dom mixed

__debugInfo ( )

public function __debugInfo(  ) : void

__get ( )

public function __get( mixed $name ) : void
Parameter Type(s) Description
$name mixed

__isset ( )

public function __isset( mixed $name ) : void
Parameter Type(s) Description
$name mixed

__set ( )

public function __set( mixed $name, mixed $value ) : void
Parameter Type(s) Description
$name mixed
$value mixed

__toString ( )

public function __toString(  ) : void

__unset ( )

public function __unset( mixed $name ) : void
Parameter Type(s) Description
$name mixed

addClass ( )

public function addClass( mixed $class ) : void
Parameter Type(s) Description
$class mixed

appendChild ( )

public function appendChild( mixed $node ) : void
Parameter Type(s) Description
$node mixed

childNodes ( )

public function childNodes( mixed $idx = -1 ) : void
Parameter Type(s) Description
$idx optional mixed

clear ( )

public function clear(  ) : void

convert_text ( )

public function convert_text( mixed $text ) : void
Parameter Type(s) Description
$text mixed

dump ( )

public function dump( mixed $show_attr = true, mixed $depth = 0 ) : void
Parameter Type(s) Description
$show_attr optional mixed
$depth optional mixed

dump_node ( )

public function dump_node( mixed $echo = true ) : void
Parameter Type(s) Description
$echo optional mixed

expect ( )

public function expect( mixed $selector, mixed $idx = null, mixed $lowercase = false ) : void
Parameter Type(s) Description
$selector mixed
$idx optional mixed
$lowercase optional mixed

find ( )

Element selector.

public function find( string $selector, integer $idx = null, boolean $lowercase = false ) : \simplehtmldom\HtmlNode
Parameter Type(s) Description
$selector string
$idx optional integer
$lowercase optional boolean

find_ancestor_tag ( )

public function find_ancestor_tag( mixed $tag ) : void
Parameter Type(s) Description
$tag mixed

firstChild ( )

public function firstChild(  ) : void

get_display_size ( )

public function get_display_size(  ) : void

getAllAttributes ( )

public function getAllAttributes(  ) : void

getAttribute ( )

public function getAttribute( mixed $name ) : void
Parameter Type(s) Description
$name mixed

getElementById ( )

public function getElementById( mixed $id ) : void
Parameter Type(s) Description
$id mixed

getElementByTagName ( )

public function getElementByTagName( mixed $name ) : void
Parameter Type(s) Description
$name mixed

getElementsById ( )

public function getElementsById( mixed $id, mixed $idx = null ) : void
Parameter Type(s) Description
$id mixed
$idx optional mixed

getElementsByTagName ( )

public function getElementsByTagName( mixed $name, mixed $idx = null ) : void
Parameter Type(s) Description
$name mixed
$idx optional mixed

hasAttribute ( )

public function hasAttribute( mixed $name ) : void
Parameter Type(s) Description
$name mixed

hasChildNodes ( )

public function hasChildNodes(  ) : void

hasClass ( )

public function hasClass( mixed $class ) : void
Parameter Type(s) Description
$class mixed

innertext ( )

public function innertext(  ) : void

is_block_element ( )

Returns true if the provided element is a block level element.

protected function is_block_element( mixed $node ) : void
Parameter Type(s) Description
$node mixed
See also https://www.w3resource.com/html/HTML-block-level-and-inline-elements.php

is_inline_element ( )

Returns true if the provided element is an inline level element.

protected function is_inline_element( mixed $node ) : void
Parameter Type(s) Description
$node mixed
See also https://www.w3resource.com/html/HTML-block-level-and-inline-elements.php

is_utf8 ( ) static

public static function is_utf8( mixed $str ) : void
Parameter Type(s) Description
$str mixed

lastChild ( )

public function lastChild(  ) : void

makeup ( )

public function makeup(  ) : void

match ( )

protected function match( mixed $exp, mixed $pattern, mixed $value, mixed $case_sensitivity ) : void
Parameter Type(s) Description
$exp mixed
$pattern mixed
$value mixed
$case_sensitivity mixed

nextSibling ( )

public function nextSibling(  ) : void

nodeName ( )

public function nodeName(  ) : void

outertext ( )

public function outertext(  ) : void

parent ( )

public function parent( mixed $parent = null ) : void
Parameter Type(s) Description
$parent optional mixed

parentNode ( )

public function parentNode(  ) : void

parse_selector ( )

protected function parse_selector( mixed $selector_string ) : void
Parameter Type(s) Description
$selector_string mixed

previousSibling ( )

public function previousSibling(  ) : void

remove ( )

public function remove(  ) : void

removeAttribute ( )

public function removeAttribute( mixed $name ) : void
Parameter Type(s) Description
$name mixed

removeChild ( )

public function removeChild( mixed $node ) : void
Parameter Type(s) Description
$node mixed

removeClass ( )

public function removeClass( mixed $class = null ) : void
Parameter Type(s) Description
$class optional mixed

save ( )

public function save( mixed $filepath = '' ) : void
Parameter Type(s) Description
$filepath optional mixed

seek ( )

protected function seek( mixed $selector, mixed &$ret, mixed $parent_cmd, mixed $lowercase = false ) : void
Parameter Type(s) Description
$selector mixed
$ret mixed
$parent_cmd mixed
$lowercase optional mixed

setAttribute ( )

public function setAttribute( mixed $name, mixed $value ) : void
Parameter Type(s) Description
$name mixed
$value mixed

text ( )

public function text( mixed $trim = true ) : void
Parameter Type(s) Description
$trim optional mixed

xmltext ( )

public function xmltext(  ) : void

# \simplehtmldom\HtmlNode Inherited methods

This class has not inherited methods.

# \simplehtmldom\HtmlNode Properties

$nodetype

public $nodetype = self::HDOM_TYPE_TEXT;

Types:

  • mixed

$tag

public $tag = 'text';

Types:

  • mixed

$attr

public $attr = array();

Types:

  • mixed

$children

public $children = array();

Types:

  • mixed

$nodes

public $nodes = array();

Types:

  • mixed

$parent

public $parent = null;

Types:

  • mixed

$_

public $_ = array();

Types:

  • mixed

$innertext

public $innertext;

Types:

  • string

$title

public $title;

Types:

  • string -null

$alt

public $alt;

Types:

  • string -null

$src

public $src;

Types:

  • string -null

$href

public $href;

Types:

  • string -null

$async

public $async;

Types:

  • string -null

$defer

public $defer;

Types:

  • string -null

# \simplehtmldom\HtmlNode Inherited properties

This class has not inherited properties.

# simplehtmldom\HtmlWeb
Extends Nothing
Implements Nothing
Uses Nothing

# \simplehtmldom\HtmlWeb Constants

This class has not constants.

# \simplehtmldom\HtmlWeb Methods

load ( )

public function load( mixed $url ) : \simplehtmldom\HtmlDocument
Parameter Type(s) Description
$url mixed

Returns:

Returns the DOM for a webpage

# \simplehtmldom\HtmlWeb Inherited methods

This class has not inherited methods.

# \simplehtmldom\HtmlWeb Properties

This class has not properties.

# \simplehtmldom\HtmlWeb Inherited properties

This class has not inherited properties.

# simplehtmldom\simple_html_dom

String to get html dom.
Extends Nothing
Implements Nothing
Uses Nothing

# \simplehtmldom\simple_html_dom Constants

This class has not constants.

# \simplehtmldom\simple_html_dom Methods

__construct ( )

public function __construct(  ) : void

file_get_html ( )

public function file_get_html( mixed $url, mixed $use_include_path = false, mixed $context = null, mixed $offset = 0, mixed $maxLen = -1, mixed $lowercase = true, mixed $forceTagsClosed = true, mixed $target_charset = \simplehtmldom\DEFAULT_TARGET_CHARSET, mixed $stripRN = true, mixed $defaultBRText = \simplehtmldom\DEFAULT_BR_TEXT, mixed $defaultSpanText = \simplehtmldom\DEFAULT_SPAN_TEXT ) : void
Parameter Type(s) Description
$url mixed
$use_include_path optional mixed
$context optional mixed
$offset optional mixed
$maxLen optional mixed
$lowercase optional mixed
$forceTagsClosed optional mixed
$target_charset optional mixed
$stripRN optional mixed
$defaultBRText optional mixed
$defaultSpanText optional mixed

str_get_html ( )

Parse HTML.

public function str_get_html( string $str, boolean $lowercase = true, boolean $forceTagsClosed = true, string $target_charset = DEFAULT_TARGET_CHARSET, boolean $stripRN = true, string $defaultBRText = DEFAULT_BR_TEXT, string $defaultSpanText = DEFAULT_SPAN_TEXT ) : void
Parameter Type(s) Description
$str string
$lowercase optional boolean
$forceTagsClosed optional boolean
$target_charset optional string
$stripRN optional boolean
$defaultBRText optional string
$defaultSpanText optional string

str_get_xml ( )

Parse XML with simplexml_load_string.

public function str_get_xml( string $str, string $class_name = 'SimpleXMLElement', integer $options = 0, string $namespace_or_prefix = '', boolean $is_prefix = false ) : \simplexml_load_string
Parameter Type(s) Description
$str string
$class_name optional string
$options optional integer
$namespace_or_prefix optional string
$is_prefix optional boolean

# \simplehtmldom\simple_html_dom Inherited methods

This class has not inherited methods.

# \simplehtmldom\simple_html_dom Properties

$innertext

public $innertext;

Types:

  • mixed

$outertext

public $outertext;

Types:

  • mixed

# \simplehtmldom\simple_html_dom Inherited properties

This class has not inherited properties.

Auto-generated at: 2021-05-31, 7:55 AM
Last Updated: 5/22/2021, 9:14:48 AM

← Interfaces →