Programming Standards - Revision history

Jcm-seedburry: /* PHP Service Function Guidelines */

2025-03-31T20:34:22Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:34, 31 March 2025
Line 81:		Line 81:
	</pre>		</pre>

	: The service logic (body)		:* The service logic (body)
	: A return statement that returns a <code>uniformReturnObject</code>		:* A return statement that returns a <code>uniformReturnObject</code>

	Additionally, everything inside the function should be wrapped in a <code>try-catch</code> block.		Additionally, everything inside the function should be wrapped in a <code>try-catch</code> block.

2025-03-31T20:34:07Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:34, 31 March 2025
Line 82:		Line 82:

	: The service logic (body)		: The service logic (body)
	** A return statement that returns a <code>uniformReturnObject</code>		: A return statement that returns a <code>uniformReturnObject</code>

	Additionally, everything inside the function should be wrapped in a <code>try-catch</code> block.		Additionally, everything inside the function should be wrapped in a <code>try-catch</code> block.

2025-03-31T20:33:49Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:33, 31 March 2025
Line 81:		Line 81:
	</pre>		</pre>

	** The service logic (body)		: The service logic (body)
	** A return statement that returns a <code>uniformReturnObject</code>		** A return statement that returns a <code>uniformReturnObject</code>

2025-03-31T20:32:14Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:32, 31 March 2025
Line 75:		Line 75:
	* Inside the function, include the following structure:		* Inside the function, include the following structure:
	** A validation section		** A validation section
	<pre>
	$validation = validate[FileName]Params($params);		<pre>
	if (!$validation['success']) return $validation;		$validation = validate[FileName]Params($params);
	</pre>		if (!$validation['success']) return $validation;
			</pre>

	** The service logic (body)		** The service logic (body)
	** A return statement that returns a <code>uniformReturnObject</code>		** A return statement that returns a <code>uniformReturnObject</code>

2025-03-31T20:30:40Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:30, 31 March 2025
Line 75:		Line 75:
	* Inside the function, include the following structure:		* Inside the function, include the following structure:
	** A validation section		** A validation section
	<pre>		<pre>
	$validation = validate[FileName]Params($params);		$validation = validate[FileName]Params($params);
	if (!$validation['success']) return $validation;		if (!$validation['success']) return $validation;
	</pre>		</pre>
	** The service logic (body)		** The service logic (body)
	** A return statement that returns a <code>uniformReturnObject</code>		** A return statement that returns a <code>uniformReturnObject</code>

2025-03-31T20:29:53Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:29, 31 March 2025
Line 74:		Line 74:
	</pre>		</pre>
	* Inside the function, include the following structure:		* Inside the function, include the following structure:
	** A validation section<pre>		** A validation section
			<pre>
	$validation = validate[FileName]Params($params);		$validation = validate[FileName]Params($params);
	if (!$validation['success']) return $validation;		if (!$validation['success']) return $validation;
	</pre>		</pre>

	** The service logic (body)		** The service logic (body)
	** A return statement that returns a <code>uniformReturnObject</code>		** A return statement that returns a <code>uniformReturnObject</code>

2025-03-31T20:28:21Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:28, 31 March 2025
Line 74:		Line 74:
	</pre>		</pre>
	* Inside the function, include the following structure:		* Inside the function, include the following structure:
	** A validation section		** A validation section<pre>
	::<pre>
	$validation = validate[FileName]Params($params);		$validation = validate[FileName]Params($params);
	if (!$validation['success']) return $validation;		if (!$validation['success']) return $validation;

2025-03-31T20:27:33Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:27, 31 March 2025
Line 75:		Line 75:
	* Inside the function, include the following structure:		* Inside the function, include the following structure:
	** A validation section		** A validation section
	<pre>		::<pre>
	$validation = validate[FileName]Params($params);		$validation = validate[FileName]Params($params);
	if (!$validation['success']) return $validation;		if (!$validation['success']) return $validation;

2025-03-31T20:27:02Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:27, 31 March 2025
Line 79:		Line 79:
	if (!$validation['success']) return $validation;		if (!$validation['success']) return $validation;
	</pre>		</pre>

	** The service logic (body)		** The service logic (body)
	** A return statement that returns a <code>uniformReturnObject</code>		** A return statement that returns a <code>uniformReturnObject</code>

2025-03-31T20:26:25Z

PHP Service Function Guidelines

← Older revision		Revision as of 20:26, 31 March 2025
Line 62:		Line 62:
	* It must be in its own file.		* It must be in its own file.
	* The file name and the function name should be the same.		* The file name and the function name should be the same.
	* It should return: <code>Closure::fromCallable('~~file_or_function_name~~')</code>		* It should return: <code>Closure::fromCallable('fileName')</code>
	* The function must include the standard service header.		* The function must include the standard service header.
	<pre>		<pre>
	/**		/**
	* ~~example~~.php		* fileName.php
	* @author [FirstName LastName] <firstName.lastName@seedburysquare.com>		* @author [FirstName LastName] <firstName.lastName@seedburysquare.com>
	* @copyright Seedbury Square, LLC. All Rights Reserved.		* @copyright Seedbury Square, LLC. All Rights Reserved.
Line 102:		Line 102:

	/**		/**
	* ~~example~~.php		* getExampleDescriptionByExampleId.php
	* @author [FirstName LastName] <firstName.lastName@seedburysquare.com>		* @author [FirstName LastName] <firstName.lastName@seedburysquare.com>
	* @copyright Seedbury Square, LLC. All Rights Reserved.		* @copyright Seedbury Square, LLC. All Rights Reserved.