PHP Classes

File: doc/xml/utils.xml

Recommend this page to a friend!
  Classes of Everton da Rosa  >  XtPHP  >  doc/xml/utils.xml  >  Download  
File: doc/xml/utils.xml
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: XtPHP
General purpose library of utility classes
Author: By
Last change:
Date: 7 years ago
Size: 4,698 bytes
 

Contents

Class file image Download
<?xml version="1.0"?>
<document title="XtPHP" description="Biblioteca de classes que facilitam a vida do programador.">
<class name="XtUtils">
	<description>Oferece métodos para diversas tarefas comuns.</description>
	<methods>
		<method name="printr" visibility="public" example="utils_printr.php">
			<description>Executa a função do PHP print_r passando por parâmetro $mixed, tudo dentro das tags PRE.</description>
			<params>
				<param type="mixed" name="$mixed" optional="false" default="">Array, Object, String, Resource ou outro tipo para exibição.</param>
			</params>
			<return type="void">void</return>
		</method>
		<method name="inputMask" visibility="public" example="utils_inputmask.php">
			<description>Formata uma string de acordo com uma máscara.</description>
			<params>
				<param type="string" name="$str" optional="false" default="">A string a ser formatada.</param>
				<param type="string" name="$mask" optional="false" default="">Uma string contendo a máscara para formatação. O caractere curinga é #.</param>
			</params>
			<return type="string">Retorna a string formatada.</return>
		</method>
		<method name="number" visibility="public" example="utils_number.php">
			<description>Converte uma string para número ou um número para string.</description>
			<params>
				<param type="mixed" name="$number" optional="false" default="">a string ou o número a ser convertido. Se $number for um número, converte para string, se $number for string, converte para número.</param>
			</params>
			<return type="mixed">Retorna uma string com o número formatado ou um número (float, integer, etc.).</return>
		</method>
		<method name="cpfcnpj" visibility="public" example="utils_cpfcnpj.php">
			<description>Formata um número inteiro como CPF ou CNPJ e opcionalmente testa se é um CPF/CNPJ válido.</description>
			<params>
				<param type="integer" name="$doc" optional="false" default="">Um inteiro representando um CPF ou CNPJ.</param>
				<param type="bool" name="$test" optional="true" default="false">True para testar se o CPF/CNPJ é válido.</param>
			</params>
			<return type="string">Retorna o CPF/CNPJ formatado ou false.</return>
		</method>
		<method name="clearNumber" visibility="public" example="utils_clearnumber.php">
			<description>Retira de $string tudo o que não for número.</description>
			<params>
				<param type="string" name="$string" optional="false" default="">A string a ser "tratada".</param>
			</params>
			<return type="integer">Retorna um número inteiro.</return>
		</method>
		<method name="cpfValid" visibility="public" example="utils_cpfcnpj.php">
			<description>Testa se um CPF é válido.</description>
			<params>
				<param type="mixed" name="$cpf" optional="false" default="">Uma string ou um inteiro representando um CPF.</param>
			</params>
			<return type="bool">Retorna true ou false.</return>
		</method>
		<method name="cnpjValid" visibility="public" example="utils_cpfcnpj.php">
			<description>Testa se um CNPJ é válido.</description>
			<params>
				<param type="mixed" name="$cnpj" optional="false" default="">Uma string ou um inteiro representando um CNPJ.</param>
			</params>
			<return type="bool">Retorna true ou false.</return>
		</method>
		<method name="sqlProtect" visibility="public" example="utils_sqlprotect.php">
			<description>Trata dados para ser usado em consultas SQL. Ideal para proteger contra ataques de SQLInjection. Aplica as funções do PHP quoted_printable_encode() e addslashes().</description>
			<params>
				<param type="mixed" name="$str" optional="false" default="">Uma string ou um array para ser tratado.</param>
			</params>
			<return type="mixed">Retorna a string ou o array tratado.</return>
		</method>
		<method name="sqlUnprotect" visibility="public" example="utils_sqlprotect.php">
			<description>Desfaz o efeito de XtUtils::sqlProtect().</description>
			<params>
				<param type="mixed" name="$str" optional="false" default="">Uma string ou um array para ser tratado.</param>
			</params>
			<return type="mixed">Retorna a string ou o array tratado.</return>
		</method>
		<method name="parseMask" visibility="public" example="utils_parsemask.php">
			<description>Interpreta uma máscara de uma string retornando apenas os valores.</description>
			<params>
				<param type="string" name="$str" optional="false" default="">A string "mascarada".</param>
				<param type="string" name="$mask" optional="false" default="">Uma string contendo a máscara para interpretação. O caractere curinga é #.</param>
			</params>
			<return type="string">Retorna a string com os dados sem a máscara.</return>
		</method>
	</methods>
</class>
</document>
For more information send a message to info at phpclasses dot org.