AloFramework documentation
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Namespaces

  • Alo
    • Cache
    • Controller
    • Db
    • Exception
    • Session
    • Statics
    • Test
    • Validators
  • Controller
  • None
  • PHP

Classes

  • Cron
  • cURL
  • Email
  • File
  • Handler
  • Profiler
  • SFTP

Class cURL

Object-oriented cURL wrapper

Namespace: Alo
Author: Art <a.molcanovas@gmail.com>
Located at sys/class/alo/curl.php

Methods summary

public
# __construct( string $url = null )

Instantiates the library

Instantiates the library

Parameters

$url
string
$url Optionally, the URL for curl_init()

Throws

Alo\Exception\ExtensionException
When the curl extention is not loaded

Author

Art <a.molcanovas@gmail.com>
public Alo\cURL
# notimeout( boolean $enabled = true )

Set whether cURL should time out

Set whether cURL should time out

Parameters

$enabled
boolean
$enabled The switch

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>
public Alo\cURL
# laxSSLMode( boolean $enabled = true )

Toggles lax SSL verification mode which doesn't check certificates

Toggles lax SSL verification mode which doesn't check certificates

Parameters

$enabled
boolean
$enabled Whether the mode is enabled or disabled

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>
public string
# __toString( )

Returns a string representation of the object data

Returns a string representation of the object data

Returns

string

Author

Art <a.molcanovas@gmail.com>
public static Alo\cURL
# init( string $url = null )

A static wrapper function for __construct()

A static wrapper function for __construct()

Parameters

$url
string
$url Optionally, the URL for curl_init()

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>
public string
# escape( string $str )

URL encodes the given string

URL encodes the given string

Parameters

$str
string
$str The string

Returns

string
The escaped string

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-escape.php
public mixed
# getinfo( integer $opt = 0 )

Get information regarding a specific transfer

Get information regarding a specific transfer

Parameters

$opt
integer
$opt One of the cURL constants

Returns

mixed

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-getinfo.php
public integer
# pause( integer $bitmask )

Pause and unpause a connection

Pause and unpause a connection

Parameters

$bitmask
integer
$bitmask One of CURLPAUSE_* constants.

Returns

integer
An error code (CURLE_OK for no error).

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-pause.php
public array
# version( integer $age = CURLVERSION_NOW )

Gets cURL version information

Gets cURL version information

Parameters

$age
integer
$age

Returns

array

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-version.php
public boolean|integer
# wasSuccessful( )

Checks whether the last transfer was successful

Checks whether the last transfer was successful

Returns

boolean|integer
If successful - true, if not & cURL error code exists - cURL error code, false otherwise

Author

Art <a.molcanovas@gmail.com>
public Alo\cURL
# reset( )

Reset all options of a libcurl session handle

Reset all options of a libcurl session handle

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-reset.php
public string
# unescape( string $str )

Decodes the given URL encoded string

Decodes the given URL encoded string

Parameters

$str
string
$str

Returns

string
The decoded string

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-unescape.php
public
# __destruct( )

Auto-cleanup

Auto-cleanup

Author

Art <a.molcanovas@gmail.com>
public Alo\cURL
# setopt( integer $name, mixed $value )

Sets an option

Sets an option

Parameters

$name
integer
$name The option - see cURL constants
$value
mixed
$value The option value

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-setopt.php
public Alo\cURL
# exec( )

Executes the cURL connection parameters

Executes the cURL connection parameters

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-exec.php
public mixed
# get( string $url = null )

Gets the results of a cURL exec. If $url is set, will exec on that URL

Gets the results of a cURL exec. If $url is set, will exec on that URL

Parameters

$url
string
$url Optional URL override

Returns

mixed
The results of exec()

Author

Art <a.molcanovas@gmail.com>
public Alo\cURL
# close( )

Closes a cURL connection

Closes a cURL connection

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-close.php
public string
# error( )

Returns the error message of the last exec()

Returns the error message of the last exec()

Returns

string

Author

Art <a.molcanovas@gmail.com>

See

Alo\cURL::exec()

Link

http://php.net/manual/en/function.curl-error.php
public integer
# errno( )

Returns the error number of the last exec() or 0 if no error occurred

Returns the error number of the last exec() or 0 if no error occurred

Returns

integer

Author

Art <a.molcanovas@gmail.com>

See

Alo\cURL::exec()

Link

http://php.net/manual/en/function.curl-errno.php
public Alo\cURL
# setopt_array( array $a )

Sets an array of options

Sets an array of options

Parameters

$a
array
$a An array specifying which options to set and their values. The keys should be valid curl_setopt() constants or their integer equivalents.

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>

Link

http://php.net/manual/en/function.curl-setopt-array.php
public Alo\cURL
# setURL( string $url )

Sets the connection URL

Sets the connection URL

Parameters

$url
string
$url The URL

Returns

Alo\cURL

Author

Art <a.molcanovas@gmail.com>
public
# __set( string $name, mixed $value )

Wrapper for setopt()

Wrapper for setopt()

Parameters

$name
string
$name Param name
$value
mixed
$value Param value

Author

Art <a.molcanovas@gmail.com>

Magic methods summary

Properties summary

protected resource $ch
#

The cURL resource

The cURL resource

protected mixed $exec
#

Result of exec()

Result of exec()

See

Alo\cURL::exec()
protected integer $errno
#

Error number of exec()

Error number of exec()

See

Alo\cURL::exec()
protected string $error
#

Error message of exec()

Error message of exec()

See

Alo\cURL::exec()
protected boolean $is_open
#

Whether the connection is open

Whether the connection is open

AloFramework documentation API documentation generated by ApiGen 2.8.0