Remove double title, make example use sessions, remove .inc usage. #2756

alfsb · 2023-09-11T12:44:20Z

The page mentions session_register/$_SESSION, but these dont occurs on example.

Also, the example use obsolete and insecure .inc extension for included files.

Girgias

Considering you are basically rewriting this whole page already, maybe address the TODO comment at the top of the file?

Girgias · 2023-09-13T13:04:34Z

language/oop5/serialization.xml


  <para>
   <function>serialize</function> returns a string containing a
   byte-stream representation of any value that can be stored in
   PHP. <function>unserialize</function> can use this string to
   recreate the original variable values. Using serialize to
-   save an object will save all variables in an object.  The
+   save an object will save all variables in an object. The


Please revert this white space change. 2 spaces after a FULL STOP is a valid (albeit less used) English formatting style.

About this, all UAs effectively replaces any runs of whitespace with a single space:

The manual is only served and rendered as HTML, even in download formats, as seen on https://www.php.net/download-docs.php :

Single HTML file Many HTML files HTML Help file HTML Help file (with user notes)

I know this, but I don't see the point in changing this, it is just noise.

Girgias · 2023-09-13T13:05:41Z

language/oop5/serialization.xml

   In order to be able to <function>unserialize</function> an object, the
   class of that object needs to be defined. That is, if you have an object
-    of class A and serialize this, you'll
-   get a string that refers to class A and contains all values of variables
+   of class <literal>UserClass</literal> and serialize this, you'll
+   get a string that refers to UserClass and contains all values of variables
   contained in it. If you want to be able to unserialize
-   this in another file, an object of class A, the
-   definition of class A must be present in that file first.
-   This can be done for example by storing the class definition of class A
+   this in another file, an object of UserClass, the
+   definition of UserClass must be present in that file first.
+   This can be done for example by storing the class definition of UserClass
   in an include file and including this file or making use of the


Add literal tags around all the UserClass maybe?

Yes, but it will pollute the text with formating, after UserClass is highlighted once.

Now:

In order to be able to unserialize an object, the class of that object needs to be defined. That is, if you have an object of class UserClass and serialize this, you'll get a string that refers to UserClass and contains all values of variables contained in it. If you want to be able to unserialize this in another file, an object of UserClass, the definition of UserClass must be present in that file first. This can be done for example by storing the class definition of UserClass in an include file and including this file or making use of the spl_autoload_register function.

Changed:

In order to be able to unserialize an object, the class of that object needs to be defined. That is, if you have an object of class UserClass and serialize this, you'll get a string that refers to UserClass and contains all values of variables contained in it. If you want to be able to unserialize this in another file, an object of UserClass, the definition of UserClass must be present in that file first. This can be done for example by storing the class definition of UserClass in an include file and including this file or making use of the spl_autoload_register function.

I don't really mind either way

Why only mark up the first UserClass? I prefer either all or none. (What was wrong with class A anyway?)

Girgias · 2023-09-13T13:07:08Z

language/oop5/serialization.xml

   <programlisting role="php">
 <![CDATA[
+// UserClass.php:
 <?php
-// classa.inc:
+class UserClass {
+    public $data = "";
+
+    function __construct($value)
+    {
+        $this->data = $value;
+    }

-  class A {
-      public $one = 1;
-
-      public function show_one() {
-          echo $this->one;
-      }
-  }
+    public function show() {
+        echo $this->data;
+    }
+}



Maybe it makes sense to split the different "files" into separate <programlisting> and CDATA tags? And use the title tag to name the file?

Ok for this and others, so will take some time.

salathe · 2023-09-13T16:18:04Z

language/oop5/serialization.xml

@@ -77,9 +83,10 @@

  <para>
   So if in the example above <varname>$a</varname> became part of a session


Where is variable $a?

salathe · 2023-09-13T16:22:44Z

language/oop5/serialization.xml

-   file <literal>classa.inc</literal> on all of your pages, not only <filename>page1.php</filename>
-   and <filename>page2.php</filename>.
+   by adding a new key to the <varname>$_SESSION</varname> superglobal array,
+   you should include the file <literal>classa.inc</literal> on all of your


What is classa.inc?

salathe · 2023-09-13T16:39:04Z

language/oop5/serialization.xml

@@ -2,66 +2,72 @@
 <!-- $Revision$ -->
 <!-- TODO Rewrite to remove usage of "you" and talk about __serialize/_unserialize -->
 <sect1 xml:id="language.oop5.serialization" xmlns="http://docbook.org/ns/docbook">
-  <title>Object Serialization</title>
-  <title>Serializing objects - objects in sessions</title>
+  <title>Object serialization and sessions</title>


👎 on this change. The page title should stay as it was. Much of the page is a general overview of serializing objects. There can be a sub-section (<sect2>) for the part about serialized objects in sessions, if you want to separate the details about sessions in particular.

salathe · 2023-09-13T16:44:55Z

Given the current set of changes, I don't like the only example on the page being about $_SESSION and it's automagic (un)serialization of objects. Can we keep a very basic "my first introduction to serializing objects" example?

Girgias reviewed Sep 13, 2023

View reviewed changes

salathe reviewed Sep 13, 2023

View reviewed changes

alfsb closed this Sep 14, 2023

alfsb force-pushed the master branch from 12b23f7 to 91791cd Compare September 14, 2023 13:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove double title, make example use sessions, remove .inc usage. #2756

Remove double title, make example use sessions, remove .inc usage. #2756

alfsb commented Sep 11, 2023

Girgias left a comment

Girgias Sep 13, 2023

alfsb Sep 13, 2023

Girgias Sep 13, 2023

Girgias Sep 13, 2023

alfsb Sep 13, 2023

Girgias Sep 13, 2023

salathe Sep 13, 2023

Girgias Sep 13, 2023

alfsb Sep 13, 2023

salathe Sep 13, 2023

salathe Sep 13, 2023

salathe Sep 13, 2023

salathe commented Sep 13, 2023

		@@ -77,9 +83,10 @@

		<para>
		So if in the example above <varname>$a</varname> became part of a session

Remove double title, make example use sessions, remove .inc usage. #2756

Remove double title, make example use sessions, remove .inc usage. #2756

Conversation

alfsb commented Sep 11, 2023

Girgias left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

salathe commented Sep 13, 2023