Kit de Développement Logiciel Open Source

Exemple d'appel :

				namespace app\controller;
				class MyController extends \AppController {
					static protected function action_store() {
						$response = new \Response();
						// Action code...
						return $response;
					}
					static protected function action_getdata() {
						$response = new \Response();
						// Action code...
						return $response;
					}
					static protected function action_remove() {
						$response = new \Response();
						// Action code...
						return $response;
					}
				}

Exemple d'appel :

				namespace app\controller;
				class MyController extends \AppController {
					static protected function setAllowedActions() {
						parent::setRequiredProfileForAction('remove', 'Remove rows');
						parent::setForbiddenProfileForAction('save', 'Read only');
					}

					static protected function action_store() {
						$response = new \Response();
						// Action code...
						return $response;
					}
					static protected function action_getdata() {
						$response = new \Response();
						// Action code...
						return $response;
					}
					static protected function action_remove() {
						$response = new \Response();
						// Action code...
						return $response;
					}
				}

Exemple d'appel :

                namespace app\controller;
                class MyController extends \AppController {

                        static protected function setAsynchronousActions()() {
                            return array('runasync');
                        }

                        static protected function action_runasync($processId, $stringParameters) {
                            // Batch processing...
                            return 'OK';
                        }
                }

Exemple d'appel :

                $processId = \AsyncExec::submitActionToLaunch('mycontroller', 'runasync', 'myparam');

Méthode disponible à partir de la version 2.6 de ZnetDK.

Exemple d'appel :

			$binaryValue = \Convert::base64UrlToBinary($base64Url);

Méthode disponible à partir de la version 2.6 de ZnetDK.

Exemple d'appel :

			$base64Url = \Convert::binaryToBase64Url($binaryValue);

Le paramètre $numberOfDecimals à la valeur NULL par défaut, permet d'indiquer le nombre de décimales à retenir après le séparateur de décimales.

Exemple d'appel :

			$myDecimalNumber = \Convert::toDecimalForDB("3451,7399", 2);

Le paramètre $withCurrencySymbol à la valeur TRUE par défaut, indique si le symbole monétaire est inclus ou non dans la chaîne texte retournée.

Le paramètre $numberOfDecimals à la valeur NULL par défaut, permet d'indiquer le nombre de décimales à afficher après le séparateur de décimales.

Le paramètre $forPdfPrinting à la valeur FALSE par défaut, indique si le symbole monétaire est destiné à être imprimé dans un document PDF (symbole € remplacé par le caractère chr(128).

Exemple d'appel :

			$myMoney = \Convert::toMoney(3451.7399);

Exemple d'appel :

			$myDate = \Convert::toLocaleDate(new \DateTime('now'));

Exemple d'appel :

			$myDate = \Convert::toW3CDate(new \DateTime('now'));

Exemple d'appel :

			// '5 677,12' => 5677.12
			$myFloat = \Convert::toDecimal('5 677,12');

Exemple d'appel :

			$myDate = \Convert::W3CtoLocaleDate('2013-04-22');

Exemple d'appel :

			$myUTF8String = \Convert::toUTF8($myString);

Exemple d'appel :

			$myAnsiString = \Convert::valuesToAnsi($values);

Exemple d'appel :

			$iso88591String = \Convert::toISO88591($utf8String);

Exemple d'appel :

namespace app\model;
class CustomersDAO extends \DAO {
    protected function initDaoProperties() {
        $this->table = "customers";
        $this->IdColumnName = "customer_id";
        $this->query = "select customer_id, customer_name, address.* from customers ";
        $this->query .= "left join address using (address_id) ";
        $this->filterClause = "where address.country = ?";
    }
    public function setCityAsFilter($cityName) {
        $this->filterClause = "where address.city = ?";
        $this->setFilterCriteria($cityName);
    }
}

Les dates spécifiées pour la propriété $dateColumns sont rajoutées au tableau retourné par la méthode getResult(), dans un format correspondant à la langue courante d'affichage. Ces dates supplémentaires sont accessibles dans le tableau avec pour nom de clé, le nom de la colonne originale, auquel est ajouté le suffixe _locale (par exemple madate_locale).
La configuration du format d'affichage des dates pour les langues supportées par l'application, est détaillée à la page Gestion multilingue.

Les nombres décimaux spécifiés pour la propriété $moneyColumns sont rajoutés au tableau retourné par la méthode getResult(), dans un format correspondant à la langue courante d'affichage. Ces valeurs au format monétaire sont accessibles dans le tableau avec comme nom de clé, le nom de la colonne originale, auquel est ajouté le suffixe _money (par exemple montant_money).
La configuration du format d'affichage des montants pour les langues supportées par l'application, est détaillée à la page Gestion multilingue.

Les nombres décimaux spécifiés pour la propriété $amountColumns sont rajoutés au tableau retourné par la méthode getResult(), dans un format correspondant à la langue courante d'affichage. Ces montants sont accessibles dans le tableau avec comme nom de clé, le nom de la colonne originale, auquel est ajouté le suffixe _amount (par exemple tarif_amount).
La configuration du format d'affichage des montants pour les langues supportées par l'application, est détaillée à la page Gestion multilingue.

Exemple d'appel :

			$myDao = new \app\model\Clients();
			$myDao->beginTransaction();

Exemple d'appel :

			$row = array('id'=>18,'name'=>'MARTIN','city'=>'Paris');
			$myDao = new \app\model\Clients();
			$myDao->beginTransaction();
			$result = $myDao->store($row);
			$myDao->commit();

Exemple d'appel :

			namespace app\model;
			class Customers extends \DAO
			{
			  protected function initDaoProperties() {
				$this->query = "select id,customer_name from customers ";
				$this->filterClause = "where customer_name= ?";
			  }
			}

La ligne est retournée dans un tableau dont les index correspondent aux noms de colonne de la table ou de la requête.

Exemple d'appel :

				$myDao = new \app\model\Clients();
				$rowData = $myDao->getById(43);
				$clientName = $rowData['client_name'];

Exemple d'appel :

				$myDao = new \app\model\Clients();
				$rowCount = $myDao->getCount();

L'accès à toutes les lignes sélectionnées par le DAO s'effectue par des appels successifs à la méthode getResult().
Une seule ligne est retournée à chaque appel de la méthode. Les données de la ligne sont renvoyées dans une variable de type tableau dont les index sont nommés selon les noms de colonnes du DAO.
La méthode retourne FALSE si la dernière ligne du DAO a déjà été retournée.

Les propriétés $dateColumns et $moneyColumns ainsi que les méthodes setFilterCriteria(), setLimit(), setProfileCriteria() et setSortCriteria(), affectent le résultat obtenu à l'appel de cette méthode.

Exemple d'appel :

				$myDao = new \app\model\Customers();
				while($row = $myDao->getResult()) {
					$customers[] = $row['id'];
				}

Si $id vaut NULL, alors sont supprimées toutes les lignes correspondant à la condition SQL définie via la propriété $filterClause.

Par défaut, la transaction est validée ou annulée automatiquement après suppression des lignes, à moins que le paramètre $autocommit n'ait été renseigné à la valeur FALSE.

La méthode retourne le nombre de lignes supprimées.

Exemple d'appel :

				$customerId = 52;
				$myDao = new \app\model\Customers();
				$rowCount = $myDao->remove($customerId);

Exemple d'appel :

			$row = array('id'=>18,'name'=>'MARTIN','city'=>'Paris');
			$myDao = new \app\model\Clients();
			$myDao->beginTransaction();
			$result = $myDao->store($row);
			$myDao->rollback();

Le paramètre $columns est un tableau contenant le nom des seules colonnes à retourner par le DAO.

Cette méthode est particulièrement utile lorsque la définition du DAO se réduit à définir la seule propriété $table.

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setSelectedColumns(array('id','name'));
				while($row = $myDao->getResult()) {
					$customers[] = $row;
				}

Cette méthode ne s'applique que si la propriété $filterClause a été initialisée pour le DAO à l'appel de la méthode initDaoProperties().

Au minimum une valeur est attendue à l'appel de la méthode.
Si plusieurs valeurs sont renseignées en paramètres, elles doivent l'être dans le même ordre que ceux prévus dans la clause where de la requête SQL (caractères ? indiqués dans la chaîne texte de la propriété $filterClause).

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setFilterCriteria('spain','france','uk');
				while($row = $myDao->getResult()) {
					$customers[] = $row['id'];
				}

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setAmountColumns('total', 'expenses');
				$row = $myDao->getById(18)

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setMoneyColumns('total', 'expenses');
				$row = $myDao->getById(18)

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setDateColumns('creation_date', 'birthday');
				$row = $myDao->getById(18)

Appeler la méthode avec la valeur TRUE en paramètre pour verrouiller les lignes en base de données qui sont sélectionnées à l'appel suivant des méthodes getResult() ou getById().

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setForUpdate(TRUE);
				$row = $myDao->getById(18)

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setLimit(20,40);
				while($row = $myDao->getResult()) {
					$customers[] = $row['id'];
				}

Par défaut, la variable $exclude si elle n'est pas renseignée, prend la valeur FALSE.
Si elle est renseignée à la valeur true, les lignes retournées par le DAO sont toutes celles qui ne correspondent pas aux profils renseignés dans le tableau $profiles.

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setProfileCriteria(array('Accountant','Manager'));
				while($row = $myDao->getResult()) {
					$customers[] = $row;
				}

Ces critères sont indiqués sous la forme d'une chaîne texte telle que "colonne1 ASC, colonne2 DESC". Cette chaîne texte vient alors compléter sur la droite la clause SQL ORDER BY.

Cette méthode accepte également d'appliquer le tri aux colonnes disposant des suffixes _money, _locale et _amount (voir propriétés $moneyColumns, $dateColumns et $amountColumns).

Exemple d'appel :

				$myDao = new \app\model\Customers();
				$myDao->setSortCriteria('name DESC, city ASC');
				while($row = $myDao->getResult()) {
					$customers[] = $row;
				}

Exemple d'appel :

$row = array('id'=>18,'name'=>'MARTIN','city'=>'Paris');
$myDao = new \app\model\Customers();
$myDao->setStoredProfiles(array('Buyer'));
$result = $myDao->store($row);

Les données sont transmises à la méthode dans une variable de type tableau dont les index correspondent aux noms de colonnes à mettre à jour dans la table définie pour le DAO.

Par défaut, la transaction est validée ou annulée automatiquement après enregistrement des données, à moins que le paramètre $autocommit n'ait été renseigné à la valeur FALSE.

Si le paramètre $emptyValuesToNull est renseigné à la valeur TRUE, alors les valeurs renseignées dans la variable $row et qui correspondent à des chaînes de texte vide (valeur '') sont forcées à la valeur NULL dans la table mise à jour en base de données.

Si le nom de la colonne identifiant la ligne de données n'est pas transmise dans le tableau (propriété $IdColumnName du DAO), alors la ligne est insérée en base de données (ordre SQL INSERT).
Autrement, seule les données sont mises à jour pour l'identifiant de la ligne renseignée (ordre SQL UPDATE).

La méthode retourne FALSE si la propriété $table n'a pas été initialisée pour le DAO ou bien si la mise à jour des données a échoué.

Exemple d'appel :

				$row = array('id'=>18,'name'=>'MARTIN','city'=>'Paris');
				$myDao = new \app\model\Customers();
				$result = $myDao->store($row);

Exemple d'appel :

				<?php
					\Database::beginTransaction();
				?>

Exemple d'appel :

				<?php
					\Database::commit();
				?>

Exemple d'appel :

				<?php
					echo \Database::inTransaction();
				?>

Exemple d'appel :

				<?php
					\Database::rollback();
				?>

• $swUrl : URL de l'application ZnetDK distante. Par exemple:
  1) https://usr:pwd@mydomain.com/
  2) https://usr:pwd@mydomain.com/mydir/?appl=myapp
• $method : valeur POST ou GET.
• $controller : nom du contrôleur exposé en tant que service web.
• $action : nom de l'action de contrôleur exposée en tant que service web.
• $extraParameters (optionnel) : tableau contenant les paramètres GET ou POST à transmettre à l'action de contrôleur. Par exemple [my_param1 => 'val1', my_param2 => 'val2'].

Pour exposer une action de contrôleur en service web, veuillez vous référer aux paramètres CFG_HTTP_BASIC_AUTHENTICATION_ENABLED et CFG_ACTIONS_ALLOWED_FOR_WEBSERVICE_USERS.

Méthode disponible à partir de la version 2.5 de ZnetDK.

Exemple d'appel :

<?php
print_r(json_decode(\General::callRemoteAction('https://usr:pwd@mydomain.com/', 'POST',
            'mycontroller', 'myaction', [my_param1 => 'val1', my_param2 => 'val2'])));
?>

Cette méthode utilise OpenSSL.

Exemple d'appel :

<?php
        echo \General::decrypt('cryptedAndBase64EncodedData', 'my password');
?>

Une fois crypté, le texte peut être décripté en appelant la méthode \General::decrypt().

Cette méthode utilise OpenSSL.

Exemple d'appel :

<?php
        echo \General::encrypt('my plain text', 'my password');
?>

Exemple d'appel :

				<?php
					echo \General::getCurrentW3CDate();
				?>

Elle Retourne le texte du message indiqué dans la variable $message après remplacement des motifs %1, %2, %3... par la valeur texte des paramètres $valeur1, $valeur2, $valeur3...

Exemple d'appel :

				<?php
					echo \General::getFilledMessage("Your car is %1 and %2.","blue","yellow");
					/* "Your car is blue and yellow." is displayed */
				?>

Cette méthode est uniquement destinée à être appelée depuis la vue httperror.php (voir rubrique Erreur HTTP).

Exemple d'appel :

				<?php
					echo \General::getHttpErrorCode();
				?>

Exemple d'appel :

				<?php
					echo \General::getMimeType(CFG_DOCUMENTS_DIR . DIRECTORY_SEPARATOR . 'mypicture.gif');
				?>

Le paramètre obligatoire $controller indique le nom du contrôleur applicatif qui dispose d'une action nommée download, chargée de renvoyer le fichier à télécharger.

Le paramètre optionnel $parameters fournit les paramètres HTTP de type GET qui sont nécessaires à l'action download pour déterminer le fichier à renvoyer.

Depuis la version 2.6 de ZnetDK, les fichiers téléchargés sont stockés dans la mémoire cache du navigateur si le paramètre cache=true est précisé pour la variable $parameters et si le paramètre CFG_NON_MOBILE_PWA_ENABLED est activé.

Exemple d'appel :

				<?php
					echo \General::getURIforDownload("mycontroller","file_id=54&cache=true");
				?>

Exemple d'appel :

<?php
        echo \General::isW3cDateValid('2019-01-31') ? 'OK' : 'KO';
?>

Vérifie si la mémoire vive est suffisante pour réduire la taille de la photo indiquée en paramètre par appel de la méthode \General::reducePictureSize().

Méthode disponible à partir de la version 2.8 de ZnetDK.

Exemple d'appel :

				<?php
					$isTooBig = \General::isPictureTooBig('myphoto.jpg');
				?>

Réduit à la taille maximale spécifiée via les paramètres $maxWidth et $maxHeight, l'image de type JPG or PNG dont le chemin absolu est indiqué dans le paramètre $filePath.

Le paramètre $asBase64Url à la valeur TRUE par défaut, indique que l'image réduite est retournée sous la forme d'une URL encodée en Base 64 (par exemple "data:image/png;base64,iVBO...").
A la valeur FALSE, le contenu binaire de l'image réduite est retourné.

Méthode disponible à partir de la version 2.6 de ZnetDK.

Exemple d'appel :

				<?php
					$reducedAsBase64Url = \General::reducePictureSize('myphoto.jpg', 200, 200);
				?>

Exemple d'appel :

				<?php
					\General::writeErrorLog("MYAPP","A severe error occurred while...");
				?>

Exemple d'appel :

				<?php
					\General::writeSystemLog("MYAPP","Backup is terminated...");
				?>

Cette méthode statique est destinée à être appelée depuis le modèle de page de l'application.

La variable $controller est alimentée par le contrôleur \Layout seulement si le paramètre CFG_VIEW_PAGE_RELOAD est défini à la valeur true ou si une erreur HTTP 403 ou 404 est survenue.

Cette méthode statique est destinée à être appelée depuis le modèle de page de l'application.

Cette méthode statique est destinée à être appelée depuis le modèle de page de l'application.

Exemple d'appel :

				<?php
					self::renderDependencies();
				?>

Cette méthode statique est destinée à être appelée depuis le modèle de page de l'application, lui-même appelé par la classe contrôleur \Layout.

Exemple d'appel :

				<?php
					self::renderLangSelection();
				?>

Cette méthode statique est appelée depuis le modèle de page de l'application et retourne l'URL racine de l'application si elle est configurée pour un rechargement de page à chaque clic de menu (paramètre CFG_VIEW_PAGE_RELOAD à la valeur true).
Elle retourne le caractère # dans les autres cas.

Exemple d'appel :

					<a href="<?php self::renderLogoURL(); ?>">...</a>

Les variables $metaDescription, $metaKeywords et $metaAuthor passées en paramètres de la méthode, ne sont valorisées par le contrôleur \Layout que si :

• le paramètre CFG_AUTHENT_REQUIRED vaut FALSE
• le paramètre CFG_VIEW_PAGE_RELOAD est renseigné à true
• les valeurs meta ont été renseignées pour l'entrée de menu de la vue affichée, dans la méthode statique \app\Menu::initAppMenuItems(), lors de l'appel de MenuManager::addMenuItem().

Exemple d'appel :

				<?php self::renderMetaTags($metaDescription,$metaKeywords,$metaAuthor);?>

La variable $type prend la valeur 'tab', 'vertical' ou 'custom' selon que le menu à afficher est un menu à onglets (modèle de page classic), un menu déroulant vertical (modèle de page office) ou un menu personnalisable (modèle de page custom).

La variable $controller est alimentée par le contrôleur \Layout seulement si le paramètre CFG_VIEW_PAGE_RELOAD est défini à la valeur true ou si une erreur HTTP 403 ou 404 est survenue.

Exemple d'appel :

					<?php self::renderNavigationMenu('custom',$controller); ?>

Les paramètres obligatoires de la méthode sont :

• $parentMenuItemID : identifiant de l'élément parent auquel doit être rattaché le nouvel élément de menu. Prend la valeur NULL pour ajouter l'élément directement à la racine du menu.
• $menuItemID : chaîne texte d'identification unique de l'entrée de menu.
• $menuItemLabel : libellé de l'entrée de menu.

En option, si le modèle de page choisi est office, alors une icône peut être affichée pour chaque élément de menu en précisant une icône jQueryUI via le paramètre $menuItemIcon. Ce paramètre est toujours renseigné à la valeur NULL pour les autres modèles de page.

En option, dans le cas en particulier où le paramètre CFG_VIEW_PAGE_RELOAD est défini à la valeur TRUE, les paramètres suivants de la méthode peuvent également être renseignés (à la valeur NULL par défaut) :

• $menuItemSEOlink : libellé affiché dans l'URL d'accès à l'application lorsque l'entrée de menu est sélectionnée.
• $menuItemDescription : description renseignée pour la balise <meta/> de l'application lorsque l'entrée de menu est sélectionnée.
• $menuItemKeywords : mots clés renseignés dans la balise <meta/> de l'application lorsque l'entrée de menu est sélectionnée.
• $menuItemAuthor : auteur renseigné dans la balise <meta/> de l'application lorsque l'entrée de menu est sélectionnée.

Exemple d'appel :

\MenuManager::addMenuItem(NULL,'examples','Exemples');
\MenuManager::addMenuItem('examples','example1','Exemple 1');
\MenuManager::addMenuItem('examples','example2','Exemple 2');

Exemple d'appel :

			$request = new \Request();
			/* The retrieved POST parameter is named "address" */
			$requestedAddress = $request->address;

Exemple d'appel :

				$request = new \Request();
				/* Return array('lastname'=>'value1','firstname'=>'value2') */
				$row = $request->getValuesAsMap('lastname','firstname');

Exemple d'appel :

				$request = new \Request();
				if ($request->isUploadedFile('the_uploaded_file')) {
					// A file has been uploaded in the POST parameter 'the_uploaded_file'...
				} else {
					// No file uploaded...
				}

• 'basename' : nom du fichier avec son extension
• 'extension' : extension du fichier
• 'filename' : nom du fichier sans son extension
• 'dirname' : chemin original du fichier transmis par le navigateur
• 'size' : taille du fichier en octets
• 'type' : type du fichier
• 'tmp_name' : nom complet du fichier comservé le temps de la requête HTTP en local sur le serveur web

Exemple d'appel :

				$request = new \Request();
				$fileInfos = $request->getUploadedFileInfos('the_uploaded_file')
				$fileName = $fileInfos['filename'];
				$fileExtension = $fileInfos['extension'];
				$fileSize = $fileInfos['size'];
				$fileType = $fileInfos['type'];

Exemple d'appel :

				$request = new \Request();
				$response = new \Response();
				$POSTparamName = 'the_uploaded_file';
				try {
				    $fileInfos = $request->getUploadedFileInfos($POSTparamName);
					$targetFile = ZNETDK_APP_ROOT . DIRECTORY_SEPARATOR . 'app'
						. DIRECTORY_SEPARATOR . 'upload' . DIRECTORY_SEPARATOR
						. $fileInfos['basename'];
					$request->moveImageFile($POSTparamName, $targetFile, 100000);
					$response->setSuccessMessage("Uploading image", "File uploaded successfully!");
				} catch(\ZDKException $ex) {
					$response->setFailedMessage('Uploading image...', $ex->getMessage());
				}

Définit les caractères à supprimer en début et en fin de chaîne texte transmise en paramètre d'une requête HTTP.

Par défaut, les caractères supprimés en début et fin de chaîne texte sont " \n\r\t\v\x00".
Cette méthode est utile par exemple pour préserver les sauts de lignes saisis en début et en fin de texte.

Méthode disponible à partir de la version 2.6 de ZnetDK.

Exemple d'appel :

$request = new \Request();
$request->setTrimedCharacters(" \r\t\v\x00");

Définit le niveau de filtrage des données transmises dans les requêtes HTTP.

Le niveau de filtrage est défini par défaut à la valeur 'HIGH' via le paramètre CFG_REQUEST_VARIABLE_FILTERING_LEVEL.

La variable $level peut prendre la valeur 'LOW' ou 'HIGH'.

• 'HIGH' : filtrage assuré par la fonction PHP filter_var() avec le filtre FILTER_SANITIZE_STRING et l'option FILTER_FLAG_NO_ENCODE_QUOTES.
• 'LOW' : filtrage effectué à l'aide de la fonction PHP strip_tags() avec préservation du texte '<=' s'il existe.

Méthode disponible à partir de la version 2.6 de ZnetDK.

Exemple d'appel :

$request = new \Request();
$request->setVariableFilteringLevel('LOW');

Exemple d'appel :

			$response = new \Response();
			$response->myFirstValue = 'value 1';
			$response->myOtherValue = 'value 2';

Cette méthode doit être uniquement appelée depuis l'action download d'un contrôleur applicatif.

Le paramètre $rowData est un tableau à 2 dimensions contenant les lignes de données du fichier CSV.

Le paramètre $fileName est le nom du fichier CSV téléchargé.

Le paramètre $header est un tableau optionnel à 1 dimension qui fournit les libellés d'entête de colonnes du fichier CSV.

Le paramètre $forDisplayInline par défaut à la valeur FALSE, indique si le fichier doit être affiché ou enregistré sur disque après téléchargement. Renseigné à la valeur TRUE, le fichier téléchargé est destiné à être affiché directement dans le navigateur internet (en-tête Content-Disposition: inline).

Exemple d'appel :

			static protected function action_download() {
				$response = new \Response();
				$header = array('Column 1','Column 2','Column 3');
				$data = array(
					array('Row 1 col. 1','Row 1 col. 2','Row 1 col. 3'),
					array('Row 2 col. 1','Row 2 col. 2','Row 2 col. 3'),
					array('Row 3 col. 1','Row 3 col. 2','Row 3 col. 3'),
				);
				$response->setDataForCsv($data, 'myfile.csv', $header);
				return $response;
			}

Cette méthode doit être uniquement appelée depuis l'action download d'un contrôleur applicatif.

Le paramètre $fileName indique le chemin et le nom du fichier à retourner pour téléchargement. La constante CFG_DOCUMENTS_DIR peut être utilisée pour obtenir le chemin de stockage côté serveur web, du fichier à télécharger.

Le paramètre $forDisplayInline par défaut à la valeur FALSE, indique si le fichier doit être affiché ou enregistré sur disque après téléchargement. Renseigné à la valeur TRUE, le fichier téléchargé est destiné à être affiché directement dans le navigateur internet (en-tête Content-Disposition: inline).

Exemple d'appel :

			static protected function action_download() {
				$response = new \Response();
				$fileToDownload = CFG_DOCUMENTS_DIR . DIRECTORY_SEPARATOR . 'mydoc.pdf';
				$response->setFileToDownload($fileToDownload, TRUE);
				return $response;
			}

Cette méthode doit être uniquement appelée depuis l'action download d'un contrôleur applicatif.

Le paramètre $printingObject transmet l'objet de type FPDF instancié depuis le contrôleur applicatif et correspondant à l'impression PDF à retourner dans la réponse HTTP.

Le paramètre $filename par défaut à la valeur NULL, indique le nom à proposer par défaut lors de l'enregistrement en local du document PDF à partir du navigateur internet.

Exemple d'appel :

			static protected function action_download() {
				$response = new \Response();
				$pdf = new \FPDF();
				$pdf->AddPage();
				$pdf->SetFont('Arial','B',16);
				$pdf->Cell(40,10,'PDF document generated from ZnetDK!');
				$response->setPrinting($pdf, 'mydoc.pdf');
				return $response;
			}

Le nom de la vue $viewName correspond à un script PHP situé dans le répertoire /engine/core/view, /engine/core/help, /applications/default/app/view ou /applications/default/app/help et nommé ${viewName}.php.

$viewType prend la valeur view ou help selon qu'il s'agisse d'une vue standard ou d'un fichier d'aide en ligne.

$viewCaller est un paramètre optionnel dont la valeur peut être lue en PHP directement dans le code de la vue (sous la forme $this->viewCaller) et ainsi connaître le contrôleur à l'origine de son appel.

Exemple d'appel :

				$response = new \Response();
				/* Return view "clients.php" */
				$response->setView('clients','view');

Exemple d'appel :

				$response = new \Response();
				$response->setCustomContent('OK');

Exemple d'appel :

				$response = new \Response();
				$myArray = array('status'=>'KO','message'=>'An error occurred!'};
				$response->setResponse($myArray);

Exemple d'appel :

				$response = new \Response();
				$response->setSuccessMessage("Add an item","The item has been added successfully.");

Exemple d'appel :

				$response = new \Response();
				$response->setWarningMessage("New item","Item has been added but it is incomplete.");

Exemple d'appel :

				$response = new \Response();
				$response->setFailedMessage("Add an item","An error occurred while adding the item.");

Exemple d'appel :

				try {
					$myDao->getResult();
				} catch (\PDOException $ex) {
					$response = new \Response();
					$response->setCriticalMessage("Unable to store the item data",$ex);
				}

Exemple d'appel :

                    $dao = new \SimpleDAO('persons');

Les lignes trouvées sont retournées dans la variable $rowsFound (passée par référence à la méthode) sous la forme d'un tableau de tableaux indexés comme illustré ci-dessous :
[0 => ['id' => '5', 'color' => 'Blue', 'type' = 'public'],
1 => ['id' => '8', 'color' => 'Red'], 'type' => 'private'],
...]
Ces lignes correspondent à toutes les lignes de la table si les paramètres POST keyword ou first et count ne sont pas spécifiés dans la requête AJAX.
Autrement, le nombre de lignes retournées dépend directement de la valeur de ces paramètres POST :

• keyword : les mots-clés (séparés par une virgule) qui doivent être présents dans les lignes à retourner. Pour que ces mots-clés soient pris en compte, la colonne de table dans laquelle ils doivent être recherchés doit être indiquée par un appel préalable à la méthode setKeywordSearchColumn().
• first : premier numéro de ligne à retourner (valeur 0 pour sélectionner la première ligne).
• count ou rows (alias) : nombre de lignes à retourner à partir du premier numéro de ligne indiqué.

Les lignes retournées dans la variable $rowsFound sont également triées selon la valeur des paramètres POST sortfield et sortorder s'ils sont renseignés.
Autrement, si la variable optionnelle $defaultSortField est renseignée (par exemple 'name DESC'), alors la colonne de table et l'ordre de tri indiqués sont appliqués.

• sortfield : nom de la colonne de table à laquelle appliquer un ordre de tri.
• sortorder : l'ordre de tri à appliquer (valeur '1' pour croissant, '-1' pour décroissant).

La valeur retournée par la méthode (affectée à la variable $total dans l'exemple ci-dessous) est un entier indiquant le nombre total de lignes qui existent dans la table si le paramètre POST keyword n'est pas renseigné.
Autrement ce nombre correspond au nombre total de lignes trouvées dans la table pour le mot-clé spécifié.
Dans tous les cas, ce nombre total est toujours supérieur ou égal au nombre de lignes retournées dans la variable $rowsFound.

Exemple d'appel :

                /* POST parameters: first='0', count='10', keyword='blue,red' */
                $dao = new \SimpleDAO('persons');
                /* keywords searched into the table's column 'name' */
                $dao->setKeywordSearchColumn('name');
                $persons = array();
                /* Rows found are sorted by 'name' (sorting POST parameters not set) */
                $total = $dao->getRows($persons, 'name ASC');

La variable $condition passée en paramètre est le texte en langage SQL de la condition à appliquer (par exemle 'color = ? AND type = ?').

Les autres variables value1 (obligatoire), value2 (optionnelle), ... et valueN (optionnelle) servent à renseigner les valeurs de la condition spécifiées à l'aide des points d'interrogation.

Les lignes trouvées sont retournées dans un tableau de tableaux indexés comme illustré ci-dessous :
[0 => ['id' => '5', 'color' => 'Blue', 'type' = 'public'],
1 => ['id' => '8', 'color' => 'Red'], 'type' => 'private'],
...]

Exemple d'appel :

                $dao = new \SimpleDAO('persons');
                $condition = 'LOWER(name) LIKE LOWER(?)';
                $value = 'jean';
                $result = $dao->getRowsForCondition($condition, "%{$value}%");

La méthode setKeywordSearchColumn() doit être appelée au préalable pour indiquer la colonne de table dans laquelle les suggestions doivent etre recherchées.

Les suggestions trouvées sont retournées dans un tableau PHP à 1 dimension.
Le nombre de suggestions retournées est de 10 par défaut. Il peut être étendu en renseignant en paramètre la variable $count.

Exemple d'appel :

                /* POST parameter: query='blue' */
                $dao = new \SimpleDAO('persons');
                $dao->setKeywordSearchColumn('name');
                $suggestions = $dao->getSuggestions(20);

Cette méthode est à invoquer juste avant l'appel de la méthode getRows() ou getSuggestions().

Exemple d'appel :

                $dao = new \SimpleDAO('persons');
                $dao->setKeywordSearchColumn('name');

La variable créée dans la session utilisateur est automatiquement supprimée après déconnexion de l'utilisateur.

Si $sanitize = TRUE, la valeur est nettoyée avant d'être stockée en session.

Exemple d'appel :

				\UserSession::setCustomValue('myVarInSession',18);

La valeur NULL est renvoyée dans le cas où la variable $variableName n'a pas été initialisée dans la session de l'utilisateur.

Si $sanitize = TRUE, la valeur est nettoyée avant d'être retournée.

Exemple d'appel :

				$myValueInSession = \UserSession::getCustomValue('myVarInSession');

Retourne la valeur TRUE si la variable $variableName a été correctement supprimée de la session de l'utilisateur.

Exemple d'appel :

				\UserSession::removeCustomValue('myVarInSession');

Méthode disponible à partir de la version 2.5 de ZnetDK.

Exemple d'appel :

$userId = \UserSession::getUserId();

Méthode disponible à partir de la version 2.9 de ZnetDK.

Exemple d'appel :

$userName = \UserSession::getUserName();

Méthode disponible à partir de la version 2.9 de ZnetDK.

Exemple d'appel :

$userEmail = \UserSession::getUserEmail();

Méthode disponible à partir de la version 2.9 de ZnetDK.

Exemple d'appel :

$hasFullMenuAccess = \UserSession::hasFullMenuAccess();

Méthode disponible à partir de la version 2.9 de ZnetDK.

Exemple d'appel :

$userProfiles = \UserSession::getUserProfiles();

Méthode disponible à partir de la version 2.9 de ZnetDK.

Exemple d'appel :

$isAllowed = \UserSession::hasUserProfile('Suppression');

Les paramètres HTTP renseignés uniquement depuis cette méthode (non renseignés dans la méthode initOptionalVariables), sont considérés obligatoires et une erreur est renvoyée par le validateur en cas d'absence de valeur pour l'un d'entre-eux.

Le message d'erreur retourné est celui défini pour la constante de localisation LC_MSG_ERR_MISSING_VALUE_FOR dans les fichiers de traductions du répertoire /engine/core/lang.

Exemple d'appel :

<?php
namespace app\validator;
class UserValidator extends \Validator
{
	protected function initVariables() {
		return array('user_id','user_name','user_email');
	}
}

Exemple d'appel :

<?php
namespace app\validator;
class UserValidator extends \Validator
{
	protected function initVariables() {
		return array('user_id','user_name','user_email');
	}
	protected function initOptionalVariables() {
		return array('user_email');
	}
}

Retourne la valeur TRUE si la valeur est valide, FALSE sinon.
Si la valeur FALSE est retournée, le message d'erreur doit être préalablement initialisé par un appel à la méthode setErrorMessage.

Exemple d'appel :

<?php
namespace app\validator;
class UserValidator extends \Validator
{
	protected function initVariables() {
		return array('user_name');
	}
	protected function check_user_name($value) {
		// 100 characters maximum
		if (strlen($value) > 100) {
			$this->setErrorMessage('User name is too long!');
			return FALSE;
		}
		return TRUE;
	}
}

Exemple d'appel :

				<?php
				namespace app\validator;
				class UserValidator extends \Validator
				{
					protected function initVariables() {
						return array('user_name','login_password','login_password2');
					}
					protected function check_login_password2($value) {
						if ($this->getValue('login_password')!==$value) {
							$this->setErrorMessage('Entered passwords are not the same!');
							return FALSE;
						}
						return TRUE;
					}
					// Other checking methods...
				}

Exemple d'appel :

<?php
namespace app\validator;
class UserValidator extends \Validator
{
	protected function initVariables() {
		return array('user_name');
	}
	protected function check_user_name($value) {
		// 100 characters maximum
		if (strlen($value) > 100) {
			$this->setErrorMessage('Name too long!');
			return FALSE;
		}
		return TRUE;
	}
}

Exemple d'appel :

				<?php
				namespace app\validator;
				class UserValidator extends \Validator
				{
					protected function initVariables() {
						return array('user_name','login_password','login_password2');
					}
					protected function check_login_password2($value) {
						if ($this->getValue('login_password')!==$value) {
							$this->setErrorVariable('login_password');
							$this->setErrorMessage('Entered password are not the same!');
							return FALSE;
						}
						return TRUE;
					}
					// Other checking methods...
				}

Exemple d'appel :

				$userValidator = new \validator\UserValidator();
				if ($userValidator->validate()) {
					echo 'Data validated.';
				} else {
					echo 'Invalid data!';
				}

Exemple d'appel :

				$userValidator = new \app\validator\UserValidator();
				if ($userValidator->validate()) {
					echo 'Data validated.';
				} else {
					echo 'Error detected for the variable'
							.$userValidator->getErrorVariable();
				}

Exemple d'appel :

				$userValidator = new \app\validator\UserValidator();
				if ($userValidator->validate()) {
					echo 'Data validated.';
				} else {
					echo $userValidator->getErrorMessage();
				}

Exemple d'appel :

				<?php
				$userValidator = new \app\validator\UserValidator();
				$userRow = $userValidator->getValues();

Par défaut, si cette méthode n'est pas appelée, c'est le validateur qui vérifie directement si la valeur est manquante pour toute variable déclarée dans la méthode initVariables qui n'est pas définie optionnelle par la méthode initOptionalVariables

Exemple d'appel :

				<?php
				$userValidator = new \app\validator\UserValidator();
				$userValidator->setCheckingMissingValues();
				$userValidator->validate();

Exemple d'appel :

				<?php
				$userValidator = new \app\validator\UserValidator();
				$userValidator->setValues(array('name'=>'Alford', 'birthdate'=>'2016-10-12'));
				$userValidator->validate();

La méthode retourne TRUE si l'utilisateur dispose de l'élément de menu $menuItem, FALSE dans le cas contraire.

Exemple d'appel :

if (\controller\Users:hasMenuItem('myview') {
	echo "The connected user has access to 'myview'";
} else {
	echo "The connected user has not access to 'myview'";
}

Le nom du profil renseigné dans la variable $profileName correspond à celui renseigné dans le formulaire d'ajout d'un profil.

La méthode retourne TRUE si l'utilisateur dispose du profil $profileName, FALSE dans le cas contraire.

Exemple d'appel :

if (\controller\Users:hasProfile('Administrator') {
	echo 'The connected user is an Administrator';
} else {
	echo 'The connected user is not an Administrator';
}

• Le paramètre $isNewUser contient la valeur TRUE lorsque la méthode est appelée dans le cas d'un ajout d'utilisateur. Autrement, il contient la valeur FALSE.
• Le paramètre $passwordInClear contient le mot de passe en clair du compte utilisateur ajouté ou modifié.
• Le paramètre $otherUserData fournit les informations complémentaires du compte utilisateur ajouté ou modifié parmi lesquelles, le nom de l'utilisateur, son identifiant de connexion, son adresse email ...

Exemple d'implémentation :

			static public function notify($isNewUser, $passwordInClear, $otherUserData)
			{
				$appURI = \General::getApplicationURI();
				$connectedUserName = \MainController::execute('Users', 'getUserName');
				$connectedUserEmail = \MainController::execute('Users', 'getUserEmail');
				$emailTemplate = $isNewUser ? 'new-user' : 'password-change';
				$email = new \zdkmail\mod\Email($emailTemplate);
				$email->addAddress('FROM', $connectedUserName .' <' . $connectedUserEmail . '>');
				$email->addAddress('TO', $otherUserData['user_email']);
				$email->setSubjectValues($otherUserData['login_name']);
				$email->setMessageValues($otherUserData['user_name'], $appURI,
					$otherUserData['login_name'], $passwordInClear, $connectedUserName);
				if (!$email->send()) {
					throw new \Exception(LM_MSG_WARN_EMAIL_NOT_SENT_TO_USER);
				}
			}

Exemple d'implémentation :

			static public function getUserTheme()
			{
				return 'asphalt';
			}

Le paramètre $templateName est obligatoire et specifie le nom du modèle de l'email à envoyer.

Le paramètre $format initialisé par défaut à la valeur 'AUTO', indique le format du modèle d'email à envoyer : 'TEXT' pour un format texte ou 'HTML' pour un format 'HTML'.
A la valeur 'AUTO', le format de l'email est détecté automatiquement en fonction de la présence ou non de balises HTML dans le modèle d'email.

Exemple d'appel :

			$email = new \zdkmail\mod\Email('new-user');

Le paramètre $type précise le type d'adresse email :

• 'TO' : l'adresse est celle d'un destinataire direct de l'email,
• 'FROM' : l'adresse est celle de l'émetteur de l'email,
• 'CC' : l'adresse est celle d'un destinataire en copie de l'email,
• 'BCC' : l'adresse est celle d'un destinataire en copie masquée de l'email,
• 'REPLY' : l'adresse est celle du destinataire de la réponse de l'email,
• 'SENDER' : l'adresse est celle de l'auteur de l'email.

Le paramètre $address indique l'adresse email du destinataire.

Exemple d'appel :

			$email = new \zdkmail\mod\Email('new-user');
			$email->addAddress('FROM','admin@email.com');
			$email->addAddress('TO','john.peer@email.com');
			$email->addAddress('CC','lisa.halo@email.com');
			$email->addAddress('CC','erick.arrow@email.com');

Le paramètre $fileName précise le nom du fichier à joindre à l'email.

Exemple d'appel :

			$email = new \zdkmail\mod\Email('new-user');
			$email->addAddress('TO','john.peer@email.com');
			$documentDirectory = ZNETDK_APP_ROOT . DIRECTORY_SEPARATOR . 'app' .
                        DIRECTORY_SEPARATOR . 'document' . DIRECTORY_SEPARATOR;
			$email->attach($documentDirectory . 'mydocument.pdf');

Retourne TRUE si l'envoi réussit, FALSE en cas d'échec.

Exemple d'appel :

			$email = new \zdkmail\mod\Email('new-user');
			$email->addAddress('TO','john.peer@email.com');
			$status = $email->send;

Exemple d'appel :

			$email = new \zdkmail\mod\Email('new-user');
			$email->addAddress('TO','john.peer@email.com');
			$email->setMessageValues('John Deer','12/01/2015', '100,00€', 'The Administrator');
			$status = $email->send;

Exemple d'appel :

			$email = new \zdkmail\mod\Email('new-user');
			$email->addAddress('TO','john.peer@email.com');
			$email->setSubjectValues('John Deer','12/01/2015');
			$status = $email->send;

Exemple d'appel :

			var selectedMenu = znetdk.getSelectedMenu();
			menuId = selectedMenu.id;
			menuLabel = selectedMenu.label;

Exemple d'appel :

			znetdk.getUserConfirmation({
				title:'Demande de confirmation',
				message:'Voulez-vous supprimer cet enregistrement ?',
				yesLabel:'Oui',
				noLabel:'Non',
				callback:function(confirmation){
					if (confirmation) {
						alert('Confirmée.');
					} else {
						alert('Non confirmée !');
					}
				}
			});

Exemple d'appel :

			var currentLanguage = znetdk.getCurrentLanguage();

Exemple d'appel :

			var textValue = znetdk.getLocalSettings('myStorageKey');

Exemple d'appel :

			znetdk.initCommonWidgets($('#mon_formulaire'));

Exemple d'appel :

			znetdk.loadView({
				control:'myview',
				action: 'show',
				htmlTarget:$("div.myclass")
				callback:function(response) {
					alert('view succesfully loaded.');
				}
			});

Exemple d'appel :

				znetdk.message('info','Adding a customer','Customer added successfully.');

Exemple d'appel :

				znetdk.multiMessages([
					{severity:'info',summary:'Info...',detail:'Info detail...'},
					{severity:'warn',summary:'Warning...',detail:'Warning detail'},
					{severity:'error',summary:'Error...',detail: 'Error detail'}
				]);

Exemple d'appel :

znetdk.notifyUser({
        title:'Information',
        message:'Dernière demande traitée.',
        buttonLabel:'Ok',
        callback:function(){
            alert('Click Ok');
        }
});

Exemple d'appel :

znetdk.reducePhotoSize(myPhoto, 1600, 1200, function(reducedPhoto){
    console.log(reducedPhoto);
});

Exemple d'appel :

znetdk.reducePhotoSizePercent(myPhoto, 50, 1600, function(reducedPhoto){
    console.log(reducedPhoto);
});

Exemple d'appel :

				znetdk.request({
					control:'fournisseurctrl',
					action:'supprimer',
					data:{numero_fournisseur:18},
					callback:function(response){
						if (response.success) {
							console.log( "Suppression réussie" );
						} else {
							console.log( "Erreur à la suppression" );
						}
					}
				});	

Exemple d'appel :

			znetdk.storeLocalSettings('myStorageKey','my text value');

Exemple d'appel :

				znetdk.showMenuView('myview',{parameter1:'value1',parameter2:'value2'});

Exemple d'interception de l'évènement initview dans la vue :

				$('#zdk-office-menu').bind('zdkofficemenuinitview', function(event, parameters) {
					alert('View displayed with parameters: ',
						parameters.parameter1, parameters.parameter2);
				});

Exemple d'appel :

				var beforeShow = function(dialogElement) { alert('Before...'); },
					afterShow = function(dialogElement) { alert('After...'); }
				znetdk.showModalDialog('mydialog', 'myview', beforeShow, afterShow);

Exemple d'appel :

				znetdk.useScriptFile('js/myviewscript.js');

Exemple d'appel :

				znetdk.useStyleSheet('css/myviewstyle.css');

Exemple de code :

			$('body').on('disconnected', function() {
				alert('User is disconnected!');
			});