BEdita API doc | 4-cactus
  • Class
  • Tree
  • Deprecated
  • Download

Classes

  • Addon
  • AddressbookController
  • AddressbookShell
  • AdminController
  • Alias
  • Annotation
  • ApiAuthComponent
  • ApiBaseController
  • ApiFormatterComponent
  • ApiUploadComponent
  • ApiValidatorComponent
  • AppController
  • AppError
  • AppHelper
  • Application
  • AppModel
  • Area
  • AreasController
  • Audio
  • AuthenticationsController
  • BannedIp
  • BEAppModel
  • BEAppObjectModel
  • BeAuthComponent
  • BeAuthFacebookComponent
  • BeAuthGoogleComponent
  • BeAuthTwitterComponent
  • BeCallbackManager
  • BeConfigure
  • BeCustomPropertyComponent
  • BeditaAnnotationModel
  • BeditaBaseShell
  • BeditaCollectionModel
  • BeditaContentModel
  • BeditaExportFilter
  • BeditaImportFilter
  • BeditaObjectModel
  • BeditaProductModel
  • BeditaShell
  • BeditaSimpleObjectModel
  • BeditaSimpleStreamModel
  • BeditaStreamModel
  • BeEmbedFlashHelper
  • BeEmbedHtml5Helper
  • BeEmbedMediaHelper
  • BeErrorCode
  • BeExceptionHandler
  • BEFile
  • BeFileHandlerComponent
  • BeFormHelper
  • BeFrontHelper
  • BeHashComponent
  • BeHtmlHelper
  • BeLangTextComponent
  • BeLib
  • BeMailComponent
  • BEObject
  • BeObjectCache
  • BePaginatorToolbarHelper
  • BeSchema
  • BeSecurityComponent
  • BeSystem
  • BeSystemComponent
  • BeThumb
  • BeTimeHelper
  • BeToolbarHelper
  • BeTreeComponent
  • BeTreeHelper
  • BeUploadToObjComponent
  • BeurlHelper
  • BeVimeoComponent
  • BeYoutubeComponent
  • BuildFilterBehavior
  • CacheableBehavior
  • CacheShell
  • CallbackBehavior
  • CaptchaComponent
  • Caption
  • CaptionsBehavior
  • Card
  • CardsImportFilter
  • Category
  • CleanupDataTask
  • CleanupTask
  • Comment
  • CommentsController
  • CompactResultBehavior
  • Content
  • CreateIndexFieldsBehavior
  • DataShell
  • DataTransfer
  • DateItem
  • DbadminShell
  • DeleteDependentObjectBehavior
  • DeleteObjectBehavior
  • DeployShell
  • Document
  • DocumentsController
  • DumpModel
  • EditorialContentsShell
  • EditorNote
  • Event
  • EventLog
  • EventsController
  • FilesController
  • ForeignDependenceSaveBehavior
  • FrontendController
  • FrontendShell
  • GalleriesController
  • Gallery
  • GeoTag
  • GettextShell
  • Git
  • GravatarHelper
  • Group
  • HashJob
  • History
  • HomeController
  • Image
  • ImageInfoHelper
  • JsonExportFilter
  • JsonImportFilter
  • JsonView
  • LangText
  • Link
  • MailGroup
  • MailGroupCard
  • MailJob
  • MailLog
  • MailMessage
  • MailShell
  • MailTemplate
  • Mask
  • MediaShell
  • MigrateDumpModel
  • MigrateShell
  • Migration
  • MigrationBase
  • MigrationDateItemsShell
  • Module
  • ModulesController
  • ModuleShell
  • MultimediaController
  • NewsController
  • NewsletterController
  • NewsletterShell
  • NotifyBehavior
  • ObjectEditor
  • ObjectProperty
  • ObjectRelation
  • ObjectType
  • ObjectUser
  • PagesController
  • Permission
  • PermissionModule
  • PermsHelper
  • Product
  • Property
  • PropertyOption
  • PublicationShell
  • RedisShell
  • RelationCheck
  • RelationRepair
  • RelationShell
  • RelationStats
  • RemoveDummyNameBehavior
  • ResponseHandlerComponent
  • RestClientModel
  • Revision
  • RevisionObjectBehavior
  • SearchText
  • SearchTextSaveBehavior
  • Section
  • SectionDummy
  • SessionFilterComponent
  • SessionFilterHelper
  • ShortNews
  • SmartyView
  • SoapClientModel
  • SplitterSql
  • StatisticsController
  • Stream
  • StreamLog
  • StreamsController
  • Svn
  • TagsController
  • ThemeSmartyView
  • ThumbnailHelper
  • ThumbShell
  • TransactionComponent
  • TransactionFS
  • TranslationsController
  • Tree
  • TrHelper
  • User
  • UserProperty
  • UsersController
  • Utility
  • Version
  • Video
  • VimeoHelper
  • WebmarksController
  • XmlExportFilter
  • XmlImportFilter
  • XmlJsonConverter
  • XmlView
  • YoutubeHelper

Interfaces

  • ApiAuthInterface
  • MediaProviderInterface
  • UploadableInterface

Exceptions

  • BeditaAjaxException
  • BEditaAllowURLException
  • BeditaBadRequestException
  • BeditaConflictException
  • BEditaDeleteStreamObjException
  • BeditaException
  • BEditaFileExistException
  • BeditaForbiddenException
  • BeditaFrontAccessException
  • BeditaHashException
  • BEditaInfoException
  • BeditaInternalErrorException
  • BEditaIOException
  • BeditaLengthRequiredException
  • BeditaMailException
  • BEditaMediaProviderException
  • BeditaMethodNotAllowedException
  • BEditaMIMEException
  • BeditaNotFoundException
  • BeditaNotImplementedException
  • BeditaPublicationException
  • BeditaRuntimeException
  • BEditaSaveStreamObjException
  • BeditaServiceUnavailableException
  • BeditaUnauthorizedException
  • BEditaUploadPHPException
  • BEditaURLException

Class RestClientModel

REST client model uses internally "curl" or cake HttpSocket if "curl" module not available

Model
Extended by AppModel
Extended by BEAppModel
Extended by RestClientModel
Located at models/business/rest_client_model.php

Methods summary

public
# setup( )

setup rest client if curl available setup RestClientModel to use it else setup RestClientModel to use CakePHP HttpSocket class

setup rest client if curl available setup RestClientModel to use it else setup RestClientModel to use CakePHP HttpSocket class

public
# setOptions( array $options = array(), boolean $merge = false )

set self::requestOptions

set self::requestOptions

Parameters

$options
$merge
true if $options has to be merged with self::requestOptions. Default false
public
# setHeaders( array $headers = array() )

Set headers for a call (get/post). After the call, reset headers

Set headers for a call (get/post). After the call, reset headers

public
# get( string $uri, array $params = array(), string $outType = null, boolean $camelize = true, array $headers = array(), $verbose = false )

Do a HTTP GET request and returns output response. Output may be parsed (only xml/json) using $outType argument ("xml" or "json").

Do a HTTP GET request and returns output response. Output may be parsed (only xml/json) using $outType argument ("xml" or "json").

Parameters

$uri
URL to GET
$params
$params, URL query parameters
$outType

$outType, can be "xml" or "json", if present output will be parsed if "xml" => php array, if "json" => json_decode is called

$camelize

$camelize, used if $outType = 'xml' true (default) camelize array keys corresponding to xml items that contain other xml items (CakePHP default behavior) false leave array keys equal to xml items

$headers
$headers, header parameters
$verbose
public
# post( string $uri, mixed $params = array(), string $outType = null, boolean $camelize = true, array $headers = array() )

Do a HTTP POST request and returns output response. Output may be parsed (only xml/json) using $outType argument ("xml" or "json").

Do a HTTP POST request and returns output response. Output may be parsed (only xml/json) using $outType argument ("xml" or "json").

Parameters

$uri
$uri, HTTP POST URL
$params
$params, POST query parameters, if array is encoded with http_build_query
$outType

$outType, can be "xml" or "json", if present output will be parsed if "xml" => php array, if "json" => json_decode is called

$camelize

$camelize, used if $outType = 'xml' true (default) camelize array keys corresponding to xml items that contain other xml items (CakePHP default behavior) false leave array keys equal to xml items

$headers
$headers, extra headers for call
public
# request( string $uri, string $method = "GET", array $params = array(), string $outType = null, boolean $camelize = true, array $headers = array() )

Do a generic HTTP request using custom $method and returns output response. Output may be parsed (only xml/json) using $outType argument ("xml" or "json").

Do a generic HTTP request using custom $method and returns output response. Output may be parsed (only xml/json) using $outType argument ("xml" or "json").

Parameters

$uri
URL to request
$method
$methot HTTP request method, default "GET"
$params
$params, URL query parameters
$outType

$outType, can be "xml" or "json", if present output will be parsed if "xml" => php array, if "json" => json_decode is called

$camelize

$camelize, used if $outType = 'xml' true (default) camelize array keys corresponding to xml items that contain other xml items (CakePHP default behavior) false leave array keys equal to xml items

$headers
Extra headers to be added to request.
private
# callRequest( )
private string
# output( string $out, string $outType, boolean $camelize )

Format response

Format response

Parameters

$out
$outType
$outType, "xml" or "json"
$camelize

Returns

string

Methods inherited from BEAppModel

am(), buildQueryStatement(), checkDate(), checkDuration(), checkFloat(), checkNumber(), containLevel(), email(), fieldsString(), findObjects(), findObjectsAfterFilter(), findObjectsClauses(), findObjectsCount(), getBindingsLevel(), getDefaultDateFormat(), getDriver(), getEndQuote(), getLimitClausole(), getStartQuote(), setBindingsLevel(), setupDbParams(), toolbar()

Methods inherited from AppModel

apiTransformer()

Properties summary

public boolean $useTable
# false
public boolean $httpReady
# false
public $client
#
public boolean $useCurl
# false
public array $callHeaders
# array()
public $lastStatusCode
# null
protected array $requestOptions

options used when a request (get/post) is done

options used when a request (get/post) is done

# array()

Properties inherited from BEAppModel

$actsAs, $driver, $eQ, $modelBindings, $sQ

Properties inherited from AppModel

$apiTransformerOptions

BEdita API doc | 4-cactus API documentation generated by ApiGen