Zend_Validate-Isbn.xml 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20229 -->
  3. <!-- Reviewed: no -->
  4. <sect2 id="zend.validate.set.isbn">
  5. <title>Isbn</title>
  6. <para>
  7. <classname>Zend_Validate_Isbn</classname> allows you to validate an
  8. <acronym>ISBN-10</acronym> or <acronym>ISBN-13</acronym> value.
  9. </para>
  10. <sect3 id="zend.validate.set.isbn.basic">
  11. <title>Basic usage</title>
  12. <para>
  13. A basic example of usage is below:
  14. </para>
  15. <programlisting language="php"><![CDATA[
  16. $validator = new Zend_Validate_Isbn();
  17. if ($validator->isValid($isbn)) {
  18. // isbn is valid
  19. } else {
  20. // isbn is not valid
  21. }
  22. ]]></programlisting>
  23. <para>
  24. This will validate any <acronym>ISBN-10</acronym> and <acronym>ISBN-13</acronym> without
  25. separator.
  26. </para>
  27. </sect3>
  28. <sect3 id="zend.validate.set.isbn.type-explicit">
  29. <title>Setting an explicit ISBN validation type</title>
  30. <para>
  31. An example of an <acronym>ISBN</acronym> type restriction is below:
  32. </para>
  33. <programlisting language="php"><![CDATA[
  34. $validator = new Zend_Validate_Isbn();
  35. $validator->setType(Zend_Validate_Isbn::ISBN13);
  36. // OR
  37. $validator = new Zend_Validate_Isbn(array(
  38. 'type' => Zend_Validate_Isbn::ISBN13,
  39. ));
  40. if ($validator->isValid($isbn)) {
  41. // this is a valid ISBN-13 value
  42. } else {
  43. // this is an invalid ISBN-13 value
  44. }
  45. ]]></programlisting>
  46. <para>
  47. The above will validate only <acronym>ISBN-13</acronym> values.
  48. </para>
  49. <para>
  50. Valid types include:
  51. </para>
  52. <itemizedlist>
  53. <listitem>
  54. <para><constant>Zend_Validate_Isbn::AUTO</constant> (default)</para>
  55. </listitem>
  56. <listitem>
  57. <para><constant>Zend_Validate_Isbn::ISBN10</constant></para>
  58. </listitem>
  59. <listitem>
  60. <para><constant>Zend_Validate_Isbn::ISBN13</constant></para>
  61. </listitem>
  62. </itemizedlist>
  63. </sect3>
  64. <sect3 id="zend.validate.set.isbn.separator">
  65. <title>Specifying a separator restriction</title>
  66. <para>
  67. An example of separator restriction is below:
  68. </para>
  69. <programlisting language="php"><![CDATA[
  70. $validator = new Zend_Validate_Isbn();
  71. $validator->setSeparator('-');
  72. // OR
  73. $validator = new Zend_Validate_Isbn(array(
  74. 'separator' => '-',
  75. ));
  76. if ($validator->isValid($isbn)) {
  77. // this is a valid ISBN with separator
  78. } else {
  79. // this is an invalid ISBN with separator
  80. }
  81. ]]></programlisting>
  82. <para>
  83. Note that this will return false if <varname>$isbn</varname> doesn't contain a separator
  84. <emphasis>or</emphasis> if it's an invalid <acronym>ISBN</acronym> value.
  85. </para>
  86. <para>
  87. Valid separators include:
  88. </para>
  89. <itemizedlist>
  90. <listitem>
  91. <para>"" (empty) (default)</para>
  92. </listitem>
  93. <listitem>
  94. <para>"-" (hyphen)</para>
  95. </listitem>
  96. <listitem>
  97. <para>" " (space)</para>
  98. </listitem>
  99. </itemizedlist>
  100. </sect3>
  101. </sect2>
  102. <!--
  103. vim:se ts=4 sw=4 et:
  104. -->