Documentation

GZip extends ContainerAwareObject
in package

GZip utils functions Helper Class

Table of Contents

Properties

$translators  : array<string|int, mixed>
$container  : ContainerInterface

Methods

__call()  : mixed
{@inheritdoc}
__construct()  : mixed
constructor
compress()  : string
Compress a single file into gzip format
containerCall()  : mixed
call method through container
containerMake()  : mixed
create object through container
extract()  : string
Extract a gzip file to a target file
getAdminRouter()  : Admin
gets admin service
getAI()  : Manager
gets ai manager service
getApp()  : App
gets app object
getApplicationLogger()  : Manager
gets application_logger service
getAppRouteInfo()  : RouteInfo|null
gets route info
getAppWebsite()  : Website|null
gets current website
getAssets()  : Manager
gets assets manager
getAuth()  : Manager
gets auth manager service
getCache()  : Manager
get cache manager
getContainer()  : ContainerInterface|Container
gets container object
getCrudRouter()  : Crud
gets crud service
getDb()  : Database|null
gets db object
getDebugbar()  : StandardDebugBar
gets debugbar object
getEnvironment()  : Manager
gets environment manager service
getEventManager()  : SharedEventEmitter
gets events manager service
getGoogleAuthenticator()  : PHPGangsta_GoogleAuthenticator
gets google authenticator service
getGuzzle()  : Client
gets guzzle service
getGZip()  : GZip
gets gzip service
getHtmlRenderer()  : HtmlPartsRenderer
gets html renderer service
getIcons()  : Icons
gets icons service
getImagine()  : Imagine
gets imagine service
getLog()  : Logger
gets log object
getMailer()  : Mailer
gets mailer service
getPdo()  : PDO|null
gets PDO object
getRedis()  : Manager
gets redis service
getRouters()  : array<string|int, mixed>
gets routers
getSchema()  : Schema|null
gets schema object
getSearch()  : Manager
gets search service
getSesMailer()  : SesClient
gets SES mailer service
getSiteData()  : SiteData
gets site data service
getSmtpMailer()  : Swift_Mailer
gets SMTP mailer service
getTemplates()  : Engine
gets plates engine object
getTranslator()  : Translator
gets translator
getUtils()  : Globals
gets global utils service
getWebhooksRouter()  : Webhooks
gets webhooks service
getWebRouter()  : Web
gets routing service
getZip()  : Zip
gets zip service
requestUrl()  : string|bool
executes an http request
getService()  : mixed
gets registered service

Properties

$translators

public static array<string|int, mixed> $translators = []

translators

Methods

__construct()

constructor

public __construct(ContainerInterface $container) : mixed
Parameters
$container : ContainerInterface

compress()

Compress a single file into gzip format

public compress(string $sourceFile[, string|null $targetFile = null ][, int $level = 9 ]) : string
Parameters
$sourceFile : string

Path to the file to compress

$targetFile : string|null = null

Optional target .gz file path (default: sourceFile.gz)

$level : int = 9

Compression level 0-9 (default 9 = max)

Return values
string —

Path to the created gzip file

containerCall()

call method through container

public containerCall(callable $callable[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
$callable : callable
$arguments : array<string|int, mixed> = []

containerMake()

create object through container

public containerMake(string $className[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
$className : string
$arguments : array<string|int, mixed> = []

extract()

Extract a gzip file to a target file

public extract(string $gzipFile[, string|null $targetFile = null ]) : string
Parameters
$gzipFile : string

Path to the .gz file

$targetFile : string|null = null

Optional target file path (default: gzipFile without .gz)

Return values
string —

Path to the extracted file

getContainer()

gets container object

public getContainer() : ContainerInterface|Container
Return values
ContainerInterface|Container

getDb()

gets db object

public getDb() : Database|null
Tags
throws
BasicException
Return values
Database|null

getDebugbar()

gets debugbar object

public getDebugbar() : StandardDebugBar
Tags
throws
BasicException
Return values
StandardDebugBar

getEventManager()

gets events manager service

public getEventManager() : SharedEventEmitter
Tags
throws
BasicException
Return values
SharedEventEmitter

getGoogleAuthenticator()

gets google authenticator service

public getGoogleAuthenticator() : PHPGangsta_GoogleAuthenticator
Tags
throws
BasicException
Return values
PHPGangsta_GoogleAuthenticator

getGuzzle()

gets guzzle service

public getGuzzle() : Client
Tags
throws
BasicException
Return values
Client

getIcons()

gets icons service

public getIcons() : Icons
Tags
throws
BasicException
Return values
Icons

getImagine()

gets imagine service

public getImagine() : Imagine
Tags
throws
BasicException
Return values
Imagine

getLog()

gets log object

public getLog() : Logger
Tags
throws
BasicException
Return values
Logger

getPdo()

gets PDO object

public getPdo() : PDO|null
Tags
throws
BasicException
Return values
PDO|null

getRouters()

gets routers

public getRouters() : array<string|int, mixed>
Tags
throws
BasicException
Return values
array<string|int, mixed>

getSchema()

gets schema object

public getSchema() : Schema|null
Tags
throws
BasicException
Return values
Schema|null

getSesMailer()

gets SES mailer service

public getSesMailer() : SesClient
Tags
throws
BasicException
Return values
SesClient

getSmtpMailer()

gets SMTP mailer service

public getSmtpMailer() : Swift_Mailer
Tags
throws
BasicException
Return values
Swift_Mailer

getTemplates()

gets plates engine object

public getTemplates() : Engine
Tags
throws
BasicException
Return values
Engine

getTranslator()

gets translator

public getTranslator([string|null $locale_code = null ]) : Translator
Parameters
$locale_code : string|null = null
Tags
throws
DependencyException
throws
NotFoundException
Return values
Translator

requestUrl()

executes an http request

public requestUrl(string $url[, string $method = 'GET' ][, array<string|int, mixed> $options = [] ]) : string|bool
Parameters
$url : string
$method : string = 'GET'
$options : array<string|int, mixed> = []
Tags
throws
Exception
throws
GuzzleException
Return values
string|bool

getService()

gets registered service

protected getService(string $service_key) : mixed
Parameters
$service_key : string
Tags
throws
BasicException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results