FrenchRCSDataRequestor Class Reference

FrenchRCSDataRequestor input. More...

Inheritance diagram for FrenchRCSDataRequestor:

Public Member Functions
	__construct ($path_type)
	initialise ($params=array())
	request ($type, $params=array())
Public Member Functions inherited from Input
	__construct ($name, $path_type)
	Input ($name, $path_type)
	display ()
	get_translation ($value, $data=null)
	set_selectedLayout ($layout='')
Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)
	get_version ()
	load_library ($library='')
	load_file ($file='')
	load_varFile ($file='')
	load_engineFile ($file='')
	get_engineFileURL ($file='', $path=false)
	get_fileURL ($file='', $path=null, $default='')
	get_varFileURL ($file='', $path=false, $default='')
	get_filePath ($file='')
	get_varFilePath ($file='')
	add_JSFile ($file)
	add_JSEngineFile ($file)
	add_JSExternFile ($file)
	add_JSScript ($script, $unique=false)
	add_JSPreScript ($script, $unique=false)
	add_JSWindowEventScript ($event, $script, $unique=false)
	add_JSLoadScript ($script, $unique=false)
	add_JSUnloadScript ($script, $unique=false)
	add_styleFile ($file, $media='', $condition='')
	add_styleScript ($css)
	add_styleIncludedFile ($file)
	add_StyleExternFile ($file, $media='', $condition='')
	set_RSSFeed ($title, $url)
	add_headerExtra ($content='')
	install ()
	uninstall ()
	is_installed ()
	update ($version, $more='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSInitialise ()
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	execute_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	execute_request ()
	get_varFile ($file)

Private Member Functions
	request_textSearch ($params)
	build_resultResponse ($result)
	build_errorResponse ($errorId)

Private Attributes
	$requestParams = array()
	HTTP request parameters. More...
	$requestErrors
	List of request errors. More...

Additional Inherited Members
Public Attributes inherited from Input
	$title
	Input title. More...
	$params = array()
	Input parameters. More...
	$selected_layout = 'input.html.inc'
	Input layout to use. More...
Public Attributes inherited from Plugin
	$name
	Plugin name. More...
	$version
	Plugin version. More...
	$active = false
	Plugin installation status. More...
	$plugin_package = ''
	Plugin package. More...
	$plugin_type
	Plugin type. More...
	$object_type
	Plugin type. More...
	$plugin_path
	Plugin path. More...
	$plugin_site_path
	Plugin site path (for element overwriting). More...
	$plugin_var_path
	Plugin var path. More...
	$plugin_url
	Plugin URL. More...
	$plugin_site_url
	Plugin site URL (for element overwriting). More...
	$plugin_var_url
	Plugin var URL. More...
	$path_type
	Plugin path type. More...
	$author_name
	Plugin author name. More...
	$author_mail
	Plugin author email. More...
	$author_group
	Plugin author group. More...
	$plugin_dependencies = array()
	Plugin dependencies. More...
Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')
	add_meta ($name, $content, $method='name')
	add_toHtaccess ($content='')
	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
	set_dependencies ()
	register_asSharedObject ($name)
&	get_sharedObject ($name)
	register_asExtension ($plugin)
	get_registeredExtensions ()
	register_asCaMykSEventHandler ($event)

Detailed Description

FrenchRCSDataRequestor input.

Plugin / Input Engine

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.0.1

Date

Creation: Jun 2025

Modification: Jul 2025

Copyright

2025 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

API Documentation page: https://recherche-entreprises.api.gouv.fr/docs/

ResponseFormat values:

• Brut : Long string with brut (json) request answer
• Data : Decoded request answer as array
• CAJaxRequest : CAJaxRequest object with decoded request answer as array in 'Response' variable FrenchRCSDataRequestor Input class.

Constructor & Destructor Documentation

__construct()

FrenchRCSDataRequestor::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Member Function Documentation

initialise()

FrenchRCSDataRequestor::initialise

(

$params = array()

)

Initialise input.

Parameters

array

$params

Returns

void

Reimplemented from Input.

request()

FrenchRCSDataRequestor::request	(		$type,
			$params = array()
	)

Perform a request.

Parameters

string	$type
array	$params

Returns

string

request_textSearch()

FrenchRCSDataRequestor::request_textSearch (   $params )

private

Perform a textual search request.

Parameters

array

$params

Returns

string

build_resultResponse()

FrenchRCSDataRequestor::build_resultResponse (   $result )

private

Build result answer.

Parameters

string

$result

Returns

mixed

build_errorResponse()

FrenchRCSDataRequestor::build_errorResponse (   $errorId )

private

Build error response.

Parameters

int

$errorId

Returns

mixed

Member Data Documentation

$requestParams

array FrenchRCSDataRequestor::$requestParams = array()

private

HTTP request parameters.

$requestErrors

array FrenchRCSDataRequestor::$requestErrors

private

List of request errors.

---

The documentation for this class was generated from the following file:

• CaMykS/plugin/input/FrenchRCSDataRequestor/FrenchRCSDataRequestor.php.inc